mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-23 11:50:44 +00:00
use golangci-lint and remove legacy verify-staticcheck.sh
This commit is contained in:
Antonio Ojea
parent
86e197991a
commit
272b31da50
@ -44,14 +44,37 @@ popd >/dev/null
|
|||||||
cd "${KUBE_ROOT}"
|
cd "${KUBE_ROOT}"
|
||||||
|
|
||||||
# The config is in ${KUBE_ROOT}/.golangci.yaml
|
# The config is in ${KUBE_ROOT}/.golangci.yaml
|
||||||
echo 'running golangci-lint '
|
echo 'running golangci-lint ' >&2
|
||||||
if [[ "$#" > 0 ]]; then
|
res=0
|
||||||
golangci-lint run "$@"
|
if [[ "$#" -gt 0 ]]; then
|
||||||
|
golangci-lint run "$@" >&2 || res=$?
|
||||||
else
|
else
|
||||||
golangci-lint run ./...
|
golangci-lint run ./... >&2 || res=$?
|
||||||
for d in staging/src/k8s.io/*; do
|
for d in staging/src/k8s.io/*; do
|
||||||
pushd ./vendor/k8s.io/$(basename "$d") >/dev/null
|
MODPATH="staging/src/k8s.io/$(basename "${d}")"
|
||||||
golangci-lint run ./...
|
echo "running golangci-lint for ${KUBE_ROOT}/${MODPATH}"
|
||||||
|
pushd "${KUBE_ROOT}/${MODPATH}" >/dev/null
|
||||||
|
golangci-lint --path-prefix "${MODPATH}" run ./... >&2 || res=$?
|
||||||
popd >/dev/null
|
popd >/dev/null
|
||||||
done
|
done
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# print a message based on the result
|
||||||
|
if [ "$res" -eq 0 ]; then
|
||||||
|
echo 'Congratulations! All files are passing lint :-)'
|
||||||
|
else
|
||||||
|
{
|
||||||
|
echo
|
||||||
|
echo 'Please review the above warnings. You can test via "./hack/verify-golangci-lint.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://golangci-lint.run/usage/false-positives/'
|
||||||
|
echo
|
||||||
|
} >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# preserve the result
|
||||||
|
exit "$res"
|
||||||
|
|||||||
@ -1,177 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
# Copyright 2014 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.
|
|
||||||
|
|
||||||
# This script lints each package by `staticcheck`.
|
|
||||||
# Usage: `hack/verify-staticcheck.sh`.
|
|
||||||
# NOTE: To ignore issues detected a package, add it to the
|
|
||||||
# `.staticcheck_failures` blacklist.
|
|
||||||
|
|
||||||
set -o errexit
|
|
||||||
set -o nounset
|
|
||||||
set -o pipefail
|
|
||||||
|
|
||||||
KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
|
|
||||||
source "${KUBE_ROOT}/hack/lib/init.sh"
|
|
||||||
source "${KUBE_ROOT}/hack/lib/util.sh"
|
|
||||||
|
|
||||||
kube::golang::verify_go_version
|
|
||||||
|
|
||||||
FOCUS="${1:-}"
|
|
||||||
FOCUS="${FOCUS%/}" # Remove the ending "/"
|
|
||||||
|
|
||||||
# See https://staticcheck.io/docs/checks
|
|
||||||
CHECKS=(
|
|
||||||
"all"
|
|
||||||
"-S1*" # Omit code simplifications for now.
|
|
||||||
"-ST1*" # Mostly stylistic, redundant w/ golint
|
|
||||||
"-SA5011" # Possible nil pointer dereference
|
|
||||||
)
|
|
||||||
export IFS=','; checks="${CHECKS[*]}"; unset IFS
|
|
||||||
|
|
||||||
# Packages to ignore due to bugs in staticcheck
|
|
||||||
# NOTE: To ignore issues detected a package, add it to the .staticcheck_failures blacklist
|
|
||||||
IGNORE=(
|
|
||||||
"vendor/k8s.io/kubectl/pkg/cmd/edit/testdata" # golang/go#24854, dominikh/go-tools#565
|
|
||||||
"cluster/addons/fluentd-elasticsearch/es-image" # cannot traverse go modules
|
|
||||||
)
|
|
||||||
export IFS='|'; ignore_pattern="^(${IGNORE[*]})\$"; unset IFS
|
|
||||||
|
|
||||||
# Ensure that we find the binaries we build before anything else.
|
|
||||||
export GOBIN="${KUBE_OUTPUT_BINPATH}"
|
|
||||||
PATH="${GOBIN}:${PATH}"
|
|
||||||
|
|
||||||
# Install staticcheck
|
|
||||||
pushd "${KUBE_ROOT}/hack/tools" >/dev/null
|
|
||||||
GO111MODULE=on go install honnef.co/go/tools/cmd/staticcheck
|
|
||||||
popd >/dev/null
|
|
||||||
|
|
||||||
cd "${KUBE_ROOT}"
|
|
||||||
|
|
||||||
# Check that the file is in alphabetical order
|
|
||||||
failure_file="${KUBE_ROOT}/hack/.staticcheck_failures"
|
|
||||||
kube::util::check-file-in-alphabetical-order "${failure_file}"
|
|
||||||
|
|
||||||
function normalize_package() {
|
|
||||||
pkg="${1}"
|
|
||||||
if [[ "${pkg}" == "vendor/"* || "${pkg}" == "k8s.io/"* ]]; then
|
|
||||||
# Treat this as a full package path (stripping vendor prefix if needed)
|
|
||||||
echo "${pkg#"vendor/"}"
|
|
||||||
else
|
|
||||||
# Treat this as a relative package path to k8s.io/kubernetes
|
|
||||||
echo "./${pkg}"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
all_packages=()
|
|
||||||
while IFS='' read -r line; do
|
|
||||||
line=$(normalize_package "${line}")
|
|
||||||
all_packages+=("${line}")
|
|
||||||
done < <( hack/make-rules/helpers/cache_go_dirs.sh "${KUBE_ROOT}/_tmp/all_go_dirs" |
|
|
||||||
grep "^${FOCUS:-.}" |
|
|
||||||
grep -vE "(third_party|generated|clientset_generated|hack|testdata|/_)" |
|
|
||||||
grep -vE "$ignore_pattern" )
|
|
||||||
|
|
||||||
failing_packages=()
|
|
||||||
if [[ -z $FOCUS ]]; then # Ignore failing_packages in FOCUS mode
|
|
||||||
while IFS='' read -r line; do failing_packages+=("$line"); done < <(cat "$failure_file")
|
|
||||||
fi
|
|
||||||
errors=()
|
|
||||||
not_failing=()
|
|
||||||
|
|
||||||
while read -r error; do
|
|
||||||
# Ignore compile errors caused by lack of files due to build tags.
|
|
||||||
# TODO: Add verification for these directories.
|
|
||||||
ignore_no_files="^-: build constraints exclude all Go files in .* \(compile\)"
|
|
||||||
if [[ $error =~ $ignore_no_files ]]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Ignore the errors caused by the generated files
|
|
||||||
ignore_gen_files=".*/zz_generated\.[a-z]+\.go:.*"
|
|
||||||
if [[ $error =~ $ignore_gen_files ]]; then
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
|
|
||||||
file="${error%%:*}"
|
|
||||||
pkg="$(dirname "$file")"
|
|
||||||
kube::util::array_contains "$pkg" "${failing_packages[@]}" && in_failing=$? || in_failing=$?
|
|
||||||
if [[ "${in_failing}" -ne "0" ]]; then
|
|
||||||
errors+=( "${error}" )
|
|
||||||
elif [[ "${in_failing}" -eq "0" ]]; then
|
|
||||||
really_failing+=( "$pkg" )
|
|
||||||
fi
|
|
||||||
done < <(GO111MODULE=on GOOS=linux staticcheck -checks "${checks}" "${all_packages[@]}" 2>/dev/null || true)
|
|
||||||
|
|
||||||
export IFS=$'\n' # Expand ${really_failing[*]} to separate lines
|
|
||||||
kube::util::read-array really_failing < <(sort -u <<<"${really_failing[*]}")
|
|
||||||
unset IFS
|
|
||||||
for pkg in "${failing_packages[@]}"; do
|
|
||||||
if ! kube::util::array_contains "$pkg" "${really_failing[@]}"; then
|
|
||||||
not_failing+=( "$pkg" )
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# Check that all failing_packages actually still exist
|
|
||||||
gone=()
|
|
||||||
for p in "${failing_packages[@]}"; do
|
|
||||||
p=$(normalize_package "${p}")
|
|
||||||
if ! kube::util::array_contains "${p}" "${all_packages[@]}"; then
|
|
||||||
gone+=( "${p}" )
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# Check to be sure all the packages that should pass check are.
|
|
||||||
if [ ${#errors[@]} -eq 0 ]; then
|
|
||||||
echo 'Congratulations! All Go source files have passed staticcheck.'
|
|
||||||
else
|
|
||||||
{
|
|
||||||
echo "Errors from staticcheck:"
|
|
||||||
for err in "${errors[@]}"; do
|
|
||||||
echo "$err"
|
|
||||||
done
|
|
||||||
echo
|
|
||||||
echo 'Please review the above warnings. You can test via:'
|
|
||||||
echo ' hack/verify-staticcheck.sh <failing package>'
|
|
||||||
echo 'If the above warnings do not make sense, you can exempt the line or file. See:'
|
|
||||||
echo ' https://staticcheck.io/docs/#ignoring-problems'
|
|
||||||
echo
|
|
||||||
} >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ ${#not_failing[@]} -gt 0 ]]; then
|
|
||||||
{
|
|
||||||
echo "Some packages in hack/.staticcheck_failures are passing staticcheck. Please remove them."
|
|
||||||
echo
|
|
||||||
for p in "${not_failing[@]}"; do
|
|
||||||
echo " $p"
|
|
||||||
done
|
|
||||||
echo
|
|
||||||
} >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ ${#gone[@]} -gt 0 ]]; then
|
|
||||||
{
|
|
||||||
echo "Some packages in hack/.staticcheck_failures do not exist anymore. Please remove them."
|
|
||||||
echo
|
|
||||||
for p in "${gone[@]}"; do
|
|
||||||
echo " $p"
|
|
||||||
done
|
|
||||||
echo
|
|
||||||
} >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
Loading…
Reference in New Issue
Block a user