Add instructions for running the integration tests.

rsamin · Mar 2, 2015 · c1f572f · c1f572f
1 parent 14d142b
commit c1f572f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/build.md b/docs/build.md
@@ -25,3 +25,5 @@ or run only unit tests:
 ```
 $ godep go test github.com/google/cadvisor/... -test.short
 ```
+
+For integration tests, see the [integration testing](integration_testing.md) page.
diff --git a/docs/integration_testing.md b/docs/integration_testing.md
@@ -0,0 +1,17 @@
+# Integration Testing cAdvisor
+
+The cAdvisor integration tests can be found in `integration/tests`. These run queries on a running cAdvisor. To run these tests:
+
+```
+$ godep go run integration/runner/runner.go -host=HOST -port=PORT
+```
+
+this will build a cAdvisor from the current repository and start it on the target machine before running the tests. Note that `HOST` and `PORT` default to `localhost` and `8080` respectively.
+
+To simply run the tests against an existing cAdvisor:
+
+```
+$ godep go test github.com/google/cadvisor/integration/tests/... -host=HOST -port=PORT
+```
+
+Today We only support remote execution in Google Compute Engine since that is where we run our continuous builds.
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,3 +25,5 @@ or run only unit tests: @@
     ```
     $ godep go test github.com/google/cadvisor/... -test.short
     ```
+    For integration tests, see the [integration testing](integration_testing.md) page.