ci: add compliance checking via GH actions
Move check_compliance script to main tree and adapt/use with GH actions. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif
parent
c4b6fd0248
commit
288ae28c13
114
.github/workflows/compliance.yml
vendored
Normal file
114
.github/workflows/compliance.yml
vendored
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
name: Compliance
|
||||
|
||||
on: pull_request
|
||||
|
||||
jobs:
|
||||
compliance_job:
|
||||
runs-on: ubuntu-latest
|
||||
name: Run compliance checks on patch series (PR)
|
||||
steps:
|
||||
- name: Checkout the code
|
||||
uses: actions/checkout@v1
|
||||
|
||||
- name: cache-pip
|
||||
uses: actions/cache@v1
|
||||
with:
|
||||
path: ~/.cache/pip
|
||||
key: ${{ runner.os }}-doc-pip
|
||||
|
||||
- name: Install python dependencies
|
||||
run: |
|
||||
pip3 install setuptools
|
||||
pip3 install wheel
|
||||
pip3 install python-magic junitparser gitlint pylint pykwalify
|
||||
pip3 install west
|
||||
|
||||
- name: Run Compliance Tests
|
||||
id: compliance
|
||||
env:
|
||||
BASE_REF: ${{ github.base_ref }}
|
||||
run: |
|
||||
export PATH=$PATH:~/.local/bin
|
||||
export ZEPHYR_BASE=$PWD
|
||||
git config --global user.email "you@example.com"
|
||||
git config --global user.name "Your Name"
|
||||
git rebase origin/${BASE_REF}
|
||||
./scripts/ci/check_compliance.py -m Codeowners -m Devicetree -m Gitlint -m Identity -m Nits -m pylint -m checkpatch -m Kconfig -c origin/${BASE_REF}.. || true
|
||||
|
||||
- name: upload-results
|
||||
uses: actions/upload-artifact@master
|
||||
continue-on-error: True
|
||||
with:
|
||||
name: compliance.xml
|
||||
path: compliance.xml
|
||||
|
||||
- name: check-warns
|
||||
run: |
|
||||
if [ -s Nits.txt ]; then
|
||||
errors=$(cat Nits.txt)
|
||||
errors="${errors//'%'/'%25'}"
|
||||
errors="${errors//$'\n'/'%0A'}"
|
||||
errors="${errors//$'\r'/'%0D'}"
|
||||
echo "::error file=Nits.txt::$errors"
|
||||
exit=1
|
||||
fi
|
||||
if [ -s checkpatch.txt ]; then
|
||||
errors=$(cat checkpatch.txt)
|
||||
errors="${errors//'%'/'%25'}"
|
||||
errors="${errors//$'\n'/'%0A'}"
|
||||
errors="${errors//$'\r'/'%0D'}"
|
||||
echo "::error file=Checkpatch.txt::$errors"
|
||||
exit=1
|
||||
fi
|
||||
if [ -s Identity.txt ]; then
|
||||
errors=$(cat Identity.txt)
|
||||
errors="${errors//'%'/'%25'}"
|
||||
errors="${errors//$'\n'/'%0A'}"
|
||||
errors="${errors//$'\r'/'%0D'}"
|
||||
echo "::error file=Identity.txt::$errors"
|
||||
exit=1
|
||||
fi
|
||||
if [ -s Gitlint.txt ]; then
|
||||
errors=$(cat Gitlint.txt)
|
||||
errors="${errors//'%'/'%25'}"
|
||||
errors="${errors//$'\n'/'%0A'}"
|
||||
errors="${errors//$'\r'/'%0D'}"
|
||||
echo "::error file=Gitlint.txt::$errors"
|
||||
exit=1
|
||||
fi
|
||||
if [ -s pylint.txt ]; then
|
||||
errors=$(cat pylint.txt)
|
||||
errors="${errors//'%'/'%25'}"
|
||||
errors="${errors//$'\n'/'%0A'}"
|
||||
errors="${errors//$'\r'/'%0D'}"
|
||||
echo "::error file=pylint.txt::$errors"
|
||||
exit=1
|
||||
fi
|
||||
if [ -s Devicetree.txt ]; then
|
||||
errors=$(cat Devicetree.txt)
|
||||
errors="${errors//'%'/'%25'}"
|
||||
errors="${errors//$'\n'/'%0A'}"
|
||||
errors="${errors//$'\r'/'%0D'}"
|
||||
echo "::error file=Devicetree.txt::$errors"
|
||||
exit=1
|
||||
fi
|
||||
if [ -s Kconfig.txt ]; then
|
||||
errors=$(cat Kconfig.txt)
|
||||
errors="${errors//'%'/'%25'}"
|
||||
errors="${errors//$'\n'/'%0A'}"
|
||||
errors="${errors//$'\r'/'%0D'}"
|
||||
echo "::error file=Kconfig.txt::$errors"
|
||||
exit=1
|
||||
fi
|
||||
if [ -s Codeowners.txt ]; then
|
||||
errors=$(cat Codeowners.txt)
|
||||
errors="${errors//'%'/'%25'}"
|
||||
errors="${errors//$'\n'/'%0A'}"
|
||||
errors="${errors//$'\r'/'%0D'}"
|
||||
echo "::error file=Codeowners.txt::$errors"
|
||||
exit=1
|
||||
fi
|
||||
|
||||
if [ ${exit} == 1 ]; then
|
||||
exit 1;
|
||||
fi
|
||||
1123
scripts/ci/check_compliance.py
Executable file
1123
scripts/ci/check_compliance.py
Executable file
File diff suppressed because it is too large
Load diff
249
scripts/ci/pylintrc
Normal file
249
scripts/ci/pylintrc
Normal file
|
|
@ -0,0 +1,249 @@
|
|||
# Copyright (c) 2019, Nordic Semiconductor ASA
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
# pylint configuration for the PyLint check in check_compliance.py.
|
||||
#
|
||||
# To run pylint manually with this configuration from the Zephyr repo, do
|
||||
#
|
||||
# pylint3 --rcfile=ci-tools/scripts/pylintrc <Python file>
|
||||
#
|
||||
# This command will check all scripts:
|
||||
#
|
||||
# pylint3 --rcfile=ci-tools/scripts/pylintrc $(git ls-files '*.py')
|
||||
|
||||
[MASTER]
|
||||
|
||||
# Use multiple processes
|
||||
jobs=0
|
||||
|
||||
# Do not pickle collected data for comparisons
|
||||
persistent=no
|
||||
|
||||
|
||||
[REPORTS]
|
||||
|
||||
# Only show messages, not full report
|
||||
reports=no
|
||||
|
||||
# Disable score
|
||||
score=no
|
||||
|
||||
|
||||
[MESSAGES CONTROL]
|
||||
|
||||
# Only enable specific (hopefully) uncontroversial warnings. Use
|
||||
# 'pylint3 --list-msgs' to list messages and their IDs.
|
||||
#
|
||||
# These might be nice to check too, but currently trigger false positives:
|
||||
#
|
||||
# no-member
|
||||
# arguments-differ
|
||||
# redefine-in-handler
|
||||
# abstract-method
|
||||
#
|
||||
# These might be too controversial:
|
||||
#
|
||||
# no-else-return
|
||||
# consider-using-get
|
||||
# redefined-builtin
|
||||
#
|
||||
# These tell you to use logger.warning("foo %d bar", 3) instead of e.g.
|
||||
# logger.warning("foo {} bar".format(3)), but it's not a clear win in all
|
||||
# cases. f-strings would be nicer too, and it's easier to convert from format()
|
||||
# to those.
|
||||
#
|
||||
# logging-not-lazy
|
||||
# logging-format-interpolation
|
||||
# logging-fstring-interpolation
|
||||
|
||||
disable=all
|
||||
# Identifiers are in the same order as in 'pylint3 --list-msgs'. Entire
|
||||
# message "types" (~= severities) like F(atal), E(error),... are listed
|
||||
# first.
|
||||
enable=
|
||||
F, # atal
|
||||
empty-docstring,
|
||||
unneeded-not,
|
||||
singleton-comparison,
|
||||
misplaced-comparison-constant,
|
||||
unidiomatic-typecheck,
|
||||
consider-using-enumerate,
|
||||
consider-iterating-dictionary,
|
||||
bad-classmethod-argument,
|
||||
bad-mcs-method-argument,
|
||||
bad-mcs-classmethod-argument,
|
||||
single-string-used-for-slots,
|
||||
trailing-newlines,
|
||||
trailing-whitespace,
|
||||
missing-final-newline,
|
||||
superfluous-parens,
|
||||
mixed-line-endings,
|
||||
unexpected-line-ending-format,
|
||||
invalid-characters-in-docstring,
|
||||
useless-import-alias,
|
||||
len-as-condition,
|
||||
syntax-error,
|
||||
init-is-generator,
|
||||
return-in-init,
|
||||
function-redefined,
|
||||
not-in-loop,
|
||||
return-outside-function,
|
||||
yield-outside-function,
|
||||
nonexistent-operator,
|
||||
duplicate-argument-name,
|
||||
abstract-class-instantiated,
|
||||
bad-reversed-sequence,
|
||||
too-many-star-expressions,
|
||||
invalid-star-assignment-target,
|
||||
star-needs-assignment-target,
|
||||
nonlocal-and-global,
|
||||
continue-in-finally,
|
||||
nonlocal-without-binding,
|
||||
misplaced-format-function,
|
||||
method-hidden,
|
||||
access-member-before-definition,
|
||||
no-method-argument,
|
||||
no-self-argument,
|
||||
invalid-slots-object,
|
||||
assigning-non-slot,
|
||||
invalid-slots,
|
||||
inherit-non-class,
|
||||
inconsistent-mro,
|
||||
duplicate-bases,
|
||||
non-iterator-returned,
|
||||
unexpected-special-method-signature,
|
||||
invalid-length-returned,
|
||||
relative-beyond-top-level,
|
||||
used-before-assignment,
|
||||
undefined-variable,
|
||||
undefined-all-variable,
|
||||
invalid-all-object,
|
||||
no-name-in-module,
|
||||
unpacking-non-sequence,
|
||||
bad-except-order,
|
||||
raising-bad-type,
|
||||
bad-exception-context,
|
||||
misplaced-bare-raise,
|
||||
raising-non-exception,
|
||||
notimplemented-raised,
|
||||
catching-non-exception,
|
||||
bad-super-call,
|
||||
not-callable,
|
||||
assignment-from-no-return,
|
||||
no-value-for-parameter,
|
||||
too-many-function-args,
|
||||
unexpected-keyword-arg,
|
||||
redundant-keyword-arg,
|
||||
missing-kwoa,
|
||||
invalid-sequence-index,
|
||||
invalid-slice-index,
|
||||
assignment-from-none,
|
||||
not-context-manager,
|
||||
invalid-unary-operand-type,
|
||||
unsupported-binary-operation,
|
||||
repeated-keyword,
|
||||
not-an-iterable,
|
||||
not-a-mapping,
|
||||
unsupported-membership-test,
|
||||
unsubscriptable-object,
|
||||
unsupported-assignment-operation,
|
||||
unsupported-delete-operation,
|
||||
invalid-metaclass,
|
||||
unhashable-dict-key,
|
||||
logging-unsupported-format,
|
||||
logging-format-truncated,
|
||||
logging-too-many-args,
|
||||
logging-too-few-args,
|
||||
bad-format-character,
|
||||
truncated-format-string,
|
||||
mixed-format-string,
|
||||
format-needs-mapping,
|
||||
missing-format-string-key,
|
||||
too-many-format-args,
|
||||
too-few-format-args,
|
||||
bad-string-format-type,
|
||||
bad-str-strip-call,
|
||||
invalid-envvar-value,
|
||||
yield-inside-async-function,
|
||||
not-async-context-manager,
|
||||
useless-suppression,
|
||||
deprecated-pragma,
|
||||
use-symbolic-message-instead,
|
||||
literal-comparison,
|
||||
comparison-with-itself,
|
||||
no-self-use,
|
||||
no-classmethod-decorator,
|
||||
no-staticmethod-decorator,
|
||||
cyclic-import,
|
||||
duplicate-code,
|
||||
consider-merging-isinstance,
|
||||
simplifiable-if-statement,
|
||||
redefined-argument-from-local,
|
||||
trailing-comma-tuple,
|
||||
stop-iteration-return,
|
||||
useless-return,
|
||||
consider-swap-variables,
|
||||
consider-using-join,
|
||||
consider-using-in,
|
||||
chained-comparison,
|
||||
consider-using-dict-comprehension,
|
||||
consider-using-set-comprehension,
|
||||
simplifiable-if-expression,
|
||||
unreachable,
|
||||
pointless-statement,
|
||||
pointless-string-statement,
|
||||
expression-not-assigned,
|
||||
unnecessary-pass,
|
||||
unnecessary-lambda,
|
||||
duplicate-key,
|
||||
assign-to-new-keyword,
|
||||
useless-else-on-loop,
|
||||
confusing-with-statement,
|
||||
using-constant-test,
|
||||
comparison-with-callable,
|
||||
lost-exception,
|
||||
assert-on-tuple,
|
||||
bad-staticmethod-argument,
|
||||
super-init-not-called,
|
||||
non-parent-init-called,
|
||||
useless-super-delegation,
|
||||
unnecessary-semicolon,
|
||||
bad-indentation,
|
||||
mixed-indentation,
|
||||
deprecated-module,
|
||||
reimported,
|
||||
import-self,
|
||||
misplaced-future,
|
||||
global-variable-not-assigned,
|
||||
unused-import,
|
||||
unused-variable,
|
||||
undefined-loop-variable,
|
||||
unbalanced-tuple-unpacking,
|
||||
possibly-unused-variable,
|
||||
self-cls-assignment,
|
||||
bare-except,
|
||||
duplicate-except,
|
||||
try-except-raise,
|
||||
binary-op-exception,
|
||||
raising-format-tuple,
|
||||
wrong-exception-operation,
|
||||
keyword-arg-before-vararg,
|
||||
bad-format-string-key,
|
||||
unused-format-string-key,
|
||||
bad-format-string,
|
||||
unused-format-string-argument,
|
||||
format-combined-specification,
|
||||
missing-format-attribute,
|
||||
invalid-format-index,
|
||||
anomalous-backslash-in-string,
|
||||
anomalous-unicode-escape-in-string,
|
||||
bad-open-mode,
|
||||
redundant-unittest-assert,
|
||||
deprecated-method,
|
||||
bad-thread-instantiation,
|
||||
shallow-copy-environ,
|
||||
invalid-envvar-default,
|
||||
deprecated-string-function,
|
||||
deprecated-str-translate-call,
|
||||
deprecated-itertools-function,
|
||||
deprecated-types-field,
|
||||
Loading…
Reference in a new issue