8288c06b2b
Now that they all call setup_env, we don't need find-binary (I think). That was originally meant to hide the diff between docker and local builds but all these tools do local builds anyway.
103 lines
3.3 KiB
Bash
Executable File
103 lines
3.3 KiB
Bash
Executable File
#!/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 checks API-related files for missing descriptions and outputs a
|
|
# list of structs and fields that are missing descriptions.
|
|
# Usage: `hack/verify-description.sh`.
|
|
|
|
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::setup_env
|
|
|
|
GOPROXY=off go install ./cmd/genswaggertypedocs
|
|
|
|
find_files() {
|
|
find . -not \( \
|
|
\( \
|
|
-wholename '.git' \
|
|
-o -wholename './_output' \
|
|
-o -wholename './release' \
|
|
-o -wholename './target' \
|
|
-o -wholename '*/third_party/*' \
|
|
-o -wholename '*/vendor/*' \
|
|
-o -wholename './pkg/*' \
|
|
\) -prune \
|
|
\) \
|
|
\( -wholename './staging/src/k8s.io/api/*/v*/types.go' \
|
|
-o -wholename './staging/src/k8s.io/kube-aggregator/pkg/apis/*/v*/types.go' \
|
|
-o -wholename './staging/src/k8s.io/apiextensions-apiserver/pkg/apis/*/v*/types.go' \
|
|
\)
|
|
}
|
|
|
|
if [[ $# -eq 0 ]]; then
|
|
versioned_api_files=$(find_files) || true
|
|
else
|
|
versioned_api_files="${*}"
|
|
fi
|
|
|
|
# find_files had incorrect regexes which led to genswaggertypedocs never being invoked.
|
|
# This led to many types.go have missing descriptions.
|
|
# These types.go files are listed in hack/.descriptions_failures
|
|
# Check that the file is in alphabetical order
|
|
failure_file="${KUBE_ROOT}/hack/.descriptions_failures"
|
|
kube::util::check-file-in-alphabetical-order "${failure_file}"
|
|
|
|
failing_files=()
|
|
while IFS='' read -r line; do failing_files+=("$line"); done < <(cat "$failure_file")
|
|
|
|
result=0
|
|
for file in $versioned_api_files; do
|
|
if ! kube::util::array_contains "$file" "${failing_files[@]}"; then
|
|
gen_swagger_result=0
|
|
genswaggertypedocs -v -s "${file}" -f - || gen_swagger_result=$?
|
|
if [[ "${gen_swagger_result}" -ne 0 ]]; then
|
|
echo "API file: ${file} is missing: ${gen_swagger_result} descriptions"
|
|
result=1
|
|
fi
|
|
fi
|
|
|
|
if grep json: "${file}" | grep -v // | grep description: ; then
|
|
echo "API file: ${file} should not contain descriptions in struct tags"
|
|
result=1
|
|
fi
|
|
if grep json: "${file}" | grep -Ee ",[[:space:]]+omitempty|omitempty[[:space:]]+" ; then
|
|
echo "API file: ${file} should not contain leading or trailing spaces for omitempty directive"
|
|
result=1
|
|
fi
|
|
done
|
|
|
|
internal_types_files="${KUBE_ROOT}/pkg/apis/core/types.go ${KUBE_ROOT}/pkg/apis/extensions/types.go"
|
|
for internal_types_file in $internal_types_files; do
|
|
if [[ ! -e $internal_types_file ]]; then
|
|
echo "Internal types file ${internal_types_file} does not exist"
|
|
result=1
|
|
continue
|
|
fi
|
|
|
|
if grep json: "${internal_types_file}" | grep -v // | grep description: ; then
|
|
echo "Internal API types should not contain descriptions"
|
|
result=1
|
|
fi
|
|
done
|
|
|
|
exit ${result}
|