Skip to content

Commit

Permalink
Extend Test Plan section in the KEP template
Browse files Browse the repository at this point in the history
  • Loading branch information
wojtek-t committed Apr 15, 2022
1 parent d2ac6fe commit 53b44a1
Showing 1 changed file with 55 additions and 8 deletions.
63 changes: 55 additions & 8 deletions keps/NNNN-kep-template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ tags, and then generate with `hack/update-toc.sh`.
- [Risks and Mitigations](#risks-and-mitigations)
- [Design Details](#design-details)
- [Test Plan](#test-plan)
- [Unit tests](#unit-tests)
- [Integration tests](#integration-tests)
- [e2e tests](#e2e-tests)
- [Graduation Criteria](#graduation-criteria)
- [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy)
- [Version Skew Strategy](#version-skew-strategy)
Expand Down Expand Up @@ -254,14 +257,7 @@ proposal will be implemented, this is the place to discuss them.

<!--
**Note:** *Not required until targeted at a release.*
Consider the following in developing a test plan for this enhancement:
- Will there be e2e and integration tests, in addition to unit tests?
- How will it be tested in isolation vs with other components?
No need to outline all of the test cases, just the general strategy. Anything
that would count as tricky in the implementation, and anything particularly
challenging to test, should be called out.
The goal is to ensure that we don't accept enhancements with inadequate testing.
All code is expected to have adequate tests (eventually with coverage
expectations). Please adhere to the [Kubernetes testing guidelines][testing-guidelines]
Expand All @@ -270,6 +266,57 @@ when drafting this test plan.
[testing-guidelines]: https://git.k8s.io/community/contributors/devel/sig-testing/testing.md
-->

[ ] I/we understand the owners of the involved components may require updating
existing tests to make this code solid enough prior committing changes necessary
to implement this enhancement.

<!--
Based on reviewers feedback describe what additional tests need to be
added prior implementing this enhancement to ensure the enhancements
have also solid foundations.
-->

##### Unit tests

<!--
In principle every added code should be unit tested.
However, the exact tests are hard to answer ahead of implementation.
As a result, this section should only be filled when targeting Beta
to ensure that something wasn't missed during Alpha implementation.
Talking about individual tests would be an overkill, so we just require
to list the packages that were touched during the implementation together
with their current test coverage in the form:
- <package>: <current test coverage>
The data can be easily read from:
https://testgrid.k8s.io/sig-testing-canaries#ci-kubernetes-coverage-unit
--->

- <package>: <test coverage>

##### Integration tests

<!--
This question should be filled when targeting a release.
For Alpha, describe what tests will be added to ensure proper quality of the enhancement.
For Beta and GA, add links to added tests together with links to k8s-triage
for those tests: https://storage.googleapis.com/k8s-triage/index.html
-->

##### e2e tests

<!--
This question should be filled when targeting a release.
For Alpha, describe what tests will be added to ensure proper quality of the enhancement.
For Beta and GA, add links to added tests together with links to k8s-triage
for those tests: https://storage.googleapis.com/k8s-triage/index.html
We expect no non-infra related flakes in the last month as a GA graduation criteria.
-->

### Graduation Criteria

<!--
Expand Down

0 comments on commit 53b44a1

Please sign in to comment.