def handle_suppress(args):
init_logger(args.verbose if 'verbose' in args else None)
limit = constants.MAX_QUERY_SIZE
client = setup_client(args.product_url)
run_info = check_run_names(client, [args.name])
run = run_info.get(args.name)
if 'input' in args:
with open(args.input) as supp_file:
suppress_data = suppress_file_handler.get_suppress_data(supp_file)
for bug_id, file_name, comment, status in suppress_data:
file_name = '%' + file_name
bug_hash_filter = ttypes.ReportFilter(filepath=[file_name],
reportHash=[bug_id])
reports = client.getRunResults([run.runId], limit, 0, None,
bug_hash_filter,
None)
for report in reports:
rw_status = ttypes.ReviewStatus.FALSE_POSITIVE
if status == 'confirmed':
rw_status = ttypes.ReviewStatus.CONFIRMED
elif status == 'intentional':
rw_status = ttypes.ReviewStatus.INTENTIONAL
client.changeReviewStatus(report.reportId, rw_status, comment)
def get_diff_base_results(client, baseids, base_hashes, suppressed_hashes):
base_results = []
report_filter = ttypes.ReportFilter()
add_filter_conditions(report_filter, args.filter)
sort_mode = [(ttypes.SortMode(
ttypes.SortType.FILENAME,
ttypes.Order.ASC))]
limit = constants.MAX_QUERY_SIZE
offset = 0
report_filter.reportHash = base_hashes + suppressed_hashes
results = client.getRunResults(baseids,
limit,
offset,
sort_mode,
report_filter,
None)
while results:
base_results.extend(results)
offset += limit
results = client.getRunResults(baseids,
limit,
offset,
sort_mode,
report_filter,
None)
return base_results
def get_diff_base_results(client, baseids, base_hashes, suppressed_hashes):
report_filter = ttypes.ReportFilter()
add_filter_conditions(client, report_filter, args)
report_filter.reportHash = base_hashes + suppressed_hashes
sort_mode = [(ttypes.SortMode(
ttypes.SortType.FILENAME,
ttypes.Order.ASC))]
limit = constants.MAX_QUERY_SIZE
offset = 0
base_results = []
while True:
results = client.getRunResults(baseids,
limit,
offset,
sort_mode,
report_filter,
None,
False)
base_results.extend(results)
offset += limit
if len(results) < limit:
break
return base_results
def handle_list_results(args):
init_logger(args.verbose if 'verbose' in args else None)
check_deprecated_arg_usage(args)
client = setup_client(args.product_url)
run_names = map(lambda x: x.strip(), args.name.split(':'))
run_ids = [run.runId for run in get_runs(client, run_names)]
if not len(run_ids):
LOG.warning("No runs were found!")
sys.exit(1)
limit = constants.MAX_QUERY_SIZE
offset = 0
report_filter = ttypes.ReportFilter()
add_filter_conditions(client, report_filter, args)
all_results = []
results = client.getRunResults(run_ids, limit, offset, None, report_filter,
None)
while results:
all_results.extend(results)
offset += limit
results = client.getRunResults(run_ids, limit, offset, None,
report_filter, None)
if args.output_format == 'json':
print(CmdLineOutputEncoder().encode(all_results))
else:
header = [
'File', 'Checker', 'Severity', 'Msg', 'Review status',
'Detection status'
]
rows = []
for res in all_results:
bug_line = res.line
checked_file = res.checkedFile
if bug_line is not None:
checked_file += ' @ ' + str(bug_line)
sev = ttypes.Severity._VALUES_TO_NAMES[res.severity]
rw_status = \
ttypes.ReviewStatus._VALUES_TO_NAMES[res.reviewData.status]
dt_status = 'N/A'
status = res.detectionStatus
if status is not None:
dt_status = ttypes.DetectionStatus._VALUES_TO_NAMES[status]
rows.append((checked_file, res.checkerId, sev, res.checkerMsg,
rw_status, dt_status))
print(twodim_to_str(args.output_format, header, rows))
def get_statistics(client, run_ids, field, values):
report_filter = ttypes.ReportFilter()
report_filter.isUnique = True
setattr(report_filter, field, values)
checkers = client.getCheckerCounts(run_ids, report_filter, None, None,
0)
return dict((res.name, res.count) for res in checkers)
def get_statistics(client, run_ids, field, values):
report_filter = ttypes.ReportFilter()
add_filter_conditions(client, report_filter, args)
setattr(report_filter, field, values)
checkers = client.getCheckerCounts(run_ids, report_filter, None, None,
0)
return dict((res.name, res.count) for res in checkers)
def get_diff_remote_runs(client, basename, newname):
"""
Compares two remote runs and returns the filtered results.
"""
report_filter = ttypes.ReportFilter()
add_filter_conditions(client, report_filter, args)
base_ids, base_run_names, base_run_tags = process_run_arg(basename)
report_filter.runTag = base_run_tags
cmp_data = ttypes.CompareData()
cmp_data.diffType = get_diff_type()
new_ids, new_run_names, new_run_tags = process_run_arg(newname)
cmp_data.runIds = new_ids
cmp_data.runTag = new_run_tags
# Do not show resolved bugs in compare mode new.
if cmp_data.diffType == ttypes.DiffType.NEW:
report_filter.detectionStatus = [
ttypes.DetectionStatus.NEW,
ttypes.DetectionStatus.UNRESOLVED,
ttypes.DetectionStatus.REOPENED]
sort_mode = [(ttypes.SortMode(
ttypes.SortType.FILENAME,
ttypes.Order.ASC))]
limit = constants.MAX_QUERY_SIZE
offset = 0
all_results = []
results = client.getRunResults(base_ids,
limit,
offset,
sort_mode,
report_filter,
cmp_data)
while results:
all_results.extend(results)
offset += limit
results = client.getRunResults(base_ids,
limit,
offset,
sort_mode,
report_filter,
cmp_data)
return all_results, base_run_names, new_run_names
def handle_list_results(args):
client = setup_client(args.product_url)
run_info = check_run_names(client, [args.name])
run = run_info.get(args.name)
limit = constants.MAX_QUERY_SIZE
offset = 0
report_filter = ttypes.ReportFilter()
add_filter_conditions(report_filter, args.filter)
all_results = []
results = client.getRunResults([run.runId], limit, offset, None,
report_filter, None)
while results:
all_results.extend(results)
offset += limit
results = client.getRunResults([run.runId], limit, offset, None,
report_filter, None)
if args.output_format == 'json':
print(CmdLineOutputEncoder().encode(all_results))
else:
if args.suppressed:
header = ['File', 'Checker', 'Severity', 'Msg', 'Suppress comment']
else:
header = ['File', 'Checker', 'Severity', 'Msg']
rows = []
for res in all_results:
bug_line = res.line
checked_file = res.checkedFile + ' @ ' + str(bug_line)
sev = ttypes.Severity._VALUES_TO_NAMES[res.severity]
if args.suppressed:
rows.append((checked_file, res.checkerId, sev,
res.checkerMsg, res.suppressComment))
else:
rows.append(
(checked_file, res.checkerId, sev, res.checkerMsg))
print(twodim_to_str(args.output_format, header, rows))
def getDiffResults(client, baseids, cmp_data):
report_filter = ttypes.ReportFilter()
add_filter_conditions(report_filter, args.filter)
sort_mode = [(ttypes.SortMode(ttypes.SortType.FILENAME,
ttypes.Order.ASC))]
limit = constants.MAX_QUERY_SIZE
offset = 0
all_results = []
results = client.getRunResults(baseids, limit, offset, sort_mode,
report_filter, cmp_data)
while results:
all_results.extend(results)
offset += limit
results = client.getRunResults(baseids, limit, offset, sort_mode,
report_filter, cmp_data)
return all_results
def getDiffResults(client, baseids, cmp_data):
report_filter = ttypes.ReportFilter()
add_filter_conditions(report_filter, args.filter)
# Do not show resolved bugs in compare mode new.
if cmp_data.diffType == ttypes.DiffType.NEW:
report_filter.detectionStatus = [
ttypes.DetectionStatus.NEW,
ttypes.DetectionStatus.UNRESOLVED,
ttypes.DetectionStatus.REOPENED]
sort_mode = [(ttypes.SortMode(
ttypes.SortType.FILENAME,
ttypes.Order.ASC))]
limit = constants.MAX_QUERY_SIZE
offset = 0
all_results = []
results = client.getRunResults(baseids,
limit,
offset,
sort_mode,
report_filter,
cmp_data)
while results:
all_results.extend(results)
offset += limit
results = client.getRunResults(baseids,
limit,
offset,
sort_mode,
report_filter,
cmp_data)
return all_results
def bug_hash_filter(bug_id, filepath):
filepath = '%' + filepath
return [
ttypes.ReportFilter(bugHash=bug_id, filepath=filepath),
ttypes.ReportFilter(bugHash=bug_id, filepath=filepath)
]
def handle_list_result_types(args):
def get_statistics(client, run_ids, field, values):
report_filter = ttypes.ReportFilter()
report_filter.isUnique = True
setattr(report_filter, field, values)
checkers = client.getCheckerCounts(run_ids, report_filter, None)
return dict((res.name, res.count) for res in checkers)
def checker_count(dict, key):
return dict[key] if key in dict else 0
client = setup_client(args.product_url)
run_ids = None
if 'all_results' not in args:
items = check_run_names(client, args.names)
run_ids = map(lambda run: run.runId, items.values())
all_checkers_report_filter = ttypes.ReportFilter()
all_checkers_report_filter.isUnique = True
all_checkers = client.getCheckerCounts(run_ids, all_checkers_report_filter,
None)
all_checkers_dict = dict((res.name, res) for res in all_checkers)
unrev_checkers = get_statistics(client, run_ids, 'reviewStatus',
[ttypes.ReviewStatus.UNREVIEWED])
confirmed_checkers = get_statistics(client, run_ids, 'reviewStatus',
[ttypes.ReviewStatus.CONFIRMED])
false_checkers = get_statistics(client, run_ids, 'reviewStatus',
[ttypes.ReviewStatus.FALSE_POSITIVE])
intentional_checkers = get_statistics(client, run_ids, 'reviewStatus',
[ttypes.ReviewStatus.INTENTIONAL])
resolved_checkers = get_statistics(client, run_ids, 'detectionStatus',
[ttypes.DetectionStatus.RESOLVED])
all_results = []
for key, checker_data in sorted(all_checkers_dict.items(),
key=lambda x: x[1].severity,
reverse=True):
all_results.append(
dict(
checker=key,
severity=ttypes.Severity._VALUES_TO_NAMES[
checker_data.severity],
reports=checker_data.count,
unreviewed=checker_count(unrev_checkers, key),
confirmed=checker_count(confirmed_checkers, key),
false_positive=checker_count(false_checkers, key),
intentional=checker_count(intentional_checkers, key),
resolved=checker_count(resolved_checkers, key),
))
if args.output_format == 'json':
print(CmdLineOutputEncoder().encode(all_results))
else:
header = [
'Checker', 'Severity', 'All reports', 'Resolved', 'Unreviewed',
'Confirmed', 'False positive', "Intentional"
]
rows = []
for stat in all_results:
rows.append(
(stat['checker'], stat['severity'], str(stat['reports']),
str(stat['resolved']), str(stat['unreviewed']),
str(stat['confirmed']), str(stat['false_positive']),
str(stat['intentional'])))
print(twodim_to_str(args.output_format, header, rows))
def get_diff_report_dir(client, baseids, report_dir, diff_type):
report_filter = ttypes.ReportFilter()
add_filter_conditions(report_filter, args.filter)
sort_mode = [(ttypes.SortMode(ttypes.SortType.FILENAME,
ttypes.Order.ASC))]
limit = constants.MAX_QUERY_SIZE
offset = 0
base_results = []
results = client.getRunResults(baseids, limit, offset, sort_mode,
report_filter, None)
while results:
base_results.extend(results)
offset += limit
results = client.getRunResults(baseids, limit, offset, sort_mode,
report_filter, None)
base_hashes = {}
for res in base_results:
base_hashes[res.bugHash] = res
filtered_reports = []
new_results = get_report_dir_results(report_dir)
new_hashes = {}
suppressed_in_code = []
for rep in new_results:
bughash = rep.main['issue_hash_content_of_line_in_context']
source_file = rep.main['location']['file_name']
bug_line = rep.main['location']['line']
new_hashes[bughash] = rep
sp_handler = suppress_handler.SourceSuppressHandler(
source_file, bug_line, bughash, rep.main['check_name'])
if sp_handler.get_suppressed():
suppressed_in_code.append(bughash)
LOG.debug("Bug " + bughash + "is suppressed in code. file:" +
source_file + "Line " + str(bug_line))
if diff_type == 'new':
# Shows new reports from the report dir
# which are not present in the baseline (server)
# and not suppressed in the code.
for result in new_results:
if not (result.main['issue_hash_content_of_line_in_context']
in base_hashes) and \
not (result.main['issue_hash_content_of_line_in_context']
in suppressed_in_code):
filtered_reports.append(result)
elif diff_type == 'resolved':
# Show bugs in the baseline (server)
# which are not present in the report dir
# or suppressed.
for result in base_results:
if not (result.bugHash in new_hashes) or \
(result.bugHash in suppressed_in_code):
filtered_reports.append(result)
elif diff_type == 'unresolved':
# Shows bugs in the report dir
# that are not suppressed and
# which are also present in the baseline (server)
for result in new_results:
new_hash = result.main['issue_hash_content_of_line_in_context']
if new_hash in base_hashes and \
not (new_hash in suppressed_in_code):
filtered_reports.append(result)
return filtered_reports
def handle_list_result_types(args):
init_logger(args.verbose if 'verbose' in args else None)
check_deprecated_arg_usage(args)
if 'disable_unique' in args:
LOG.warning("--disable-unique option is deprecated. Please use the "
"'--uniqueing on' option to get uniqueing results.")
args.uniqueing = 'off'
def get_statistics(client, run_ids, field, values):
report_filter = ttypes.ReportFilter()
add_filter_conditions(client, report_filter, args)
setattr(report_filter, field, values)
checkers = client.getCheckerCounts(run_ids, report_filter, None, None,
0)
return dict((res.name, res.count) for res in checkers)
def checker_count(checker_dict, key):
return checker_dict.get(key, 0)
client = setup_client(args.product_url)
run_ids = None
if 'all_results' not in args:
run_ids = [run.runId for run in get_runs(client, args.names)]
if not len(run_ids):
LOG.warning("No runs were found!")
sys.exit(1)
all_checkers_report_filter = ttypes.ReportFilter()
add_filter_conditions(client, all_checkers_report_filter, args)
all_checkers = client.getCheckerCounts(run_ids, all_checkers_report_filter,
None, None, 0)
all_checkers_dict = dict((res.name, res) for res in all_checkers)
unrev_checkers = get_statistics(client, run_ids, 'reviewStatus',
[ttypes.ReviewStatus.UNREVIEWED])
confirmed_checkers = get_statistics(client, run_ids, 'reviewStatus',
[ttypes.ReviewStatus.CONFIRMED])
false_checkers = get_statistics(client, run_ids, 'reviewStatus',
[ttypes.ReviewStatus.FALSE_POSITIVE])
intentional_checkers = get_statistics(client, run_ids, 'reviewStatus',
[ttypes.ReviewStatus.INTENTIONAL])
resolved_checkers = get_statistics(client, run_ids, 'detectionStatus',
[ttypes.DetectionStatus.RESOLVED])
# Get severity counts
report_filter = ttypes.ReportFilter()
add_filter_conditions(client, report_filter, args)
sev_count = client.getSeverityCounts(run_ids, report_filter, None)
severities = []
severity_total = 0
for key, count in sorted(sev_count.items(), reverse=True):
severities.append(
dict(severity=ttypes.Severity._VALUES_TO_NAMES[key],
reports=count))
severity_total += count
all_results = []
total = defaultdict(int)
for key, checker_data in sorted(all_checkers_dict.items(),
key=lambda x: x[1].severity,
reverse=True):
all_results.append(
dict(
checker=key,
severity=ttypes.Severity._VALUES_TO_NAMES[
checker_data.severity],
reports=checker_data.count,
unreviewed=checker_count(unrev_checkers, key),
confirmed=checker_count(confirmed_checkers, key),
false_positive=checker_count(false_checkers, key),
intentional=checker_count(intentional_checkers, key),
resolved=checker_count(resolved_checkers, key),
))
total['total_reports'] += checker_data.count
total['total_resolved'] += checker_count(resolved_checkers, key)
total['total_unreviewed'] += checker_count(unrev_checkers, key)
total['total_confirmed'] += checker_count(confirmed_checkers, key)
total['total_false_positive'] += checker_count(false_checkers, key)
total['total_intentional'] += checker_count(intentional_checkers, key)
if args.output_format == 'json':
print(CmdLineOutputEncoder().encode(all_results))
else:
header = [
'Checker', 'Severity', 'All reports', 'Resolved', 'Unreviewed',
'Confirmed', 'False positive', "Intentional"
]
rows = []
for stat in all_results:
rows.append(
(stat['checker'], stat['severity'], str(stat['reports']),
str(stat['resolved']), str(stat['unreviewed']),
str(stat['confirmed']), str(stat['false_positive']),
str(stat['intentional'])))
rows.append(
('Total', '-', str(total['total_reports']),
str(total['total_resolved']), str(total['total_unreviewed']),
str(total['total_confirmed']), str(total['total_false_positive']),
str(total['total_intentional'])))
print(
twodim_to_str(args.output_format,
header,
rows,
separate_footer=True))
# Print severity counts
header = ['Severity', 'All reports']
rows = []
for stat in severities:
rows.append((stat['severity'], str(stat['reports'])))
rows.append(('Total', str(severity_total)))
print(
twodim_to_str(args.output_format,
header,
rows,
separate_footer=True))
def handle_diff_results(args):
init_logger(args.verbose if 'verbose' in args else None)
check_deprecated_arg_usage(args)
context = generic_package_context.get_context()
def get_diff_results(client, baseids, report_filter, cmp_data):
add_filter_conditions(client, report_filter, args)
# Do not show resolved bugs in compare mode new.
if cmp_data.diffType == ttypes.DiffType.NEW:
report_filter.detectionStatus = [
ttypes.DetectionStatus.NEW, ttypes.DetectionStatus.UNRESOLVED,
ttypes.DetectionStatus.REOPENED
]
sort_mode = [(ttypes.SortMode(ttypes.SortType.FILENAME,
ttypes.Order.ASC))]
limit = constants.MAX_QUERY_SIZE
offset = 0
all_results = []
results = client.getRunResults(baseids, limit, offset, sort_mode,
report_filter, cmp_data)
while results:
all_results.extend(results)
offset += limit
results = client.getRunResults(baseids, limit, offset, sort_mode,
report_filter, cmp_data)
return all_results
def get_report_dir_results(reportdir):
all_reports = []
processed_path_hashes = set()
for filename in os.listdir(reportdir):
if filename.endswith(".plist"):
file_path = os.path.join(reportdir, filename)
LOG.debug("Parsing:" + file_path)
try:
files, reports = plist_parser.parse_plist(file_path)
for report in reports:
path_hash = get_report_path_hash(report, files)
if path_hash in processed_path_hashes:
LOG.debug("Not showing report because it is a "
"deduplication of an already processed "
"report!")
LOG.debug("Path hash: %s", path_hash)
LOG.debug(report)
continue
processed_path_hashes.add(path_hash)
report.main['location']['file_name'] = \
files[int(report.main['location']['file'])]
all_reports.append(report)
except Exception as ex:
LOG.error('The generated plist is not valid!')
LOG.error(ex)
return all_reports
def get_line_from_file(filename, lineno):
with open(filename, 'r') as f:
i = 1
for line in f:
if i == lineno:
return line
i += 1
return ""
def get_diff_base_results(client, baseids, base_hashes, suppressed_hashes):
base_results = []
report_filter = ttypes.ReportFilter()
add_filter_conditions(client, report_filter, args)
sort_mode = [(ttypes.SortMode(ttypes.SortType.FILENAME,
ttypes.Order.ASC))]
limit = constants.MAX_QUERY_SIZE
offset = 0
report_filter.reportHash = base_hashes + suppressed_hashes
results = client.getRunResults(baseids, limit, offset, sort_mode,
report_filter, None)
while results:
base_results.extend(results)
offset += limit
results = client.getRunResults(baseids, limit, offset, sort_mode,
report_filter, None)
return base_results
def get_diff_report_dir(client, baseids, report_dir, cmp_data):
filtered_reports = []
report_dir_results = get_report_dir_results(report_dir)
new_hashes = {}
suppressed_in_code = []
for rep in report_dir_results:
bughash = rep.main['issue_hash_content_of_line_in_context']
source_file = rep.main['location']['file_name']
bug_line = rep.main['location']['line']
checker_name = rep.main['check_name']
new_hashes[bughash] = rep
sc_handler = SourceCodeCommentHandler(source_file)
src_comment_data = sc_handler.filter_source_line_comments(
bug_line, checker_name)
if len(src_comment_data) == 1:
suppressed_in_code.append(bughash)
LOG.debug("Bug " + bughash + "is suppressed in code. file:" +
source_file + "Line " + str(bug_line))
elif len(src_comment_data) > 1:
LOG.warning("Multiple source code comment can be found "
"for '{0}' checker in '{1}' at line {2}. "
"This bug will not be suppressed!".format(
checker_name, source_file, bug_line))
base_hashes = client.getDiffResultsHash(baseids, new_hashes.keys(),
cmp_data.diffType)
if cmp_data.diffType == ttypes.DiffType.NEW or \
cmp_data.diffType == ttypes.DiffType.UNRESOLVED:
# Shows reports from the report dir which are not present in the
# baseline (NEW reports) or appear in both side (UNRESOLVED
# reports) and not suppressed in the code.
for result in report_dir_results:
h = result.main['issue_hash_content_of_line_in_context']
if h in base_hashes and h not in suppressed_in_code:
filtered_reports.append(result)
elif cmp_data.diffType == ttypes.DiffType.RESOLVED:
# Show bugs in the baseline (server) which are not present in the
# report dir or suppressed.
results = get_diff_base_results(client, baseids, base_hashes,
suppressed_in_code)
for result in results:
filtered_reports.append(result)
return filtered_reports
def cached_report_file_lookup(file_cache, file_id):
"""
Get source file data for the given file and caches it in a file cache
if file data is not found in the cache. Finally, it returns the source
file data from the cache.
"""
if file_id not in file_cache:
source = client.getSourceFileData(file_id, True,
ttypes.Encoding.BASE64)
file_content = base64.b64decode(source.fileContent)
file_cache[file_id] = {
'id': file_id,
'path': source.filePath,
'content': file_content
}
return file_cache[file_id]
def get_report_data(client, reports, file_cache):
"""
Returns necessary report files and report data events for the HTML
plist parser.
"""
file_sources = {}
report_data = []
for report in reports:
file_sources[report.fileId] = cached_report_file_lookup(
file_cache, report.fileId)
details = client.getReportDetails(report.reportId)
events = []
for index, event in enumerate(details.pathEvents):
file_sources[event.fileId] = cached_report_file_lookup(
file_cache, event.fileId)
events.append({
'line': event.startLine,
'col': event.startCol,
'file': event.fileId,
'msg': event.msg,
'step': index + 1
})
report_data.append({
'events': events,
'path': report.checkedFile,
'reportHash': report.bugHash,
'checkerName': report.checkerId
})
return {'files': file_sources, 'reports': report_data}
def reports_to_report_data(reports):
"""
Converts reports from Report class from one plist file
to report data events for the HTML plist parser.
"""
file_sources = {}
fname_to_fid = {}
report_data = []
findex = 0
for report in reports:
# Not all report in this list may refer to the same files
# thus we need to create a single file list with
# all files from all reports.
for f in report.files:
if f not in fname_to_fid:
try:
with codecs.open(f, 'r', 'UTF-8',
errors='replace') as source_data:
content = source_data.read()
except (OSError, IOError):
content = f + " NOT FOUND."
file_sources[findex] = {
'id': findex,
'path': f,
'content': content
}
fname_to_fid[f] = findex
findex += 1
events = []
pathElements = report.bug_path
index = 1
for element in pathElements:
if element['kind'] == 'event':
fname = report.files[element['location']['file']]
new_fid = fname_to_fid[fname]
events.append({
'line': element['location']['line'],
'col': element['location']['col'],
'file': new_fid,
'msg': element['message'],
'step': index
})
index += 1
report_hash = report.main['issue_hash_content_of_line_in_context']
report_data.append({
'events': events,
'path': report.main['location']['file_name'],
'reportHash': report_hash,
'checkerName': report.main['check_name']
})
return {'files': file_sources, 'reports': report_data}
def report_to_html(client, reports, output_dir):
"""
Generate HTML output files for the given reports in the given output
directory by using the Plist To HTML parser.
"""
html_builder = PlistToHtml.HtmlBuilder(
context.path_plist_to_html_dist,
context.checkers_severity_map_file)
file_report_map = defaultdict(list)
for report in reports:
file_path = ""
if isinstance(report, Report):
file_path = report.main['location']['file_name']
else:
file_path = report.checkedFile
file_report_map[file_path].append(report)
file_cache = {}
for file_path, file_reports in file_report_map.items():
checked_file = file_path
filename = os.path.basename(checked_file)
h = int(hashlib.md5(file_path).hexdigest(), 16) % (10**8)
if isinstance(file_reports[0], Report):
report_data = reports_to_report_data(file_reports)
else:
report_data = get_report_data(client, file_reports, file_cache)
output_path = os.path.join(output_dir,
filename + '_' + str(h) + '.html')
html_builder.create(output_path, report_data)
print('Html file was generated for file://{0}: file://{1}'.format(
checked_file, output_path))
html_builder.create_index_html(output_dir)
def print_reports(client, reports, output_format):
output_dir = args.export_dir if 'export_dir' in args else None
if 'clean' in args and os.path.isdir(output_dir):
print("Previous analysis results in '{0}' have been removed, "
"overwriting with current results.".format(output_dir))
shutil.rmtree(output_dir)
if output_format == 'json':
output = []
for report in reports:
if isinstance(report, Report):
output.append(report.main)
else:
output.append(report)
print(CmdLineOutputEncoder().encode(output))
return
if output_format == 'html':
output_dir = args.export_dir
if not os.path.exists(output_dir):
os.makedirs(output_dir)
print("Generating HTML output files to file://{0} directory:\n".
format(output_dir))
report_to_html(client, reports, output_dir)
print('\nTo view the results in a browser run:\n'
' $ firefox {0}'.format(
os.path.join(args.export_dir, 'index.html')))
return
header = ['File', 'Checker', 'Severity', 'Msg', 'Source']
rows = []
source_lines = defaultdict(set)
for report in reports:
if not isinstance(report, Report):
source_lines[report.fileId].add(report.line)
lines_in_files_requested = []
for key in source_lines:
lines_in_files_requested.append(
ttypes.LinesInFilesRequested(fileId=key,
lines=source_lines[key]))
source_line_contents = client.getLinesInSourceFileContents(
lines_in_files_requested, ttypes.Encoding.BASE64)
for report in reports:
if isinstance(report, Report):
# report is coming from a plist file.
bug_line = report.main['location']['line']
bug_col = report.main['location']['col']
sev = 'unknown'
checked_file = report.main['location']['file_name']\
+ ':' + str(bug_line) + ":" + str(bug_col)
check_name = report.main['check_name']
check_msg = report.main['description']
source_line =\
get_line_from_file(report.main['location']['file_name'],
bug_line)
else:
# report is of ReportData type coming from CodeChecker server.
bug_line = report.line
bug_col = report.column
sev = ttypes.Severity._VALUES_TO_NAMES[report.severity]
checked_file = report.checkedFile + ':' + str(bug_line) +\
":" + str(bug_col)
source_line = base64.b64decode(
source_line_contents[report.fileId][bug_line])
check_name = report.checkerId
check_msg = report.checkerMsg
rows.append(
(checked_file, check_name, sev, check_msg, source_line))
if output_format == 'plaintext':
for row in rows:
print("{0}: {1} [{2}]\n{3}\n".format(row[0], row[3], row[1],
row[4]))
else:
print(twodim_to_str(output_format, header, rows))
def get_run_tag(client, run_ids, tag_name):
"""
Returns run tag information for the given tag name in the given runs.
"""
run_history_filter = ttypes.RunHistoryFilter()
run_history_filter.tagNames = [tag_name]
run_histories = client.getRunHistory(run_ids, None, None,
run_history_filter)
return run_histories[0] if len(run_histories) else None
client = setup_client(args.product_url)
report_filter = ttypes.ReportFilter()
# Process base run names and tags.
run_with_tag = args.basename.split(':')
base_run_name = run_with_tag[0]
base_runs = get_runs(client, [base_run_name])
base_ids = map(lambda run: run.runId, base_runs)
# Set base run tag if it is available.
run_tag_name = run_with_tag[1] if len(run_with_tag) > 1 else None
if run_tag_name:
tag = get_run_tag(client, base_ids, run_tag_name)
report_filter.runTag = [tag.id] if tag else None
if len(base_ids) == 0:
LOG.warning("No run names match the given pattern: " + args.basename)
sys.exit(1)
LOG.info("Matching base runs: " +
', '.join(map(lambda run: run.name, base_runs)))
cmp_data = ttypes.CompareData()
if 'new' in args:
cmp_data.diffType = ttypes.DiffType.NEW
elif 'unresolved' in args:
cmp_data.diffType = ttypes.DiffType.UNRESOLVED
elif 'resolved' in args:
cmp_data.diffType = ttypes.DiffType.RESOLVED
results = []
if os.path.isdir(args.newname):
# If newname is a valid directory we assume that it is a report dir and
# we are in local compare mode.
results = get_diff_report_dir(client, base_ids,
os.path.abspath(args.newname), cmp_data)
else:
run_with_tag = args.newname.split(':')
new_run_name = run_with_tag[0]
run_tag_name = run_with_tag[1] if len(run_with_tag) > 1 else None
new_runs = get_runs(client, [new_run_name])
new_ids = map(lambda run: run.runId, new_runs)
if len(new_ids) == 0:
LOG.warning("No run names match the given pattern: " +
args.newname)
sys.exit(1)
LOG.info("Matching new runs: " +
', '.join(map(lambda run: run.name, new_runs)))
cmp_data.runIds = new_ids
if run_tag_name:
tag = get_run_tag(client, new_ids, run_tag_name)
cmp_data.runTag = [tag.id] if tag else None
results = get_diff_results(client, base_ids, report_filter, cmp_data)
if len(results) == 0:
LOG.info("No results.")
else:
print_reports(client, results, args.output_format)
