github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-19 09:52:49 +00:00
Code Issues Projects Releases Wiki Activity

hack/verify-description.sh: correctly look for versioned API types

Browse Source 
`find_files` had incorrect regexes which led to `genswaggertypedocs`
never being invoked. This commit updates the regex to correctly
look for versioned API types.go files.

Since `genswaggertypedocs` was never invoked, there are many API types
with missing descriptions. This commit lists these `types.go` files
in `hack/.descriptions_failures`.

The `verify-description.sh` script skips running `genswaggertypedocs`
on the files listed in `hack/.descriptions_failures`.
This commit is contained in:
Nikhita Raghunath 2021-03-02 10:44:40 +05:30
parent 4eca18b6b0
commit 4b9b926e5d
2 changed files with 49 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
hack/.descriptions_failures Normal file
View File

@ -0,0 +1,25 @@
./staging/src/k8s.io/api/apiserverinternal/v1alpha1/types.go
./staging/src/k8s.io/api/apps/v1/types.go
./staging/src/k8s.io/api/apps/v1beta1/types.go
./staging/src/k8s.io/api/apps/v1beta2/types.go
./staging/src/k8s.io/api/authentication/v1/types.go
./staging/src/k8s.io/api/authentication/v1beta1/types.go
./staging/src/k8s.io/api/authorization/v1/types.go
./staging/src/k8s.io/api/authorization/v1beta1/types.go
./staging/src/k8s.io/api/autoscaling/v2beta2/types.go
./staging/src/k8s.io/api/certificates/v1/types.go
./staging/src/k8s.io/api/certificates/v1beta1/types.go
./staging/src/k8s.io/api/core/v1/types.go
./staging/src/k8s.io/api/events/v1/types.go
./staging/src/k8s.io/api/events/v1beta1/types.go
./staging/src/k8s.io/api/extensions/v1beta1/types.go
./staging/src/k8s.io/api/flowcontrol/v1alpha1/types.go
./staging/src/k8s.io/api/flowcontrol/v1beta1/types.go
./staging/src/k8s.io/api/imagepolicy/v1alpha1/types.go
./staging/src/k8s.io/api/networking/v1/types.go
./staging/src/k8s.io/api/networking/v1beta1/types.go
./staging/src/k8s.io/api/policy/v1beta1/types.go
./staging/src/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1/types.go
./staging/src/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1/types.go
./staging/src/k8s.io/kube-aggregator/pkg/apis/apiregistration/v1/types.go
./staging/src/k8s.io/kube-aggregator/pkg/apis/apiregistration/v1beta1/types.go

32
hack/verify-description.sh
View File

@ -24,6 +24,7 @@ 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
@ -32,7 +33,6 @@ make -C "${KUBE_ROOT}" WHAT=cmd/genswaggertypedocs
# Find binary
genswaggertypedocs=$(kube::util::find-binary "genswaggertypedocs")
gen_swagger_result=0
result=0
find_files() {
@ -45,25 +45,41 @@ find_files() {
-o -wholename './target' \
-o -wholename '*/third_party/*' \
-o -wholename '*/vendor/*' \
-o -wholename './pkg/*' \
\) -prune \
\) \
\( -wholename '*pkg/apis/*/v*/types.go' \
-o -wholename '*pkg/api/unversioned/types.go' \
\( -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 | grep -E "pkg/.[^/]*/((v.[^/]*)|unversioned)/types\.go") || true
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")
for file in $versioned_api_files; do
$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
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