Veronica Berglyd Olsen
1c45331b0a
* Fix bug in early error reporting in main init * Update docstrings and optimise code in GuiMain * Update docstrings and optimise code in Config * Update docstrings and optimise code in common module * Update docstrings and optimise code in main project classes * Update the OptionState class * Update the spell checker class * Update the file converter classes and extend tests * Update the about, merge, split and item editor classes and extend tests * Update item editor test * Update about dialog tests * Some minor test cleanup * Fix typo and add clarification in contributing guide
novelWriter Tests
The test suite uses PyTest for testing.
Dependencies
python3-pytestfor the basic framework (required)python3-pytestqtfor Qt support (required)python3-pytest-covfor code coverage reports (optional)python3-pytest-xvfbfor headless tests (optional)
HowTo
Basic Usage
To run all tests, type:
pytest-3 -v
The -v switch enables verbose mode, with one test per line.
For a more compact view, omit this switch.
Headless
To run tests in headless mode, either use the Qt offscreen mode:
export QT_QPA_PLATFORM=offscreen
or run with xvfb:
xvfb-run pytest-3 -v
Test Coverage
To add test coverage, run the following:
pytest-3 -v --cov=novelwriter --cov-report=html
The --cov-report switch generates an html report, omit it to print a coverage summary to the
terminal. The html coverage report will be available in the htmlcov folder.
Test Markers (Categories)
To run with specific test markers, add the -m switch:
pytest-3 -v -m core
Available markers are:
basefor unit tests covering the non-gui classes of thenovelwriterfolder..corefor unit tests covering the classes in thenovelwriter/corefolder.guifor unit and integrations tests covering the classes in thenovelwriter/guifolder.
You can filter tests further with the -k switch, all the way down to a single test. You can for
instance run only dialog tests with -k testDlg or tools with -k testTool.