Add delete branches command

Author: trodge

.ci/gcb-push-downstream.yml

@@ -211,6 +211,18 @@ steps:
       args:
         - "check-cassettes"
 
+    - name: 'gcr.io/graphite-docker-images/go-plus'
+      id: magician-delete-branches
+      waitFor: ["vcr-merge"]
+      entrypoint: '/workspace/.ci/scripts/go-plus/magician/exec.sh'
+      secretEnv:
+        - "GITHUB_TOKEN_CLASSIC"
+      args:
+        - "delete-branches"
+        - $COMMIT_SHA
+        - $BRANCH_NAME
+
+
 # set extremely long 1 day timeout, in order to ensure that any jams / backlogs can be cleared.
 timeout: 86400s
 options:

.ci/magician/cmd/delete_branches.go

@@ -0,0 +1,141 @@
+/*
+* Copyright 2024 Google LLC. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*     http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+ */
+package cmd
+
+import (
+	"fmt"
+	"magician/exec"
+	"magician/source"
+	"os"
+	"strings"
+
+	"github.com/spf13/cobra"
+)
+
+var deleteBranchesCmd = &cobra.Command{
+	Use:   "delete-branches",
+	Short: "Delete the auto pr branches after pushing the given commit",
+	Long: `This command deletes auto pr branches after pushing the given commit SHA to downstreams.
+
+	It expects the following parameters:
+	1. COMMIT_SHA
+	2. BASE_BRANCH
+
+	It also expects the following environment variables:
+	1. GITHUB_TOKEN_CLASSIC
+	2. GOPATH`,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		baseBranch := args[0]
+		sha := args[1]
+
+		githubToken, ok := os.LookupEnv("GITHUB_TOKEN_CLASSIC")
+		if !ok {
+			return fmt.Errorf("did not provide GITHUB_TOKEN_CLASSIC environment variable")
+		}
+
+		goPath, ok := os.LookupEnv("GOPATH")
+		if !ok {
+			return fmt.Errorf("did not provide GOPATH environment variable")
+		}
+
+		rnr, err := exec.NewRunner()
+		if err != nil {
+			return fmt.Errorf("error creating Runner: %s", err)
+		}
+
+		ctlr := source.NewController(goPath, "modular-magician", githubToken, rnr)
+
+		return execDeleteBranchesCmd(baseBranch, sha, githubToken, rnr, ctlr)
+	},
+}
+
+func execDeleteBranchesCmd(baseBranch, sha, githubToken string, runner source.Runner, controller *source.Controller) error {
+	prNumber, err := fetchPRNumber(sha, baseBranch, runner, controller)
+
+	if err != nil {
+		return err
+	}
+
+	err = deleteBranches(prNumber, githubToken, runner)
+
+	return err
+}
+
+func fetchPRNumber(sha, baseBranch string, runner source.Runner, controller *source.Controller) (string, error) {
+	repo := &source.Repo{
+		Name:   "terraform-provider-google-beta",
+		Branch: baseBranch,
+	}
+	controller.SetPath(repo)
+
+	if err := controller.Clone(repo); err != nil {
+		return "", err
+	}
+
+	controller.SetPath(repo)
+
+	if err := runner.PushDir(repo.Path); err != nil {
+		return "", err
+	}
+
+	message, err := runner.Run("git", []string{
+		"show",
+		"-s",
+		"--format=%s",
+		sha,
+	}, nil)
+	if err != nil {
+		return "", fmt.Errorf("error getting commit message: %s", err)
+	}
+
+	messageParts := strings.Split(message, " ")
+
+	prNumber := messageParts[len(messageParts)-1]
+
+	return strings.Trim(prNumber, "()#\n"), nil
+}
+
+var repoList = []string{
+	"terraform-provider-google",
+	"terraform-provider-google-beta",
+	"terraform-google-conversion",
+	"tf-oics",
+}
+
+func deleteBranches(prNumber, githubToken string, runner source.Runner) error {
+	for _, repo := range repoList {
+		for _, branch := range []string{
+			fmt.Sprintf(":auto-pr-%s", prNumber),
+			fmt.Sprintf(":auto-pr-%s-old", prNumber),
+		} {
+			_, err := runner.Run("git", []string{
+				"push",
+				fmt.Sprintf("https://modular-magician:%[email protected]/modular-magician/%s", githubToken, repo),
+				branch,
+			}, nil)
+
+			if err != nil {
+				return err
+			}
+		}
+	}
+
+	return nil
+}
+
+func init() {
+	rootCmd.AddCommand(deleteBranchesCmd)
+}

.ci/magician/cmd/delete_branches_test.go

@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	"magician/exec"
+	"magician/source"
+	"testing"
+)
+
+func TestFetchPRNumber(t *testing.T) {
+	rnr, err := exec.NewRunner()
+	if err != nil {
+		t.Errorf("error creating Runner: %s", err)
+	}
+
+	ctlr := source.NewController("", "modular-magician", "", rnr)
+
+	prNumber, err := fetchPRNumber("8c6e61bb62d52c950008340deafc1e2a2041898a", "main", rnr, ctlr)
+
+	if err != nil {
+		t.Errorf("error fetching PR number: %s", err)
+	}
+
+	if prNumber != "6504" {
+		t.Errorf("PR number is %s, expected 6504", prNumber)
+	}
+}