feat(build): add job states filter to build view command (#735)

* feat(build): add job states filter to build view command

Adds a --job-states (-s) flag to `bk build view` that filters jobs by
state using the new JobStates option in go-buildkite v4.17.0.

* test(build): add tests for build view job states filter

Extract buildGetOptions method on ViewCmd and add unit tests covering
multiple, single, and empty job state filtering.

Author: wolfeidau

cmd/build/view.go

@@ -21,12 +21,13 @@ import (
 )
 
 type ViewCmd struct {
-	BuildNumber string `arg:"" optional:"" help:"Build number to view (omit for most recent build)"`
-	Pipeline    string `help:"The pipeline to use. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}." short:"p"`
-	Branch      string `help:"Filter builds to this branch." short:"b"`
-	User        string `help:"Filter builds to this user. You can use name or email." short:"u" xor:"userfilter"`
-	Mine        bool   `help:"Filter builds to only my user." xor:"userfilter"`
-	Web         bool   `help:"Open the build in a web browser." short:"w"`
+	BuildNumber string   `arg:"" optional:"" help:"Build number to view (omit for most recent build)"`
+	Pipeline    string   `help:"The pipeline to use. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}." short:"p"`
+	Branch      string   `help:"Filter builds to this branch." short:"b"`
+	User        string   `help:"Filter builds to this user. You can use name or email." short:"u" xor:"userfilter"`
+	Mine        bool     `help:"Filter builds to only my user." xor:"userfilter"`
+	JobStates   []string `help:"Filter jobs by state. Valid states: running, scheduled, passed, failed, canceled, skipped, not_run, broken." short:"s" sep:","`
+	Web         bool     `help:"Open the build in a web browser." short:"w"`
 	output.OutputFlags
 }
 
@@ -55,11 +56,21 @@ Examples:
   # A shortcut to view your builds is --mine
   $ bk build view --mine
 
+  # Filter to only show failed and broken jobs
+  $ bk build view -s failed,broken
+
   # You can combine most of these flags
   # To view most recent build by greg on the deploy-pipeline
   $ bk build view -p deploy-pipeline -u "greg"`
 }
 
+func (c *ViewCmd) buildGetOptions() *buildkite.BuildGetOptions {
+	if len(c.JobStates) > 0 {
+		return &buildkite.BuildGetOptions{JobStates: c.JobStates}
+	}
+	return nil
+}
+
 func (c *ViewCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
 	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
@@ -150,7 +161,7 @@ func (c *ViewCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
 				opts.Organization,
 				opts.Pipeline,
 				fmt.Sprint(opts.BuildNumber),
-				nil,
+				c.buildGetOptions(),
 			)
 			if apiErr != nil {
 				mu.Lock()

cmd/build/view_test.go

@@ -0,0 +1,56 @@
+package build
+
+import (
+	"testing"
+)
+
+func TestViewCmd_BuildGetOptions_WithJobStates(t *testing.T) {
+	cmd := &ViewCmd{
+		JobStates: []string{"failed", "broken"},
+	}
+
+	opts := cmd.buildGetOptions()
+	if opts == nil {
+		t.Fatal("Expected non-nil BuildGetOptions")
+	}
+
+	if len(opts.JobStates) != 2 {
+		t.Fatalf("Expected 2 job states, got %d", len(opts.JobStates))
+	}
+
+	if opts.JobStates[0] != "failed" {
+		t.Errorf("Expected first state to be 'failed', got %q", opts.JobStates[0])
+	}
+
+	if opts.JobStates[1] != "broken" {
+		t.Errorf("Expected second state to be 'broken', got %q", opts.JobStates[1])
+	}
+}
+
+func TestViewCmd_BuildGetOptions_Empty(t *testing.T) {
+	cmd := &ViewCmd{}
+
+	opts := cmd.buildGetOptions()
+	if opts != nil {
+		t.Errorf("Expected nil BuildGetOptions when no job states, got %+v", opts)
+	}
+}
+
+func TestViewCmd_BuildGetOptions_SingleState(t *testing.T) {
+	cmd := &ViewCmd{
+		JobStates: []string{"running"},
+	}
+
+	opts := cmd.buildGetOptions()
+	if opts == nil {
+		t.Fatal("Expected non-nil BuildGetOptions")
+	}
+
+	if len(opts.JobStates) != 1 {
+		t.Fatalf("Expected 1 job state, got %d", len(opts.JobStates))
+	}
+
+	if opts.JobStates[0] != "running" {
+		t.Errorf("Expected state to be 'running', got %q", opts.JobStates[0])
+	}
+}