diff options
| author | Brad King <brad.king@kitware.com> | 2024-05-23 19:54:35 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2024-05-23 20:11:46 (GMT) |
| commit | 0dbf2c24bf59d2c2363939790d651bf872d5d52e (patch) | |
| tree | bc8871602668bcd1e94a92c27e7ca4ce4f851a69 /Tests/RunCMake | |
| parent | 61a08b0856a9aafc75b6cac755787cf05d86a34f (diff) | |
| download | CMake-0dbf2c24bf59d2c2363939790d651bf872d5d52e.zip CMake-0dbf2c24bf59d2c2363939790d651bf872d5d52e.tar.gz CMake-0dbf2c24bf59d2c2363939790d651bf872d5d52e.tar.bz2 | |
Tests/RunCMake: Document how to write multi-step test cases
Diffstat (limited to 'Tests/RunCMake')
| -rw-r--r-- | Tests/RunCMake/README.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/Tests/RunCMake/README.rst b/Tests/RunCMake/README.rst index 412b2b0..ea6db54 100644 --- a/Tests/RunCMake/README.rst +++ b/Tests/RunCMake/README.rst @@ -195,6 +195,8 @@ customized by setting the following variables before a call. ``${RunCMake_TEST_BINARY_DIR}`` directory before running the test case. If not set, or if set to a false value, the directory is removed. + This is useful to run `Multi-Step Test Cases`_. + ``RunCMake_TEST_COMMAND`` The command for ``run_cmake(<case>)`` to execute. If not set, defaults to running CMake to generate a project:: @@ -221,6 +223,30 @@ customized by setting the following variables before a call. Specify a timeout, in seconds, for ``run_cmake(<case>)`` to pass to its underlying ``execute_process()`` call using the ``TIMEOUT`` option. +Multi-Step Test Cases +===================== + +Normally each ``run_cmake(<case>)`` call corresponds to one standalone +test case with its own build tree. However, some test cases may require +multiple steps to be performed in a single build tree. This can be +achieved as follows:: + + block() + set(RunCMake_TEST_BINARY_DIR ${RunCMake_BINARY_DIR}/example-build) + run_cmake(example) + set(RunCMake_TEST_NO_CLEAN 1) + set(RunCMake_TEST_OUTPUT_MERGE 1) + run_cmake_command(example-build ${CMAKE_COMMAND} --build . --config Debug) + endblock() + +In this example, ``block() ... endblock()`` is used to isolate the +variable settings from later cases. A single build tree is used for +all cases inside the block. The first step cleans the build tree and +runs CMake to configure the case's project. The second step runs +``cmake --build`` to drive the generated build system and merges the +build tool's ``stderr`` into its ``stdout``. Note that each call uses +a unique case name so that expected results can be expressed individually. + Running a Test ============== |