Skip to content

Conversation

drewavisautodesk
Copy link

Adding additional information about running named tests to the "Unit Tests" section of the Contributing Guide. This is for Issue #1868 - "Improve Documentation for running unit tests".

Copy link

linux-foundation-easycla bot commented May 16, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link
Collaborator

@doug-walker doug-walker left a comment

Choose a reason for hiding this comment

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

Thanks Drew Avis!

Here are a few suggestions to improve things further.

@@ -27,6 +27,27 @@ 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.


Similarly you can run just Python tests directly::

python3 tests/python/OpenColorIOTestSuite.py
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please remove lines 47-50, it is better to just run those via ctest as described on line 40.

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

Copy link
Collaborator

@doug-walker doug-walker left a comment

Choose a reason for hiding this comment

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

Thank you, Drew!

@doug-walker
Copy link
Collaborator

doug-walker commented May 21, 2025

@drewavisautodesk , you need to sign your commits for the DCO check to pass. Usually one may do: git commit --amend -s, then re-push. But unfortunately I already merged in updates from the main branch, so you may just want to create a new PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants