From 62e9a76b63a8cb56d04e77a8b5ef963d25ceacd9 Mon Sep 17 00:00:00 2001 From: Solomon Hykes Date: Fri, 25 Apr 2014 13:21:28 -0700 Subject: [PATCH] Freeze ./integration and explain where to contribute new tests Docker-DCO-1.1-Signed-off-by: Solomon Hykes (github: shykes) Upstream-commit: e83fc70d362bf0035811bbcc5566020c6cc9893f Component: engine --- components/engine/integration/MAINTAINERS | 4 ++++ components/engine/integration/README.md | 23 +++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 components/engine/integration/MAINTAINERS create mode 100644 components/engine/integration/README.md diff --git a/components/engine/integration/MAINTAINERS b/components/engine/integration/MAINTAINERS new file mode 100644 index 0000000000..2d47d7a711 --- /dev/null +++ b/components/engine/integration/MAINTAINERS @@ -0,0 +1,4 @@ +Solomon Hykes +# WE ARE LOOKING FOR VOLUNTEERS TO HELP CLEAN THIS UP. +# TO VOLUNTEER PLEASE OPEN A PULL REQUEST ADDING YOURSELF TO THIS FILE. +# WE WILL HELP YOU GET STARTED. THANKS! diff --git a/components/engine/integration/README.md b/components/engine/integration/README.md new file mode 100644 index 0000000000..41f43a4ba7 --- /dev/null +++ b/components/engine/integration/README.md @@ -0,0 +1,23 @@ +## Legacy integration tests + +`./integration` contains Docker's legacy integration tests. +It is DEPRECATED and will eventually be removed. + +### If you are a *CONTRIBUTOR* and want to add a test: + +* Consider mocking out side effects and contributing a *unit test* in the subsystem +you're modifying. For example, the remote API has unit tests in `./api/server/server_unit_tests.go`. +The events subsystem has unit tests in `./events/events_test.go`. And so on. + +* For end-to-end integration tests, please contribute to `./integration-cli`. + + +### If you are a *MAINTAINER* + +Please don't allow patches adding new tests to `./integration`. + +### If you are *LOOKING FOR A WAY TO HELP* + +Please consider porting tests away from `./integration` and into either unit tests or CLI tests. + +Any help will be greatly appreciated!