feat: Stage release with forceRun flag. Check cloudBuild trigger with triggersRun variable (#2150)

Stage release job with forceRun flag.
By default Stage release job will only be run on odd weeks, and forceRun
flag is False.
If forceRun is True, Stage release job can be run on even weeks.


Check cloudBuild trigger with triggersRun variable

#2060

Author: catchyzheng

infra/prod/stage-release-worker.yaml

@@ -24,6 +24,7 @@ steps:
       - '--project=$PROJECT_ID'
       - '--command=stage-release'
       - '--push=$_PUSH'
+      - '--force-run=$_FORCE_RUN'
 tags: ['stage-release-dispatcher']
 availableSecrets:
 options:

internal/automation/cli.go

@@ -20,6 +20,9 @@ import (
 	"log/slog"
 )
 
+// runCommandFn is a function type that matches RunCommand, for mocking in tests.
+var runCommandFn = RunCommand
+
 // Run parses the command line arguments and triggers the specified command.
 func Run(args []string) error {
 	ctx := context.Background()
@@ -29,7 +32,7 @@ func Run(args []string) error {
 		return err
 	}
 
-	err = RunCommand(ctx, options.Command, options.ProjectId, options.Push, options.Build)
+	err = runCommandFn(ctx, options.Command, options.ProjectId, options.Push, options.Build, options.ForceRun)
 	if err != nil {
 		slog.Error("Error running command", slog.Any("err", err))
 		return err
@@ -42,6 +45,7 @@ type runOptions struct {
 	ProjectId string
 	Push      bool
 	Build     bool
+	ForceRun  bool
 }
 
 func parseFlags(args []string) (*runOptions, error) {
@@ -50,6 +54,7 @@ func parseFlags(args []string) (*runOptions, error) {
 	command := flagSet.String("command", "generate", "The librarian command to run")
 	push := flagSet.Bool("push", true, "The _PUSH flag (true/false) to Librarian CLI's -push option")
 	build := flagSet.Bool("build", true, "The _BUILD flag (true/false) to Librarian CLI's -build option")
+	forceRun := flagSet.Bool("force-run", false, "The _FORCE_RUN flag (true/false) to Librarian CLI's -force-run option")
 	err := flagSet.Parse(args)
 	if err != nil {
 		return nil, err
@@ -59,5 +64,6 @@ func parseFlags(args []string) (*runOptions, error) {
 		Command:   *command,
 		Push:      *push,
 		Build:     *build,
+		ForceRun:  *forceRun,
 	}, nil
 }

internal/automation/cli_test.go

@@ -15,11 +15,50 @@
 package automation
 
 import (
+	"context"
+	"errors"
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
 )
 
+func TestRun(t *testing.T) {
+
+	tests := []struct {
+		name          string
+		args          []string
+		runCommandErr error
+		wantErr       bool
+	}{
+		{
+			name:    "success",
+			args:    []string{"--command=generate"},
+			wantErr: false,
+		},
+		{
+			name:    "error parsing flags",
+			args:    []string{"--unknown-flag"},
+			wantErr: true,
+		},
+		{
+			name:          "error from RunCommand",
+			args:          []string{"--command=generate"},
+			runCommandErr: errors.New("run command failed"),
+			wantErr:       true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			runCommandFn = func(ctx context.Context, command string, projectId string, push bool, build bool, forceRun bool) error {
+				return tt.runCommandErr
+			}
+			if err := Run(tt.args); (err != nil) != tt.wantErr {
+				t.Errorf("Run() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}
+
 func TestParseArgs(t *testing.T) {
 	for _, test := range []struct {
 		name    string
@@ -36,6 +75,7 @@ func TestParseArgs(t *testing.T) {
 				ProjectId: "cloud-sdk-librarian-prod",
 				Push:      true,
 				Build:     true,
+				ForceRun:  false,
 			},
 		},
 		{
@@ -47,6 +87,7 @@ func TestParseArgs(t *testing.T) {
 				ProjectId: "some-project-id",
 				Push:      true,
 				Build:     true,
+				ForceRun:  false,
 			},
 		},
 		{
@@ -58,6 +99,7 @@ func TestParseArgs(t *testing.T) {
 				ProjectId: "cloud-sdk-librarian-prod",
 				Push:      true,
 				Build:     true,
+				ForceRun:  false,
 			},
 		},
 		{
@@ -69,6 +111,7 @@ func TestParseArgs(t *testing.T) {
 				ProjectId: "cloud-sdk-librarian-prod",
 				Push:      false,
 				Build:     true,
+				ForceRun:  false,
 			},
 		},
 		{
@@ -80,6 +123,19 @@ func TestParseArgs(t *testing.T) {
 				ProjectId: "cloud-sdk-librarian-prod",
 				Push:      true,
 				Build:     false,
+				ForceRun:  false,
+			},
+		},
+		{
+			name:    "sets forceRun",
+			args:    []string{"--force-run=true"},
+			wantErr: false,
+			want: &runOptions{
+				Command:   "generate",
+				ProjectId: "cloud-sdk-librarian-prod",
+				Push:      true,
+				Build:     true,
+				ForceRun:  true,
 			},
 		},
 	} {

internal/automation/cloudbuild_test.go

@@ -29,13 +29,20 @@ import (
 type mockCloudBuildClient struct {
 	runError      error
 	buildTriggers []*cloudbuildpb.BuildTrigger
+	triggersRun   []string
 }
 
 func (c *mockCloudBuildClient) RunBuildTrigger(ctx context.Context, req *cloudbuildpb.RunBuildTriggerRequest, opts ...gax.CallOption) error {
 	slog.Info("running fake RunBuildTrigger")
 	if c.runError != nil {
 		return c.runError
 	}
+	for _, t := range c.triggersRun {
+		if t == req.TriggerId {
+			return nil
+		}
+	}
+	c.triggersRun = append(c.triggersRun, req.TriggerId)
 	return nil
 }
 

internal/automation/trigger.go

@@ -22,6 +22,7 @@ import (
 	"log/slog"
 	"os"
 	"strings"
+	"time"
 
 	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
 	"cloud.google.com/go/cloudbuild/apiv1/v2/cloudbuildpb"
@@ -63,7 +64,7 @@ func (c *wrappedCloudBuildClient) ListBuildTriggers(ctx context.Context, req *cl
 }
 
 // RunCommand triggers a command for each registered repository that supports it.
-func RunCommand(ctx context.Context, command string, projectId string, push bool, build bool) error {
+func RunCommand(ctx context.Context, command string, projectId string, push bool, build bool, forceRun bool) error {
 	c, err := cloudbuild.NewClient(ctx)
 	if err != nil {
 		return fmt.Errorf("error creating cloudbuild client: %w", err)
@@ -76,25 +77,32 @@ func RunCommand(ctx context.Context, command string, projectId string, push bool
 	if err != nil {
 		return fmt.Errorf("error creating github client: %w", err)
 	}
-	return runCommandWithClient(ctx, wrappedClient, ghClient, command, projectId, push, build)
+	return runCommandWithClient(ctx, wrappedClient, ghClient, command, projectId, push, build, forceRun, time.Now())
 }
 
-func runCommandWithClient(ctx context.Context, client CloudBuildClient, ghClient GitHubClient, command string, projectId string, push bool, build bool) error {
+func runCommandWithClient(ctx context.Context, client CloudBuildClient, ghClient GitHubClient, command string, projectId string, push bool, build bool, forceRun bool, dateTime time.Time) error {
 	config, err := loadRepositoriesConfig()
 	if err != nil {
 		slog.Error("error loading repositories config", slog.Any("err", err))
 		return err
 	}
-	return runCommandWithConfig(ctx, client, ghClient, command, projectId, push, build, config)
+	return runCommandWithConfig(ctx, client, ghClient, command, projectId, push, build, forceRun, config, dateTime)
 }
 
-func runCommandWithConfig(ctx context.Context, client CloudBuildClient, ghClient GitHubClient, command string, projectId string, push bool, build bool, config *RepositoriesConfig) error {
+func runCommandWithConfig(ctx context.Context, client CloudBuildClient, ghClient GitHubClient, command string, projectId string, push bool, build bool, forceRun bool, config *RepositoriesConfig, dateTime time.Time) error {
 	// validate command is allowed
 	triggerName := triggerNameByCommandName[command]
 	if triggerName == "" {
-		return fmt.Errorf("unsuppoted command: %s", command)
+		return fmt.Errorf("unsupported command: %s", command)
 	}
 
+	if triggerName == "stage-release" {
+		_, week := dateTime.ISOWeek()
+		if week%2 == 0 && !forceRun {
+			slog.Info("Skipping stage-release on an even week.")
+			return nil
+		}
+	}
 	errs := make([]error, 0)
 
 	repositories := config.RepositoriesForCommand(command)