Skip to content

Commit 468fa66

Browse files
committed
improve sig-node e2e-node testing documentation
- Allow people to help themselves, by showing PRINT_HELP - More explicit demonstration of the FOCUS and SKIP arguments, as used by CI environment. - update command comment for rerunning tests - point out ProwJob types and the image configurations used for testing
1 parent 9dfb475 commit 468fa66

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

contributors/devel/sig-node/e2e-node-tests.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ This will: run the *ginkgo* binary against the subdirectory *test/e2e_node*, whi
4040
- Output the test results to STDOUT
4141
- Stop *kubelet*, *kube-apiserver*, and *etcd*
4242

43+
To view the settings and print help, run:
44+
45+
```sh
46+
make test-e2e-node PRINT_HELP=y
47+
```
48+
4349
## Remotely
4450

4551
Why Run tests *Remotely*? Tests will be run in a customized pristine environment. Closely mimics what will be done
@@ -84,7 +90,7 @@ provisioning a new one. To delete the GCE instance after each test see
8490
*[DELETE_INSTANCE](#delete-instance-after-tests-run)*.**
8591

8692

87-
# Additional Remote Options
93+
## Additional Remote Options
8894

8995
## Run tests using different images
9096

@@ -189,6 +195,13 @@ To run tests NOT matching a regex:
189195
make test-e2e-node REMOTE=true SKIP="<regex-to-match>"
190196
```
191197

198+
These are often configured in the CI environment.
199+
For example, the [`ci-kubernetes-node-kubelet`](https://github.com/kubernetes/test-infra/blob/05eeaff67cc936181c18a63fdc9d5847c55ef258/config/jobs/kubernetes/sig-node/node-kubelet.yaml#L31) uses `--focus="\[NodeConformance\]" --skip="\[Flaky\]|\[Serial\]"`, this can be specified to the make target as:
200+
201+
```sh
202+
make test-e2e-node REMOTE=true FOCUS="\[NodeConformance\]" SKIP="\[Flaky\]|\[Serial\]"
203+
```
204+
192205
## Run tests continually until they fail
193206

194207
This is useful if you are trying to debug a flaky test failure. This will cause ginkgo to continually
@@ -243,15 +256,24 @@ make test_e2e_node TEST_ARGS="--cgroups-per-qos=true"
243256

244257
# Notes on tests run by the Kubernetes project during pre-, post- submit.
245258

246-
The node e2e tests are run by the PR builder for each Pull Request and the results published at
247-
the bottom of the comments section. To re-run just the node e2e tests from the PR builder add the comment
248-
`@k8s-bot node e2e test this issue: #<Flake-Issue-Number or IGNORE>` and **include a link to the test
259+
The node e2e tests are run by the [Prow](https://prow.k8s.io/) for each Pull Request and the results published
260+
in the status checks box at
261+
the bottom of the Pull Request below all comments. To have prow re-run the node e2e tests against a PR add the comment
262+
`/test pull-kubernetes-node-e2e` and **include a link to the test
249263
failure logs if caused by a flake.**
264+
Note that [commands to prow](https://prow.k8s.io/command-help#test) must be on separate lines from any commentary.
265+
266+
For example,
250267

251-
The PR builder runs tests against the images listed in [jenkins-pull.properties](https://git.k8s.io/kubernetes/test/e2e_node/jenkins/jenkins-pull.properties)
268+
/test pull-kubernetes-node-e2e
269+
flake due to #12345
252270

253-
The post submit tests run against the images listed in [jenkins-ci.properties](https://git.k8s.io/kubernetes/test/e2e_node/jenkins/jenkins-ci.properties)
271+
The PR builder runs tests against the images listed in [image-config.yaml](https://github.com/kubernetes/test-infra/blob/master/jobs/e2e_node/image-config.yaml).
254272

273+
Other [node e2e prow jobs](https://github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes/sig-node)
274+
run against different images depending on the configuration chosen in the
275+
[test-infra repo](https://github.com/kubernetes/test-infra/tree/master/jobs/e2e_node).
276+
The source code for these tests comes from the [kubernetes/kubernetes repo](https://github.com/kubernetes/kubernetes/tree/master/test/e2e_node).
255277

256278
# Notes on the Topology Manager tests
257279

0 commit comments

Comments
 (0)