diff options
| author | Kubernetes Submit Queue <k8s-merge-robot@users.noreply.github.com> | 2017-12-08 09:45:05 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-08 09:45:05 -0800 |
| commit | 1d05904c79f810b7dc55d23ccee3e573c47daf8b (patch) | |
| tree | 1d7baea0dad171a96c6502bf85d023b5f41160aa | |
| parent | b2357a7de7286c7008e1d41a1de2e20a069caa1e (diff) | |
| parent | 951c10e5d1baa92aa6ca823937084120af3d331c (diff) | |
Merge pull request #1468 from tpepper/contrib_guide
Automatic merge from submit-queue.
contributing guide: add initial section on testing
This commit replaces the "Improvements needed" marker for the testing
topic with an initial section of overview information and jumping off links
to sig-testing, test documentation, and test code.
Part of: https://github.com/kubernetes/community/issues/1413
Signed-off-by: Tim Pepper <tpepper@vmware.com>
| -rw-r--r-- | contributors/guide/README.md | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/contributors/guide/README.md b/contributors/guide/README.md index 97a3243c..e416a733 100644 --- a/contributors/guide/README.md +++ b/contributors/guide/README.md @@ -168,9 +168,19 @@ _Improvements needed_ ## Testing -_Improvements needed_ -* link to testing process -* walkthrough of where to find what in the tests (how to use, how to debug) +Testing is the responsibility of all contributors and is in part owned by all sigs, but is also coordinated by [sig-testing](/sig-testing). + +The main testing overview document is [here](/contributors/devel/testing.md). + +There are three types of test in kubernetes. The location of the test code varies with type, as does the specifics of the environment needed to successfully run the test: + +* Unit: These confirm that a particular function behaves as intended. Golang includes native ability for unit testing via the [testing](https://golang.org/pkg/testing/) package. Unit test source code can be found adjacent to the corresponding source code within a given package. For example: functions defined in [kubernetes/cmd/kubeadm/app/util/version.go](https://git.k8s.io/kubernetes/cmd/kubeadm/app/util/version.go) will have unit tests in [kubernetes/cmd/kubeadm/app/util/version_test.go](https://git.k8s.io/kubernetes/cmd/kubeadm/app/util/version_test.go). These are easily run locally be any developer on any OS. +* Integration: These tests cover interactions of package components or interactions between kubernetes components and some other non-kubernetes system resource (eg: etcd). An example would be testing whether a piece of code can correctly store data to or retrieve data from etcd. Integration tests are stored in [kubernetes/test/integration/](https://git.k8s.io/kubernetes/test/integration). Running these can require the developer set up additional functionality on their development system. +* End-to-end ("e2e"): These are broad tests of overall kubernetes system behavior and coherence. These are more complicated as they require a functional kubernetes cluster built from the sources to be tested. A separate document [here](/contributors/devel/e2e-tests.md) details e2e testing and test cases themselves can be found in [kubernetes/test/e2e/](https://git.k8s.io/kubernetes/test/e2e). + +Continuous integration will run these tests either as pre-submits on PRs, post-submits against master/release branches, or both. The results appear on [testgrid](https://testgrid.k8s.io). + +sig-testing is responsible for that official infrastructure and CI. The associated automation is tracked in the [test-infra repo](https://git.k8s.io/test-infra). If you're looking to run e2e tests on your own infrastructure, [kubetest](https://git.k8s.io/test-infra/kubetest) is the mechanism. ## Security |