9310258c57
Implements new script (count-bugs.py) for peeking inside clang static analyzer's report and print just a summary. If number of detected bugs goes beyond the limit, script will return with error code 1, thus failing the CI run. The upper limit is set to 113, which is current result of static analysis in our CI environment (local run is likely to indicate different number); upper limit will be updated in time, as issues get fixed or new compiler (detecting more bugs) will be introduced. This commit includes also slight modifictaions to count-warnings.py script, to keep the both scripts outputting in similar format.
74 lines
2.2 KiB
Python
Executable file
74 lines
2.2 KiB
Python
Executable file
#!/usr/bin/python3
|
|
|
|
# Copyright (c) 2019 Patryk Obara <patryk.obara@gmail.com>
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
# This script prints a summary snippet of information out of reports created
|
|
# by scan-build or analyze-build for Clang's static code analysis.
|
|
#
|
|
# Usage: ./count-warnings.py path/to/report/index.html
|
|
#
|
|
# This script depends on BeautifulSoup module, if you're distribution is
|
|
# missing it, you can use pipenv to install it for virtualenv spanning only
|
|
# this repo: pipenv install beautifulsoup4 html5lib
|
|
|
|
# pylint: disable=invalid-name
|
|
# pylint: disable=missing-docstring
|
|
|
|
import sys
|
|
|
|
from bs4 import BeautifulSoup
|
|
|
|
# Maximum allowed number of issues; if report will include more bugs,
|
|
# then script will return with status 1. Simply change this line if you
|
|
# want to set a different limit.
|
|
#
|
|
MAX_ISSUES = 113
|
|
|
|
|
|
def summary_values(summary_table):
|
|
if not summary_table:
|
|
return
|
|
for row in summary_table.find_all('tr'):
|
|
description = row.find('td', 'SUMM_DESC')
|
|
value = row.find('td', 'Q')
|
|
if description is None or value is None:
|
|
continue
|
|
yield description.get_text(), int(value.get_text())
|
|
|
|
|
|
def read_soup(index_html):
|
|
with open(index_html) as index:
|
|
soup = BeautifulSoup(index, 'html5lib')
|
|
tables = soup.find_all('table')
|
|
summary = tables[1]
|
|
return {bug: count for bug, count in summary_values(summary)}
|
|
|
|
|
|
def find_longest_name_length(names):
|
|
return max(len(x) for x in names)
|
|
|
|
|
|
def print_summary(issues):
|
|
summary = list(issues.items())
|
|
size = find_longest_name_length(issues.keys()) + 1
|
|
for warning, count in sorted(summary, key=lambda x: -x[1]):
|
|
print(' {text:{field_size}s}: {count}'.format(
|
|
text=warning, count=count, field_size=size))
|
|
print()
|
|
|
|
|
|
def main():
|
|
bug_types = read_soup(sys.argv[1])
|
|
total = bug_types.pop('All Bugs')
|
|
if bug_types:
|
|
print("Bugs grouped by type:\n")
|
|
print_summary(bug_types)
|
|
print('Total: {} bugs (out of {} allowed)\n'.format(total, MAX_ISSUES))
|
|
if total > MAX_ISSUES:
|
|
print('Error: upper limit of allowed bugs is', MAX_ISSUES)
|
|
sys.exit(1)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|