| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| |
| <title>ctest_test — CMake 3.8.2 Documentation</title> |
| |
| |
| <link rel="stylesheet" href="../_static/cmake.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: '../', |
| VERSION: '3.8.2', |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: '.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script type="text/javascript" src="../_static/jquery.js"></script> |
| <script type="text/javascript" src="../_static/underscore.js"></script> |
| <script type="text/javascript" src="../_static/doctools.js"></script> |
| <link rel="shortcut icon" href="../_static/cmake-favicon.ico"/> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="ctest_update" href="ctest_update.html" /> |
| <link rel="prev" title="ctest_submit" href="ctest_submit.html" /> |
| </head> |
| <body role="document"> |
| <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> » |
| </li> |
| <li> |
| <a href="../index.html">3.8.2 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" accesskey="U">cmake-commands(7)</a> »</li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="ctest-test"> |
| <span id="command:ctest_test"></span><h1>ctest_test<a class="headerlink" href="#ctest-test" title="Permalink to this headline">ΒΆ</a></h1> |
| <p>Perform the <a class="reference internal" href="../manual/ctest.1.html#ctest-test-step"><span class="std std-ref">CTest Test Step</span></a> as a <a class="reference internal" href="../manual/ctest.1.html#dashboard-client"><span class="std std-ref">Dashboard Client</span></a>.</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ctest_test</span><span class="p">([</span><span class="n">BUILD</span> <span class="o"><</span><span class="n">build</span><span class="o">-</span><span class="nb">dir</span><span class="o">></span><span class="p">]</span> <span class="p">[</span><span class="n">APPEND</span><span class="p">]</span> |
| <span class="p">[</span><span class="n">START</span> <span class="o"><</span><span class="n">start</span><span class="o">-</span><span class="n">number</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">END</span> <span class="o"><</span><span class="n">end</span><span class="o">-</span><span class="n">number</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">STRIDE</span> <span class="o"><</span><span class="n">stride</span><span class="o">-</span><span class="n">number</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">EXCLUDE</span> <span class="o"><</span><span class="n">exclude</span><span class="o">-</span><span class="n">regex</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">INCLUDE</span> <span class="o"><</span><span class="n">include</span><span class="o">-</span><span class="n">regex</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">EXCLUDE_LABEL</span> <span class="o"><</span><span class="n">label</span><span class="o">-</span><span class="n">exclude</span><span class="o">-</span><span class="n">regex</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">INCLUDE_LABEL</span> <span class="o"><</span><span class="n">label</span><span class="o">-</span><span class="n">include</span><span class="o">-</span><span class="n">regex</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">PARALLEL_LEVEL</span> <span class="o"><</span><span class="n">level</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">TEST_LOAD</span> <span class="o"><</span><span class="n">threshold</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">SCHEDULE_RANDOM</span> <span class="o"><</span><span class="n">ON</span><span class="o">|</span><span class="n">OFF</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">STOP_TIME</span> <span class="o"><</span><span class="n">time</span><span class="o">-</span><span class="n">of</span><span class="o">-</span><span class="n">day</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">RETURN_VALUE</span> <span class="o"><</span><span class="n">result</span><span class="o">-</span><span class="n">var</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">CAPTURE_CMAKE_ERROR</span> <span class="o"><</span><span class="n">result</span><span class="o">-</span><span class="n">var</span><span class="o">></span><span class="p">]</span> |
| <span class="p">[</span><span class="n">QUIET</span><span class="p">]</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Run tests in the project build tree and store results in |
| <code class="docutils literal"><span class="pre">Test.xml</span></code> for submission with the <span class="target" id="index-0-command:ctest_submit"></span><a class="reference internal" href="ctest_submit.html#command:ctest_submit" title="ctest_submit"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_submit()</span></code></a> command.</p> |
| <p>The options are:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">BUILD</span> <span class="pre"><build-dir></span></code></dt> |
| <dd>Specify the top-level build directory. If not given, the |
| <span class="target" id="index-0-variable:CTEST_BINARY_DIRECTORY"></span><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"><span class="pre">CTEST_BINARY_DIRECTORY</span></code></a> variable is used.</dd> |
| <dt><code class="docutils literal"><span class="pre">APPEND</span></code></dt> |
| <dd>Mark <code class="docutils literal"><span class="pre">Test.xml</span></code> for append to results previously submitted to a |
| dashboard server since the last <span class="target" id="index-0-command:ctest_start"></span><a class="reference internal" href="ctest_start.html#command:ctest_start" title="ctest_start"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_start()</span></code></a> call. |
| Append semantics are defined by the dashboard server in use. |
| This does <em>not</em> cause results to be appended to a <code class="docutils literal"><span class="pre">.xml</span></code> file |
| produced by a previous call to this command.</dd> |
| <dt><code class="docutils literal"><span class="pre">START</span> <span class="pre"><start-number></span></code></dt> |
| <dd>Specify the beginning of a range of test numbers.</dd> |
| <dt><code class="docutils literal"><span class="pre">END</span> <span class="pre"><end-number></span></code></dt> |
| <dd>Specify the end of a range of test numbers.</dd> |
| <dt><code class="docutils literal"><span class="pre">STRIDE</span> <span class="pre"><stride-number></span></code></dt> |
| <dd>Specify the stride by which to step across a range of test numbers.</dd> |
| <dt><code class="docutils literal"><span class="pre">EXCLUDE</span> <span class="pre"><exclude-regex></span></code></dt> |
| <dd>Specify a regular expression matching test names to exclude.</dd> |
| <dt><code class="docutils literal"><span class="pre">INCLUDE</span> <span class="pre"><include-regex></span></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"><span class="pre">EXCLUDE_LABEL</span> <span class="pre"><label-exclude-regex></span></code></dt> |
| <dd>Specify a regular expression matching test labels to exclude.</dd> |
| <dt><code class="docutils literal"><span class="pre">INCLUDE_LABEL</span> <span class="pre"><label-include-regex></span></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"><span class="pre">PARALLEL_LEVEL</span> <span class="pre"><level></span></code></dt> |
| <dd>Specify a positive number representing the number of tests to |
| be run in parallel.</dd> |
| <dt><code class="docutils literal"><span class="pre">TEST_LOAD</span> <span class="pre"><threshold></span></code></dt> |
| <dd>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 <span class="target" id="index-0-variable:CTEST_TEST_LOAD"></span><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"><span class="pre">CTEST_TEST_LOAD</span></code></a> variable will be checked, |
| and then the <code class="docutils literal"><span class="pre">--test-load</span></code> command-line argument to <span class="target" id="index-0-manual:ctest(1)"></span><a class="reference internal" href="../manual/ctest.1.html#manual:ctest(1)" title="ctest(1)"><code class="xref cmake cmake-manual docutils literal"><span class="pre">ctest(1)</span></code></a>. |
| See also the <code class="docutils literal"><span class="pre">TestLoad</span></code> setting in the <a class="reference internal" href="../manual/ctest.1.html#ctest-test-step"><span class="std std-ref">CTest Test Step</span></a>.</dd> |
| <dt><code class="docutils literal"><span class="pre">SCHEDULE_RANDOM</span> <span class="pre"><ON|OFF></span></code></dt> |
| <dd>Launch tests in a random order. This may be useful for detecting |
| implicit test dependencies.</dd> |
| <dt><code class="docutils literal"><span class="pre">STOP_TIME</span> <span class="pre"><time-of-day></span></code></dt> |
| <dd>Specify a time of day at which the tests should all stop running.</dd> |
| <dt><code class="docutils literal"><span class="pre">RETURN_VALUE</span> <span class="pre"><result-var></span></code></dt> |
| <dd>Store in the <code class="docutils literal"><span class="pre"><result-var></span></code> variable <code class="docutils literal"><span class="pre">0</span></code> if all tests passed. |
| Store non-zero if anything went wrong.</dd> |
| <dt><code class="docutils literal"><span class="pre">CAPTURE_CMAKE_ERROR</span> <span class="pre"><result-var></span></code></dt> |
| <dd>Store in the <code class="docutils literal"><span class="pre"><result-var></span></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"><span class="pre">QUIET</span></code></dt> |
| <dd>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"><span class="pre">QUIET</span></code> option.</dd> |
| </dl> |
| <p>See also the <span class="target" id="index-0-variable:CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE"></span><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"><span class="pre">CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE</span></code></a> |
| and <span class="target" id="index-0-variable:CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE"></span><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"><span class="pre">CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE</span></code></a> variables.</p> |
| </div> |
| |
| |
| </div> |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <h4>Previous topic</h4> |
| <p class="topless"><a href="ctest_submit.html" |
| title="previous chapter">ctest_submit</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="ctest_update.html" |
| title="next chapter">ctest_update</a></p> |
| <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>Quick search</h3> |
| <form class="search" action="../search.html" method="get"> |
| <div><input type="text" name="q" /></div> |
| <div><input type="submit" value="Go" /></div> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| <script type="text/javascript">$('#searchbox').show(0);</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> » |
| </li> |
| <li> |
| <a href="../index.html">3.8.2 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" >cmake-commands(7)</a> »</li> |
| </ul> |
| </div> |
| <div class="footer" role="contentinfo"> |
| © Copyright 2000-2017 Kitware, Inc. and Contributors. |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2. |
| </div> |
| </body> |
| </html> |
