Skip webbpsf tests by default #958
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WilliamJamieson
requested review from
zacharyburnett and
bmorris3
and removed request for
a team
WilliamJamieson
commented
Oct 27, 2023
romancal/conftest.py
Outdated
|
|
||
| def pytest_addoption(parser): | ||
| parser.addoption( | ||
| "--webbpsf", action="store_true", default=False, help="run webbpsf tests" |
There was a problem hiding this comment.
Technically, we could set default to be true if users happen to have the WEBBPSF_PATH environment variable set.
zacharyburnett
approved these changes
Oct 27, 2023
There was a problem hiding this comment.
Looks good! Should the readme instructions also be updated?
Line 188 in 13c316e
- Additionally, currently WebbPSF data is also required. Follow [these instructions to download the data files / point to existing files on the shared internal network](https://webbpsf.readthedocs.io/en/latest/installation.html#data-install).
+ Additionally, if it is desired to run tests against WebbPSF data, use the `pytest --webbpsf` flag or the `-webbpsf` tox factor and follow [these instructions to download the data files / point to existing files on the shared internal network](https://webbpsf.readthedocs.io/en/latest/installation.html#data-install). 
This is to make it simpler for users to run their tests.
WilliamJamieson
force-pushed
the
testing/skip_webbpsf
branch
from
58be002 to
fa8c473
Compare
github-actions
bot
added
the
documentation
WilliamJamieson
force-pushed
the
testing/skip_webbpsf
branch
from
fa8c473 to
15c3000
Compare
Codecov ReportAttention:
📢 Thoughts on this report? Let us know!. |
5 tasks
ddavis-stsci
pushed a commit
to ddavis-stsci/romancal
that referenced
this pull request
Nov 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently the
romancaltesting runs tests which require thewebbpsf's input data by default. This is undesirable because it requires users to have to set up this data in order for the test suite to complete successfully.This PR adds the
--webbpsfmarker which enables these tests. This means that the--webbpsfflag must be passed topytestin order to run the tests in question. This means that by default thewebbpsfmarked tests are not run. However,this PR does add this marker to every CI job both on GitHub and Jenkins, so that the CI will always run the
webbpsftests. This means we will know prior to merging any changes if these tests are broken while also removing the burden of requiring outside users to not have to worry aboutwebbpsf.Checklist
CHANGES.rstunder the corresponding subsection