Skip to content

Commit

Permalink
Add CONTRIBUTING note on local test config framework (#3438)
Browse files Browse the repository at this point in the history
Co-authored-by: Logan Ward <WardLT@users.noreply.github.com>
  • Loading branch information
benclifford and WardLT committed May 17, 2024
1 parent a7cf9b4 commit bdb9e63
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ 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``.
Provide the special configuration creating a ``local_config`` function
that returns the required configuration in that test file.
Or, provide both a ``local_setup`` function that loads the proper configuration
and ``local_teardown`` that stops parsl.

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

0 comments on commit bdb9e63

Please sign in to comment.