Documentation for writing functional tests and unit tests

[karlcow]

The issue #395 made me think, that we lack documentation for:

• writing functional tests
• writing unit tests
• run tests before committing code

The only thing we have now is in CONTRIBUTING.md
https://github.com/webcompat/webcompat.com/blob/master/CONTRIBUTING.md#running-tests

which is a bit dry.

You can run tests from the project root with the nosetests command.

For example, right now we get:

→ nosetests
....F...
======================================================================
FAIL: Test that the /issues route 307s to /index (for now).
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/karl/code/webcompat.com/tests/test_urls.py", line 79, in test_issues_redirect
    self.assertEqual(rv.status_code, 307)
AssertionError: 200 != 307

----------------------------------------------------------------------
Ran 8 tests in 0.808s

FAILED (failures=1)

[miketaylr]

Just a note I sent a PR fixing that failing test last night.

[miketaylr]

Dumping a few notes.

The python unit tests are vanilla flavored https://docs.python.org/2/library/unittest.html tests. nose is smart enough to pick up unit tests without having to register them anywhere, which is cool.

Functional tests are run using http://theintern.io/, a NodeJS Selenium client. We use http://chaijs.com/api/assert/ assertions and the https://theintern.github.io/leadfoot/ library to "drive" selenium.