OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	04/04/2023 07:10:48 PM	rwxr-xr-x
📄 add_compile_definitions.html	8.97 KB	04/04/2023 07:04:57 PM	rw-r--r--
📄 add_compile_options.html	13.11 KB	04/04/2023 07:04:57 PM	rw-r--r--
📄 add_custom_command.html	67.2 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_custom_target.html	26.7 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_definitions.html	9.72 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_dependencies.html	8.79 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_executable.html	20.23 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_library.html	43.25 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_link_options.html	17.79 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_subdirectory.html	8.85 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_test.html	17.09 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 aux_source_directory.html	6.45 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 block.html	13.15 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 break.html	5.97 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 build_command.html	10.66 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 build_name.html	6.43 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_host_system_information.html	38.46 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_language.html	59.74 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_minimum_required.html	13.56 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_parse_arguments.html	18.62 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_path.html	80.45 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_policy.html	23.14 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 configure_file.html	20.36 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 continue.html	6.15 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 create_test_sourcelist.html	7.61 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_build.html	14.87 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_configure.html	10.28 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_coverage.html	9.93 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_empty_binary_directory.html	5.54 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_memcheck.html	11.73 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_read_custom_files.html	5.78 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_run_script.html	6.72 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_sleep.html	5.66 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_start.html	14.68 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_submit.html	16.18 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_test.html	38.64 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_update.html	8.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_upload.html	6.7 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 define_property.html	15.53 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 else.html	5.35 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 elseif.html	5.44 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 enable_language.html	10.08 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 enable_testing.html	6.04 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endblock.html	5.66 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endforeach.html	5.88 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endfunction.html	5.85 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endif.html	5.71 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endmacro.html	5.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endwhile.html	5.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 exec_program.html	7.52 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 execute_process.html	20.95 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 export.html	19.49 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 export_library_dependencies.html	8.01 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 file.html	128.25 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 find_file.html	39.65 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 find_library.html	46.52 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_package.html	91.29 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_path.html	40.22 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_program.html	37.17 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 fltk_wrap_ui.html	5.8 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 foreach.html	18.65 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 function.html	12.42 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_cmake_property.html	8.05 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_directory_property.html	9.08 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_filename_component.html	12.57 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_property.html	15.95 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_source_file_property.html	11.47 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_target_property.html	9.1 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_test_property.html	8.06 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 if.html	41.89 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include.html	8.04 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_directories.html	10.54 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_external_msproject.html	8.14 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_guard.html	8.85 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_regular_expression.html	6.14 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install.html	126.44 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_files.html	9.13 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_programs.html	9.09 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_targets.html	7 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 link_directories.html	11.99 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 link_libraries.html	7.36 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 list.html	35.79 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 load_cache.html	6.78 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 load_command.html	6.61 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 macro.html	20.49 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 make_directory.html	5.77 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 mark_as_advanced.html	6.73 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 math.html	9.01 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 message.html	27.67 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 option.html	6.48 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 output_required_files.html	6.59 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 project.html	30.84 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 qt_wrap_cpp.html	7.2 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 qt_wrap_ui.html	7.43 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 remove.html	6 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 remove_definitions.html	6.15 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 return.html	16.06 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 separate_arguments.html	11.04 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set.html	18.35 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_directory_properties.html	7.58 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_property.html	17.74 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_source_files_properties.html	10.63 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_target_properties.html	8.33 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_tests_properties.html	7.98 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 site_name.html	5.46 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 source_group.html	10.97 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 string.html	64.24 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 subdir_depends.html	5.69 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 subdirs.html	7.51 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_definitions.html	16.09 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_features.html	14.47 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_options.html	18.02 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_include_directories.html	22.39 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_directories.html	16.03 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_libraries.html	60.83 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_options.html	23.66 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_precompile_headers.html	24.42 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_sources.html	38.35 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 try_compile.html	57.47 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 try_run.html	24.62 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 unset.html	9.21 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 use_mangled_mesa.html	5.91 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 utility_source.html	6.78 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 variable_requires.html	6.84 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 variable_watch.html	8.98 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 while.html	9.14 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 write_file.html	7.25 KB	04/04/2023 07:05:04 PM	rw-r--r--

Editing: ctest_test.html

<!DOCTYPE html>

<title>ctest_test &mdash; CMake 3.26.3 Documentation</title>

</head><body>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="ctest_update.html" title="ctest_update"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="ctest_submit.html" title="ctest_submit"
 accesskey="P">previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" accesskey="U">cmake-commands(7)</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">ctest_test</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="ctest-test">
