kitsune/docs/tests.md

title
All about testing

!!! warning

This section of documentation may be outdated.

Kitsune has a fairly comprehensive Python test suite. Changes should not break tests---only change a test if there is a good reason to change the expected behavior---and new code should come with tests.

Running the Test Suite

If you followed the steps in the installation docs <hacking_howto>{.interpreted-text role="any"}, then you should be all set setup-wise.

To run the tests, you need to do:

./manage.py test

That doesn't provide the most sensible defaults for running the tests. Here is a good command to alias to something short:

./manage.py test -s --noinput --logging-clear-handlers

The -s flag is important if you want to be able to drop into PDB from within tests.

Some other helpful flags are:

-x:

Fast fail. Exit immediately on failure. No need to run the whole test suite if you already know something is broken.

--pdb:

Drop into PDB on an uncaught exception. (These show up as E or errors in the test results, not F or failures.)

--pdb-fail:

Drop into PDB on a test failure. This usually drops you right at the assertion.

--no-skip:

All SkipTests show up as errors. This is handy when things shouldn't be skipping silently with reckless abandon.

Running a Subset of Tests

You can run part of the test suite by specifying the apps you want to run, like:

./manage.py test kitsune/wiki kitsune/search kitsune/kbforums

You can also specify modules:

./manage.py test kitsune.wiki.tests.test_views

You can specify specific tests:

./manage.py test kitsune.wiki.tests.test_views:VersionGroupTests.test_version_groups

See the output of ./manage.py test --help for more arguments.

Running tests without collecting static files

By default the test runner will run collectstatic to ensure that all the required assets have been collected to the static folder. If you do not want this default behavior you can run:

REUSE_STATIC=1 ./manage.py test

The Test Database

The test suite will create a new database named test_%s where %s is whatever value you have for settings.DATABASES['default']['NAME'].

Make sure the user has ALL on the test database as well. This is covered in the installation chapter.

When the schema changes, you may need to drop the test database. You can also run the test suite with FORCE_DB once to cause Django to drop and recreate it:

FORCE_DB=1 ./manage.py test -s --noinput --logging-clear-handlers

Writing New Tests

Code should be written so it can be tested, and then there should be tests for it.

When adding code to an app, tests should be added in that app that cover the new functionality. All apps have a tests module where tests should go. They will be discovered automatically by the test runner as long as the look like a test.

• We use "modelmakers" instead of fixtures. Models should have modelmakers defined in the tests module of the Django app. For example, forums.tests.document is the modelmaker for forums.Models.Document class.

Changing Tests

Unless the current behavior, and thus the test that verifies that behavior is correct, is demonstrably wrong, don't change tests. Tests may be refactored as long as its clear that the result is the same.

Removing Tests

On those rare, wonderful occasions when we get to remove code, we should remove the tests for it, as well.

If we liberate some functionality into a new package, the tests for that functionality should move to that package, too.

JavaScript Tests

Frontend JavaScript is currently tested with Mocha.

Running JavaScript Tests

To run tests, make sure you have have the NPM dependencies installed, and then run:

$ npm run webpack:test

Writing JavaScript Tests

Mocha tests are discovered using the pattern kitsune/*/static/*/js/tests/**/*.js. That means that any app can have a [tests]{.title-ref} directory in its JavaScript directory, and the files in there will all be considered test files. Files that don't define tests won't cause issues, so it is safe to put testing utilities in these directories as well.

Here are a few tips for writing tests:

• Any HTML required for your test should be added by the tests or a beforeEach function in that test suite. React is useful for this.
• You can use [sinon]{.title-ref} to mock out parts of libraries or functions under test. This is useful for testing AJAX.
• The tests run in a Node.js environment. A browser environment can be simulated using jsdom.