feat(sidekick): update supports different roots (#2473)

Author: coryan

internal/sidekick/cmdline.go

@@ -25,6 +25,7 @@ type CommandLine struct {
 	Output              string
 	Language            string
 	Codec               map[string]string
+	UpdatedRoot         string
 	DryRun              bool
 }
 
@@ -38,4 +39,5 @@ var (
 	flagLanguage    string
 	codecOpts       = map[string]string{}
 	dryrun          bool
+	updatedRoot     string
 )

internal/sidekick/command.go

@@ -147,6 +147,7 @@ func (c *command) parseCmdLine(args []string) (*CommandLine, error) {
 		Output:              output,
 		Codec:               codecOpts,
 		DryRun:              dryrun,
+		UpdatedRoot:         updatedRoot,
 	}, nil
 }
 

internal/sidekick/internal/config/update_root_config.go

@@ -47,9 +47,12 @@ type githubRepo struct {
 }
 
 // UpdateRootConfig updates the root configuration file with the latest SHA from GitHub.
-func UpdateRootConfig(rootConfig *Config) error {
+func UpdateRootConfig(rootConfig *Config, rootName string) error {
+	if rootName == "" {
+		rootName = defaultRoot
+	}
 	endpoints := githubConfig(rootConfig)
-	repo, err := githubRepoFromTarballLink(rootConfig, defaultRoot)
+	repo, err := githubRepoFromTarballLink(rootConfig, rootName)
 	if err != nil {
 		return err
 	}
@@ -73,7 +76,7 @@ func UpdateRootConfig(rootConfig *Config) error {
 	if err != nil {
 		return err
 	}
-	newContents, err := updateRootConfigContents(defaultRoot, contents, endpoints, repo, latestSha, newSha256)
+	newContents, err := updateRootConfigContents(rootName, contents, endpoints, repo, latestSha, newSha256)
 	if err != nil {
 		return err
 	}

internal/sidekick/internal/config/update_root_config_test.go

@@ -72,23 +72,23 @@ func TestUpdateRootConfig(t *testing.T) {
 			SpecificationFormat: "protobuf",
 		},
 		Source: map[string]string{
-			"github-api":        server.URL,
-			"github":            server.URL,
-			"googleapis-root":   fmt.Sprintf("%s/googleapis/googleapis/archive/old.tar.gz", server.URL),
-			"googleapis-sha256": "old-sha-unused",
+			"github-api":  server.URL,
+			"github":      server.URL,
+			"test-root":   fmt.Sprintf("%s/googleapis/googleapis/archive/old.tar.gz", server.URL),
+			"test-sha256": "old-sha-unused",
 		},
 		Codec: map[string]string{},
 	}
 	if err := WriteSidekickToml(".", rootConfig); err != nil {
 		t.Fatal(err)
 	}
 
-	if err := UpdateRootConfig(rootConfig); err != nil {
+	if err := UpdateRootConfig(rootConfig, "test"); err != nil {
 		t.Fatal(err)
 	}
 
 	got := &Config{}
-	contents, err := os.ReadFile(path.Join(tempDir, ".sidekick.toml"))
+	contents, err := os.ReadFile(path.Join(tempDir, configName))
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -98,10 +98,10 @@ func TestUpdateRootConfig(t *testing.T) {
 	want := &Config{
 		General: rootConfig.General,
 		Source: map[string]string{
-			"github-api":        server.URL,
-			"github":            server.URL,
-			"googleapis-root":   fmt.Sprintf("%s/googleapis/googleapis/archive/%s.tar.gz", server.URL, latestSha),
-			"googleapis-sha256": latestShaContentsHash,
+			"github-api":  server.URL,
+			"github":      server.URL,
+			"test-root":   fmt.Sprintf("%s/googleapis/googleapis/archive/%s.tar.gz", server.URL, latestSha),
+			"test-sha256": latestShaContentsHash,
 		},
 	}
 
@@ -258,7 +258,7 @@ func TestUpdateRootConfigErrors(t *testing.T) {
 			rootConfig.Source[k] = v
 		}
 		test.Setup(rootConfig)
-		if err := UpdateRootConfig(rootConfig); err == nil {
+		if err := UpdateRootConfig(rootConfig, ""); err == nil {
 			t.Errorf("expected an error with configuration %v", rootConfig)
 			t.Fatal(err)
 		}

internal/sidekick/sidekick.go

@@ -36,6 +36,7 @@ var cmdSidekick = newCommand(
 	addFlagString(&output, "output", "the path within project-root to put generated files").
 	addFlagString(&flagLanguage, "language", "the generated language").
 	addFlagBool(&dryrun, "dry-run", false, "do a dry-run: load the configuration, but do not perform any changes.").
+	addFlagString(&updatedRoot, "updated-root", "update a specific *-root commit SHA, defaults to `googleapis`.").
 	addFlagFunc("source-option", "source options", func(opt string) error {
 		components := strings.SplitN(opt, "=", 2)
 		if len(components) != 2 {

internal/sidekick/update.go

@@ -31,7 +31,7 @@ This command will update the googleapis-root and googleapis-sha256 fields in the
 }
 
 func update(rootConfig *config.Config, cmdLine *CommandLine) error {
-	if err := config.UpdateRootConfig(rootConfig); err != nil {
+	if err := config.UpdateRootConfig(rootConfig, cmdLine.UpdatedRoot); err != nil {
 		return err
 	}
 	// Reload the freshly minted configuration.