<h1>ctest_test<a class="headerlink" href="#ctest-test" title="Permalink to this heading">¶</a></h1>
Perform the <a class="reference internal" href="../manual/ctest.1.html#ctest-test-step">CTest Test Step</a> as a <a class="reference internal" href="../manual/ctest.1.html#dashboard-client">Dashboard Client</a>.
<div class="highlight-cmake notranslate"><div class="highlight"><pre>ctest_test([BUILD &lt;build-dir&gt;] [APPEND]
 [START &lt;start-number&gt;]
 [END &lt;end-number&gt;]
 [STRIDE &lt;stride-number&gt;]
 [EXCLUDE &lt;exclude-regex&gt;]
 [INCLUDE &lt;include-regex&gt;]
 [EXCLUDE_LABEL &lt;label-exclude-regex&gt;]
 [INCLUDE_LABEL &lt;label-include-regex&gt;]
 [EXCLUDE_FIXTURE &lt;regex&gt;]
 [EXCLUDE_FIXTURE_SETUP &lt;regex&gt;]
 [EXCLUDE_FIXTURE_CLEANUP &lt;regex&gt;]
 [PARALLEL_LEVEL &lt;level&gt;]
 [RESOURCE_SPEC_FILE &lt;file&gt;]
 [TEST_LOAD &lt;threshold&gt;]
 [SCHEDULE_RANDOM &lt;ON|OFF&gt;]
 [STOP_ON_FAILURE]
 [STOP_TIME &lt;time-of-day&gt;]
 [RETURN_VALUE &lt;result-var&gt;]
 [CAPTURE_CMAKE_ERROR &lt;result-var&gt;]
 [REPEAT &lt;mode&gt;:&lt;n&gt;]
 [OUTPUT_JUNIT &lt;file&gt;]
 [QUIET]
 )
