-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
greplogs: refine output for issue triage #11
Closed
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| // Copyright 2022 The Go Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| // Command broken lists the current Go builders with known issues. | ||
| // | ||
| // To test this program, cd to its directory and run: | ||
| // go mod init | ||
| // go get golang.org/x/build/dashboard@HEAD | ||
| // go run . | ||
| // rm go.mod go.sum | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "golang.org/x/build/dashboard" | ||
| ) | ||
|
|
||
| func main() { | ||
| for _, b := range dashboard.Builders { | ||
| if len(b.KnownIssues) > 0 { | ||
| fmt.Println(b.Name) | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| // Copyright 2022 The Go Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| _ "embed" | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| "path/filepath" | ||
| "sort" | ||
| "strings" | ||
| ) | ||
|
|
||
| //go:embed _embed/broken.go | ||
| var brokenScript []byte | ||
|
|
||
| // listBrokenBuilders returns the builders that are marked | ||
| // as broken in golang.org/x/build/dashboard at HEAD. | ||
| func listBrokenBuilders() (broken []string, err error) { | ||
| defer func() { | ||
| if err != nil { | ||
| err = fmt.Errorf("identifying broken builders: %v", err) | ||
| } | ||
| }() | ||
|
|
||
| // Though this be madness, yet there is method in 't. | ||
| // | ||
| // Our goals here are: | ||
| // | ||
| // 1. Always use the most up-to-date information about broken builders, even | ||
| // if the user hasn't recently updated the greplogs binary. | ||
| // | ||
| // 2. Avoid the need to massively refactor the builder configuration right | ||
| // now. (Currently, the Go builders are configured programmatically in the | ||
| // x/build/dashboard package, not in external configuration files.) | ||
| // | ||
| // 3. Avoid the need to redeploy a production x/build/cmd/coordinator or | ||
| // x/build/devapp to pick up changes. (A user triaging test failures might | ||
| // not have access to deploy the coordinator, or might not want to disrupt | ||
| // running tests or active gomotes by pushing it.) | ||
| // | ||
| // Goals (2) and (3) imply that we must use x/build/dashboard, not fetch the | ||
| // list from build.golang.org or dev.golang.org. Since that is a Go package, | ||
| // we must run it as a Go program in order to evaluate it. | ||
| // | ||
| // Goal (1) implies that we must use x/build at HEAD, not (say) at whatever | ||
| // version of x/build this command was built with. We could perhaps relax that | ||
| // constraint if we move greplogs itself into x/build and consistently triage | ||
| // using 'go run golang.org/x/build/cmd/greplogs@HEAD' instead of an installed | ||
| // 'greplogs'. | ||
|
|
||
| if os.Getenv("GO111MODULE") == "off" { | ||
| return nil, errors.New("operation requires GO111MODULE=on or auto") | ||
| } | ||
|
|
||
| modDir, err := os.MkdirTemp("", "greplogs") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| defer func() { | ||
| removeErr := os.RemoveAll(modDir) | ||
| if err == nil { | ||
| err = removeErr | ||
| } | ||
| }() | ||
|
|
||
| runCommand := func(name string, args ...string) ([]byte, error) { | ||
| cmd := exec.Command(name, args...) | ||
| cmd.Dir = modDir | ||
| cmd.Env = append(os.Environ(), | ||
| "PWD="+modDir, // match cmd.Dir | ||
| "GOPRIVATE=golang.org/x/build", // avoid proxy cache; see https://go.dev/issue/38065 | ||
| ) | ||
| cmd.Stderr = new(strings.Builder) | ||
|
|
||
| out, err := cmd.Output() | ||
| if err != nil { | ||
| return out, fmt.Errorf("%s: %w\nstderr:\n%s", strings.Join(cmd.Args, " "), err, cmd.Stderr) | ||
| } | ||
| return out, nil | ||
| } | ||
|
|
||
| _, err = runCommand("go", "mod", "init", "github.com/aclements/go-misc/greplogs/_embed") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| _, err = runCommand("go", "get", "golang.org/x/build/dashboard@HEAD") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| err = os.WriteFile(filepath.Join(modDir, "broken.go"), brokenScript, 0644) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| out, err := runCommand("go", "run", "broken.go") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| broken = strings.Split(strings.TrimSpace(string(out)), "\n") | ||
| sort.Strings(broken) | ||
| return broken, nil | ||
| } | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was certainly... unexpected. I assume the idea here is that we actually need to get whatever's at HEAD to get the current broken builders and there's not, like, an RPC API we can hit to get this?
If I'm understanding right, this definitely could use a comment explaining the rationale here. (Also, could we instead add a dashboard API to get this?)
The other thing I wonder is how well-defined this is at all. This will get the list of broken builders right now, but greplogs is all about digging back in history. Doesn't this mean it could miss real failures that happened before a builder was marked broken, and surface expected failures after a builder stops being marked broken?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct. And even if there was an RPC API, because the configuration is encoded as a Go package we would have to push a new version of some server every time we wanted to update it.
Done!
Yep! That's why we only use this if the
--triageflag is set — we don't have a log of which builders were broken at which commits (and that would be fairly tedious to maintain), so instead we bias toward over-suppressing failures for builders that are currently broken.(If triage falls too far behind and a builder is already fixed, a user can explicitly notch out additional previously-broken builders using the
--omitflag.)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't we have to do redeploy whenever the broken builder list changes anyway? As far as most people are concerned, the broken builders are whatever's grayed out on the dashboard. If the dashboard was also serving this list via an API, it would match up with whatever's grayed out.
(There's a bigger question here of whether it makes sense for this to be configured in a giant Go struct that can't track history and requires a redeploy on any changes, but that's for another time...)