API Reference

pytest_discover_tests(NAME ARGV)

Automatically create CTest tests for Python tests collected with Pytest within a controlled environment:

pytest_discover_tests(NAME
    [WORKING_DIRECTORY dir]
    [TRIM_FROM_NAME pattern]
    [LIBRARY_PATH_PREPEND path1 path2...]
    [PYTHON_PATH_PREPEND path1 path2...]
    [ENVIRONMENT env1 env2...]
    [DEPENDS target1 target2...]
    [BUNDLE_TESTS]
)

The options are:

  • NAME

    Indicate the name of the target that will be created. It will also be used as a prefix for each test created, or as an identifier the bundled test.

  • WORKING_DIRECTORY

    Specify the directory in which to run the Pytest command. If this option is not provided, the current source directory is used.

  • TRIM_FROM_NAME

    Specify a regular expression to trim part of the class, method and function names discovered before creating the test. This option can be used to trim the convention prefix required by Pytest for discovery.:

    pytest_discover_tests(
    ...
    TRIM_FROM_NAME "^(Test|test_)"
)

  • LIBRARY_PATH_PREPEND

    List of library paths to prepend to the corresponding environment variable (LD_LIBRARY_PATH on Linux, DYLD_LIBRARY_PATH on macOS, and PATH on Windows) when running the tests. Each path can be defined literally or as a CMake expression generator for convenience:

    pytest_discover_tests(
    ...
    LIBRARY_PATH_PREPEND
        $<TARGET_FILE_DIR:lib1>
        $<TARGET_FILE_DIR:lib2>
        /path/to/libs/
)

  • PYTHON_PATH_PREPEND

    List of Python paths to prepend to the PYTHONPATH environment variable when running the tests. Each path can be defined literally or as a CMake expression generator for convenience:

    pytest_discover_tests(
    ...
    PYTHON_PATH_PREPEND
        $<TARGET_FILE_DIR:lib1>
        $<TARGET_FILE_DIR:lib2>
        /path/to/python/
)

  • ENVIRONMENT

    List of custom environment variables with associated values to set when running the tests:

    pytest_discover_tests(
    ...
    ENVIRONMENT
        "ENV_VAR1=VALUE1"
        "ENV_VAR2=VALUE2"
        "ENV_VAR3=VALUE3"
)

  • DEPENDS

    List of dependent targets that need to be executed before running the tests:

    pytest_discover_tests(
    ...
    DEPENDS lib1 lib2
)

  • BUNDLE_TESTS

    Indicate whether Python tests should be bundled under a single CTest test. This option can also be set dynamically by using the BUNDLE_PYTHON_TESTS environment variable.

    Bundled tests generally run faster because Pytest can use caching and fixtures with a broader scope.

Note

This function works similarly to the gtest_discover_tests function, which creates CTest tests for each GTest tests discovered within a single C++ executable test file.