Skip to content

Commit

Permalink
chore(tests): add large model test marker to pytest.ini
Browse files Browse the repository at this point in the history
  • Loading branch information
wpbonelli committed Jan 17, 2023
1 parent 0b4e70d commit 33d7e9b
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 109 deletions.
34 changes: 27 additions & 7 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ This document describes how to set up a development environment to modify, build
- [Building](#building)
- [Testing](#testing)
- [Configuring a test environment](#configuring-a-test-environment)
- [Testing](#testing-1)
- [Building development binaries](#building-development-binaries)
- [Rebuilding and installing release binaries](#rebuilding-and-installing-release-binaries)
- [Updating `flopy` plugins](#updating-flopy-plugins)
Expand All @@ -41,6 +40,7 @@ This document describes how to set up a development environment to modify, build
- [Running Tests](#running-tests)
- [Selecting tests with markers](#selecting-tests-with-markers)
- [External model tests](#external-model-tests)
- [Writing tests](#writing-tests)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down Expand Up @@ -237,7 +237,6 @@ MODFLOW 6 tests are driven with [`pytest`](https://docs.pytest.org/en/7.1.x/), w

A few tasks must be completed before running tests:

## Testing
- build local MODFLOW 6 development version
- rebuild the last MODFLOW 6 release
- install additional executables
Expand Down Expand Up @@ -362,6 +361,8 @@ pytest -v -n auto
Markers can be used to select subsets of tests. Markers provided in `pytest.ini` include:

- `slow`: tests that take longer than a few seconds to complete
- `repo`: tests that require external model repositories
- `large`: tests using large models (from the `modflow6-examples` and `modflow6-largetestmodels` repos)
- `regression`: tests comparing results from multiple versions

Markers can be used with the `-m <marker>` option, and can be applied in boolean combinations with `and`, `or` and `not`. For instance, to run fast tests in parallel, excluding regression tests:
Expand All @@ -386,18 +387,37 @@ Tests using models from external repositories can be selected with the `repo` ma
pytest -v -n auto -m "repo"
```

The test scripts can also be run independently:
The `large` marker is a subset of the `repo` marker. To test models excluded from commit-triggered CI and only run on GitHub Actions nightly:

```shell
pytest -v -n auto -m "large"
```

Test scripts for external model repositories can also be run independently:

```shell
# Run MODFLOW 6 test models
# MODFLOW 6 test models
pytest -v -n auto test_z01_testmodels_mf6.py

# Run MODFLOW 5 to 6 conversion test models
# MODFLOW 5 to 6 conversion test models
pytest -v -n auto test_z02_testmodels_mf5to6.py

# Run example models
# models from modflow6-examples repo
pytest -v -n auto test_z03_examples.py

# Run large test models
# models from modflow6-largetestmodels repo
pytest -v -n auto test_z03_largetestmodels.py
```

#### Writing tests

Tests should ideally follow a few conventions for easier maintenance:

- Use temporary directory fixtures. Tests which write to disk should use `pytest`'s built-in `tmp_path` fixtures or one of the [keepable temporary directory fixtures from `modflow-devtools`](https://modflow-devtools.readthedocs.io/en/latest/md/fixtures.html#keepable-temporary-directories). This prevents tests from polluting one another's state.

- Use markers for convenient (de-)selection:
- `@pytest.mark.slow` if the test doesn't complete in a few seconds (this preserves the ability to quickly [`--smoke` test](https://modflow-devtools.readthedocs.io/en/latest/md/markers.html#smoke-testing)
- `@pytest.mark.repo` if the test relies on external model repositories
- `@pytest.mark.regression` if the test compares results from different versions

The test suite must pass before code can be merged, so be sure it passes locally before opening a PR.
8 changes: 4 additions & 4 deletions autotest/pytest.ini
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ markers =
developmode: tests that should only run with IDEVELOPMODE = 1
gwf: tests for groundwater flow models
gwt: tests for groundwater transport models
ats: tests for adaptive time step utility plugin
aux: tests for auxiliary variables plugin
lak: tests for flow lake plugin
maw: tests for multi-aquifer well plugin
ats: tests for adaptive time step package
aux: tests for auxiliary variables
lak: tests for lake package
maw: tests for multi-aquifer well package
98 changes: 0 additions & 98 deletions autotest/targets.py

This file was deleted.

0 comments on commit 33d7e9b

Please sign in to comment.