106 lines
3.9 KiB
Bash
Executable File
106 lines
3.9 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# Copyright 2022 The Kubernetes Authors.
|
|
#
|
|
# 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.
|
|
|
|
# CI script to run shellcheck
|
|
set -o errexit
|
|
set -o nounset
|
|
set -o pipefail
|
|
|
|
# cd to the repo root
|
|
REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." &> /dev/null && pwd -P)"
|
|
cd "${REPO_ROOT}"
|
|
|
|
# allow overriding docker cli, which should work fine for this script
|
|
DOCKER="${DOCKER:-docker}"
|
|
|
|
# required version for this script, if not installed on the host we will
|
|
# use the official docker image instead. keep this in sync with SHELLCHECK_IMAGE
|
|
SHELLCHECK_VERSION="0.8.0"
|
|
# upstream shellcheck latest stable image as of October 23rd, 2019
|
|
SHELLCHECK_IMAGE="docker.io/koalaman/shellcheck-alpine@sha256:f42fde76d2d14a645a848826e54a4d650150e151d9c81057c898da89a82c8a56"
|
|
|
|
# Find all shell scripts excluding:
|
|
# - Anything git-ignored - No need to lint untracked files.
|
|
# - ./.git/* - Ignore anything in the git object store.
|
|
# - ./hack/third_party/* - Ignore vendored scripts.
|
|
# - ./bin/* - No need to lint output directories.
|
|
all_shell_scripts=()
|
|
while IFS=$'\n' read -r script;
|
|
do git check-ignore -q "$script" || all_shell_scripts+=("$script");
|
|
done < <(grep -irl '#!.*sh' . | grep -Ev '^(\./\.git/)|(\./hack/third_party/)|(\./bin/)')
|
|
|
|
# common arguments we'll pass to shellcheck
|
|
SHELLCHECK_OPTIONS=(
|
|
# allow following sourced files that are not specified in the command,
|
|
# we need this because we specify one file at a time in order to trivially
|
|
# detect which files are failing
|
|
'--external-sources'
|
|
# disabled lint codes
|
|
# 2330 - disabled due to https://github.com/koalaman/shellcheck/issues/1162
|
|
'--exclude=2230'
|
|
# 2126 - disabled because grep -c exits error when there are zero matches,
|
|
# unlike grep | wc -l
|
|
'--exclude=2126'
|
|
# set colorized output
|
|
'--color=auto'
|
|
)
|
|
|
|
# detect if the host machine has the required shellcheck version installed
|
|
# if so, we will use that instead.
|
|
HAVE_SHELLCHECK=false
|
|
if which shellcheck &>/dev/null; then
|
|
detected_version="$(shellcheck --version | grep 'version: .*')"
|
|
if [[ "${detected_version}" = "version: ${SHELLCHECK_VERSION}" ]]; then
|
|
HAVE_SHELLCHECK=true
|
|
fi
|
|
fi
|
|
|
|
|
|
# tell the user which we've selected and lint all scripts
|
|
# The shellcheck errors are printed to stdout by default, hence they need to be redirected
|
|
# to stderr in order to be well parsed for Junit representation by juLog function
|
|
res=0
|
|
if ${HAVE_SHELLCHECK}; then
|
|
echo "Using host shellcheck ${SHELLCHECK_VERSION} binary."
|
|
shellcheck "${SHELLCHECK_OPTIONS[@]}" "${all_shell_scripts[@]}" >&2 || res=$?
|
|
else
|
|
echo "Using shellcheck ${SHELLCHECK_VERSION} docker image."
|
|
"${DOCKER}" run \
|
|
--rm -v "${KUBE_ROOT}:${KUBE_ROOT}" -w "${KUBE_ROOT}" \
|
|
"${SHELLCHECK_IMAGE}" \
|
|
shellcheck "${SHELLCHECK_OPTIONS[@]}" "${all_shell_scripts[@]}" >&2 || res=$?
|
|
fi
|
|
|
|
# print a message based on the result
|
|
if [ $res -eq 0 ]; then
|
|
echo 'Congratulations! All shell files are passing lint :-)'
|
|
else
|
|
{
|
|
echo
|
|
echo 'Please review the above warnings. You can test via "./hack/verify/shellcheck.sh"'
|
|
echo 'If the above warnings do not make sense, you can exempt this warning with a comment'
|
|
echo ' (if your reviewer is okay with it).'
|
|
echo 'In general please prefer to fix the error, we have already disabled specific lints'
|
|
echo ' that the project chooses to ignore.'
|
|
echo 'See: https://github.com/koalaman/shellcheck/wiki/Ignore#ignoring-one-specific-instance-in-a-file'
|
|
echo
|
|
} >&2
|
|
exit 1
|
|
fi
|
|
|
|
# preserve the result
|
|
exit $res
|