Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ test/**/*.pyc
test/**/*.dat
test/**/cmake_packages*
test/**/
idefix-tests.junit.xml

# machine specific cache and hidden files
.*
Expand Down
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ repos:
rev: v5.0.2
hooks:
- id: inifix-format
files: ^(test/).*\.(ini)$ # want to skip pytest.ini

- repo: https://github.com/Lucas-C/pre-commit-hooks
rev: v1.5.5
Expand Down
12 changes: 11 additions & 1 deletion doc/source/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,17 @@ How tests are driven (testme scripts)
Each test directory contains a small Python "testMe" driver that uses the helper Python
class documented in the repository:

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

That helper (idfxTest) is responsible for:
The test launcher (test.py) is responsible for:

- Loading all the test definitions by search all the ``testme.json`` files in the ``test``
directory.
- Calling the :doc:`idfxTest <testing/idfxTest>` helper to run the particular test.
- Generate reports about success and failures.

The helper (idfxTest) is responsible for:

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

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

.. toctree::
:maxdepth: 2
:caption: Contents:

testing/testLauncher.rst
testing/idfxTest.rst
3 changes: 3 additions & 0 deletions doc/source/testing/idfxTest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ The constructor parses command-line arguments using ``argparse``. These options
* - ``-Werror``
- ``Werror``
- Treat compiler warnings as errors.
* - ``-ccache``
- ``ccache``
- Enable usage of ccache to build the tests and reduce the build time.

Main Methods
------------
Expand Down
Loading
Loading