summaryrefslogtreecommitdiffstats
path: root/Help/command/ctest_test.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Use CMake highlighting for command synopsisAlex Turbov2022-11-091-2/+2
| | | | Most of CMake commands use it. Fix a few of them to do the same.
* Help: Add crossrefs to ctest output control optionsCraig Scott2022-08-191-1/+5
|
* Merge branch 'backport-3.24-doc-ctest_test-output-control' into ↵Craig Scott2022-08-191-1/+1
|\ | | | | | | doc-ctest_test-output-control
| * Help: Add missing closing quote on C++ exampleCraig Scott2022-08-191-1/+1
| |
* | Help: Replace a bunch of more ``--option`` to `:option:` roleAlex Turbov2022-08-041-2/+3
|/
* ctest: add option for output truncationFrank Winklmeier2022-03-081-2/+3
| | | | | | | | | | Add `--test-output-truncation` to `ctest`. This option can be used to customize which part of the test output is being truncated. Currently supported values are `tail`, `middle` and `head`. Also add equivalent `CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION` variable. Fixes: #23206
* Help: Improve cross-referencing of test LABELS and related featuresCraig Scott2021-11-131-0/+2
|
* Help: Add missing version details for Additional Test MeasurementsCraig Scott2021-11-131-3/+10
|
* Merge topic 'doc-ctest-output'Craig Scott2021-07-261-3/+3
|\ | | | | | | | | | | | | | | ba6d1947b6 Help: Add cross-references between test output size ctest variables cdde9e5a10 Help: Improve wording and cross-referencing for ctest JUnit output Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6389
| * Help: Improve wording and cross-referencing for ctest JUnit outputCraig Scott2021-07-251-3/+3
| |
* | Merge topic 'Help-ctest_memcheck-shared-args'Brad King2021-07-191-0/+4
|\ \ | |/ | | | | | | | | | | | | 85e740312f Help/ctest_test: add a comment to also update `ctest_memcheck` 731cfd45fd Help/ctest_memcheck: mention `ctest_test` arguments Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6351
| * Help/ctest_test: add a comment to also update `ctest_memcheck`Ben Boeckel2021-07-191-0/+4
| | | | | | | | | | Since these commands share a common argument parser, the documentation should be kept synchronized.
* | help: update ctest attached file exampleZack Galbreath2021-07-011-2/+4
| | | | | | | | Clarify that multiple files can be attached to a given test at runtime
* | ctest: support <CTestMeasurement> for runtime measurementsZack Galbreath2021-07-011-13/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Teach CTest to parse output for <CTestMeasurement> in addition to <DartMeasurement> for measurements defined at runtime. Use a new class (cmCTestTestMeasurementXMLParser) derived from cmXMLParser to parse the data and attributes these XML elements. This is an improvement over our previous approach of using a series of regular expressions. As part of this commit we also rename some member variables and methods to make their purpose more clear. DartStuff -> AllTestMeasurementsRegex DartStuff1 -> SingleTestMeasurementRegex DartString -> TestMeasurementsOutput GenerateDartOutput() -> GenerateCTestXML() GenerateRegressionImages() -> RecordCustomTestMeasurements() cmCTestRunTest::DartProcessing() -> ParseOutputForMeasurements()
* | ctest: allow test output to add labelsZack Galbreath2021-06-171-0/+15
|/ | | | | Parse test output for <CTestLabel>...</CTestLabel>. If found, add this value to the list of labels associated with this test.
* ctest: allow test output to override the 'details' fieldZack Galbreath2021-06-091-0/+11
| | | | | | Parse test output for <CTestDetails>...</CTestDetails>. If found, use this value to override the default 'Details' string reported to CDash.
* ctest: add support for attaching files to tests at run timeZack Galbreath2021-06-081-2/+11
| | | | | | | | | | | | | | Allow tests to specify files to upload at runtime. Previously this was only possible to specify at configure time with the ATTACHED_FILES test properties. This commit also fixes a bug in how our test data tarballs were generated by CTest. Previously, if you tried to attach a file outside of the binary directory, CTest would generate a tar file with a relative path, and tar would not allow you to extract it. We resolve this problem by creating tar files with a flat directory structure instead. Fixes: #22284
* Help: Document CTest custom test measurementsZack Galbreath2021-04-271-0/+80
|
* ctest: Add support for writing test results in JUnit XML formatZack Galbreath2021-04-261-0/+10
| | | | Addresses #18654
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-0/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
* ctest: add option --stop-on-failureJohnny Jazeix2020-04-201-0/+4
| | | | | | To stop the tests once one has failed Fixes: #16628
* ctest_test: Add option to REPEAT testsBrad King2019-11-071-0/+20
|
* CTest: Rename hardware -> resources for CMake variables, command optionsCraig Scott2019-11-051-4/+4
| | | | | | Only changes the user-visible effects of renaming hardware allocation to resource allocation. Code changes are the minimum needed to achieve that.
* Help: Add documentation for CTest hardware allocationKyle Edwards2019-10-021-0/+6
|
* Add ctest options for limiting which tests fixtures addCraig Scott2017-05-011-0/+17
| | | | | The new options allow the user to restrict the setup and cleanup tests automatically added for fixtures.
* Help: Clarify `ctest_*` APPEND option behaviorBrad King2016-10-141-1/+3
| | | | | | Explicitly state that this marks the `.xml` to tell the dashboard server to append it to previously submitted results and that it does not cause results to be appended to the `.xml` file.
* CTest: Add CAPTURE_CMAKE_ERROR val to `ctest_*` commandsBill Hoffman2016-09-201-0/+5
| | | | | | | If a `ctest_*` command has CAPTURE_CMAKE_ERROR then any errors generated by cmake during that command will cause the value to be assigned `-1`. This will prevent a `ctest -S` script from returning non-zero unless the script explicitly calls `message(FATAL_ERROR)`.
* CTest: Document and test custom output size settingsBrad King2015-09-181-0/+3
| | | | | | | | | Add documentation and tests for the existing CTEST_CUSTOM_MAXIMUM_PASSED_TEST_OUTPUT_SIZE CTEST_CUSTOM_MAXIMUM_FAILED_TEST_OUTPUT_SIZE CTest variables.
* ctest: Optionally avoid starting tests that may exceed a given CPU loadBetsy McPhail2015-06-301-0/+8
| | | | | | | | | | | | | | Add a TestLoad setting to CTest that can be set via a new --test-load command-line option, CTEST_TEST_LOAD variable, or TEST_LOAD option to the ctest_test command. Teach cmCTestMultiProcessHandler to measure the CPU load and avoid starting tests that may take more than the spare load currently available. The expression <current_load> + <test_processors> <= <max-load> must be true to start a new test. Co-Author: Zack Galbreath <zack.galbreath@kitware.com>
* Help: Fix typo in ctest_test documentationZack Galbreath2015-06-241-1/+1
| | | | s/acorss/across/
* Help: Revise ctest_* command documentation (#15559)Brad King2015-05-071-33/+73
| | | | | | Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
* ctest_test: Add QUIET optionZack Galbreath2015-02-231-0/+6
|
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+33
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.