ci: Cloud Build jobs to propagate _PUSH substitution variable (#1757)

The Cloud Build generate-worker job to pass the _PUSH substitution
variable to the next Cloud Build jobs. They invoke Librarian CLI with
either '-push=true' or '-push=false' parameter. This controls whether
the job creates a pull request or not.

This change should come with the Terraform change cl/795539979.

Author: suztomo

infra/prod/generate-worker.yaml

@@ -23,6 +23,7 @@ steps:
       - './cmd/automation'
       - '--project=$PROJECT_ID'
       - '--command=generate'
+      - '--push=$_PUSH'
 tags: ['generate-dispatcher']
 availableSecrets:
 options:

infra/prod/generate.yaml

@@ -41,6 +41,7 @@ steps:
       - $_LIBRARY_ID
       - '-api-source'
       - '/workspace/googleapis'
+      - '-push=$_PUSH'
     secretEnv: ['LIBRARIAN_GITHUB_TOKEN']
 tags: ['generate-$_REPOSITORY']
 availableSecrets:

internal/automation/cli.go

@@ -29,7 +29,7 @@ func Run(args []string) error {
 		return err
 	}
 
-	err = RunCommand(ctx, options.Command, options.ProjectId)
+	err = RunCommand(ctx, options.Command, options.ProjectId, options.Push)
 	if err != nil {
 		slog.Error("Error running command", slog.Any("err", err))
 		return err
@@ -40,18 +40,21 @@ func Run(args []string) error {
 type runOptions struct {
 	Command   string
 	ProjectId string
+	Push      bool
 }
 
 func parseFlags(args []string) (*runOptions, error) {
 	flagSet := flag.NewFlagSet("dispatcher", flag.ContinueOnError)
 	projectId := flagSet.String("project", "cloud-sdk-librarian-prod", "GCP project ID")
 	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")
 	err := flagSet.Parse(args)
 	if err != nil {
 		return nil, err
 	}
 	return &runOptions{
 		ProjectId: *projectId,
 		Command:   *command,
+		Push:      *push,
 	}, nil
 }

internal/automation/cli_test.go

@@ -34,6 +34,7 @@ func TestParseArgs(t *testing.T) {
 			want: &runOptions{
 				Command:   "generate",
 				ProjectId: "cloud-sdk-librarian-prod",
+				Push:      true,
 			},
 		},
 		{
@@ -43,6 +44,7 @@ func TestParseArgs(t *testing.T) {
 			want: &runOptions{
 				Command:   "generate",
 				ProjectId: "some-project-id",
+				Push:      true,
 			},
 		},
 		{
@@ -52,6 +54,17 @@ func TestParseArgs(t *testing.T) {
 			want: &runOptions{
 				Command:   "stage-release",
 				ProjectId: "cloud-sdk-librarian-prod",
+				Push:      true,
+			},
+		},
+		{
+			name:    "sets command",
+			args:    []string{"--command=stage-release", "--push=false"},
+			wantErr: false,
+			want: &runOptions{
+				Command:   "stage-release",
+				ProjectId: "cloud-sdk-librarian-prod",
+				Push:      false,
 			},
 		},
 	} {

internal/automation/trigger.go

@@ -55,7 +55,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) error {
+func RunCommand(ctx context.Context, command string, projectId string, push bool) error {
 	c, err := cloudbuild.NewClient(ctx)
 	if err != nil {
 		return fmt.Errorf("error creating cloudbuild client: %w", err)
@@ -64,10 +64,10 @@ func RunCommand(ctx context.Context, command string, projectId string) error {
 	wrappedClient := &wrappedCloudBuildClient{
 		client: c,
 	}
-	return runCommandWithClient(ctx, wrappedClient, command, projectId)
+	return runCommandWithClient(ctx, wrappedClient, command, projectId, push)
 }
 
-func runCommandWithClient(ctx context.Context, client CloudBuildClient, command string, projectId string) error {
+func runCommandWithClient(ctx context.Context, client CloudBuildClient, command string, projectId string, push bool) error {
 	// validate command is allowed
 	triggerName := triggerNameByCommandName[command]
 	if triggerName == "" {
@@ -89,6 +89,7 @@ func runCommandWithClient(ctx context.Context, client CloudBuildClient, command
 		substitutions := map[string]string{
 			"_REPOSITORY":               repository.Name,
 			"_GITHUB_TOKEN_SECRET_NAME": repository.SecretName,
+			"_PUSH":                     fmt.Sprintf("%v", push),
 		}
 		err = runCloudBuildTriggerByName(ctx, client, projectId, region, triggerName, substitutions)
 		if err != nil {

internal/automation/trigger_test.go

@@ -26,6 +26,7 @@ func TestRunCommandWithClient(t *testing.T) {
 	for _, test := range []struct {
 		name          string
 		command       string
+		push          bool
 		want          string
 		runError      error
 		wantErr       bool
@@ -34,6 +35,7 @@ func TestRunCommandWithClient(t *testing.T) {
 		{
 			name:    "runs generate trigger",
 			command: "generate",
+			push:    true,
 			wantErr: false,
 			buildTriggers: []*cloudbuildpb.BuildTrigger{
 				{
@@ -49,6 +51,7 @@ func TestRunCommandWithClient(t *testing.T) {
 		{
 			name:    "runs prepare-release trigger",
 			command: "stage-release",
+			push:    true,
 			wantErr: false,
 			buildTriggers: []*cloudbuildpb.BuildTrigger{
 				{
@@ -64,6 +67,7 @@ func TestRunCommandWithClient(t *testing.T) {
 		{
 			name:    "invalid command",
 			command: "invalid-command",
+			push:    true,
 			wantErr: true,
 			buildTriggers: []*cloudbuildpb.BuildTrigger{
 				{
@@ -79,6 +83,7 @@ func TestRunCommandWithClient(t *testing.T) {
 		{
 			name:     "error triggering",
 			command:  "generate",
+			push:     true,
 			runError: fmt.Errorf("some-error"),
 			wantErr:  true,
 			buildTriggers: []*cloudbuildpb.BuildTrigger{
@@ -99,7 +104,7 @@ func TestRunCommandWithClient(t *testing.T) {
 				runError:      test.runError,
 				buildTriggers: test.buildTriggers,
 			}
-			err := runCommandWithClient(ctx, client, test.command, "some-project")
+			err := runCommandWithClient(ctx, client, test.command, "some-project", test.push)
 			if test.wantErr && err == nil {
 				t.Errorf("expected error, but did not return one")
 			} else if !test.wantErr && err != nil {