def parse(f, context, metadata_dict, suppress_handler, skip_handler, steps):
"""
Prints the results in the given file to the standard output in a human-
readable format.
Returns the report statistics collected by the result handler.
"""
if not f.endswith(".plist"):
LOG.debug("Skipping input file '" + f + "' as it is not a plist.")
return {}
LOG.debug("Parsing input file '" + f + "'")
rh = plist_parser.PlistToPlaintextFormatter(suppress_handler, skip_handler,
context.severity_map)
rh.print_steps = steps
# Set some variables of the result handler to use the saved file.
analyzed_source_file = "UNKNOWN"
if 'result_source_files' in metadata_dict and \
f in metadata_dict['result_source_files']:
analyzed_source_file = \
metadata_dict['result_source_files'][f]
return rh.parse_and_write(f, analyzed_source_file)
def parse(f, context, metadata_dict, suppress_handler, skip_handler, steps,
processed_path_hashes):
"""
Prints the results in the given file to the standard output in a human-
readable format.
Returns the report statistics collected by the result handler.
"""
if not f.endswith(".plist"):
LOG.debug("Skipping input file '" + f + "' as it is not a plist.")
return {}, set()
LOG.debug("Parsing input file '" + f + "'")
rh = plist_parser.PlistToPlaintextFormatter(suppress_handler,
skip_handler,
context.severity_map,
processed_path_hashes)
rh.print_steps = steps
# Set some variables of the result handler to use the saved file.
analyzed_source_file = "UNKNOWN"
if 'result_source_files' in metadata_dict and \
f in metadata_dict['result_source_files']:
analyzed_source_file = \
metadata_dict['result_source_files'][f]
files, reports = rh.parse(f)
plist_mtime = util.get_last_mod_time(f)
changed_files = set()
for source_file in files:
if plist_mtime is None:
# Failed to get the modification time for
# a file mark it as changed.
changed_files.add(source_file)
LOG.warning(source_file +
' is missing since the last analysis.')
continue
file_mtime = util.get_last_mod_time(source_file)
if file_mtime > plist_mtime:
changed_files.add(source_file)
LOG.warning(source_file +
' did change since the last analysis.')
if changed_files:
return {}, changed_files
else:
report_stats = rh.write(files, reports, analyzed_source_file)
return report_stats, set()
def main(args):
"""
Entry point for parsing some analysis results and printing them to the
stdout in a human-readable format.
"""
logger.setup_logger(args.verbose if 'verbose' in args else None)
context = package_context.get_context()
# To ensure the help message prints the default folder properly,
# the 'default' for 'args.input' is a string, not a list.
# But we need lists for the foreach here to work.
if isinstance(args.input, str):
args.input = [args.input]
original_cwd = os.getcwd()
suppr_handler = None
if 'suppress' in args:
__make_handler = False
if not os.path.isfile(args.suppress):
if 'create_suppress' in args:
with open(args.suppress, 'w') as _:
# Just create the file.
__make_handler = True
LOG.info("Will write source-code suppressions to "
"suppress file.")
else:
LOG.warning("Suppress file '" + args.suppress + "' given, but "
"it does not exist -- will not suppress anything.")
else:
__make_handler = True
if __make_handler:
suppr_handler = suppress_handler.\
GenericSuppressHandler(args.suppress,
'create_suppress' in args)
elif 'create_suppress' in args:
LOG.error("Can't use '--export-source-suppress' unless '--suppress "
"SUPPRESS_FILE' is also given.")
sys.exit(2)
processed_path_hashes = set()
def skip_html_report_data_handler(report_hash, source_file, report_line,
checker_name, diag, files):
"""
Report handler which skips bugs which were suppressed by source code
comments.
"""
report = Report(None, diag['path'], files)
path_hash = get_report_path_hash(report, files)
if path_hash in processed_path_hashes:
LOG.debug("Skip report because it is a deduplication of an "
"already processed report!")
LOG.debug("Path hash: %s", path_hash)
LOG.debug(diag)
return True
skip = plist_parser.skip_report(report_hash, source_file, report_line,
checker_name, suppr_handler)
if not skip:
processed_path_hashes.add(path_hash)
return skip
skip_handler = None
if 'skipfile' in args:
with open(args.skipfile, 'r') as skip_file:
skip_handler = SkipListHandler(skip_file.read())
html_builder = None
for input_path in args.input:
input_path = os.path.abspath(input_path)
os.chdir(original_cwd)
LOG.debug("Parsing input argument: '" + input_path + "'")
export = args.export if 'export' in args else None
if export is not None and export == 'html':
output_path = os.path.abspath(args.output_path)
if not html_builder:
html_builder = \
PlistToHtml.HtmlBuilder(context.path_plist_to_html_dist,
context.severity_map)
LOG.info("Generating html output files:")
PlistToHtml.parse(input_path, output_path,
context.path_plist_to_html_dist,
skip_html_report_data_handler, html_builder)
continue
files = []
metadata_dict = {}
if os.path.isfile(input_path):
files.append(input_path)
elif os.path.isdir(input_path):
metadata_file = os.path.join(input_path, "metadata.json")
if os.path.exists(metadata_file):
metadata_dict = util.load_json_or_empty(metadata_file)
LOG.debug(metadata_dict)
if 'working_directory' in metadata_dict:
working_dir = metadata_dict['working_directory']
try:
os.chdir(working_dir)
except OSError as oerr:
LOG.debug(oerr)
LOG.error(
"Working directory %s is missing.\n"
"Can not parse reports safely.", working_dir)
sys.exit(1)
_, _, file_names = next(os.walk(input_path), ([], [], []))
files = [
os.path.join(input_path, file_name) for file_name in file_names
]
file_change = set()
file_report_map = defaultdict(list)
rh = plist_parser.PlistToPlaintextFormatter(suppr_handler,
skip_handler,
context.severity_map,
processed_path_hashes)
rh.print_steps = 'print_steps' in args
for file_path in files:
f_change = parse(file_path, metadata_dict, rh, file_report_map)
file_change = file_change.union(f_change)
report_stats = rh.write(file_report_map)
severity_stats = report_stats.get('severity')
file_stats = report_stats.get('files')
reports_stats = report_stats.get('reports')
print("\n----==== Summary ====----")
if file_stats:
vals = [[os.path.basename(k), v]
for k, v in dict(file_stats).items()]
keys = ['Filename', 'Report count']
table = twodim_to_str('table', keys, vals, 1, True)
print(table)
if severity_stats:
vals = [[k, v] for k, v in dict(severity_stats).items()]
keys = ['Severity', 'Report count']
table = twodim_to_str('table', keys, vals, 1, True)
print(table)
report_count = reports_stats.get("report_count", 0)
print("----=================----")
print("Total number of reports: {}".format(report_count))
print("----=================----")
if file_change:
changed_files = '\n'.join([' - ' + f for f in file_change])
LOG.warning("The following source file contents changed since the "
"latest analysis:\n{0}\nMultiple reports were not "
"shown and skipped from the statistics. Please "
"analyze your project again to update the "
"reports!".format(changed_files))
os.chdir(original_cwd)
# Create index.html for the generated html files.
if html_builder:
html_builder.create_index_html(args.output_path)