</pre></div>
</div>
Run tests in the project build tree and store results in
<code class="docutils literal notranslate">Test.xml</code> for submission with the <a class="reference internal" href="ctest_submit.html#command:ctest_submit" title="ctest_submit"><code class="xref cmake cmake-command docutils literal notranslate">ctest_submit()</code></a> command.
The options are:
<dl>
<dt><code class="docutils literal notranslate">BUILD &lt;build-dir&gt;</code></dt><dd>Specify the top-level build directory. If not given, the
<a class="reference internal" href="../variable/CTEST_BINARY_DIRECTORY.html#variable:CTEST_BINARY_DIRECTORY" title="CTEST_BINARY_DIRECTORY"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_BINARY_DIRECTORY</code></a> variable is used.
</dd>
<dt><code class="docutils literal notranslate">APPEND</code></dt><dd>Mark <code class="docutils literal notranslate">Test.xml</code> for append to results previously submitted to a
dashboard server since the last <a class="reference internal" href="ctest_start.html#command:ctest_start" title="ctest_start"><code class="xref cmake cmake-command docutils literal notranslate">ctest_start()</code></a> call.
Append semantics are defined by the dashboard server in use.
This does not cause results to be appended to a <code class="docutils literal notranslate">.xml</code> file
produced by a previous call to this command.
</dd>
<dt><code class="docutils literal notranslate">START &lt;start-number&gt;</code></dt><dd>Specify the beginning of a range of test numbers.
</dd>
<dt><code class="docutils literal notranslate">END &lt;end-number&gt;</code></dt><dd>Specify the end of a range of test numbers.
</dd>
<dt><code class="docutils literal notranslate">STRIDE &lt;stride-number&gt;</code></dt><dd>Specify the stride by which to step across a range of test numbers.
</dd>
<dt><code class="docutils literal notranslate">EXCLUDE &lt;exclude-regex&gt;</code></dt><dd>Specify a regular expression matching test names to exclude.
</dd>
<dt><code class="docutils literal notranslate">INCLUDE &lt;include-regex&gt;</code></dt><dd>Specify a regular expression matching test names to include.
Tests not matching this expression are excluded.
</dd>
<dt><code class="docutils literal notranslate">EXCLUDE_LABEL &lt;label-exclude-regex&gt;</code></dt><dd>Specify a regular expression matching test labels to exclude.
</dd>
<dt><code class="docutils literal notranslate">INCLUDE_LABEL &lt;label-include-regex&gt;</code></dt><dd>Specify a regular expression matching test labels to include.
Tests not matching this expression are excluded.
</dd>
<dt><code class="docutils literal notranslate">EXCLUDE_FIXTURE &lt;regex&gt;</code></dt><dd><div class="versionadded">
New in version 3.7.
</div>
If a test in the set of tests to be executed requires a particular fixture,
that fixture's setup and cleanup tests would normally be added to the test
set automatically. This option prevents adding setup or cleanup tests for
fixtures matching the <code class="docutils literal notranslate">&lt;regex&gt;</code>. Note that all other fixture behavior is
retained, including test dependencies and skipping tests that have fixture
setup tests that fail.
</dd>
<dt><code class="docutils literal notranslate">EXCLUDE_FIXTURE_SETUP &lt;regex&gt;</code></dt><dd><div class="versionadded">
New in version 3.7.
</div>
Same as <code class="docutils literal notranslate">EXCLUDE_FIXTURE</code> except only matching setup tests are excluded.
</dd>
<dt><code class="docutils literal notranslate">EXCLUDE_FIXTURE_CLEANUP &lt;regex&gt;</code></dt><dd><div class="versionadded">
New in version 3.7.
</div>
Same as <code class="docutils literal notranslate">EXCLUDE_FIXTURE</code> except only matching cleanup tests are excluded.
</dd>
<dt><code class="docutils literal notranslate">PARALLEL_LEVEL &lt;level&gt;</code></dt><dd>Specify a positive number representing the number of tests to
be run in parallel.
</dd>
<dt><code class="docutils literal notranslate">RESOURCE_SPEC_FILE &lt;file&gt;</code></dt><dd><div class="versionadded">
New in version 3.16.
</div>
Specify a
<a class="reference internal" href="../manual/ctest.1.html#ctest-resource-specification-file">resource specification file</a>. See
<a class="reference internal" href="../manual/ctest.1.html#ctest-resource-allocation">Resource Allocation</a> for more information.
</dd>
<dt><code class="docutils literal notranslate">TEST_LOAD &lt;threshold&gt;</code></dt><dd><div class="versionadded">
New in version 3.4.
</div>
While running tests in parallel, try not to start tests when they
may cause the CPU load to pass above a given threshold. If not
specified the <a class="reference internal" href="../variable/CTEST_TEST_LOAD.html#variable:CTEST_TEST_LOAD" title="CTEST_TEST_LOAD"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_TEST_LOAD</code></a> variable will be checked,
and then the <a class="reference internal" href="../manual/ctest.1.html#cmdoption-ctest-test-load"><code class="xref std std-option docutils literal notranslate">--test-load</code></a> command-line
argument to <a class="reference internal" href="../manual/ctest.1.html#manual:ctest(1)" title="ctest(1)"><code class="xref cmake cmake-manual docutils literal notranslate">ctest(1)</code></a>. See also the <code class="docutils literal notranslate">TestLoad</code> setting
in the <a class="reference internal" href="../manual/ctest.1.html#ctest-test-step">CTest Test Step</a>.
</dd>
<dt><code class="docutils literal notranslate">REPEAT &lt;mode&gt;:&lt;n&gt;</code></dt><dd><div class="versionadded">
New in version 3.17.
</div>
Run tests repeatedly based on the given <code class="docutils literal notranslate">&lt;mode&gt;</code> up to <code class="docutils literal notranslate">&lt;n&gt;</code> times.
The modes are:
<dl class="simple">
<dt><code class="docutils literal notranslate">UNTIL_FAIL</code></dt><dd>Require each test to run <code class="docutils literal notranslate">&lt;n&gt;</code> times without failing in order to pass.
This is useful in finding sporadic failures in test cases.
</dd>
<dt><code class="docutils literal notranslate">UNTIL_PASS</code></dt><dd>Allow each test to run up to <code class="docutils literal notranslate">&lt;n&gt;</code> times in order to pass.
Repeats tests if they fail for any reason.
This is useful in tolerating sporadic failures in test cases.
</dd>
<dt><code class="docutils literal notranslate">AFTER_TIMEOUT</code></dt><dd>Allow each test to run up to <code class="docutils literal notranslate">&lt;n&gt;</code> times in order to pass.
Repeats tests only if they timeout.
This is useful in tolerating sporadic timeouts in test cases
on busy machines.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">SCHEDULE_RANDOM &lt;ON|OFF&gt;</code></dt><dd>Launch tests in a random order. This may be useful for detecting
implicit test dependencies.
</dd>
<dt><code class="docutils literal notranslate">STOP_ON_FAILURE</code></dt><dd><div class="versionadded">
New in version 3.18.
</div>
Stop the execution of the tests once one has failed.
</dd>
<dt><code class="docutils literal notranslate">STOP_TIME &lt;time-of-day&gt;</code></dt><dd>Specify a time of day at which the tests should all stop running.
</dd>
<dt><code class="docutils literal notranslate">RETURN_VALUE &lt;result-var&gt;</code></dt><dd>Store in the <code class="docutils literal notranslate">&lt;result-var&gt;</code> variable <code class="docutils literal notranslate">0</code> if all tests passed.
Store non-zero if anything went wrong.
</dd>
<dt><code class="docutils literal notranslate">CAPTURE_CMAKE_ERROR &lt;result-var&gt;</code></dt><dd><div class="versionadded">
New in version 3.7.
</div>
Store in the <code class="docutils literal notranslate">&lt;result-var&gt;</code> variable -1 if there are any errors running
the command and prevent ctest from returning non-zero if an error occurs.
</dd>
<dt><code class="docutils literal notranslate">OUTPUT_JUNIT &lt;file&gt;</code></dt><dd><div class="versionadded">
New in version 3.21.
</div>
Write test results to <code class="docutils literal notranslate">&lt;file&gt;</code> in JUnit XML format. If <code class="docutils literal notranslate">&lt;file&gt;</code> is a
relative path, it will be placed in the build directory. If <code class="docutils literal notranslate">&lt;file&gt;</code>
already exists, it will be overwritten. Note that the resulting JUnit XML
file is not uploaded to CDash because it would be redundant with
CTest's <code class="docutils literal notranslate">Test.xml</code> file.
</dd>
<dt><code class="docutils literal notranslate">QUIET</code></dt><dd><div class="versionadded">
New in version 3.3.
</div>
Suppress any CTest-specific non-error messages that would have otherwise
been printed to the console. Output from the underlying test command is not
affected. Summary info detailing the percentage of passing tests is also
unaffected by the <code class="docutils literal notranslate">QUIET</code> option.
</dd>
</dl>
See also the <a class="reference internal" href="../variable/CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE.html#variable:CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE" title="CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE</code></a>,
<a class="reference internal" href="../variable/CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE.html#variable:CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE" title="CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE</code></a> and
<a class="reference internal" href="../variable/CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION.html#variable:CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION" title="CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION</code></a> variables, along with their
corresponding <a class="reference internal" href="../manual/ctest.1.html#manual:ctest(1)" title="ctest(1)"><code class="xref cmake cmake-manual docutils literal notranslate">ctest(1)</code></a> command line options
<a class="reference internal" href="../manual/ctest.1.html#cmdoption-ctest-test-output-size-passed"><code class="xref std std-option docutils literal notranslate">--test-output-size-passed</code></a>,
<a class="reference internal" href="../manual/ctest.1.html#cmdoption-ctest-test-output-size-failed"><code class="xref std std-option docutils literal notranslate">--test-output-size-failed</code></a>, and
<a class="reference internal" href="../manual/ctest.1.html#cmdoption-ctest-test-output-truncation"><code class="xref std std-option docutils literal notranslate">--test-output-truncation</code></a>.
<section id="additional-test-measurements">
<h2>Additional Test Measurements<a class="headerlink" href="#additional-test-measurements" title="Permalink to this heading">¶</a></h2>
CTest can parse the output of your tests for extra measurements to report
to CDash.
When run as a <a class="reference internal" href="../manual/ctest.1.html#dashboard-client">Dashboard Client</a>, CTest will include these custom
measurements in the <code class="docutils literal notranslate">Test.xml</code> file that gets uploaded to CDash.
Check the <a class="reference external" href="https://github.com/Kitware/CDash/blob/master/docs/test_measurements.md">CDash test measurement documentation</a>
for more information on the types of test measurements that CDash recognizes.
The following example demonstrates how to output a variety of custom test
measurements.
<div class="highlight-c++ notranslate"><div class="highlight"><pre>std::cout &lt;&lt;
 &quot;&lt;CTestMeasurement type=\&quot;numeric/double\&quot; name=\&quot;score\&quot;&gt;28.3&lt;/CTestMeasurement&gt;&quot;
 &lt;&lt; std::endl;

