mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-11-17 20:00:23 +00:00
fd62a5897a
While introducing scripts/build_step.inc.sh the tests start to fail as the script is included and each shell script is tested separately. By adding the option --external-sources to shellcheck, the related warnings are not reported. Signed-off-by: Niels de Vos <ndevos@redhat.com>
58 lines
1.6 KiB
Bash
Executable File
58 lines
1.6 KiB
Bash
Executable File
#! /bin/bash
|
|
# vim: set ts=4 sw=4 et :
|
|
|
|
# Usage: pre-commit.sh [--require-all]
|
|
# --require-all Fail instead of warn if a checker is not found
|
|
|
|
set -e
|
|
|
|
# Run checks from root of the repo
|
|
scriptdir="$(dirname "$(realpath "$0")")"
|
|
cd "$scriptdir/.."
|
|
|
|
# run_check <file_regex> <checker_exe> [optional args to checker...]
|
|
# Pass empty regex when no regex is needed
|
|
function run_check() {
|
|
regex="$1"
|
|
shift
|
|
exe="$1"
|
|
shift
|
|
|
|
if [ -x "$(command -v "$exe")" ]; then
|
|
if [ -z "$regex" ]; then
|
|
"$exe" "$@"
|
|
else
|
|
find . -path ./vendor -prune -o -regextype egrep -iregex "$regex" -print0 |
|
|
xargs -0rt -n1 "$exe" "$@"
|
|
fi
|
|
elif [ "$all_required" -eq 0 ]; then
|
|
echo "Warning: $exe not found... skipping some tests."
|
|
else
|
|
echo "FAILED: All checks required, but $exe not found!"
|
|
exit 1
|
|
fi
|
|
}
|
|
|
|
all_required=0
|
|
if [ "x$1" == "x--require-all" ]; then
|
|
all_required=1
|
|
fi
|
|
|
|
# markdownlint: https://github.com/markdownlint/markdownlint
|
|
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
|
|
# Install via: gem install mdl
|
|
run_check '.*\.md' mdl --style scripts/mdl-style.rb
|
|
|
|
# Install via: dnf install shellcheck
|
|
run_check '.*\.(ba)?sh' shellcheck --external-sources
|
|
run_check '.*\.(ba)?sh' bash -n
|
|
|
|
# Install via: pip install yamllint
|
|
# disable yamlint check for helm charts
|
|
run_check '.*\.ya?ml' yamllint -s -d "{extends: default, rules: {line-length: {allow-non-breakable-inline-mappings: true}},ignore: charts/*/templates/*.yaml}"
|
|
|
|
# Install via: https://github.com/helm/helm/blob/master/docs/install.md
|
|
run_check '' helm lint --namespace=test charts/*
|
|
|
|
echo "ALL OK."
|