refactor(sidekick): split update root config (#2448)

Author: coryan

internal/sidekick/internal/config/config.go

@@ -17,26 +17,18 @@
 package config
 
 import (
-	"crypto/sha256"
 	"fmt"
-	"io"
 	"maps"
-	"net/http"
 	"os"
 	"path"
-	"strings"
 
 	"github.com/googleapis/librarian/internal/sidekick/internal/config/gcloudyaml"
 	"github.com/googleapis/librarian/internal/sidekick/internal/license"
 	toml "github.com/pelletier/go-toml/v2"
 )
 
 const (
-	defaultGitHubApi = "https://api.github.com"
-	defaultGitHub    = "https://github.com"
-	repo             = "googleapis/googleapis"
-	branch           = "master"
-	configName       = ".sidekick.toml"
+	configName = ".sidekick.toml"
 )
 
 // DocumentationOverride describes overrides for the documentation of a single element.
@@ -174,112 +166,6 @@ func mergeConfigs(rootConfig, local *Config) *Config {
 	return &merged
 }
 
-// UpdateRootConfig updates the root configuration file with the latest SHA from GitHub.
-func UpdateRootConfig(rootConfig *Config) error {
-	gitHubApi, ok := rootConfig.Source["github-api"]
-	if !ok {
-		gitHubApi = defaultGitHubApi
-	}
-	gitHub, ok := rootConfig.Source["github"]
-	if !ok {
-		gitHub = defaultGitHub
-	}
-
-	query := fmt.Sprintf("%s/repos/%s/commits/%s", gitHubApi, repo, branch)
-	fmt.Printf("getting latest SHA from %q\n", query)
-	latestSha, err := getLatestSha(query)
-	if err != nil {
-		return err
-	}
-
-	newRoot := fmt.Sprintf("%s/%s/archive/%s.tar.gz", gitHub, repo, latestSha)
-	fmt.Printf("computing SHA256 for %q\n", newRoot)
-	newSha256, err := getSha256(newRoot)
-	if err != nil {
-		return err
-	}
-	fmt.Printf("updating .sidekick.toml\n")
-
-	contents, err := os.ReadFile(".sidekick.toml")
-	if err != nil {
-		return err
-	}
-	var newContents []string
-	for _, line := range strings.Split(string(contents), "\n") {
-		switch {
-		case strings.HasPrefix(line, "googleapis-root "):
-			s := strings.SplitN(line, "=", 2)
-			if len(s) != 2 {
-				return fmt.Errorf("invalid googleapis-root line, expected = separator, got=%q", line)
-			}
-			newContents = append(newContents, fmt.Sprintf("%s= '%s'", s[0], newRoot))
-		case strings.HasPrefix(line, "googleapis-sha256 "):
-			s := strings.SplitN(line, "=", 2)
-			if len(s) != 2 {
-				return fmt.Errorf("invalid googleapis-sha256 line, expected = separator, got=%q", line)
-			}
-			newContents = append(newContents, fmt.Sprintf("%s= '%s'", s[0], newSha256))
-		default:
-			newContents = append(newContents, line)
-		}
-	}
-
-	cwd, _ := os.Getwd()
-	fmt.Printf("%s\n", cwd)
-	f, err := os.Create(".sidekick.toml")
-	if err != nil {
-		return err
-	}
-	defer f.Close()
-	for i, line := range newContents {
-		f.Write([]byte(line))
-		if i != len(newContents)-1 {
-			f.Write([]byte("\n"))
-		}
-	}
-	return f.Close()
-}
-
-func getSha256(query string) (string, error) {
-	response, err := http.Get(query)
-	if err != nil {
-		return "", err
-	}
-	if response.StatusCode >= 300 {
-		return "", fmt.Errorf("http error in download %s", response.Status)
-	}
-	defer response.Body.Close()
-
-	hasher := sha256.New()
-	if _, err := io.Copy(hasher, response.Body); err != nil {
-		return "", err
-	}
-	got := fmt.Sprintf("%x", hasher.Sum(nil))
-	return got, nil
-}
-
-func getLatestSha(query string) (string, error) {
-	client := &http.Client{}
-	request, err := http.NewRequest(http.MethodGet, query, nil)
-	if err != nil {
-		return "", err
-	}
-	request.Header.Set("Accept", "application/vnd.github.VERSION.sha")
-	response, err := client.Do(request)
-	if err != nil {
-		return "", err
-	}
-	if response.StatusCode >= 300 {
-		return "", fmt.Errorf("http error in download %s", response.Status)
-	}
-	defer response.Body.Close()
-	contents, err := io.ReadAll(response.Body)
-	if err != nil {
-		return "", err
-	}
-	return string(contents), nil
-}
-
 // WriteSidekickToml writes the configuration to a .sidekick.toml file.
 func WriteSidekickToml(outDir string, config *Config) error {
 	if err := os.MkdirAll(outDir, 0777); err != nil {

internal/sidekick/internal/config/config_test.go

@@ -16,9 +16,6 @@ package config
 
 import (
 	"bytes"
-	"fmt"
-	"net/http"
-	"net/http/httptest"
 	"os"
 	"path"
 	"testing"
@@ -485,81 +482,3 @@ func mergeTestConfigs(t *testing.T, root, local *Config) (*Config, error) {
 	tempFile.Close()
 	return MergeConfigAndFile(root, tempFile.Name())
 }
-
-func TestUpdateRootConfig(t *testing.T) {
-	// update() normally writes `.sidekick.toml` to cwd. We need to change to a
-	// temporary directory to avoid changing the actual configuration, and any
-	// conflicts with other tests running at the same time.
-	tempDir := t.TempDir()
-	t.Chdir(tempDir)
-
-	const (
-		getLatestShaPath      = "/repos/googleapis/googleapis/commits/master"
-		latestSha             = "5d5b1bf126485b0e2c972bac41b376438601e266"
-		tarballPath           = "/googleapis/googleapis/archive/5d5b1bf126485b0e2c972bac41b376438601e266.tar.gz"
-		latestShaContents     = "The quick brown fox jumps over the lazy dog"
-		latestShaContentsHash = "d7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592"
-	)
-
-	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		switch r.URL.Path {
-		case getLatestShaPath:
-			got := r.Header.Get("Accept")
-			want := "application/vnd.github.VERSION.sha"
-			if got != want {
-				t.Fatalf("mismatched Accept header for %q, got=%q, want=%s", r.URL.Path, got, want)
-			}
-			w.WriteHeader(http.StatusOK)
-			w.Write([]byte(latestSha))
-		case tarballPath:
-			w.WriteHeader(http.StatusOK)
-			w.Write([]byte(latestShaContents))
-		default:
-			t.Fatalf("unexpected request path %q", r.URL.Path)
-		}
-	}))
-	defer server.Close()
-
-	rootConfig := &Config{
-		General: GeneralConfig{
-			Language:            "rust",
-			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",
-		},
-		Codec: map[string]string{},
-	}
-	if err := WriteSidekickToml(".", rootConfig); err != nil {
-		t.Fatal(err)
-	}
-
-	if err := UpdateRootConfig(rootConfig); err != nil {
-		t.Fatal(err)
-	}
-
-	got := &Config{}
-	contents, err := os.ReadFile(path.Join(tempDir, ".sidekick.toml"))
-	if err != nil {
-		t.Fatal(err)
-	}
-	if err := toml.Unmarshal(contents, got); err != nil {
-		t.Fatal("error reading top-level configuration: %w", err)
-	}
-	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,
-		},
-	}
-
-	if diff := cmp.Diff(want, got); diff != "" {
-		t.Errorf("mismatch in loaded root config (-want, +got)\n:%s", diff)
-	}
-}

