mirror of
https://github.com/hohn/sarif-cli.git
synced 2025-12-16 17:23:03 +01:00
e36874cb54
Using
sarif-results-summary -s data/linux-small data/torvalds_linux__2021-10-21_10_07_00__export.sarif |less
now underscores the indicated regions, e.g.
tools/cgroup/iocost_monitor.py:64:5:64:27: Normal methods should have 'self', rather than 'blkcg', as their first parameter.
def blkcg_name(blkcg):
^^^^^^^^^^^^^^^^^^^^^^
95 lines
2.9 KiB
Python
95 lines
2.9 KiB
Python
import sys
|
|
import os
|
|
import re
|
|
|
|
MIN_PYTHON = (3, 7)
|
|
if sys.version_info < MIN_PYTHON:
|
|
sys.exit("Python %s.%s or later is required.\n" % MIN_PYTHON)
|
|
|
|
def underline_for_result(first_line, first_column, last_line, last_column, line, line_num):
|
|
"""Provide the underline for a result line.
|
|
|
|
first_line, first_column, last_line, last_column :
|
|
the region from S.lineinfo(region)
|
|
line:
|
|
the line of source
|
|
line_num:
|
|
the index of line, must satisfy first_line <= line_num <= last_line
|
|
"""
|
|
# Underline the affected region
|
|
# col_* use the [start, end) indexing
|
|
# From the first non-whitespace char
|
|
match = re.search("([^\s])+", line)
|
|
if match:
|
|
col_from = match.span()[0]
|
|
else:
|
|
col_from = 0
|
|
# To the last non-whitespace char
|
|
match = re.search("(\s)+$", line)
|
|
if match:
|
|
col_to = match.span()[0]
|
|
else:
|
|
col_to = len(line)
|
|
# Use 1-indexing
|
|
col_from += 1 ; col_to += 1
|
|
# Adjust first line
|
|
if line_num == first_line:
|
|
col_from = max(col_from, first_column)
|
|
# Adjust last line
|
|
if line_num == last_line:
|
|
col_to = min(col_to, last_column)
|
|
# Use 0-indexing
|
|
col_from -= 1 ; col_to -= 1
|
|
# Return the underline
|
|
return " " * col_from + "^" * (col_to - col_from)
|
|
|
|
|
|
def load_lines(root, path, line_from, line_to):
|
|
"""Load the line range [line_from, line_to], including both,
|
|
from the file at root/path.
|
|
Lines are counted from 1.
|
|
Use 1 space for each tab. This seems to be the codeql handling for beginning of line.
|
|
Newlines are dropped.
|
|
"""
|
|
fname = os.path.join(root, path)
|
|
with open(fname, 'r') as file:
|
|
lines = file.readlines()
|
|
return [line.rstrip("\n\r").replace("\t", " ")
|
|
for line in lines[line_from-1 : line_to-1+1]]
|
|
|
|
def lineinfo(region):
|
|
""" Return sensible values for start/end line/columns for the possibly empty
|
|
entries in the sarif 'region' structure.
|
|
"""
|
|
startLine, startColumn, endLine, endColumn = map(
|
|
lambda e: region.get(e, -1), ['startLine', 'startColumn', 'endLine', 'endColumn'])
|
|
# Full information is startLine / startColumn / endLine / endcolumn
|
|
# - only have startLine / startColumn / _ / endcolumn
|
|
if endLine == -1: endLine = startLine
|
|
|
|
# - only have startLine / _ / _ / endcolumn
|
|
if startColumn == -1: startColumn = 1
|
|
|
|
return startLine, startColumn, endLine, endColumn
|
|
|
|
def indices(sarif_struct, *path):
|
|
""" Return a range for the indices of PATH """
|
|
return range(0, len(get(sarif_struct, *path)))
|
|
|
|
def get(sarif_struct, *path):
|
|
""" Get the sarif entry at PATH """
|
|
res = sarif_struct
|
|
for p in path:
|
|
res = res[p]
|
|
return res
|
|
|
|
def msg(message):
|
|
""" Print message to stdout """
|
|
sys.stdout.write(message)
|
|
|
|
def dbg(message):
|
|
""" Print message to stderr """
|
|
sys.stdout.flush()
|
|
sys.stderr.write(message)
|
|
sys.stderr.flush()
|