From 5054ead4bc22f6ad8a8101b52ff05f41fd7e39c4 Mon Sep 17 00:00:00 2001 From: Nathan LeClaire Date: Mon, 2 Feb 2015 13:35:44 -0800 Subject: [PATCH] Document how to run unit tests in container in README Signed-off-by: Nathan LeClaire --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 0e705e15d1..2b9d4073f0 100644 --- a/README.md +++ b/README.md @@ -313,6 +313,24 @@ run: If you have any questions we're in #docker-machine on Freenode. +## Unit Tests + +To run the unit tests for the whole project, using the following script: + + $ script/test + +This will run the unit tests inside of a container, so you don't have to worry +about configuring your environment properly before doing so. + +To run the unit tests for only a specific subdirectory of the project, you can +pass an argument to that script to specify which directory, e.g.: + + $ script/test ./drivers/amazonec2 + +If you make a pull request, it is highly encouraged that you submit tests for +the code that you have added or modified in the same pull request. + + ## Integration Tests There is a suite of integration tests that will run for the drivers. In order to use these you must export the corresponding environment variables for each