std::cout &lt;&lt;
 &quot;&lt;CTestMeasurementFile type=\&quot;image/png\&quot; name=\&quot;AlgoResult\&quot;&gt;&quot; &lt;&lt;
 &quot;/dir/to/img.png&lt;/CTestMeasurementFile&gt;&quot;
 &lt;&lt; std::endl;
</pre></div>
</div>
Images will be displayed together in an interactive comparison mode on CDash
if they are provided with two or more of the following names.
<ul class="simple">
<li><code class="docutils literal notranslate">TestImage</code></li>
<li><code class="docutils literal notranslate">ValidImage</code></li>
<li><code class="docutils literal notranslate">BaselineImage</code></li>
<li><code class="docutils literal notranslate">DifferenceImage2</code></li>
</ul>
By convention, <code class="docutils literal notranslate">TestImage</code> is the image generated by your test, and
<code class="docutils literal notranslate">ValidImage</code> (or <code class="docutils literal notranslate">BaselineImage</code>) is basis of comparison used to determine
if the test passed or failed.
If another image name is used it will be displayed by CDash as a static image
separate from the interactive comparison UI.
</section>
<section id="attached-files">
<h3>Attached Files<a class="headerlink" href="#attached-files" title="Permalink to this heading">¶</a></h3>
<div class="versionadded">
New in version 3.21.
</div>
The following example demonstrates how to upload non-image files to CDash.
<div class="highlight-c++ notranslate"><div class="highlight"><pre>std::cout &lt;&lt;
 &quot;&lt;CTestMeasurementFile type=\&quot;file\&quot; name=\&quot;TestInputData1\&quot;&gt;&quot; &lt;&lt;
 &quot;/dir/to/data1.csv&lt;/CTestMeasurementFile&gt;\n&quot; &lt;&lt;
 &quot;&lt;CTestMeasurementFile type=\&quot;file\&quot; name=\&quot;TestInputData2\&quot;&gt;&quot; &lt;&lt;
 &quot;/dir/to/data2.csv&lt;/CTestMeasurementFile&gt;&quot; &lt;&lt; std::endl;
