leanprover / leanprover/reference-manual
Improve testing of Lake examples
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
Right now, only the parsing of Lake configuration examples is tested. This risks missing later validation steps, such as in #272.
Ideally, Lake snippets would be tested more thoroughly. Some of the validation steps require actually running Lake with real packages, however - the error thrown in #272 happens while actually fetching the package from Reservoir. A proper test setup would need to run a small Reservoir-compatible server and run Lake in a project in a temporary directory.
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 reviewing the existing tests for parsing Lake configuration examples and the Lake snippets they cover. Define a temporary-directory project test that can run Lake against a small Reservoir-compatible server, then extend coverage beyond parsing to package-fetching and later validation steps such as the failure described in #272.
Written by the indexing model from the issue text.
Assessment
- Domain
- testing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100