Skip to content
Snippets Groups Projects
Commit c8c5ee64 authored by James Catmore's avatar James Catmore Committed by Walter Lampl
Browse files

Clarify instructions for running CITests in README

Clarify instructions for running CITests in README

The instructions for running the CITests locally miss a few details which aren't completely obvious to an inexperienced user. This MR attempts to clarify these points.
parent 335d8360
No related branches found
No related tags found
18 merge requests!78241Draft: FPGATrackSim: GenScan code refactor,!78236Draft: Switching Streams https://its.cern.ch/jira/browse/ATR-27417,!78056AFP monitoring: new synchronization and cleaning,!78041AFP monitoring: new synchronization and cleaning,!77990Updating TRT chip masks for L1TRT trigger simulation - ATR-28372,!77731Draft: Updates to ZDC reconstruction,!77728Draft: updates to ZDC reconstruction,!77522Draft: sTGC Pad Trigger Emulator,!76725ZdcNtuple: Fix cppcheck warning.,!76611L1CaloFEXByteStream: Fix out-of-bounds array accesses.,!76475Punchthrough AF3 implementation in FastG4,!76474Punchthrough AF3 implementation in FastG4,!76343Draft: MooTrackBuilder: Recalibrate NSW hits in refine method,!75729New implementation of ZDC nonlinear FADC correction.,!75703Draft: Update to HI han config for HLT jets,!75184Draft: Update file heavyions_run.config,!74430Draft: Fixing upper bound for Delayed Jet Triggers,!74354Clarify instructions for running CITests in README
......@@ -4,10 +4,15 @@ these as they have a significant impact on the CI turnaround time.
[TOC]
# Running the tests
After compiling this package locally, individual tests can be run specifying the test name (supports regex):
Once you have made the local modifications to the code that you wish to test, compile them locally alongside this package. Remain in the build directory. Individual tests can then be run by specifying the test name (supports regex):
```sh
ctest -R CITest_RecoRun2Data
```
or
```sh
ctest -R LuminosityCondAlgConfig_test
```
for a test defined in `LumiBlockComps/CMakeLists.txt` with the name `LuminosityCondAlgConfig_test`.
For builds involving several packages, tests can be selected/excluded using the "CITest" label:
```sh
......@@ -15,6 +20,8 @@ ctest -L CITest # run all CI tests
ctest -LE CITest # run all tests, except CI tests
```
This runs the test job and compares the output with the reference file, whose locations are specified in the `CMakeLists.txt` file. The results of the test are written to a temporary directory as reported by the job's message to the command prompt. The output of the test job itself is embedded in this file and so the relevant lines can be extracted in case you need to update the reference file.
# Adding new tests
- Test are defined in separate files for each project (e.g. [`Athena.cmake`](Athena.cmake)).
- Tests should have a short self-explanatory name. Do not add the word "test" to the name itself.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment