Document pytest usage for omeroweb

[cneves]

Running tests

New test system depends on pytest:

pip install pytest

Some optional plugins that really help out:

• pytest-cov - Coverage reporting (required for --cov* options)
• pytest-capturelog - Capture log messages

We don't use pytest-django as all that plugin does is allow for easier setting of DJANGO_SETTINGS_MODULE, which we handle on plugins/web.py thus preventing an extra dependency.

Running the tests:

bin/omero web test

The test runner assumes there's an ice.config file in ./etc/ice.config and that omeroweb apps are found in ./lib/python/omeroweb.

Optional arguments to test:

--config <path> : location of ice.config, default: ./etc/ice.config
--basepath <path> : location of base directory holding the django apps> (default: ./lib/python/omeroweb)
--testpath <path> : path for test collection relative to basepath
--string <string> : only run tests with name including string
--failfast : exit tests on first error
--verbose
--quiet
--pdb : drop to pdb on error
--cov <path>: measure coverage for path (relative to basepath), multiple allowed
--cov-report [term | term-missing | annotate | html | xml] : coverage report type, multiple allowed

Examples:

• Run tests for webgateway

  bin/omero web test --testpath webgateway
  

• Run tests in TestFileCache? class only

  bin/omero web test --string TestFileCache
  

[sbesson]

Assuming this is covered by http://www.openmicroscopy.org/site/support/omero5.2/developers/testing.html, closing.