poll: Continue(): use format.Message for formatting #279
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
thaJeztah
force-pushed
the
poll_msgAndArgs
branch
from
7e0fb1f to
97d125f
Compare
|
Windows failure looks unrelated; not sure what's causing it though; |
|
fix for the panic in this PR: |
|
@dnephin @vdemeester PTAL 🤗 |
vdemeester
approved these changes
Aug 22, 2024
dnephin
reviewed
Aug 24, 2024
There was a problem hiding this comment.
It is possible this could be a breaking change for some code, but it seems unlikely.
The problem the linter is complaining about is still there. Ex:
errorMsg := "invalid %size% value '4f'"
poll.Continue(errorMsg)
// invalid %!s(MISSING)ize%!v(MISSING)alue '4f'Maybe there should have been both a Continue and Continuef.
Another option would be to add an issues.exclude-rule to https://github.com/moby/moby/blob/master/.golangci.yml:
// ignore possible invalid format strings in test helper
- path: _test\.go
linters: [govet]
text: non-constant format string in call to gotest.tools/v3/poll.Continue
or to be safe
return poll.Continue("%v", msg)
dnephin
reviewed
Aug 24, 2024
Yes, works for me! I was initially considering doing that, but then went for the Let me update. |
Current versions of govet check for printf functions called with a format
string, but no arguments. This results in linting errors for uses of Continue
with a fixed message, for example:
poll/poll.go:154:18: printf: non-constant format string in call to gotest.tools/v3/poll.Continue (govet)
return Continue(buf.String())
^
While not explicitly called out in the function's GoDoc, I think the intent
was to provide the same behavior as the msgAndArgs arguments in the assert
package, which allows for either a literal message (or value), or a format
with arguments to be passed.
Accepting a non-string variable as first argument would require a change
of the function's signature, but we can use the format.Message function
internally to fix the linting issue.
Signed-off-by: Sebastiaan van Stijn <[email protected]>
thaJeztah
force-pushed
the
poll_msgAndArgs
branch
from
97d125f to
7f28766
Compare
thaJeztah
changed the title
|
Oh; forgot to coment; I updated with your suggestions; @dnephin PTAL 🤗 |
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.
Current versions of govet check for printf functions called with a format
string, but no arguments. This results in linting errors for uses of Continue
with a fixed message, for example:
While not explicitly called out in the function's GoDoc, I think the intent
was to provide the same behavior as the msgAndArgs arguments in the assert
package, which allows for either a literal message (or value), or a format
with arguments to be passed.
Accepting a non-string variable as first argument would require a change
of the function's signature, but we can use the format.Message function
internally to fix the linting issue.