diff options
Diffstat (limited to 'coverage')
| -rw-r--r-- | coverage/cmdline.py | 26 | ||||
| -rw-r--r-- | coverage/config.py | 3 | ||||
| -rw-r--r-- | coverage/control.py | 20 | ||||
| -rw-r--r-- | coverage/lcovreport.py | 106 | ||||
| -rw-r--r-- | coverage/results.py | 15 |
5 files changed, 170 insertions, 0 deletions
diff --git a/coverage/cmdline.py b/coverage/cmdline.py index efed9040..9f5c9ea8 100644 --- a/coverage/cmdline.py +++ b/coverage/cmdline.py @@ -127,6 +127,11 @@ class Opts: '', '--pretty-print', action='store_true', help="Format the JSON for human readers.", ) + lcov = optparse.make_option( + '-o', '', action='store', dest='outfile', + metavar="OUTFILE", + help="Write the LCOV report to this file. Defaults to 'coverage.lcov'" + ) parallel_mode = optparse.make_option( '-p', '--parallel-mode', action='store_true', help=( @@ -473,6 +478,20 @@ CMDS = { usage="[options] [modules]", description="Generate an XML report of coverage results." ), + + 'lcov': CmdOptionParser( + "lcov", + [ + Opts.fail_under, + Opts.ignore_errors, + Opts.include, + Opts.lcov, + Opts.omit, + Opts.quiet, + ] + GLOBAL_ARGS, + usage="[options] [modules]", + description="Generate an LCOV report of coverage results." + ) } @@ -657,6 +676,12 @@ class CoverageScript: show_contexts=options.show_contexts, **report_args ) + elif options.action == "lcov": + total = self.coverage.lcov_report( + outfile=options.outfile, + **report_args + ) + else: # There are no other possible actions. raise AssertionError @@ -854,6 +879,7 @@ HELP_TOPICS = { report Report coverage stats on modules. run Run a Python program and measure code execution. xml Create an XML report of coverage results. + lcov Create an LCOV report of coverage results. Use "{program_name} help <command>" for detailed help on any command. """, diff --git a/coverage/config.py b/coverage/config.py index 9835e341..75217def 100644 --- a/coverage/config.py +++ b/coverage/config.py @@ -227,6 +227,9 @@ class CoverageConfig: self.json_pretty_print = False self.json_show_contexts = False + # Default output filename for lcov_reporter + self.lcov_output = "coverage.lcov" + # Defaults for [paths] self.paths = collections.OrderedDict() diff --git a/coverage/control.py b/coverage/control.py index 99319c05..bd51ffc5 100644 --- a/coverage/control.py +++ b/coverage/control.py @@ -26,6 +26,7 @@ from coverage.files import PathAliases, abs_file, relative_filename, set_relativ from coverage.html import HtmlReporter from coverage.inorout import InOrOut from coverage.jsonreport import JsonReporter +from coverage.lcovreport import LcovReporter from coverage.misc import bool_or_none, join_regex, human_sorted, human_sorted_items from coverage.misc import DefaultValue, ensure_dir_for_file, isolate_module from coverage.plugin import FileReporter @@ -1049,6 +1050,25 @@ class Coverage: ): return render_report(self.config.json_output, JsonReporter(self), morfs, self._message) + def lcov_report( + self, morfs=None, outfile=None, ignore_errors=None, + omit=None, include=None, contexts=None, + ): + """Generate an LCOV report of coverage results. + + Each module in 'morfs' is included in the report. 'outfile' is the + path to write the file to, "-" will write to stdout. + + See :meth 'report' for other arguments. + + .. versionadded:: 6.3 + """ + with override_config(self, + ignore_errors=ignore_errors, report_omit=omit, report_include=include, + lcov_output=outfile, report_contexts=contexts, + ): + return render_report(self.config.lcov_output, LcovReporter(self), morfs, self._message) + def sys_info(self): """Return a list of (key, value) pairs showing internal information.""" diff --git a/coverage/lcovreport.py b/coverage/lcovreport.py new file mode 100644 index 00000000..5a49ac4a --- /dev/null +++ b/coverage/lcovreport.py @@ -0,0 +1,106 @@ +# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 +# For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt + +"""LCOV reporting for coverage.py.""" + +import sys +import base64 +from hashlib import md5 + +from coverage.report import get_analysis_to_report + + +class LcovReporter: + """A reporter for writing LCOV coverage reports.""" + + report_type = "LCOV report" + + def __init__(self, coverage): + self.coverage = coverage + self.config = self.coverage.config + + def report(self, morfs, outfile=None): + """Renders the full lcov report + + 'morfs' is a list of modules or filenames + + outfile is the file object to write the file into. + """ + + self.coverage.get_data() + outfile = outfile or sys.stdout + + for fr, analysis in get_analysis_to_report(self.coverage, morfs): + self.get_lcov(fr, analysis, outfile) + + def get_lcov(self, fr, analysis, outfile=None): + """Produces the lcov data for a single file + + get_lcov currently supports both line and branch coverage, + however function coverage is not supported. + + """ + + outfile.write("TN:\n") + outfile.write(f"SF:{fr.relative_filename()}\n") + source_lines = fr.source().splitlines() + for covered in sorted(analysis.executed): + # Note: Coveragepy currently only supports checking *if* a line has + # been executed, not how many times, so we set this to 1 for nice + # output even if it's technically incorrect + + # The lines below calculate a 64 bit encoded md5 hash of the line + # corresponding to the DA lines in the lcov file, + # for either case of the line being covered or missed in Coveragepy + # The final two characters of the encoding ("==") are removed from + # the hash to allow genhtml to run on the resulting lcov file + if source_lines: + line = source_lines[covered - 1].encode("utf-8") + else: + line = b"" + hashed = str(base64.b64encode(md5(line).digest())[:-2], encoding="utf-8") + outfile.write(f"DA:{covered},1,{hashed}\n") + for missed in sorted(analysis.missing): + if source_lines: + line = source_lines[missed - 1].encode("utf-8") + else: + line = b"" + hashed = str(base64.b64encode(md5(line).digest())[:-2], encoding="utf-8") + outfile.write(f"DA:{missed},0,{hashed}\n") + outfile.write(f"LF:{len(analysis.statements)}\n") + outfile.write(f"LH:{len(analysis.executed)}\n") + + # More information dense branch coverage data + missing_arcs = analysis.missing_branch_arcs() + executed_arcs = analysis.executed_branch_arcs() + for block_number, block_line_number in enumerate( + sorted(analysis.branch_stats().keys()) + ): + for branch_number, line_number in enumerate( + sorted(missing_arcs[block_line_number]) + ): + # The exit branches have a negative line number, + # this will not produce valid lcov, and so setting + # the line number of the exit branch to 0 will allow + # for valid lcov, while preserving the data + line_number = max(line_number, 0) + outfile.write(f"BRDA:{line_number},{block_number},{branch_number},-\n") + # The start value below allows for the block number to be + # preserved between these two for loops (stopping the loop from + # resetting the value of the block number to 0) + for branch_number, line_number in enumerate( + sorted(executed_arcs[block_line_number]), + start=len(missing_arcs[block_line_number]), + ): + line_number = max(line_number, 0) + outfile.write(f"BRDA:{line_number},{block_number},{branch_number},1\n") + + # Summary of the branch coverage + if analysis.has_arcs(): + branch_stats = analysis.branch_stats() + brf = sum(t for t, k in branch_stats.values()) + brh = brf - sum(t - k for t, k in branch_stats.values()) + outfile.write(f"BRF:{brf}\n") + outfile.write(f"BRH:{brh}\n") + + outfile.write("end_of_record\n") diff --git a/coverage/results.py b/coverage/results.py index 7bb4781c..9675bff9 100644 --- a/coverage/results.py +++ b/coverage/results.py @@ -136,6 +136,21 @@ class Analysis: mba[l1].append(l2) return mba + @contract(returns='dict(int: list(int))') + def executed_branch_arcs(self): + """Return arcs that were executed from branch lines. + + Returns {l1:[l2a,l2b,...], ...} + + """ + executed = self.arcs_executed() + branch_lines = set(self._branch_lines()) + eba = collections.defaultdict(list) + for l1, l2 in executed: + if l1 in branch_lines: + eba[l1].append(l2) + return eba + @contract(returns='dict(int: tuple(int, int))') def branch_stats(self): """Get stats about branches. |