oxidecomputer / oxidecomputer/crucible
Audit test-only functions and public data
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 260
- Forks
- 34
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 8
Description
Once #1058 is merged, there will be a bunch of helper functions which #[cfg(test)], and member variables which are only pub(crate) for the sake of testing. We should audit them and see whether they're necessary, or whether we can perform equivalent testing using only the same public APIs that are used in normal runtime operation.
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 changes from #1058, then locate the #[cfg(test)] helper functions and pub(crate) members that exist for testing. Audit whether each is necessary or can be tested through the public APIs used at runtime. Done means the test-only access is removed where equivalent public-API coverage is possible, with remaining exceptions justified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- backend, testing
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100