Skip to content

Commit f8851a6

Browse files
committed
KEP template: enhance suggestions for integration and e2e tests
The template gives the impression that both integration and e2e tests must be written. Let's be a bit more flexible and document that feature owners can opt out of that if it makes sense. Linking to the triage tool is not sufficient. We want an empty result there, but that could also have been caused by not running the tests at all. A link to the periodic job which included the tests is more important. To ensure more consistency, the suggested bullet list gets extended to be more realistic. Otherwise feature owners have to guess how they are meant to fill in the placeholders.
1 parent f431a1a commit f8851a6

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

keps/NNNN-kep-template/README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -308,31 +308,41 @@ Integration tests are contained in k8s.io/kubernetes/test/integration.
308308
Integration tests allow control of the configuration parameters used to start the binaries under test.
309309
This is different from e2e tests which do not allow configuration of parameters.
310310
Doing this allows testing non-default options and multiple different and potentially conflicting command line options.
311+
If integration tests are not necessary or useful, explain why.
311312
-->
312313

313314
<!--
314315
This question should be filled when targeting a release.
315316
For Alpha, describe what tests will be added to ensure proper quality of the enhancement.
316317
317-
For Beta and GA, add links to added tests together with links to k8s-triage for those tests:
318-
https://storage.googleapis.com/k8s-triage/index.html
318+
For Beta and GA, document that tests have been written,
319+
have been executed regularly, and have been stable.
320+
This can be done with:
321+
- permalinks to the GitHub source code
322+
- links to the periodic job (typically https://testgrid.k8s.io/sig-release-master-blocking#integration-master), filtered by the test name
323+
- a search in the Kubernetes bug triage tool (https://storage.googleapis.com/k8s-triage/index.html)
319324
-->
320325

321-
- <test>: <link to test coverage>
326+
- [test name](https://github.com/kubernetes/kubernetes/blob/2334b8469e1983c525c0c6382125710093a25883/test/integration/...): [integration master](https://testgrid.k8s.io/sig-release-master-blocking#integration-master?include-filter-by-regex=MyCoolFeature), [triage search](https://storage.googleapis.com/k8s-triage/index.html?test=MyCoolFeature)
322327

323328
##### e2e tests
324329

325330
<!--
326331
This question should be filled when targeting a release.
327332
For Alpha, describe what tests will be added to ensure proper quality of the enhancement.
328333
329-
For Beta and GA, add links to added tests together with links to k8s-triage for those tests:
330-
https://storage.googleapis.com/k8s-triage/index.html
334+
For Beta and GA, document that tests have been written,
335+
have been executed regularly, and have been stable.
336+
This can be done with:
337+
- permalinks to the GitHub source code
338+
- links to the periodic job (typically a job owned by the SIG responsible for the feature), filtered by the test name
339+
- a search in the Kubernetes bug triage tool (https://storage.googleapis.com/k8s-triage/index.html)
331340
332341
We expect no non-infra related flakes in the last month as a GA graduation criteria.
342+
If e2e tests are not necessary or useful, explain why.
333343
-->
334344

335-
- <test>: <link to test coverage>
345+
- [test name](https://github.com/kubernetes/kubernetes/blob/2334b8469e1983c525c0c6382125710093a25883/test/e2e/...): [SIG ...](https://testgrid.k8s.io/sig-...?include-filter-by-regex=MyCoolFeature), [triage search](https://storage.googleapis.com/k8s-triage/index.html?test=MyCoolFeature)
336346

337347
### Graduation Criteria
338348

0 commit comments

Comments
 (0)