From 95e59f8e8c427bf199445a75102f1dfaeb4bf8a6 Mon Sep 17 00:00:00 2001 From: Brett Smith Date: Wed, 19 Mar 2014 14:50:21 -0400 Subject: [PATCH] workbench: Document integration test dependencies. This adds appropriate notes to the installation guide, and suggestions to application.yml.example. --- apps/workbench/config/application.yml.example | 8 ++++++++ doc/install/install-workbench-app.html.textile.liquid | 4 ++++ 2 files changed, 12 insertions(+) diff --git a/apps/workbench/config/application.yml.example b/apps/workbench/config/application.yml.example index 395f1a94bd..5db52ed925 100644 --- 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 73fbd15c94..9c1e56067f 100644 --- 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> ApiClient.find(1234).update_attribut +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 -- 2.30.2