Skip to content

Commit 436c368

Browse files
committed
Updating test paths for python unit tests and script.
1 parent 27f58e4 commit 436c368

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/development/cam-testing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,21 +129,21 @@ CAM-SIMA supports two kinds of python unit tests, `doctest` and `unittest` tests
129129

130130
All `unittest` tests should be in:
131131

132-
`CAM-SIMA/test/unit`
132+
`CAM-SIMA/test/unit/python`
133133

134134
while all files used by the tests should be in:
135135

136-
`CAM-SIMA/test/unit/sample_files`
136+
`CAM-SIMA/test/unit/python/sample_files`
137137

138138
All `unittest` tests are automatically run via Github Actions whenever a Pull Request (PR) is opened, modified, or merged.
139139

140140
All `doctest` tests are also run automatically as long as the scripts they are located in are under `CAM-SIMA/cime_config` or `CAM-SIMA/src/data`.
141141

142142
To manually run all of the unit tests at any time, simply run the following shell script:
143143

144-
`CAM-SIMA/test/run_unit_tests.sh`
144+
`CAM-SIMA/test/run_python_unit_tests.sh`
145145

146-
Finally, when adding new tests, determine if the test can be done in only a few lines with minimal interaction with external files or variables. If so, then it would likely be best as a `doctest`. Otherwise it should be a `unittest` test. Failure to follow this rule of thumb could result in test failures in the Github Actions workflow. Also remember to add your new tests to the `run_tests.sh` script so future users can easily run the tests manually.
146+
Finally, when adding new tests, determine if the test can be done in only a few lines with minimal interaction with external files or variables. If so, then it would likely be best as a `doctest`. Otherwise it should be a `unittest` test. Failure to follow this rule of thumb could result in test failures in the Github Actions workflow. Also remember to add your new tests to the `run_python_unit_tests.sh` script so future users can easily run the tests manually.
147147

148148
#### Updating sample files
149149
If you modified any python files in your code modifications (those in `cime_config` or in `src/data`), you may need to update the sample files to match what is now expected.

0 commit comments

Comments
 (0)