Add testing instructions to README.rst

This commit is contained in:
Tim Buckley 2015-08-03 15:33:51 -06:00
parent 7c3d0b3d9e
commit 36473acceb

View File

@ -78,3 +78,32 @@ StackViz:
:code:`/opt/stack/tempest/`
* DevStack: *TODO*
* Dstat: *TODO*
Testing
=======
Server (Python)
---------------
Server-side tests can be run using Tox::
tox
A linter (flake8) will be run automatically and its output included in the
report.
Client (JavaScript)
-------------------
Client-side tests are run via `Karma <http://karma-runner.github.io/>`_.
To run, install the :code:`karma-cli` and the npm dependencies::
npm install
sudo npm install --global karma-cli
Then, run Karma::
karma start --single-run
Tests will be executed using `PhantomJS <http://phantomjs.org/>`_ by default.
Similarly, `ESLint <http://eslint.org/>`_ can be used to verify formatting::
eslint stackviz/static/