Delete `*.golden` file tests?
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 11.5k
- Forks
- 1.4k
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 53
Description
We have dozens (hundreds?) of "golden" files that we use in tests to compare against CLI-generated output. Any time our generated code changes, we simply regenerate all of these files. In most cases, we don't actually validate that these files are even valid manifests...
What benefit do these tests offer? What errors do they prevent? If we removed all of these tests, what sorts of bugs might be likely to encounter?
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
No files or specific tests are named. Start by searching the repository for *.golden files and the CLI test harnesses that generate or compare them, then identify which behaviors they cover and whether validity is checked. Done means documenting the risks and reaching a clear decision about retaining, replacing, or removing the tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, testing
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100