Skip to content

Commit e4ab312

Browse files
authored
Merge pull request #5864 from pravarag/verify-documentation
Add documentation for multiple kubernetes/kubernetes/hack/verify* tests
2 parents 5560498 + 15d2ce6 commit e4ab312

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

contributors/devel/sig-testing/verify-tests.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,3 +105,61 @@ Finally the script checks that all external group versions
105105
(e.g. `foobar/v1`) are defined in `hack/lib/init.sh` in either the
106106
`KUBE_AVAILABLE_GROUP_VERSIONS` or `KUBE_NONSERVER_GROUP_VERSIONS`
107107
bash variables.
108+
109+
### `verify-bazel`
110+
111+
This verify-bazel script validates the removal of bazel related
112+
files. The script ensures no bazel related temporary, intermediate or
113+
output files remain as part of
114+
[KEP-2420](https://github.com/kubernetes/enhancements/issues/2420).
115+
116+
## `verify-boilerplate`
117+
118+
This script checks for the license headers for all the files, whether
119+
the header is correct or wrong. The purpose of boilerplate headers is
120+
to identify license headers. The script collects all the file names
121+
generated by `hack/boilerplate/boilerplate.py` script and stores them
122+
into a list called `files_need_boilerplate`.
123+
124+
Once we collect all the file names, we run a check to identify the
125+
files with wrong header. This check will only run if the file exists
126+
in the list mentioned above.
127+
128+
129+
## `verify-cli-conventions`
130+
131+
This script checks whether the description format of `help` message of
132+
kubectl command is valid or not. This check is done for all the
133+
`kubectl` sub-commands as well. The script first checks whether the go
134+
command is available or not in the ${PATH}. And then the binary
135+
`cmd/clicheck` is checked if it exists or not in the well-known output
136+
locations. It runs command checks on all the kubectl commands or subcommands like,
137+
138+
```bash
139+
kubectl version
140+
kubectl uncordon
141+
kubectl wait
142+
kubectl top node
143+
```
144+
145+
And if the output looks good i.e. CLI follows all tested conventions
146+
the test passes.
147+
148+
149+
## `verify-codegen`
150+
151+
This script verifies if the code update is needed or not for specific
152+
sub-projects. It first verifies the correct Go version and creates Go
153+
path. The script checks for the updated code for below subprojects,
154+
155+
```bash
156+
k8s.io/code-generator
157+
k8s.io/kube-aggregator
158+
k8s.io/sample-apiserver
159+
k8s.io/sample-controller
160+
k8s.io/apiextensions-apiserver
161+
k8s.io/metrics
162+
```
163+
164+
Once it completes checking for code updates, later the script calls
165+
`update-codegen.sh` scripts.

0 commit comments

Comments
 (0)