Installing QA Results Dashboard

The AMP Dashboard allows users to see the results of tests that have been run. It provides a high-level overview of the test results and allows user to drill-down to view the details. It provides visibility of results over time and across differing locations (e.g. clouds).

You only need to follow these instructions if you want to manually install the QA Framework Results Dashboard.

If you previously followed the steps in Deploying the QA Framework, then your dashboard is already installed and configured. It is accessible at http://<server host>:8080/, you can log in with the default credentials of:

username: C0uchdb1!
password: Cl0udsoftamp1!

Requirements

The Cloudsoft QA Results Dashboard requires the following:

Access to a CouchDB database which will be populated with test results from a Cloudsoft Test Scheduler.
- Write access is required to configure the database during Dashboard install
- Read access is required when running the Dashboard
Java 8

Install the Cloudsoft Results Dashboard

Extract the release archive and cd into the new directory:

tar zxf qa-dashboard-1.0-SNAPSHOT-dist
cd qa-dashboard-1.0-SNAPSHOT

Configure CouchDB

The CouchDB database must have Dashboard views added using the provided setup script and design doc JSON, for example

bin/configure_couchdb.sh -u adminuser \
                         -h my-couchdb-host.domain.com \
                         -p 5984 \
                         -n qa-scheduler\
                         -f conf/dashboard_views_designdoc.json

Create read-only CouchDB user

The results dashboard recommends using a read-only CouchDB user to run and connect to the dashboard, a simple script is provided to create such a user, for example to create the user myreadonlyusername for the qa-scheduler database (you will be prompted for both the admin users password and also asked to enter a password for the new user)

bin/create_readonly_user.sh -u adminuser \
                            -h my-couchdb-host.domain.com \
                            -p 5984 \
                            -n qa-scheduler\
                            -a myreadonlyusername

Configuring the Dashboard Server

Update the conf/qa-dashboard.properties file with the details of your CouchDB server (note that you can use the admin user here but a read only user as created above is preferred), for example

couchdb.server.db=qa-scheduler
couchdb.server.url=http://my-couchdb-host.domain.com:5984
couchdb.server.username=myreadonlyuser
couchdb.server.password=mypassword

If this file is configured incorrectly you will will not be able to log into the Dashboard.

Running the Dashboard

Start the Dashboard with the provided start.sh script.

bin/start.sh

The Dashboard process will continue to run in the background and is accessible at http://<server host>:8080/, you can log in with any couchdb user with access to the scheduler database.

Stopping the Dashboard

Stop the Dashboard with the provided stop.sh script.

bin/stop.sh