1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
#!/usr/bin/env python3
# Copyright 2022 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Merge lcov files, discarding all lines that are not in the template file.
Given 2 or more lcov files, merge the results only for the lines present in
the template file.
File format reverse engineered from
https://github.com/linux-test-project/lcov/blob/master/bin/geninfo
"""
import argparse
from collections import defaultdict
import logging
import re
import sys
from typing import Dict, Set
EXTRACT_LINE = re.compile(r"^(FN|DA|BRDA):(\d+),")
EXTRACT_FN = re.compile(r"^(FN):(\d+),(\S+)")
EXTRACT_FNDA = re.compile(r"^(FNDA):(\d+),(\S+)")
EXTRACT_DA = re.compile(r"^(DA):(\d+),(\d+)")
EXTRACT_BRDA = re.compile(r"^(BRDA):(\d+),(\d+),(\d+),([-\d]+)")
EXTRACT_COUNT = re.compile(r"^([A-Z]+):(\d+)")
def parse_args(argv=None):
"""Parses command line args"""
parser = argparse.ArgumentParser()
parser.add_argument(
"--log-level",
choices=[
"CRITICAL",
"ERROR",
"WARNING",
"INFO",
"DEBUG",
],
default="INFO",
help="Set logging level to report at.",
)
parser.add_argument(
"--output-file",
"-o",
help="destination filename, defaults to stdout",
)
parser.add_argument(
"template_file",
help="lcov info file to use as template",
)
parser.add_argument(
"lcov_input",
nargs="+",
help="lcov info file to merge",
)
return parser.parse_args(argv)
def parse_template_file(filename) -> Dict[str, Set[str]]:
"""Reads the template file and returns covered lines.
Reads the lines that indicate covered line numbers (FN, DA, and BRDA)
and adds them to the returned data structure.
Returns
-------
Dict[str, Set[str]]
A dictionary of filename to set of covered line numbers (as strings)
"""
logging.info("Reading template file %s", filename)
with open(filename, "r") as template_file:
data_by_path: Dict[str, Set[str]] = defaultdict(set)
file_name = None
for line in template_file.readlines():
line = line.strip()
if line == "end_of_record":
file_name = None
elif (
line.startswith( # pylint:disable=too-many-boolean-expressions
"TN:"
)
or line.startswith("FNDA:")
or line.startswith("FNF:")
or line.startswith("FNH:")
or line.startswith("BRF:")
or line.startswith("BRH:")
or line.startswith("LF:")
or line.startswith("LH:")
):
pass
elif line.startswith("SF:"):
file_name = line
else:
match = EXTRACT_LINE.match(line)
if file_name and match:
data_by_path[file_name].add(match.group(2))
else:
raise NotImplementedError(line)
return data_by_path
def filter_coverage_file(filename, output_file, data_by_path):
"""Reads a coverage file from filename and writes filtered lines to
output_file.
For each line in filename, if it covers the same lines as the template
in data_by_path, then write the line to output_file.
Directives that act as totals (FNF, FNH, BRF, BRH, LF, LH) are recalculated
after filtering, and records that refer to unknown files are omitted.
"""
logging.info("Merging file %s", filename)
with open(filename, "r") as input_file:
def empty_record():
return {
"text": "",
"function_names": set(),
}
record = empty_record()
for line in input_file.readlines():
line = line.strip()
if line == "end_of_record":
record["text"] += line + "\n"
if record.get("should_write_record", False):
output_file.write(record["text"])
else:
logging.debug("Omitting record %s", record["text"])
record = empty_record()
elif line.startswith("SF:"):
record["file_name"] = line
record["text"] += line + "\n"
elif line.startswith("TN:"):
record["text"] += line + "\n"
elif line.startswith("FN:"):
match = EXTRACT_FN.match(line)
if (
match
and match.group(2) in data_by_path[record["file_name"]]
):
record["text"] += line + "\n"
record["functions_found"] = (
record.get("functions_found", 0) + 1
)
record["should_write_record"] = True
record["function_names"].add(match.group(3))
else:
logging.debug("Omitting %s", line)
elif line.startswith("FNDA:"):
match = EXTRACT_FNDA.match(line)
if match and match.group(3) in record["function_names"]:
record["text"] += line + "\n"
record["should_write_record"] = True
if match.group(2) != "0":
record["functions_hit"] = (
record.get("functions_hit", 0) + 1
)
else:
logging.debug("Omitting %s", line)
elif line.startswith("DA:"):
match = EXTRACT_DA.match(line)
if (
match
and match.group(2) in data_by_path[record["file_name"]]
):
record["text"] += line + "\n"
record["lines_found"] = record.get("lines_found", 0) + 1
record["should_write_record"] = True
if match.group(3) != "0":
record["lines_hit"] = record.get("lines_hit", 0) + 1
else:
logging.debug("Omitting %s", line)
elif line.startswith("BRDA:"):
match = EXTRACT_BRDA.match(line)
if (
match
and match.group(2) in data_by_path[record["file_name"]]
):
record["text"] += line + "\n"
record["branches_found"] = (
record.get("branches_found", 0) + 1
)
record["should_write_record"] = True
if match.group(4) != "-" and match.group(4) != "0":
record["branches_hit"] = (
record.get("branches_hit", 0) + 1
)
else:
logging.debug("Omitting %s", line)
elif line.startswith("FNF:"):
record["text"] += "FNF:%s\n" % record.get("functions_found", 0)
elif line.startswith("FNH:"):
record["text"] += "FNH:%s\n" % record.get("functions_hit", 0)
elif line.startswith("BRF:"):
record["text"] += "BRF:%s\n" % record.get("branches_found", 0)
elif line.startswith("BRH:"):
record["text"] += "BRH:%s\n" % record.get("branches_hit", 0)
elif line.startswith("LF:"):
record["text"] += "LF:%s\n" % record.get("lines_found", 0)
elif line.startswith("LH:"):
record["text"] += "LH:%s\n" % record.get("lines_hit", 0)
else:
logging.debug("record = %s", record)
raise NotImplementedError(line)
def main(argv=None):
"""Merges lcov files."""
opts = parse_args(argv)
logging.basicConfig(level=opts.log_level)
output_file = sys.stdout
if opts.output_file:
logging.info("Writing output to %s", opts.output_file)
output_file = open( # pylint:disable=consider-using-with
opts.output_file, "w"
)
data_by_path = parse_template_file(opts.template_file)
with output_file:
for lcov_input in [opts.template_file] + opts.lcov_input:
filter_coverage_file(lcov_input, output_file, data_by_path)
if __name__ == "__main__":
sys.exit(main(sys.argv[1:]))
|
