mockgen: format generated code without invoking go - #310
Open
podtserkovskiy wants to merge 1 commit into
Open
Conversation
mockgen formats its output with goimports, whose default import insert/delete
pass shells out to `go` (unconditionally since x/tools v0.27.0). That means the
`go` toolchain must be in $PATH just to format, breaking hermetic builds
(Buck, Bazel):
Failed to format generated source code: exec: "go": executable file not found in $PATH
mockgen already emits a complete import set, so set FormatOnly to skip that pass.
Output is byte-for-byte unchanged.
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
1 participant
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.
mockgen formats its output with goimports (
x/tools,imports.Process). With the default options that pass also inserts and deletes imports, and since x/tools v0.27.0 it shells out togounconditionally — even when there is nothing to fix. So mockgen needs thegotoolchain in$PATHpurely to format its output, which breaks hermetic builds (Buck, Bazel):mockgen already computes a complete, self-consistent import set (it even excludes the self/output package), so goimports has nothing to add or remove. Passing
FormatOnly: truekeeps the gofmt formatting and stdlib/third-party import grouping while skipping thegoinvocation.Verification
go generate ./...produces byte-for-byte identical output across the whole mock corpus (the insert/delete pass was a no-op).go build ./...andgo test ./...pass.goremoved from$PATHnow generates and formats a mock successfully (previously failed with the error above).Bisected the regression to x/tools v0.27.0 (v0.26.0 formats hermetically; v0.27.0+ requires
go).