kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5864 from pravarag/verify-documentation 

Add documentation for multiple kubernetes/kubernetes/hack/verify* tests
This commit is contained in:
Kubernetes Prow Robot 2021-10-05 09:23:18 -07:00 committed by GitHub
parent 556049876c 15d2ce6938
commit e4ab312788
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 58 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
contributors/devel/sig-testing/verify-tests.md
View File

@ -105,3 +105,61 @@ Finally the script checks that all external group versions
(e.g. `foobar/v1`) are defined in `hack/lib/init.sh` in either the
`KUBE_AVAILABLE_GROUP_VERSIONS` or `KUBE_NONSERVER_GROUP_VERSIONS`
bash variables.
### `verify-bazel`
This verify-bazel script validates the removal of bazel related
files. The script ensures no bazel related temporary, intermediate or
output files remain as part of
[KEP-2420](https://github.com/kubernetes/enhancements/issues/2420).
## `verify-boilerplate`
This script checks for the license headers for all the files, whether
the header is correct or wrong. The purpose of boilerplate headers is
to identify license headers. The script collects all the file names
generated by `hack/boilerplate/boilerplate.py` script and stores them
into a list called `files_need_boilerplate`.
Once we collect all the file names, we run a check to identify the
files with wrong header. This check will only run if the file exists
in the list mentioned above.
## `verify-cli-conventions`
This script checks whether the description format of `help` message of
kubectl command is valid or not. This check is done for all the
`kubectl` sub-commands as well. The script first checks whether the go
command is available or not in the ${PATH}. And then the binary
`cmd/clicheck` is checked if it exists or not in the well-known output
locations. It runs command checks on all the kubectl commands or subcommands like,
```bash
kubectl version
kubectl uncordon
kubectl wait
kubectl top node
```
And if the output looks good i.e. CLI follows all tested conventions
the test passes.
## `verify-codegen`
This script verifies if the code update is needed or not for specific
sub-projects. It first verifies the correct Go version and creates Go
path. The script checks for the updated code for below subprojects,
```bash
k8s.io/code-generator
k8s.io/kube-aggregator
k8s.io/sample-apiserver
k8s.io/sample-controller
k8s.io/apiextensions-apiserver
k8s.io/metrics
```
Once it completes checking for code updates, later the script calls
`update-codegen.sh` scripts.