Add an EventuallyChecker #141
Open
Conversation
This file contains 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
|
@rogpeppe ptal when you have the chance, this is an implementation proposal for the Eventually checker you proposed |
frankban
reviewed
May 13, 2022
eventually.go
Outdated
| break | ||
| } | ||
| if !i.Next(nil) { | ||
| note("got", got) |
There was a problem hiding this comment.
Can't we trust that the underlying checker already notes the got argument?
There was a problem hiding this comment.
The problem is that the got argument is not noted by the checkers, it's appended to the output by the caller in writeError according to the parameter passed to the Eventually checker, which is a function. So the output will look like this:
got: func () int {...}
want: 42
We need overwrite that and that's why I added it as a note and then changed the logic slightly in writeError to skip any provided argument if they are already in the notes.
| @@ -90,9 +90,12 @@ func writeError(w io.Writer, err error, p reportParams) { | |||
| } | |||
|
|
|||
| // Write notes if present. | |||
| noteKeys := map[string]bool{} | |||
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.
This PR proposes one form of an EventuallyChecker, which allows asserting eventually (i.e. retry for a given period of time until the assertion holds true) and also for stability (i.e. retry for a given period of time during which the assertion should still hold true).
The EventuallyChecker implements the Checker interface so it can be used like any regular checker. It expects as argument a function with no parameters and one return value.
See issue #121.