mirror of
https://github.com/hohn/sarif-cli.git
synced 2025-12-16 17:23:03 +01:00
2c3ca3c0eb
Region / line / column information are present in most messages. The one that
caused this error refers to the whole file:
ipdb> p sarif_struct
{'ruleId': 'com.lgtm/cpp-queries:cpp/missing-header-guard', 'ruleIndex': 12,
'message': {'text': 'This header file should contain a header guard to prevent
multiple inclusion.'}, 'locations': [{'physicalLocation': {'artifactLocation':
{'uri': 'diff/cmpbuf.h', 'uriBaseId': '%SRCROOT%', 'index': 13}}}],
'partialFingerprints': {'primaryLocationLineHash': 'd04cb834fa64727d:1',
'primaryLocationStartColumnFingerprint': '0'}}
The goal is fixed-structure output formatting, so whole-file output uses
-1,-1,-1,-1 for line, column information.
97 lines
4.7 KiB
Python
Executable File
97 lines
4.7 KiB
Python
Executable File
#!/usr/bin/env python
|
|
import argparse
|
|
import json
|
|
import sarif_cli as S
|
|
import re
|
|
import sys
|
|
import collections
|
|
|
|
parser = argparse.ArgumentParser(description='summary of results')
|
|
parser.add_argument('file', metavar='sarif-file', type=str, help='input file, - for stdin')
|
|
parser.add_argument('-s', '--list-source', metavar='srcroot', type=str,
|
|
help='list source snippets using srcroot as sarif SRCROOT')
|
|
parser.add_argument('-r', '--related-locations', action="store_true",
|
|
help='list related locations like "hides [parameter](1)"')
|
|
# TODO mutually exclusive options
|
|
parser.add_argument('-c', '--csv', action="store_true",
|
|
help='output csv instead of human-readable summary')
|
|
|
|
args = parser.parse_args()
|
|
with open(args.file, 'r') if args.file != '-' else sys.stdin as fp:
|
|
sarif_struct = json.load(fp)
|
|
|
|
if args.csv:
|
|
cw = S.get_csv_writer()
|
|
|
|
for runi in S.indices(sarif_struct, 'runs'):
|
|
num_results = len(S.get(sarif_struct, 'runs', runi, 'results'))
|
|
if num_results == 0: continue
|
|
#
|
|
for resi in S.indices(sarif_struct, 'runs', runi, 'results'):
|
|
result = S.get(sarif_struct, 'runs', runi, 'results', resi)
|
|
if 'locations' in result:
|
|
# Non-path problems
|
|
# TODO: just pull out the uri, not the artifact
|
|
message, artifact, region = S.get_location_message_info(result)
|
|
if region == S.WholeFile:
|
|
l1, c1, l2, c2 = -1, -1, -1, -1
|
|
else:
|
|
l1, c1, l2, c2 = S.lineinfo(region)
|
|
filepath = "%s:%d:%d:%d:%d" % (artifact['uri'], l1, c1, l2, c2)
|
|
if args.csv:
|
|
S.write_csv(cw, "result", artifact['uri'], l1, c1, l2, c2, message)
|
|
else:
|
|
S.msg("RESULT: %s: %s\n\n" % (filepath, message))
|
|
|
|
if region != S.WholeFile and args.list_source:
|
|
lines = S.load_lines(args.list_source, artifact['uri'], l1, l2)
|
|
if args.csv:
|
|
pass
|
|
else:
|
|
for line, line_num in zip(lines, range(l1, l2+1)):
|
|
S.display_underlined(l1, c1, l2, c2, line, line_num)
|
|
if args.related_locations:
|
|
# Full path: S.get(sarif_struct, 'runs', runi, 'results', resi, 'relatedLocations')
|
|
relatedLocations = result.get('relatedLocations', None)
|
|
if type(relatedLocations) == list:
|
|
# Linking is explicit in output, so no need to get id(s) from message string.
|
|
for relo in relatedLocations:
|
|
message, artifact, region = S.get_relatedlocation_message_info(relo)
|
|
l1, c1, l2, c2 = S.lineinfo(region)
|
|
filepath = "%s:%d:%d:%d:%d" % (artifact['uri'], l1, c1, l2, c2)
|
|
if args.csv:
|
|
S.write_csv(cw, "result", artifact['uri'], l1, c1, l2, c2, message)
|
|
else:
|
|
S.msg("REFERENCE: %s: %s\n\n" % (filepath, message))
|
|
if args.list_source:
|
|
lines = S.load_lines(args.list_source, artifact['uri'], l1, l2)
|
|
if args.csv:
|
|
pass
|
|
else:
|
|
for line, line_num in zip(lines, range(l1, l2+1)):
|
|
S.display_underlined(l1, c1, l2, c2, line, line_num)
|
|
if 'codeFlows' in result:
|
|
# Path problems
|
|
for codeFlow in S.get(result, 'codeFlows'):
|
|
for threadFlow in S.get(codeFlow, 'threadFlows'):
|
|
for loci in S.indices(threadFlow, 'locations'):
|
|
location = S.get(threadFlow, 'locations', loci, 'location')
|
|
message, artifact, region = S.get_relatedlocation_message_info(location)
|
|
l1, c1, l2, c2 = S.lineinfo(region)
|
|
filepath = "%s:%d:%d:%d:%d" % (artifact['uri'], l1, c1, l2, c2)
|
|
if args.csv:
|
|
S.write_csv(cw, "flow_step", loci, artifact['uri'], l1, c1, l2, c2, message)
|
|
else:
|
|
S.msg("FLOW STEP %d: %s: %s\n\n" % (loci, filepath, message))
|
|
if args.list_source:
|
|
lines = S.load_lines(args.list_source, artifact['uri'], l1, l2)
|
|
if args.csv:
|
|
pass
|
|
else:
|
|
for line, line_num in zip(lines, range(l1, l2+1)):
|
|
S.display_underlined(l1, c1, l2, c2, line, line_num)
|
|
if args.csv:
|
|
pass
|
|
else:
|
|
S.msg("\n")
|