Add linting to flag outdir being set in test_full or test
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
Some pipelines set outdir in their test_full config to a local results path. This is not flagged on the full-size tests, because we explicitly overwrite it. However, it can trip up users when they run the pipelines on their system. Since outdir is already defined the parameter validation does not catch it. Depending on the system they will only notice it, when the pipeline has completed and the results folder is missing.
It would be great to have a linting option that checks that outdir is not defined in any of the test configs.
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 linting entry point and the tests covering pipeline test configurations. Trace how test and test_full configs are inspected, then add coverage showing that an outdir defined in either config is reported; done means the linting option flags these definitions without affecting full-size test behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100