Improve TestEnv for cleaner tests#4005
Open
mbg wants to merge 14 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the test-only TestEnv helper in src/testing-utils.ts into a builder-style API that enables cleaner test chaining and adds delayed log assertions, then updates existing config tests to use the new API.
Changes:
- Replaced
TestEnvwithEnvBuilder/CallableEnvBuilderand updatedcallee(...)to return the new builder. - Added delayed log assertion helpers (
logs,notLogs) and athrows(...)helper for more concise tests. - Updated
src/config/*.test.tstests to use.passes(t.is, ...),.throws(t, ...), and the new env/actions mutation helpers.
Show a summary per file
| File | Description |
|---|---|
| src/testing-utils.ts | Introduces the new builder-based test harness, delayed checks, and new assertion helpers. |
| src/config/remote-file.test.ts | Updates tests to the new callee(...).withEnv(...).withArgs(...).passes/throws chaining style. |
| src/config/file.test.ts | Simplifies config-file input tests using delayed log assertions and the new .passes(...) signature. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 4
- Review effort level: Low
6109575 to
d2e6ffe
Compare
Also extract env var strings into `ActionsEnvVars`
d2e6ffe to
d0a69d7
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Various changes to the test-only
TestEnvthat was introduced recently as part of #3990 to make tests nicer to write.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Environments:
How did/will you validate this change?
.test.tsfiles).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist