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

Merge pull request #4128 from ii/add-resource-usage-docs 

Add resource usage docs
This commit is contained in:
Kubernetes Prow Robot 2019-10-01 14:19:08 -07:00 committed by GitHub
parent c58280e63f 2aa77f1a77
commit 85c4df9ba3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
contributors/devel/sig-testing/writing-good-e2e-tests.md
View File

@ -229,3 +229,18 @@ Unreachable nodes are evacuated and then repopulated upon rejoining [Disruptive]
Note that opening issues for specific better tooling is welcome, and
code implementing that tooling is even more welcome :-).
### Resource usage ###
When writing tests, resources used in the tests should be chosen specifically and sanely quanified.
Therefore it is important to use resources that are:
1. appropriate to the test
2. inexpensive (containing little or no overhead)
3. create just as many an needed, no more
4. should be cleaned up at the end of the tests's run
For example:
1. only using the resource type which is appropriate to the `test/e2e/<AREA>/<SPECIFIC_AREA>`
2. the resource type `ConfigMap` is inexpensive, common, and stateless. It should be used for such things as fetching created resources
3. although the clusters used for testing are generally beefy, an overamount of resources should not be created as it is unnecessary
4. using afterEach, make sure that your test destroys any resources leftover from the test