aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/bash/entry/check/pylint.sh
blob: 4d8c27d6347042723f948c445f1fa9f36c7d5831 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# Copyright (c) 2021 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

set -exuo pipefail

# This file should be executed from tox, as the assumend working directory
# is different from where this file is located.
# This file does not have executable flag nor shebang,
# to dissuade non-tox callers.

# This script runs pylint and propagates its exit code.
# Config is taken from pylint.cfg, and proper virtualenv is assumed to be active.
# The pylint output stored to pylint.log (overwriting).

# "set -eu" handles failures from the following two lines.
BASH_CHECKS_DIR="$(dirname $(readlink -e "${BASH_SOURCE[0]}"))"
BASH_FUNCTION_DIR="$(readlink -e "${BASH_CHECKS_DIR}/../../function")"
source "${BASH_FUNCTION_DIR}/common.sh" || {
    echo "Source failed." >&2
    exit 1
}
pylint_args=("--rcfile=pylint.cfg" "resources/" "GPL/")
if pylint "${pylint_args[@]}" > "pylint.log"; then
    warn
    warn "Pylint checker: PASS"
else
    # TODO: Decide which text goes to stdout and which to stderr.
    warn "Pylint exited with nonzero status."
    ## TODO: Enable when output size does more good than harm.
    # cat "pylint.log" >&2
    warn
    warn "Pylint checker: FAIL"
    exit 1
fi