Freeze ./integration and explain where to contribute new tests

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
This commit is contained in:
Solomon Hykes 2014-04-25 13:21:28 -07:00
parent 40882cc0b6
commit e83fc70d36
2 changed files with 27 additions and 0 deletions

4
integration/MAINTAINERS Normal file
View file

@ -0,0 +1,4 @@
Solomon Hykes <s@docker.com>
# 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!

23
integration/README.md Normal file
View file

@ -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!