OpenColorIO icon indicating copy to clipboard operation
OpenColorIO copied to clipboard

Improve documentation for running unit tests

Open doug-walker opened this issue 2 years ago • 4 comments

The documentation on Contributing has some basic information about running the unit tests. However, it would be helpful to extend that to cover situations such as:

  • Running individual tests rather than all tests
  • Running only the CPU, GPU, or Python tests rather than all tests

For example, this will run only the CPU unit tests from the Builtins suite: tests/cpu/test_cpu_exec --run_only Builtins

And this will run just Python test: python3 ../tests/python/OpenColorIOTestSuite.py $PWD

doug-walker avatar Sep 22 '23 02:09 doug-walker

Can I take this?

JaydenShel avatar Feb 10 '24 00:02 JaydenShel

To just run one category of unit test, it might be simpler to stick with ctest:

# Get the list of tests
ctest -N
# Run individual tests examples
ctest -V -R test_cpu
ctest -V -R test_gpu
ctest -V -R test_python

But to reach individual tests within a group, I think we have to use our executable directly with --run_only like Doug showed.

remia avatar Feb 18 '24 11:02 remia

Hello, I'm interested in working on this issue for ASWF dev days.

drewavisautodesk avatar May 14 '25 17:05 drewavisautodesk

Great @drewavisautodesk - assigning it to you :) let us know if you have questions!

carolalynn avatar May 14 '25 17:05 carolalynn