x/tuskar-ui
Code Issues Proposed changes
db3d7cd35c
tuskar-ui/HACKING.rst
Peter Belanyi 51673a0dfc Add jshint for javascript linting 
Added nodeenv as a test requirement.

Added a jshint environment to tox.ini, which installs node.js into the
python virtual environment with nodeenv, installs jshint using npm,
and calls runtest.sh to run the tests.

runtest.sh now supports the -j|--jshint flags to run jshint on the
javascript files. jshint must be installed before running runtest.sh

The documentation also got updated to include some info about testing.

Change-Id: I3e7dcea481806eddc10625fe353ac9092b30573a
Partial-Bug: #1282961
2014-05-29 14:03:59 +02:00

2.2 KiB
Raw Blame History

Contributing

The code repository is located at OpenStack. Please go there if you want to check it out:

git clone https://github.com/openstack/tuskar-ui.git

The list of bugs and blueprints is on Launchpad:

https://launchpad.net/tuskar-ui

We use OpenStack's Gerrit for the code contributions:

https://review.openstack.org/#/q/status:open+project:openstack/tuskar-ui,n,z

and we follow the OpenStack Gerrit Workflow.

If you're interested in the code, here are some key places to start:

Running tests

There are several ways to run tests for tuskar-ui.

Using tox:

This is the easiest way to run tests. When run, tox installs dependencies, prepares the virtual python environment, then runs test commands. The gate tests in gerrit usually also use tox to run tests. For avaliable tox environments, see tox.ini.

By running run_tests.sh:

Tests can also be run using the run_tests.sh script, to see available options, run it with the --help option. It handles preparing the virtual environment and executing tests, but in contrast with tox, it does not install all dependencies, e.g. jshint must be installed before running the jshint testcase.

Manual tests:

To manually check tuskar-ui, it is possible to run a development server for tuskar-ui by running run_tests.sh --runserver.

To run the server with the settings used by the test environment: run_tests.sh --runserver 0.0.0.0:8000 --settings=tuskar_ui.test.settings

OpenStack Style Commandments