internal/sidekick/internal/config/update_root_config.go

@@ -0,0 +1,137 @@
+// Copyright 2025 Google LLC
+//
+// 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
+//
+//     https://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 config
+
+import (
+	"crypto/sha256"
+	"fmt"
+	"io"
+	"net/http"
+	"os"
+	"strings"
+)
+
+const (
+	defaultGitHubApi = "https://api.github.com"
+	defaultGitHub    = "https://github.com"
+	repo             = "googleapis/googleapis"
+	branch           = "master"
+)
+
+// UpdateRootConfig updates the root configuration file with the latest SHA from GitHub.
+func UpdateRootConfig(rootConfig *Config) error {
+	gitHubApi, ok := rootConfig.Source["github-api"]
+	if !ok {
+		gitHubApi = defaultGitHubApi
+	}
+	gitHub, ok := rootConfig.Source["github"]
+	if !ok {
+		gitHub = defaultGitHub
+	}
+
+	query := fmt.Sprintf("%s/repos/%s/commits/%s", gitHubApi, repo, branch)
+	fmt.Printf("getting latest SHA from %q\n", query)
+	latestSha, err := getLatestSha(query)
+	if err != nil {
+		return err
+	}
+
+	newRoot := fmt.Sprintf("%s/%s/archive/%s.tar.gz", gitHub, repo, latestSha)
+	fmt.Printf("computing SHA256 for %q\n", newRoot)
+	newSha256, err := getSha256(newRoot)
+	if err != nil {
+		return err
+	}
+	fmt.Printf("updating .sidekick.toml\n")
+
+	contents, err := os.ReadFile(".sidekick.toml")
+	if err != nil {
+		return err
+	}
+	var newContents []string
+	for _, line := range strings.Split(string(contents), "\n") {
+		switch {
+		case strings.HasPrefix(line, "googleapis-root "):
+			s := strings.SplitN(line, "=", 2)
+			if len(s) != 2 {
+				return fmt.Errorf("invalid googleapis-root line, expected = separator, got=%q", line)
+			}
+			newContents = append(newContents, fmt.Sprintf("%s= '%s'", s[0], newRoot))
+		case strings.HasPrefix(line, "googleapis-sha256 "):
+			s := strings.SplitN(line, "=", 2)
+			if len(s) != 2 {
+				return fmt.Errorf("invalid googleapis-sha256 line, expected = separator, got=%q", line)
+			}
+			newContents = append(newContents, fmt.Sprintf("%s= '%s'", s[0], newSha256))
+		default:
+			newContents = append(newContents, line)
+		}
+	}
+
+	cwd, _ := os.Getwd()
+	fmt.Printf("%s\n", cwd)
+	f, err := os.Create(".sidekick.toml")
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+	for i, line := range newContents {
+		f.Write([]byte(line))
+		if i != len(newContents)-1 {
+			f.Write([]byte("\n"))
+		}
+	}
+	return f.Close()
+}
+
+func getSha256(query string) (string, error) {
+	response, err := http.Get(query)
+	if err != nil {
+		return "", err
+	}
+	if response.StatusCode >= 300 {
+		return "", fmt.Errorf("http error in download %s", response.Status)
+	}
+	defer response.Body.Close()
+
+	hasher := sha256.New()
+	if _, err := io.Copy(hasher, response.Body); err != nil {
+		return "", err
+	}
+	got := fmt.Sprintf("%x", hasher.Sum(nil))
+	return got, nil
+}
+
+func getLatestSha(query string) (string, error) {
+	client := &http.Client{}
+	request, err := http.NewRequest(http.MethodGet, query, nil)
+	if err != nil {
+		return "", err
+	}
+	request.Header.Set("Accept", "application/vnd.github.VERSION.sha")
+	response, err := client.Do(request)
+	if err != nil {
+		return "", err
+	}
+	if response.StatusCode >= 300 {
+		return "", fmt.Errorf("http error in download %s", response.Status)
+	}
+	defer response.Body.Close()
+	contents, err := io.ReadAll(response.Body)
+	if err != nil {
+		return "", err
+	}
+	return string(contents), nil
+}