|
1 # Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 |
|
2 # For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt |
|
3 |
|
4 """Json reporting for coverage.py""" |
|
5 |
|
6 import datetime |
|
7 import json |
|
8 import sys |
|
9 |
|
10 from coverage import __version__ |
|
11 from coverage.report import get_analysis_to_report |
|
12 from coverage.results import Numbers |
|
13 |
|
14 |
|
15 class JsonReporter: |
|
16 """A reporter for writing JSON coverage results.""" |
|
17 |
|
18 report_type = "JSON report" |
|
19 |
|
20 def __init__(self, coverage): |
|
21 self.coverage = coverage |
|
22 self.config = self.coverage.config |
|
23 self.total = Numbers(self.config.precision) |
|
24 self.report_data = {} |
|
25 |
|
26 def report(self, morfs, outfile=None): |
|
27 """Generate a json report for `morfs`. |
|
28 |
|
29 `morfs` is a list of modules or file names. |
|
30 |
|
31 `outfile` is a file object to write the json to. |
|
32 |
|
33 """ |
|
34 outfile = outfile or sys.stdout |
|
35 coverage_data = self.coverage.get_data() |
|
36 coverage_data.set_query_contexts(self.config.report_contexts) |
|
37 self.report_data["meta"] = { |
|
38 "version": __version__, |
|
39 "timestamp": datetime.datetime.now().isoformat(), |
|
40 "branch_coverage": coverage_data.has_arcs(), |
|
41 "show_contexts": self.config.json_show_contexts, |
|
42 } |
|
43 |
|
44 measured_files = {} |
|
45 for file_reporter, analysis in get_analysis_to_report(self.coverage, morfs): |
|
46 measured_files[file_reporter.relative_filename()] = self.report_one_file( |
|
47 coverage_data, |
|
48 analysis |
|
49 ) |
|
50 |
|
51 self.report_data["files"] = measured_files |
|
52 |
|
53 self.report_data["totals"] = { |
|
54 'covered_lines': self.total.n_executed, |
|
55 'num_statements': self.total.n_statements, |
|
56 'percent_covered': self.total.pc_covered, |
|
57 'percent_covered_display': self.total.pc_covered_str, |
|
58 'missing_lines': self.total.n_missing, |
|
59 'excluded_lines': self.total.n_excluded, |
|
60 } |
|
61 |
|
62 if coverage_data.has_arcs(): |
|
63 self.report_data["totals"].update({ |
|
64 'num_branches': self.total.n_branches, |
|
65 'num_partial_branches': self.total.n_partial_branches, |
|
66 'covered_branches': self.total.n_executed_branches, |
|
67 'missing_branches': self.total.n_missing_branches, |
|
68 }) |
|
69 |
|
70 json.dump( |
|
71 self.report_data, |
|
72 outfile, |
|
73 indent=(4 if self.config.json_pretty_print else None), |
|
74 ) |
|
75 |
|
76 return self.total.n_statements and self.total.pc_covered |
|
77 |
|
78 def report_one_file(self, coverage_data, analysis): |
|
79 """Extract the relevant report data for a single file.""" |
|
80 nums = analysis.numbers |
|
81 self.total += nums |
|
82 summary = { |
|
83 'covered_lines': nums.n_executed, |
|
84 'num_statements': nums.n_statements, |
|
85 'percent_covered': nums.pc_covered, |
|
86 'percent_covered_display': nums.pc_covered_str, |
|
87 'missing_lines': nums.n_missing, |
|
88 'excluded_lines': nums.n_excluded, |
|
89 } |
|
90 reported_file = { |
|
91 'executed_lines': sorted(analysis.executed), |
|
92 'summary': summary, |
|
93 'missing_lines': sorted(analysis.missing), |
|
94 'excluded_lines': sorted(analysis.excluded), |
|
95 } |
|
96 if self.config.json_show_contexts: |
|
97 reported_file['contexts'] = analysis.data.contexts_by_lineno(analysis.filename) |
|
98 if coverage_data.has_arcs(): |
|
99 reported_file['summary'].update({ |
|
100 'num_branches': nums.n_branches, |
|
101 'num_partial_branches': nums.n_partial_branches, |
|
102 'covered_branches': nums.n_executed_branches, |
|
103 'missing_branches': nums.n_missing_branches, |
|
104 }) |
|
105 return reported_file |