Merge pull request #435 from depot/luke/jj-xoqspmnyvtoz

feat: `depot ci run list`

Author: lukevmorris

pkg/api/ci.go

@@ -58,6 +58,49 @@ func CIRun(ctx context.Context, token string, req *civ1.RunRequest) (*civ1.RunRe
 	return resp.Msg, nil
 }
 
+// CIListRuns returns CI runs, paginating as needed to collect up to `limit` results.
+// If limit is 0, all results are returned.
+func CIListRuns(ctx context.Context, token string, statuses []civ1.CIRunStatus, limit int32) ([]*civ1.ListRunsResponseRun, error) {
+	client := newCIServiceClient()
+	var allRuns []*civ1.ListRunsResponseRun
+	var pageToken string
+
+	for {
+		pageSize := limit
+		if limit > 0 {
+			remaining := limit - int32(len(allRuns))
+			if remaining <= 0 {
+				break
+			}
+			pageSize = remaining
+		}
+
+		req := &civ1.ListRunsRequest{
+			Status:    statuses,
+			PageSize:  pageSize,
+			PageToken: pageToken,
+		}
+		resp, err := client.ListRuns(ctx, WithAuthentication(connect.NewRequest(req), token))
+		if err != nil {
+			return nil, err
+		}
+
+		allRuns = append(allRuns, resp.Msg.Runs...)
+
+		if limit > 0 && int32(len(allRuns)) >= limit {
+			allRuns = allRuns[:limit]
+			break
+		}
+
+		if resp.Msg.NextPageToken == "" {
+			break
+		}
+		pageToken = resp.Msg.NextPageToken
+	}
+
+	return allRuns, nil
+}
+
 func newCISecretServiceClient() civ1connect.SecretServiceClient {
 	baseURL := baseURLFunc()
 	return civ1connect.NewSecretServiceClient(getHTTPClient(baseURL), baseURL, WithUserAgent())

pkg/cmd/ci/run.go

@@ -2,6 +2,7 @@ package ci
 
 import (
 	"crypto/sha256"
+	"encoding/json"
 	"fmt"
 	"os"
 	"os/exec"
@@ -201,6 +202,8 @@ This command is in beta and subject to change.`,
 	cmd.Flags().StringSliceVar(&jobNames, "job", nil, "Job name(s) to run (repeatable; omit to run all)")
 	cmd.Flags().IntVar(&sshAfterStep, "ssh-after-step", 0, "1-based step index to insert a tmate debug step after (requires single --job)")
 
+	cmd.AddCommand(NewCmdRunList())
+
 	return cmd
 }
 
@@ -399,3 +402,155 @@ func injectTmateStep(jobs map[string]interface{}, jobName string, afterStep int,
 
 	return nil
 }
+
+// validStatuses are the user-facing status names accepted by --status.
+var validStatuses = []string{"queued", "running", "finished", "failed", "cancelled"}
+
+func parseStatus(s string) (civ1.CIRunStatus, error) {
+	switch strings.ToLower(s) {
+	case "queued":
+		return civ1.CIRunStatus_CI_RUN_STATUS_QUEUED, nil
+	case "running":
+		return civ1.CIRunStatus_CI_RUN_STATUS_RUNNING, nil
+	case "finished":
+		return civ1.CIRunStatus_CI_RUN_STATUS_FINISHED, nil
+	case "failed":
+		return civ1.CIRunStatus_CI_RUN_STATUS_FAILED, nil
+	case "cancelled":
+		return civ1.CIRunStatus_CI_RUN_STATUS_CANCELLED, nil
+	default:
+		return 0, fmt.Errorf("invalid status %q, valid values: %s", s, strings.Join(validStatuses, ", "))
+	}
+}
+
+func formatStatus(s civ1.CIRunStatus) string {
+	switch s {
+	case civ1.CIRunStatus_CI_RUN_STATUS_QUEUED:
+		return "queued"
+	case civ1.CIRunStatus_CI_RUN_STATUS_RUNNING:
+		return "running"
+	case civ1.CIRunStatus_CI_RUN_STATUS_FINISHED:
+		return "finished"
+	case civ1.CIRunStatus_CI_RUN_STATUS_FAILED:
+		return "failed"
+	case civ1.CIRunStatus_CI_RUN_STATUS_CANCELLED:
+		return "cancelled"
+	default:
+		return "unknown"
+	}
+}
+
+func NewCmdRunList() *cobra.Command {
+	var (
+		token    string
+		statuses []string
+		n        int32
+		output   string
+	)
+
+	cmd := &cobra.Command{
+		Use:   "list",
+		Short: "List CI runs",
+		Long:  `List CI runs for your organization.`,
+		Example: `  # List runs (defaults to queued and running)
+  depot ci run list
+
+  # List failed runs
+  depot ci run list --status failed
+
+  # List finished and failed runs
+  depot ci run list --status finished --status failed
+
+  # List the 5 most recent runs
+  depot ci run list -n 5
+
+  # Output as JSON
+  depot ci run list --output json`,
+		Aliases: []string{"ls"},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if n <= 0 {
+				return fmt.Errorf("page size (-n) must be greater than 0")
+			}
+
+			ctx := cmd.Context()
+
+			tokenVal, err := helpers.ResolveOrgAuth(ctx, token)
+			if err != nil {
+				return err
+			}
+			if tokenVal == "" {
+				return fmt.Errorf("missing API token, please run `depot login`")
+			}
+
+			var protoStatuses []civ1.CIRunStatus
+			for _, s := range statuses {
+				ps, err := parseStatus(s)
+				if err != nil {
+					return err
+				}
+				protoStatuses = append(protoStatuses, ps)
+			}
+
+			runs, err := api.CIListRuns(ctx, tokenVal, protoStatuses, n)
+			if err != nil {
+				return fmt.Errorf("failed to list runs: %w", err)
+			}
+
+			if output == "json" {
+				enc := json.NewEncoder(os.Stdout)
+				enc.SetIndent("", "  ")
+				return enc.Encode(runs)
+			}
+
+			if len(runs) == 0 {
+				fmt.Println("No runs found.")
+				return nil
+			}
+
+			fmt.Printf("%-24s %-30s %-12s %-10s %-12s %s\n", "RUN ID", "REPO", "SHA", "STATUS", "TRIGGER", "CREATED")
+			fmt.Printf("%-24s %-30s %-12s %-10s %-12s %s\n",
+				strings.Repeat("-", 24),
+				strings.Repeat("-", 30),
+				strings.Repeat("-", 12),
+				strings.Repeat("-", 10),
+				strings.Repeat("-", 12),
+				strings.Repeat("-", 20),
+			)
+
+			for _, run := range runs {
+				repo := run.Repo
+				if len(repo) > 30 {
+					repo = repo[:27] + "..."
+				}
+
+				sha := run.Sha
+				if len(sha) > 12 {
+					sha = sha[:12]
+				}
+
+				trigger := run.Trigger
+				if len(trigger) > 12 {
+					trigger = trigger[:9] + "..."
+				}
+
+				fmt.Printf("%-24s %-30s %-12s %-10s %-12s %s\n",
+					run.RunId,
+					repo,
+					sha,
+					formatStatus(run.Status),
+					trigger,
+					run.CreatedAt,
+				)
+			}
+
+			return nil
+		},
+	}
+
+	cmd.Flags().StringVar(&token, "token", "", "Depot API token")
+	cmd.Flags().StringSliceVar(&statuses, "status", nil, "Filter by status (repeatable: queued, running, finished, failed, cancelled)")
+	cmd.Flags().Int32VarP(&n, "n", "n", 50, "Number of runs to return")
+	cmd.Flags().StringVarP(&output, "output", "o", "", "Output format (json)")
+
+	return cmd
+}