Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/guides/contributing/unit_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,35 @@ expected to validate the behavior of every part of OCIO:
* Any change to existing functionality should have tests added if they don't
already exist.

The test should should be run, via ``ctest``, before submitting a pull request.
The test should be run, via ``ctest``, before submitting a pull request.
Pull requests will not be merged until tests are present, running and passing
as part of the OpenColorIO CI system.

For verbose test output (listing each test and result status), run::

ctest -V

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The word "should" appears twice on line 22, please correct that too.

You can also run single test categories or individual tests. To view a list of
availble tests, run::

ctest -N

You can run specific groups of tests by name using the ``-R`` (match by regex)
option, for example::

ctest -V -R test_cpu
ctest -V -R test_gpu
ctest -V -R test_python

You can also run individual test directly using ``--run_only``, for example to
run only the CPU unit tests from the Builtins suite::

tests/cpu/test_cpu_exec --run_only Builtins

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the following:

Additional options for the CPU tests, such as --stop_on_error are described using the --help option:

tests/cpu/test_cpu_exec --help

You can view additional options for the CPU tests, such as `--stop_on_error`, by using the --help otion::

tests/cpu/test_cpu_exec --help

Test framework
==============

Expand Down