Send colobot-lint results to GitHub using annotations
This makes the results visible directly in the pull request UI changes view1164-fix
krzys-h
parent
4bd6e01b65
commit
dcd84523ab
|
|
@ -84,79 +84,133 @@ jobs:
|
||||||
with:
|
with:
|
||||||
name: HTML results
|
name: HTML results
|
||||||
path: build/html_report
|
path: build/html_report
|
||||||
- name: Update stable/unstable build status
|
- run: pip install requests
|
||||||
shell: bash
|
- name: Send linter results to GitHub
|
||||||
|
shell: python
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
run: |
|
run: |
|
||||||
set -e +x
|
import os
|
||||||
# Update stable/unstable build status
|
import sys
|
||||||
ret=0
|
import requests
|
||||||
WORKSPACE=$PWD
|
import xml.etree.ElementTree as ET
|
||||||
COLOBOT_LINT_REPORT_FILE="$WORKSPACE/build/colobot_lint_report.xml"
|
|
||||||
COLOBOT_LINT_DIR="/tmp/colobot-lint/archive"
|
OVERALL_STABLE_RULES=[
|
||||||
OVERALL_STABLE_RULES=(
|
"class naming",
|
||||||
"class naming"
|
"code block placement",
|
||||||
"code block placement"
|
"compile error",
|
||||||
"compile error"
|
# "compile warning",
|
||||||
# "compile warning"
|
# "enum naming",
|
||||||
# "enum naming"
|
# "function naming",
|
||||||
# "function naming"
|
"header file not self-contained",
|
||||||
"header file not self-contained"
|
# "implicit bool cast",
|
||||||
# "implicit bool cast"
|
# "include style",
|
||||||
# "include style"
|
# "inconsistent declaration parameter name",
|
||||||
# "inconsistent declaration parameter name"
|
"license header",
|
||||||
"license header"
|
# "naked delete",
|
||||||
# "naked delete"
|
# "naked new",
|
||||||
# "naked new"
|
# "old style function",
|
||||||
# "old style function"
|
"old-style null pointer",
|
||||||
"old-style null pointer"
|
# "possible forward declaration",
|
||||||
# "possible forward declaration"
|
"undefined function",
|
||||||
"undefined function"
|
# "uninitialized field",
|
||||||
# "uninitialized field"
|
# "uninitialized local variable",
|
||||||
# "uninitialized local variable"
|
# "unused forward declaration",
|
||||||
# "unused forward declaration"
|
# "variable naming",
|
||||||
# "variable naming"
|
"whitespace",
|
||||||
"whitespace"
|
]
|
||||||
)
|
|
||||||
echo "Checking rule stability (overall)"
|
STABLE_RULES_WITHOUT_CBOT=[
|
||||||
for ((i = 0; i < ${#OVERALL_STABLE_RULES[@]}; i++)); do
|
"class naming",
|
||||||
rule="${OVERALL_STABLE_RULES[$i]}"
|
"code block placement",
|
||||||
count="$("$COLOBOT_LINT_DIR/Tools/count_errors.py" --rule-filter="$rule" --xml-report-file "$COLOBOT_LINT_REPORT_FILE")"
|
"compile error",
|
||||||
if [ "$count" != "0" ]; then
|
"compile warning",
|
||||||
echo "UNSTABLE RULE: $rule ($count occurences)"
|
# "enum naming",
|
||||||
ret=1
|
# "function naming",
|
||||||
fi
|
"header file not self-contained",
|
||||||
done
|
# "implicit bool cast",
|
||||||
STABLE_RULES_WITHOUT_CBOT=(
|
"include style",
|
||||||
"class naming"
|
"inconsistent declaration parameter name",
|
||||||
"code block placement"
|
"license header",
|
||||||
"compile error"
|
"naked delete",
|
||||||
"compile warning"
|
"naked new",
|
||||||
# "enum naming"
|
# "old style function",
|
||||||
# "function naming"
|
"old-style null pointer",
|
||||||
"header file not self-contained"
|
# "possible forward declaration",
|
||||||
# "implicit bool cast"
|
"undefined function",
|
||||||
"include style"
|
"uninitialized field",
|
||||||
"inconsistent declaration parameter name"
|
# "uninitialized local variable",
|
||||||
"license header"
|
"unused forward declaration",
|
||||||
"naked delete"
|
# "variable naming",
|
||||||
"naked new"
|
"whitespace",
|
||||||
# "old style function"
|
]
|
||||||
"old-style null pointer"
|
|
||||||
# "possible forward declaration"
|
# None of the available actions seem to do what I want, they all do stupid things like adding another check... let's just do it manually
|
||||||
"undefined function"
|
# GitHub also doesn't seem to provide you with the check suite or check run ID, so we have to get it from the action ID via the API
|
||||||
"uninitialized field"
|
s = requests.Session()
|
||||||
# "uninitialized local variable"
|
s.headers.update({
|
||||||
"unused forward declaration"
|
'Authorization': 'token ' + os.environ['GITHUB_TOKEN'],
|
||||||
# "variable naming"
|
'Accept': 'application/vnd.github.antiope-preview+json' # Annotations are still technically a preview feature of the API
|
||||||
"whitespace"
|
})
|
||||||
)
|
action_run = s.get(os.environ['GITHUB_API_URL'] + "/repos/" + os.environ['GITHUB_REPOSITORY'] + "/actions/runs/" + os.environ['GITHUB_RUN_ID']).json()
|
||||||
echo "Checking rule stability (without CBOT)"
|
check_suite = s.get(action_run['check_suite_url']).json()
|
||||||
for ((i = 0; i < ${#STABLE_RULES_WITHOUT_CBOT[@]}; i++)); do
|
check_suite_runs = s.get(check_suite['check_runs_url']).json()
|
||||||
rule="${STABLE_RULES_WITHOUT_CBOT[$i]}"
|
check_run = check_suite_runs['check_runs'][0] # NOTE: This assumes that the 'lint' job is the first one in the workflow. You could find it by name if you really wanted.
|
||||||
count="$("$COLOBOT_LINT_DIR/Tools/count_errors.py" --rule-filter="$rule" --file-filter="-.*CBot.*" --xml-report-file "$COLOBOT_LINT_REPORT_FILE")"
|
|
||||||
if [ "$count" != "0" ]; then
|
def we_care_about(file_name, type):
|
||||||
echo "UNSTABLE RULE: $rule (without CBOT, $count occurences)"
|
if 'CBot' in file_name:
|
||||||
ret=1
|
return type in OVERALL_STABLE_RULES
|
||||||
fi
|
else:
|
||||||
done
|
return type in STABLE_RULES_WITHOUT_CBOT
|
||||||
exit $ret
|
|
||||||
|
results = ET.parse('build/colobot_lint_report.xml')
|
||||||
|
annotations = []
|
||||||
|
for error in results.find('errors').findall('error'):
|
||||||
|
location = error.find('location')
|
||||||
|
file_name = os.path.relpath(location.get('file'), os.environ['GITHUB_WORKSPACE'])
|
||||||
|
line_num = int(location.get('line'))
|
||||||
|
type = error.get('id')
|
||||||
|
severity = error.get('severity')
|
||||||
|
msg = error.get('msg')
|
||||||
|
|
||||||
|
gh_severity = 'warning'
|
||||||
|
if severity == 'error':
|
||||||
|
gh_severity = 'failure'
|
||||||
|
elif severity == 'information':
|
||||||
|
gh_severity = 'notice'
|
||||||
|
|
||||||
|
if not we_care_about(file_name, type):
|
||||||
|
# don't send the unstable rules to github at all as there are way too many of them and it would overload the API rate limit
|
||||||
|
continue
|
||||||
|
|
||||||
|
print('{}:{}: [{}] {}'.format(file_name, line_num, type, msg))
|
||||||
|
|
||||||
|
annotations.append({
|
||||||
|
'path': file_name,
|
||||||
|
'start_line': line_num,
|
||||||
|
'end_line': line_num,
|
||||||
|
'annotation_level': gh_severity,
|
||||||
|
'title': type,
|
||||||
|
'message': msg
|
||||||
|
})
|
||||||
|
|
||||||
|
summary = 'colobot-lint found {} issues'.format(len(annotations))
|
||||||
|
all_ok = len(annotations) == 0
|
||||||
|
|
||||||
|
# Annotations have to be sent in batches of 50
|
||||||
|
first = True
|
||||||
|
while first or len(annotations) > 0:
|
||||||
|
first = False
|
||||||
|
to_send = annotations[:50]
|
||||||
|
annotations = annotations[50:]
|
||||||
|
data = {
|
||||||
|
'output': {
|
||||||
|
'title': summary,
|
||||||
|
'summary': summary,
|
||||||
|
'annotations': to_send
|
||||||
|
}
|
||||||
|
}
|
||||||
|
r = s.patch(check_run['url'], json=data)
|
||||||
|
r.raise_for_status()
|
||||||
|
|
||||||
|
sys.exit(0 if all_ok else 1)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue