From 1a6b591c080c84932ba27990d95cbbd356fbacc9 Mon Sep 17 00:00:00 2001 From: holger krekel Date: Wed, 25 Nov 2009 18:56:24 +0100 Subject: merging/unifying test plugin code * coverage/testplugin.py contains common test plugin options and pytest hooks (which don't induce "import py") * coverage/nose_coverage.py contains a basic Nose Plugin * test/test_testplugin.py contains a pytest-functional test and a nose-skeleton one. skipped as appropriate. --- coverage/testplugin.py | 190 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 coverage/testplugin.py (limited to 'coverage/testplugin.py') diff --git a/coverage/testplugin.py b/coverage/testplugin.py new file mode 100644 index 0000000..a979ad2 --- /dev/null +++ b/coverage/testplugin.py @@ -0,0 +1,190 @@ +import coverage, optparse + +class CoverageTestWrapper(object): + """ + A Coverage Test Wrapper. + + 1) Setup the with the parsed options + 2) Call start() + 3) Run your tests + 4) Call finish() + 5) Improve your code coverage ;) + """ + + def __init__(self, options, _covpkg=None): + self.options = options + + # _covpkg is for dependency injection, so we can test this code. + if _covpkg: + self.covpkg = _covpkg + else: + import coverage + self.covpkg = coverage + + self.coverage = None + + def start(self): + # Set up coverage + self.coverage = self.covpkg.coverage( + data_suffix = bool(self.options.cover_parallel_mode), + cover_pylib = self.options.cover_pylib, + timid = self.options.cover_timid, + branch = self.options.cover_branch, + ) + + # Run the script. + self.coverage.start() + + def finish(self): + # end coverage and save the results + self.coverage.stop() + self.coverage.save() + + # Remaining actions are reporting, with some common self.options. + report_args = { + 'morfs': [], + 'ignore_errors': self.options.cover_ignore_errors, + } + + # Handle any omits + # Allow pointing to a file as well + try: + omit_file = open(self.options.cover_omit) + omit_prefixes = [line.strip() for line in omit_file.readlines()] + report_args['omit_prefixes'] = omit_prefixes + except: + omit = self.options.cover_omit.split(',') + report_args['omit_prefixes'] = omit + + if 'report' in self.options.cover_actions: + self.coverage.report( + show_missing=self.options.cover_show_missing, **report_args) + if 'annotate' in self.options.cover_actions: + self.coverage.annotate( + directory=self.options.cover_directory, **report_args) + if 'html' in self.options.cover_actions: + self.coverage.html_report( + directory=self.options.cover_directory, **report_args) + if 'xml' in self.options.cover_actions: + outfile = self.options.cover_outfile + if outfile == '-': + outfile = None + self.coverage.xml_report(outfile=outfile, **report_args) + + return + +options = [ + optparse.Option('', + '--cover-action', action='append', default=None, + dest='cover_actions', type="choice", choices=['annotate', 'html', 'report', 'xml'], + help="""\ +annotate Annotate source files with execution information. +html Create an HTML report. +report Report coverage stats on modules. +xml Create an XML report of coverage results. +""".strip()), + + optparse.Option( + '--cover-branch', action='store_true', + help="Measure branch execution. HIGHLY EXPERIMENTAL!" + ), + optparse.Option( + '--cover-directory', action='store', + metavar="DIR", + help="Write the output files to DIR." + ), + optparse.Option( + '--cover-ignore-errors', action='store_true', + help="Ignore errors while reading source files." + ), + optparse.Option( + '--cover-pylib', action='store_true', + help="Measure coverage even inside the Python installed library, " + "which isn't done by default." + ), + optparse.Option( + '--cover-show-missing', action='store_true', + help="Show line numbers of statements in each module that weren't " + "executed." + ), + optparse.Option( + '--cover-omit', action='store', + metavar="PRE1,PRE2,...", + default='', + help="Omit files when their filename path starts with one of these " + "prefixes." + ), + optparse.Option( + '--cover-outfile', action='store', + metavar="OUTFILE", + help="Write the XML report to this file. Defaults to 'coverage.xml'" + ), + optparse.Option( + '--cover-parallel-mode', action='store_true', + help="Include the machine name and process id in the .coverage " + "data file name." + ), + optparse.Option( + '--cover-timid', action='store_true', + help="Use a simpler but slower trace method. Try this if you get " + "seemingly impossible results!" + ), + optparse.Option( + '--cover-append', action='store_false', + help="Append coverage data to .coverage, otherwise it is started " + "clean with each run." + ) +] + +# py.test plugin hooks + +def pytest_addoption(parser): + """ + Get all the options from the coverage.runner and import them + """ + group = parser.getgroup('Coverage options') + for opt in options: + group._addoption_instance(opt) + +def pytest_configure(config): + # Load the runner and start it up + if config.getvalue("cover_actions"): + config.pluginmanager.register(DoCover(config), "do_coverage") + +class DoCover: + def __init__(self, config): + self.config = config + + def pytest_sessionstart(self): + self.coverage = CoverageTestWrapper(self.config.option) + # XXX maybe better to start/suspend/resume coverage + # for each single test item + self.coverage.start() + + def pytest_terminal_summary(self, terminalreporter): + # Finished the tests start processing the coverage + config = terminalreporter.config + tw = terminalreporter._tw + tw.sep('-', 'coverage') + tw.line('Processing Coverage...') + self.coverage.finish() + + +# XXX please make the following unnessary +# Monkey patch omit_filter to use regex patterns for file omits +def omit_filter(omit_prefixes, code_units): + import re + exclude_patterns = [re.compile(line.strip()) for line in omit_prefixes if line and not line.startswith('#')] + filtered = [] + for cu in code_units: + skip = False + for pattern in exclude_patterns: + if pattern.search(cu.filename): + skip = True + break + + if not skip: + filtered.append(cu) + return filtered + +coverage.codeunit.omit_filter = omit_filter -- cgit v1.2.1 From ab747f7c2f3bb2e9ca5d88e78b9bac5284466187 Mon Sep 17 00:00:00 2001 From: holger krekel Date: Wed, 10 Feb 2010 18:23:18 +0100 Subject: integrate a patch by prologic (James Mills) to add some options. --- coverage/testplugin.py | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) (limited to 'coverage/testplugin.py') diff --git a/coverage/testplugin.py b/coverage/testplugin.py index a979ad2..7b8c0f4 100644 --- a/coverage/testplugin.py +++ b/coverage/testplugin.py @@ -1,4 +1,10 @@ -import coverage, optparse +import os +import re +import sys +import optparse +from types import ListType + +import coverage class CoverageTestWrapper(object): """ @@ -11,6 +17,9 @@ class CoverageTestWrapper(object): 5) Improve your code coverage ;) """ + coverTests = False + coverPackages = None + def __init__(self, options, _covpkg=None): self.options = options @@ -22,6 +31,9 @@ class CoverageTestWrapper(object): self.covpkg = coverage self.coverage = None + + self.coverTests = options.cover_tests + self.coverPackage = options.cover_package def start(self): # Set up coverage @@ -31,6 +43,8 @@ class CoverageTestWrapper(object): timid = self.options.cover_timid, branch = self.options.cover_branch, ) + + self.skipModules = sys.modules.keys()[:] # Run the script. self.coverage.start() @@ -39,10 +53,14 @@ class CoverageTestWrapper(object): # end coverage and save the results self.coverage.stop() self.coverage.save() + + modules = [module + for name, module in sys.modules.items() + if module is not None and name.startswith(self.coverPackage)] # Remaining actions are reporting, with some common self.options. report_args = { - 'morfs': [], + 'morfs': modules, 'ignore_errors': self.options.cover_ignore_errors, } @@ -55,7 +73,7 @@ class CoverageTestWrapper(object): except: omit = self.options.cover_omit.split(',') report_args['omit_prefixes'] = omit - + if 'report' in self.options.cover_actions: self.coverage.report( show_missing=self.options.cover_show_missing, **report_args) @@ -83,7 +101,17 @@ html Create an HTML report. report Report coverage stats on modules. xml Create an XML report of coverage results. """.strip()), - + optparse.Option( + '--cover-package', action='store', + dest="cover_package", + metavar="COVER_PACKAGE", + help="Restrict coverage output to selected package" + ), + optparse.Option("--cover-tests", action="store_true", + dest="cover_tests", + metavar="[NOSE_COVER_TESTS]", + default=False, + help="Include test modules in coverage report "), optparse.Option( '--cover-branch', action='store_true', help="Measure branch execution. HIGHLY EXPERIMENTAL!" -- cgit v1.2.1 From db9a63f43c8d0c2aa83c64c6e5b314797e9486c8 Mon Sep 17 00:00:00 2001 From: David Stanek Date: Sat, 20 Feb 2010 18:36:25 -0500 Subject: fixed busted nose integration --- coverage/testplugin.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'coverage/testplugin.py') diff --git a/coverage/testplugin.py b/coverage/testplugin.py index 7b8c0f4..4ff598a 100644 --- a/coverage/testplugin.py +++ b/coverage/testplugin.py @@ -49,7 +49,7 @@ class CoverageTestWrapper(object): # Run the script. self.coverage.start() - def finish(self): + def finish(self, stream=None): # end coverage and save the results self.coverage.stop() self.coverage.save() @@ -76,7 +76,8 @@ class CoverageTestWrapper(object): if 'report' in self.options.cover_actions: self.coverage.report( - show_missing=self.options.cover_show_missing, **report_args) + show_missing=self.options.cover_show_missing, + file=stream, **report_args) if 'annotate' in self.options.cover_actions: self.coverage.annotate( directory=self.options.cover_directory, **report_args) -- cgit v1.2.1 From f1935555fb148d173b9adf2e35f687573c929370 Mon Sep 17 00:00:00 2001 From: David Stanek Date: Fri, 21 May 2010 23:40:04 -0400 Subject: modified to use report as the default action - the way the old nose plugin worked --- coverage/testplugin.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'coverage/testplugin.py') diff --git a/coverage/testplugin.py b/coverage/testplugin.py index 4ff598a..89334d7 100644 --- a/coverage/testplugin.py +++ b/coverage/testplugin.py @@ -94,7 +94,7 @@ class CoverageTestWrapper(object): options = [ optparse.Option('', - '--cover-action', action='append', default=None, + '--cover-action', action='append', default=['report'], dest='cover_actions', type="choice", choices=['annotate', 'html', 'report', 'xml'], help="""\ annotate Annotate source files with execution information. -- cgit v1.2.1 From 8713c466aeb25a736e7b095682b8dc6500e3d382 Mon Sep 17 00:00:00 2001 From: David Stanek Date: Fri, 21 May 2010 23:40:04 -0400 Subject: fixed an error where not specifying the cover package would cause a traceback --- coverage/testplugin.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'coverage/testplugin.py') diff --git a/coverage/testplugin.py b/coverage/testplugin.py index 89334d7..3cef47c 100644 --- a/coverage/testplugin.py +++ b/coverage/testplugin.py @@ -54,10 +54,12 @@ class CoverageTestWrapper(object): self.coverage.stop() self.coverage.save() - modules = [module - for name, module in sys.modules.items() - if module is not None and name.startswith(self.coverPackage)] - + modules = [] + if self.coverPackage: + for name, module in sys.modules.items(): + if module is not None and name.startswith(self.coverPackage): + modules.append(module) + # Remaining actions are reporting, with some common self.options. report_args = { 'morfs': modules, -- cgit v1.2.1 From 8550826b49fa6f229098601c9236e9895ab312bf Mon Sep 17 00:00:00 2001 From: David Stanek Date: Fri, 21 May 2010 23:40:04 -0400 Subject: fixed the --cover-packages option --- coverage/testplugin.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'coverage/testplugin.py') diff --git a/coverage/testplugin.py b/coverage/testplugin.py index 3cef47c..f685758 100644 --- a/coverage/testplugin.py +++ b/coverage/testplugin.py @@ -33,7 +33,7 @@ class CoverageTestWrapper(object): self.coverage = None self.coverTests = options.cover_tests - self.coverPackage = options.cover_package + self.coverPackages = options.cover_package def start(self): # Set up coverage @@ -55,10 +55,11 @@ class CoverageTestWrapper(object): self.coverage.save() modules = [] - if self.coverPackage: + if self.coverPackages: for name, module in sys.modules.items(): - if module is not None and name.startswith(self.coverPackage): - modules.append(module) + for package in self.coverPackages: + if module is not None and name.startswith(package): + modules.append(module) # Remaining actions are reporting, with some common self.options. report_args = { @@ -105,10 +106,11 @@ report Report coverage stats on modules. xml Create an XML report of coverage results. """.strip()), optparse.Option( - '--cover-package', action='store', + '--cover-package', action='append', default=[], dest="cover_package", metavar="COVER_PACKAGE", - help="Restrict coverage output to selected package" + help=("Restrict coverage output to selected package " + "- can be specified multiple times") ), optparse.Option("--cover-tests", action="store_true", dest="cover_tests", @@ -205,16 +207,14 @@ class DoCover: # Monkey patch omit_filter to use regex patterns for file omits def omit_filter(omit_prefixes, code_units): import re - exclude_patterns = [re.compile(line.strip()) for line in omit_prefixes if line and not line.startswith('#')] + exclude_patterns = [re.compile(line.strip()) for line in omit_prefixes + if line and not line.startswith('#')] filtered = [] for cu in code_units: - skip = False for pattern in exclude_patterns: if pattern.search(cu.filename): - skip = True break - - if not skip: + else: filtered.append(cu) return filtered -- cgit v1.2.1 From 4f3a0803c488997fee42b8f8781d67b959f81eae Mon Sep 17 00:00:00 2001 From: David Stanek Date: Fri, 21 May 2010 23:40:04 -0400 Subject: refactored the plugin's finish method to better enable filtering modules from a report --- coverage/testplugin.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) (limited to 'coverage/testplugin.py') diff --git a/coverage/testplugin.py b/coverage/testplugin.py index f685758..c93b859 100644 --- a/coverage/testplugin.py +++ b/coverage/testplugin.py @@ -54,12 +54,8 @@ class CoverageTestWrapper(object): self.coverage.stop() self.coverage.save() - modules = [] - if self.coverPackages: - for name, module in sys.modules.items(): - for package in self.coverPackages: - if module is not None and name.startswith(package): - modules.append(module) + modules = [module for name, module in sys.modules.items() + if self._want_module(name, module)] # Remaining actions are reporting, with some common self.options. report_args = { @@ -95,6 +91,14 @@ class CoverageTestWrapper(object): return + def _want_module(self, name, module): + for package in self.coverPackages: + if module is not None and name.startswith(package): + return True + + return False + + options = [ optparse.Option('', '--cover-action', action='append', default=['report'], -- cgit v1.2.1 From 0f53d84d463713f40dea772a9b3f75bf6f035f96 Mon Sep 17 00:00:00 2001 From: David Stanek Date: Fri, 21 May 2010 23:40:04 -0400 Subject: cleaned up the testplugin module --- coverage/testplugin.py | 178 +++++++++++++++++++++---------------------------- 1 file changed, 75 insertions(+), 103 deletions(-) (limited to 'coverage/testplugin.py') diff --git a/coverage/testplugin.py b/coverage/testplugin.py index c93b859..75c5b33 100644 --- a/coverage/testplugin.py +++ b/coverage/testplugin.py @@ -1,42 +1,34 @@ -import os import re import sys import optparse -from types import ListType import coverage + class CoverageTestWrapper(object): - """ - A Coverage Test Wrapper. - + """A coverage test wrapper. + 1) Setup the with the parsed options 2) Call start() 3) Run your tests 4) Call finish() 5) Improve your code coverage ;) """ - - coverTests = False + coverPackages = None - def __init__(self, options, _covpkg=None): - self.options = options - + def __init__(self, options, _covpkg=coverage): # _covpkg is for dependency injection, so we can test this code. - if _covpkg: - self.covpkg = _covpkg - else: - import coverage - self.covpkg = coverage - + + self.options = options + self.covpkg = _covpkg + self.coverage = None self.coverTests = options.cover_tests self.coverPackages = options.cover_package - + def start(self): - # Set up coverage self.coverage = self.covpkg.coverage( data_suffix = bool(self.options.cover_parallel_mode), cover_pylib = self.options.cover_pylib, @@ -44,13 +36,11 @@ class CoverageTestWrapper(object): branch = self.options.cover_branch, ) - self.skipModules = sys.modules.keys()[:] - - # Run the script. + self.skipModules = sys.modules.keys()[:] #TODO: is this necessary?? + self.coverage.start() - + def finish(self, stream=None): - # end coverage and save the results self.coverage.stop() self.coverage.save() @@ -62,33 +52,31 @@ class CoverageTestWrapper(object): 'morfs': modules, 'ignore_errors': self.options.cover_ignore_errors, } - - # Handle any omits - # Allow pointing to a file as well - try: + + try: # try looking for an omit file omit_file = open(self.options.cover_omit) omit_prefixes = [line.strip() for line in omit_file.readlines()] report_args['omit_prefixes'] = omit_prefixes - except: + except: # assume cover_omit is a ',' separated list if provided omit = self.options.cover_omit.split(',') report_args['omit_prefixes'] = omit if 'report' in self.options.cover_actions: self.coverage.report( - show_missing=self.options.cover_show_missing, - file=stream, **report_args) + show_missing=self.options.cover_show_missing, + file=stream, **report_args) if 'annotate' in self.options.cover_actions: self.coverage.annotate( - directory=self.options.cover_directory, **report_args) + directory=self.options.cover_directory, **report_args) if 'html' in self.options.cover_actions: self.coverage.html_report( - directory=self.options.cover_directory, **report_args) + directory=self.options.cover_directory, **report_args) if 'xml' in self.options.cover_actions: outfile = self.options.cover_outfile if outfile == '-': outfile = None self.coverage.xml_report(outfile=outfile, **report_args) - + return def _want_module(self, name, module): @@ -100,77 +88,62 @@ class CoverageTestWrapper(object): options = [ - optparse.Option('', - '--cover-action', action='append', default=['report'], - dest='cover_actions', type="choice", choices=['annotate', 'html', 'report', 'xml'], - help="""\ + optparse.Option('--cover-action', action='append', default=['report'], + dest='cover_actions', type="choice", + choices=['annotate', 'html', 'report', 'xml'], + help="""\ annotate Annotate source files with execution information. html Create an HTML report. report Report coverage stats on modules. xml Create an XML report of coverage results. -""".strip()), - optparse.Option( - '--cover-package', action='append', default=[], - dest="cover_package", - metavar="COVER_PACKAGE", - help=("Restrict coverage output to selected package " - "- can be specified multiple times") - ), - optparse.Option("--cover-tests", action="store_true", - dest="cover_tests", - metavar="[NOSE_COVER_TESTS]", - default=False, - help="Include test modules in coverage report "), - optparse.Option( - '--cover-branch', action='store_true', - help="Measure branch execution. HIGHLY EXPERIMENTAL!" - ), - optparse.Option( - '--cover-directory', action='store', - metavar="DIR", - help="Write the output files to DIR." - ), - optparse.Option( - '--cover-ignore-errors', action='store_true', - help="Ignore errors while reading source files." - ), - optparse.Option( - '--cover-pylib', action='store_true', - help="Measure coverage even inside the Python installed library, " - "which isn't done by default." - ), - optparse.Option( - '--cover-show-missing', action='store_true', - help="Show line numbers of statements in each module that weren't " - "executed." - ), - optparse.Option( - '--cover-omit', action='store', - metavar="PRE1,PRE2,...", - default='', - help="Omit files when their filename path starts with one of these " - "prefixes." - ), - optparse.Option( - '--cover-outfile', action='store', - metavar="OUTFILE", - help="Write the XML report to this file. Defaults to 'coverage.xml'" - ), - optparse.Option( - '--cover-parallel-mode', action='store_true', - help="Include the machine name and process id in the .coverage " - "data file name." - ), - optparse.Option( - '--cover-timid', action='store_true', - help="Use a simpler but slower trace method. Try this if you get " - "seemingly impossible results!" - ), - optparse.Option( - '--cover-append', action='store_false', - help="Append coverage data to .coverage, otherwise it is started " - "clean with each run." - ) + """.strip()), + + optparse.Option('--cover-package', action='append', default=[], + dest="cover_package", metavar="COVER_PACKAGE", + help=("Restrict coverage output to selected package " + "- can be specified multiple times")), + + optparse.Option("--cover-tests", action="store_true", dest="cover_tests", + metavar="[NOSE_COVER_TESTS]", default=False, + help="Include test modules in coverage report "), + + optparse.Option('--cover-branch', action='store_true', + help="Measure branch execution. HIGHLY EXPERIMENTAL!"), + + optparse.Option('--cover-directory', action='store', metavar="DIR", + help="Write the output files to DIR."), + + optparse.Option('--cover-ignore-errors', action='store_true', + help="Ignore errors while reading source files."), + + optparse.Option('--cover-pylib', action='store_true', + help=("Measure coverage even inside the Python installed " + "library, which isn't done by default.")), + + optparse.Option('--cover-show-missing', action='store_true', + help=("Show line numbers of statements in each module " + "that weren't executed.")), + + optparse.Option('--cover-omit', action='store', + metavar="PRE1,PRE2,...", default='', + help=("Omit files when their filename path starts with " + "one of these prefixes.")), + + optparse.Option('--cover-outfile', action='store', metavar="OUTFILE", + help=("Write the XML report to this file. Defaults to " + "'coverage.xml'")), + + optparse.Option('--cover-parallel-mode', action='store_true', + help=("Include the machine name and process id in the " + ".coverage data file name.")), + + optparse.Option('--cover-timid', action='store_true', + help=("Use a simpler but slower trace method. Try this " + "if you get seemingly impossible results!")), + + optparse.Option('--cover-append', action='store_false', + help=("Append coverage data to .coverage, otherwise it " + "is started clean with each run.")) ] # py.test plugin hooks @@ -189,6 +162,7 @@ def pytest_configure(config): config.pluginmanager.register(DoCover(config), "do_coverage") class DoCover: + def __init__(self, config): self.config = config @@ -199,18 +173,16 @@ class DoCover: self.coverage.start() def pytest_terminal_summary(self, terminalreporter): - # Finished the tests start processing the coverage config = terminalreporter.config tw = terminalreporter._tw tw.sep('-', 'coverage') tw.line('Processing Coverage...') self.coverage.finish() - + # XXX please make the following unnessary # Monkey patch omit_filter to use regex patterns for file omits def omit_filter(omit_prefixes, code_units): - import re exclude_patterns = [re.compile(line.strip()) for line in omit_prefixes if line and not line.startswith('#')] filtered = [] -- cgit v1.2.1 From 343f36c3fe555a196ca59268f71ea4c7838f4d1c Mon Sep 17 00:00:00 2001 From: David Stanek Date: Sat, 22 May 2010 08:33:18 -0400 Subject: fixed a bug caused in 8e1995c8156a - refactoring out omit_filter never really worked --- coverage/testplugin.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'coverage/testplugin.py') diff --git a/coverage/testplugin.py b/coverage/testplugin.py index 75c5b33..bb0231a 100644 --- a/coverage/testplugin.py +++ b/coverage/testplugin.py @@ -182,7 +182,7 @@ class DoCover: # XXX please make the following unnessary # Monkey patch omit_filter to use regex patterns for file omits -def omit_filter(omit_prefixes, code_units): +def omit_filter(omit_prefixes, code_units, file_locator): exclude_patterns = [re.compile(line.strip()) for line in omit_prefixes if line and not line.startswith('#')] filtered = [] -- cgit v1.2.1