From b942859fcf55a06d0e78387c06267c169b44b206 Mon Sep 17 00:00:00 2001
From: "mccasland, trevor (tm2086)" <tm2086@att.com>
Date: Thu, 9 Aug 2018 13:47:40 -0500
Subject: [PATCH] update test section about requiring chromium

when running npm test and npm run unit without the chromium-browser
package installed, the tests fail to run[1]. This commit aims to make
the requirement for this package clear to testers.

[1] http://paste.openstack.org/show/727761/
Change-Id: I5685af1160321378829df27f31c0da1724d263ab
---
 README.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.rst b/README.rst
index f7ad69ff..27ba7b73 100644
--- a/README.rst
+++ b/README.rst
@@ -226,6 +226,21 @@ To test python code, run::
 Frontend
 --------
 
+The frontend tests ``npm test`` and ``npm run unit`` use a headless chrome
+driver and the driver requires the chromium-browser package to be installed on
+the system, you can do this by running::
+
+    $ sudo apt-get install chromium-browser
+
+.. note::
+    When using an operating system that is not ubuntu 16.04 the
+    process.env.CHROME_BIN variable may need to be updated in
+    openstack-health/test/karma.conf.js to reflect your system's chromium
+    path.
+
+    For example on SUSE Leap OS, process.env.CHROME_BIN = '/usr/bin/chromium'
+    must be set.
+
 To test javascript code, run::
 
     $ npm test