Skip to content

Commit

Permalink
Rework description of --config local tests (#3402)
Browse files Browse the repository at this point in the history
The previous description of putting --config local tests into /sites/ and /integration/ does not reflect the reality of current Parsl development.
  • Loading branch information
benclifford committed Apr 26, 2024
1 parent 92ad7a7 commit 2697bb7
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions CONTRIBUTING.rst
Expand Up @@ -50,19 +50,17 @@ There are two broad groups of tests: those which must run with a
specific configuration, and those which should work with any
configuration.

Tests which run with a specific configuration live under the
``parsl/tests/sites`` and ``parsl/tests/integration`` directories.
They can be launched with a pytest parameter of
``--config local`` and each test file should initialise a DFK
explicitly.

Tests which should run with with any configuration live under
themed directories ``parsl/tests/test*/`` and should be named ``test*.py``.
They can be run with any configuration, by specifying ``--config CONFIGPATH``
where CONFIGPATH is a path to a ``.py`` file exporting a parsl configuration
object named ``config``. The parsl-specific test fixtures will ensure
a suitable DFK is loaded with that configuration for each test.

Tests which require their own specially configured DFK, or no DFK at all,
should be labelled with ``@pytest.mark.local`` and can be run with
``--config local``.

There is more fine-grained enabling and disabling of tests within the
above categories:

Expand Down

0 comments on commit 2697bb7

Please sign in to comment.