OpenFreeEnergy / OpenFreeEnergy/openfe
Add env variables to openfe tests
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 331
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
We now have "slow", "integration" (aka real slow), and "downloads" category tests.
After discussions our plan is:
a) Not rely on pytest plugins for controlling this (to avoid issues with plugin discovery)
b) Have the default options as "downloads=True", "slow=False", "integration=False"
c) These will be controlled by environment variables (suggestions below):
- OFE_SLOW
- OFE_VERY_SLOW
- OFE_DOWNLOADS
d) The user defined approach to running tests will be via openfe cli (allowing us to run tests for gufe, openfe, openfecli, and any key protocols)
e) The openfecli entry point will include flags to control all the above environment variables.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the test configuration and the openfecli entry point that runs tests across the related projects. Read how the slow, integration, and downloads categories are currently selected, then verify that the documented environment variables and CLI flags control them with the stated defaults. Done means the categories can be selected without relying on pytest plugin discovery.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, testing-qa
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100