Skip to content

Commit 91d0c22

Browse files
committed
test: document the semantic of test.py
1 parent 836b7bd commit 91d0c22

2 files changed

Lines changed: 395 additions & 1 deletion

File tree

doc/source/testing.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,17 @@ How tests are driven (testme scripts)
7171
Each test directory contains a small Python "testMe" driver that uses the helper Python
7272
class documented in the repository:
7373

74+
- See the test launcher documentation: :doc:`test.py <testing/testLauncher>`
7475
- See the test helper documentation: :doc:`idfxTest <testing/idfxTest>`
7576

76-
That helper (idfxTest) is responsible for:
77+
The test launcher (test.py) is responsible for:
78+
79+
- Loading all the test definitions by search all the ``testme.json`` files in the ``test``
80+
directory.
81+
- Calling the :doc:`idfxTest <testing/idfxTest>` helper to run the particular test.
82+
- Generate reports about success and failures.
83+
84+
The helper (idfxTest) is responsible for:
7785

7886
- parsing TESTME_OPTIONS-like flags (precision, MPI, CUDA, reconstruction, vector potential, etc.),
7987
- calling configure / compile / run,
@@ -108,10 +116,12 @@ Relevant files
108116

109117
- Workflow entry point: .github/workflows/idefix-ci.yml
110118
- Reusable jobs: .github/workflows/idefix-ci-jobs.yml
119+
- Test launcher documentation: :doc:`test launcher <testing/testLauncher>`
111120
- Test helper documentation: :doc:`idfxTest <testing/idfxTest>`
112121

113122
.. toctree::
114123
:maxdepth: 2
115124
:caption: Contents:
116125

126+
testing/testLauncher.rst
117127
testing/idfxTest.rst

0 commit comments

Comments
 (0)