Added readme file for running the tests

Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/3ea73b28
Tree: 
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/3ea73b28
Diff: 
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/3ea73b28

Branch: refs/heads/psql-rebase
Commit: 3ea73b28ca386485a664c8810c455f77edbb6124
Parents: 3c6ccec
Author: David Neuman <david.neuma...@gmail.com>
Authored: Tue Dec 6 16:24:03 2016 -0700
Committer: Dave Neuman <neu...@apache.org>
Committed: Wed Dec 7 10:32:25 2016 -0700

----------------------------------------------------------------------
 traffic_ops/client/tests/integration/Readme.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/3ea73b28/traffic_ops/client/tests/integration/Readme.md
----------------------------------------------------------------------
diff --git a/traffic_ops/client/tests/integration/Readme.md 
b/traffic_ops/client/tests/integration/Readme.md
new file mode 100644
index 0000000..9889b47
--- /dev/null
+++ b/traffic_ops/client/tests/integration/Readme.md
@@ -0,0 +1,14 @@
+# Traffic Ops Client Integration Tests
+
+The Traffic Ops Client Integration tests are used to validate the clients 
responses against those from the Traffic Ops API.  In order to run the tests 
you will need a Traffic Ops instance with at least one of each of the 
following:  CDN, Delivery Service, Type, Cachegroup, User and Server.
+
+## Running the Integration Tests
+The integration tests are run using `go test`, however, there are some flags 
that need to be provided in order for the tests to work.  The flags are:
+
+* toURL - The URL to Traffic Ops.  Default is "http://localhost:3000";.
+* toUser - The Traffic Ops user to use.  Default is "admin".
+* toPass - The password of the user provided.  Deafault is "password".
+
+Example command to run the tests: `go test -v -toUrl=https://to.kabletown.net 
-toUser=myUser -toPass=myPass`
+
+*It can take serveral minutes for the integration tests to complete, so using 
the `-v` flag is recommended to see progress.*

Reply via email to