There are many schools of thought when it comes to test design. When building Highcharts for Python, we decided to focus on practicality. That means:
DRY is good, KISS is better. To avoid repetition, our test suite makes extensive use of fixtures, parametrization, and decorator-driven behavior. This minimizes the number of test functions that are nearly-identical. However, there are certain elements of code that are repeated in almost all test functions, as doing so will make future readability and maintenance of the test suite easier.
Coverage matters…kind of. We have documented the primary intended behavior of every function in the Highcharts for Python library, and the most-likely failure modes that can be expected. At the time of writing, we have about 94% code coverage. Yes, yes: We know that is less than 100%. But there are edge cases which are almost impossible to bring about, based on confluences of factors in the wide world. Our goal is to test the key functionality, and as bugs are uncovered to add to the test functions as necessary.
Each individual test module (e.g.
test_chart.py) corresponds to a
conceptual grouping of functionality. For example:
tests/test_chart.pytests the contents of the
tests/options/annotations/test_annotations.pytests the contents of
If you are implementing a new class, please use the same test structure as used for the other test modules. If you are adding a new method that is specific to one class, you do not need to use this pattern. However, if it is a method that will be inherited by or used by other classes, then we ask that you implement a similar pattern to keep test maintenance as easy as possible.
$ pip install highcharts-stock[tests]
When you create a local development environment, all dependencies for running and extending the test suite are installed.
Highcharts for Python does not use any custom command-line options in its test suite.
For a full list of the CLI options, including the defaults available, try:
highcharts-stock $ cd tests/
highcharts-stock/tests/ $ pytest --help
Because Highcharts for Python has a very simple test suite, we have not
pytest.ini configuration file.
tests/ $ pytest
tests/ $ pytest tests/test_module.py
tests/ $ pytest tests/test_module.py -k 'test_my_test_function'
Because of the simplicity of Highcharts for Python, the test suite does not currently support any test skipping.
The Highcharts for Python test suite does support incremental testing using, however at the moment none of the tests designed rely on this functionality.
A variety of test functions are designed to test related functionality. As a
result, they are designed to execute incrementally. In order to execute tests
incrementally, they need to be defined as methods within a class that you decorate
@pytest.mark.incremental decorator as shown below:
This class will execute the
TestIncremental.test_function1() test, execute and
fail on the
TestIncremental.test_modification() test, and automatically fail
TestIncremental.test_modification2() because of the
To pass state between incremental tests, add a
state argument to their method
definitions. For example:
def test_function(self, state):
state.is_logged_in = True
assert state.is_logged_in = True
def test_modification1(self, state):
assert state.is_logged_in is True
state.is_logged_in = False
assert state.is_logged_in is False
def test_modification2(self, state):
assert state.is_logged_in is True
Given the example above, the third test (
test_modification2) will fail because
test_modification updated the value of
state is instantiated at the level of the entire test session (one run of
the test suite). As a result, it can be affected by tests in other test modules.