Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
| 0 | 4 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,23 @@ |
| 0 |
+## Legacy integration tests |
|
| 1 |
+ |
|
| 2 |
+`./integration` contains Docker's legacy integration tests. |
|
| 3 |
+It is DEPRECATED and will eventually be removed. |
|
| 4 |
+ |
|
| 5 |
+### If you are a *CONTRIBUTOR* and want to add a test: |
|
| 6 |
+ |
|
| 7 |
+* Consider mocking out side effects and contributing a *unit test* in the subsystem |
|
| 8 |
+you're modifying. For example, the remote API has unit tests in `./api/server/server_unit_tests.go`. |
|
| 9 |
+The events subsystem has unit tests in `./events/events_test.go`. And so on. |
|
| 10 |
+ |
|
| 11 |
+* For end-to-end integration tests, please contribute to `./integration-cli`. |
|
| 12 |
+ |
|
| 13 |
+ |
|
| 14 |
+### If you are a *MAINTAINER* |
|
| 15 |
+ |
|
| 16 |
+Please don't allow patches adding new tests to `./integration`. |
|
| 17 |
+ |
|
| 18 |
+### If you are *LOOKING FOR A WAY TO HELP* |
|
| 19 |
+ |
|
| 20 |
+Please consider porting tests away from `./integration` and into either unit tests or CLI tests. |
|
| 21 |
+ |
|
| 22 |
+Any help will be greatly appreciated! |