Allow tests to be cancelled via a context in library mode #58
+23
−12
Conversation
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
The internals of uptest respect context cancellation, but previously it wasn't possible to pass a context in when calling uptest as a library. This meant that callers couldn't cancel tests, for example when receiving a signal. Rename `RunTest` to `RunTestContext` and add a context argument. Make `RunTest` a wrapper that uses `context.Background()` to avoid a breaking change for any existing users, but mark the context-free version as deprecated. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description of your changes
The internals of uptest respect context cancellation, but previously it wasn't possible to pass a context in when calling uptest as a library. This meant that callers couldn't cancel tests, for example when receiving a signal.
Rename
RunTesttoRunTestContextand add a context argument. MakeRunTesta wrapper that usescontext.Background()to avoid a breaking change for any existing users, but mark the context-free version as deprecated.I have:
make reviewable testto ensure this PR is ready for review.How has this code been tested
upCLI to verify that cancellation works.