</pre></div>
</div>
If the name of the file to upload is known at configure time, you can use the
<a class="reference internal" href="../prop_test/ATTACHED_FILES.html#prop_test:ATTACHED_FILES" title="ATTACHED_FILES"><code class="xref cmake cmake-prop_test docutils literal notranslate">ATTACHED_FILES</code></a> or <a class="reference internal" href="../prop_test/ATTACHED_FILES_ON_FAIL.html#prop_test:ATTACHED_FILES_ON_FAIL" title="ATTACHED_FILES_ON_FAIL"><code class="xref cmake cmake-prop_test docutils literal notranslate">ATTACHED_FILES_ON_FAIL</code></a> test
properties instead.
</section>
<section id="custom-details">
<h3>Custom Details<a class="headerlink" href="#custom-details" title="Permalink to this heading">¶</a></h3>
<div class="versionadded">
New in version 3.21.
</div>
The following example demonstrates how to specify a custom value for the
<code class="docutils literal notranslate">Test Details</code> field displayed on CDash.
<div class="highlight-c++ notranslate"><div class="highlight"><pre>std::cout &lt;&lt;
 &quot;&lt;CTestDetails&gt;My Custom Details Value&lt;/CTestDetails&gt;&quot; &lt;&lt; std::endl;
</pre></div>
</div>
</section>
<section id="additional-labels">
<h3>Additional Labels<a class="headerlink" href="#additional-labels" title="Permalink to this heading">¶</a></h3>
<div class="versionadded">
New in version 3.22.
</div>
The following example demonstrates how to add additional labels to a test
at runtime.
<div class="highlight-c++ notranslate"><div class="highlight"><pre>std::cout &lt;&lt;
 &quot;&lt;CTestLabel&gt;Custom Label 1&lt;/CTestLabel&gt;\n&quot; &lt;&lt;
 &quot;&lt;CTestLabel&gt;Custom Label 2&lt;/CTestLabel&gt;&quot; &lt;&lt; std::endl;
</pre></div>
</div>
Use the <a class="reference internal" href="../prop_test/LABELS.html#prop_test:LABELS" title="LABELS"><code class="xref cmake cmake-prop_test docutils literal notranslate">LABELS</code></a> test property instead for labels that can be
determined at configure time.
</section>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../index.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">ctest_test</a><ul>
<li><a class="reference internal" href="#additional-test-measurements">Additional Test Measurements</a><ul>
<li><a class="reference internal" href="#image-measurements">Image Measurements</a></li>
<li><a class="reference internal" href="#attached-files">Attached Files</a></li>
<li><a class="reference internal" href="#custom-details">Custom Details</a></li>
<li><a class="reference internal" href="#additional-labels">Additional Labels</a></li>
</ul>
</li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="ctest_submit.html"
 title="previous chapter">ctest_submit</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="ctest_update.html"
 title="next chapter">ctest_update</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/command/ctest_test.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="ctest_update.html" title="ctest_update"
 >next</a> |</li>
 <li class="right" >
 <a href="ctest_submit.html" title="ctest_submit"
 >previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" >cmake-commands(7)</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">ctest_test</a></li> 
 </ul>
 </div>

<div class="footer" role="contentinfo">
 &#169; Copyright 2000-2023 Kitware, Inc. and Contributors.
 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
 </div>
 </body>
</html>