Skip to content

Commit

Permalink
Update testing_strategy.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gecoombs authored Nov 29, 2023
1 parent 0d60adb commit b33c03c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions tests/testing_strategy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Testing Strategy
When updating any files within the PolarRoute repository, tests must be run to ensure that the core functionality of the software remains unchanged. To allow for validation of changes, a suite of regression tests have been provided in the folder `tests/regression_tests/...`. These tests attempt to rebuild existing test cases using the changed code and compares these rebuilt outputs to the reference test files. If any differences are found, the tests will fail.
When updating any files within the MeshiPhi repository, tests must be run to ensure that the core functionality of the software remains unchanged. To allow for validation of changes, a suite of regression tests have been provided in the folder `tests/regression_tests/...`. These tests attempt to rebuild existing test cases using the changed code and compares these rebuilt outputs to the reference test files. If any differences are found, the tests will fail.

Evidence that all the required regression tests have passed needs to be submitted as part of a pull request. This should be in the form of a `pytest_output.txt` attached to the pull request.

Expand All @@ -19,12 +19,12 @@ Pull requests will not be accepted unless all required regression tests pass.
| `environment_mesh.py` | |
| | |
## Testing files
Some updates to PolarRoute may result in changes to meshes calculated in our tests suite (*such as adding additional attributes to the cellbox object*). These changes will cause the test suite to fail, though the mode of failure should be predictable.
Some updates to MeshiPhi may result in changes to meshes calculated in our tests suite (*such as adding additional attributes to the cellbox object*). These changes will cause the test suite to fail, though the mode of failure should be predictable.

Details of these failed tests should be submitted as part of the pull request in the form of a `pytest_failures.txt` file, as well as reasoning for a cause of the failures.

If the changes made are valid, the test files should be updated so-as the tests pass again, and evidence of the updated tests passing also submitted with the pull request.

### Files

`tests/regression_tests/example_meshes/*`
`tests/regression_tests/example_meshes/*`

0 comments on commit b33c03c

Please sign in to comment.