workbench: Document integration test dependencies.

This adds appropriate notes to the installation guide, and suggestions
to application.yml.example.

diff --git a/apps/workbench/config/application.yml.example b/apps/workbench/config/application.yml.example
index 395f1a94bd470e540b4c69fcb4c32c97896a6526..5db52ed92519830b27d641ea40c31cf499d21281 100644 (file)
--- a/apps/workbench/config/application.yml.example
+++ b/apps/workbench/config/application.yml.example
@@ -18,3 +18,11 @@ common:
   arvados_login_base: https://arvados.local:3000/login
   arvados_v1_base: https://arvados.local:3000/arvados/v1
   arvados_insecure_https: true
+
+test:
+  # When you run the Workbench's integration tests, it starts the API server
+  # as a dependency.  These settings should match the API server's Rails
+  # defaults.  If you adjust those, change these settings to match.
+  arvados_login_base: https://localhost:3001/login
+  arvados_v1_base: https://localhost:3001/arvados/v1
+  arvados_insecure_https: true

diff --git a/doc/install/install-workbench-app.html.textile.liquid b/doc/install/install-workbench-app.html.textile.liquid
index 73fbd15c944878436c098b350da97808447da4cc..9c1e56067fdd8e4fb6d6d0f83def83e43d47208c 100644 (file)
--- a/doc/install/install-workbench-app.html.textile.liquid
+++ b/doc/install/install-workbench-app.html.textile.liquid
@@ -51,4 +51,8 @@ irb(main):002:0&gt; <span class="userinput">ApiClient.find(1234).update_attribut
 </code></pre>
 </notextile>
 
+h2. Running tests
 
+The Workbench application includes a series of integration tests.  When you run these, it starts the API server in a test environment, with all of its fixtures loaded, then tests Workbench by starting that server and making requests against it.
+
+In addition to bundled gems, running the integration tests requires "PhantomJS":http://phantomjs.org/download.html to test JavaScript elements.  The simplest way to get started is to download one of the binary builds provided, and install the executable into one of the directories in your @$PATH@.
\ No newline at end of file