feat(sidekick): subcommand to publish Rust crates (#2182)

Author: coryan

internal/sidekick/internal/config/release.go

@@ -34,6 +34,10 @@ type Release struct {
 
 	// IgnoredChanges defines globs that are ignored in change analysis.
 	IgnoredChanges []string `toml:"ignored-changes,omitempty"`
+
+	// An alternative location for the `roots.pem` file. If empty it has no
+	// effect.
+	RootsPem string
 }
 
 // Tool defines the configuration required to install helper tools.

internal/sidekick/internal/rust_release/bump_versions_test.go

@@ -188,6 +188,32 @@ func setupForVersionBump(t *testing.T, wantTag string) {
 	configNewGitRepository(t)
 }
 
+func setupForPublish(t *testing.T, wantTag string) string {
+	remoteDir := t.TempDir()
+	continueInNewGitRepository(t, remoteDir)
+	initRepositoryContents(t)
+	if err := external.Run("git", "tag", wantTag); err != nil {
+		t.Fatal(err)
+	}
+	name := path.Join("src", "storage", "src", "lib.rs")
+	if err := os.WriteFile(name, []byte(newLibRsContents), 0644); err != nil {
+		t.Fatal(err)
+	}
+	if err := external.Run("git", "commit", "-m", "feat: changed storage", "."); err != nil {
+		t.Fatal(err)
+	}
+	return remoteDir
+}
+
+func cloneRepository(t *testing.T, remoteDir string) {
+	cloneDir := t.TempDir()
+	t.Chdir(cloneDir)
+	if err := external.Run("git", "clone", remoteDir, "."); err != nil {
+		t.Fatal(err)
+	}
+	configNewGitRepository(t)
+}
+
 func continueInNewGitRepository(t *testing.T, tmpDir string) {
 	t.Helper()
 	requireCommand(t, "git")

internal/sidekick/internal/rust_release/changes.go

@@ -15,6 +15,8 @@
 package rustrelease
 
 import (
+	"bytes"
+	"fmt"
 	"os/exec"
 	"slices"
 	"strings"
@@ -23,6 +25,33 @@ import (
 	"github.com/googleapis/librarian/internal/sidekick/internal/config"
 )
 
+func matchesBranchPoint(config *config.Release) error {
+	branch := fmt.Sprintf("%s/%s", config.Remote, config.Branch)
+	delta := fmt.Sprintf("%s...HEAD", branch)
+	cmd := exec.Command(gitExe(config), "diff", "--name-only", delta)
+	cmd.Dir = "."
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		return err
+	}
+	if len(output) != 0 {
+		return fmt.Errorf("the local repository does not match is branch point from %s, change files:\n%s", branch, string(output))
+	}
+	return nil
+}
+
+func isNewFile(config *config.Release, ref, name string) bool {
+	delta := fmt.Sprintf("%s..HEAD", ref)
+	cmd := exec.Command(gitExe(config), "diff", "--summary", delta, "--", name)
+	cmd.Dir = "."
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		return false
+	}
+	expected := fmt.Sprintf(" create mode 100644 %s", name)
+	return bytes.HasPrefix(output, []byte(expected))
+}
+
 func filesChangedSince(config *config.Release, ref string) ([]string, error) {
 	cmd := exec.Command(gitExe(config), "diff", "--name-only", ref)
 	cmd.Dir = "."

internal/sidekick/internal/rust_release/changes_test.go

@@ -28,6 +28,97 @@ const (
 	newLibRsContents = `pub fn hello() -> &'static str { "Hello World" }`
 )
 
+func TestMatchesBranchPointSuccess(t *testing.T) {
+	requireCommand(t, "git")
+	config := &config.Release{
+		Remote: "origin",
+		Branch: "main",
+	}
+	remoteDir := setupForPublish(t, "v1.0.0")
+	cloneRepository(t, remoteDir)
+	if err := matchesBranchPoint(config); err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestMatchesBranchDiffError(t *testing.T) {
+	requireCommand(t, "git")
+	config := &config.Release{
+		Remote: "origin",
+		Branch: "not-a-valid-branch",
+	}
+	remoteDir := setupForPublish(t, "v1.0.0")
+	cloneRepository(t, remoteDir)
+	if err := matchesBranchPoint(config); err == nil {
+		t.Errorf("expected an error with an invalid branch")
+	}
+}
+
+func TestMatchesDirtyCloneError(t *testing.T) {
+	requireCommand(t, "git")
+	config := &config.Release{
+		Remote: "origin",
+		Branch: "not-a-valid-branch",
+	}
+	remoteDir := setupForPublish(t, "v1.0.0")
+	cloneRepository(t, remoteDir)
+	addCrate(t, path.Join("src", "pubsub"), "google-cloud-pubsub")
+	if err := external.Run("git", "add", path.Join("src", "pubsub")); err != nil {
+		t.Fatal(err)
+	}
+	if err := external.Run("git", "commit", "-m", "feat: created pubsub", "."); err != nil {
+		t.Fatal(err)
+	}
+
+	if err := matchesBranchPoint(config); err == nil {
+		t.Errorf("expected an error with a dirty clone")
+	}
+}
+
+func TestIsNewFile(t *testing.T) {
+	const wantTag = "new-file-success"
+	release := config.Release{
+		Remote:       "origin",
+		Branch:       "main",
+		Preinstalled: map[string]string{},
+	}
+	setupForVersionBump(t, wantTag)
+	existingName := path.Join("src", "storage", "src", "lib.rs")
+	if err := os.WriteFile(existingName, []byte(newLibRsContents), 0644); err != nil {
+		t.Fatal(err)
+	}
+	newName := path.Join("src", "storage", "src", "new.rs")
+	if err := os.WriteFile(newName, []byte(newLibRsContents), 0644); err != nil {
+		t.Fatal(err)
+	}
+	if err := external.Run("git", "add", "."); err != nil {
+		t.Fatal(err)
+	}
+	if err := external.Run("git", "commit", "-m", "feat: changed storage", "."); err != nil {
+		t.Fatal(err)
+	}
+	if isNewFile(&release, wantTag, existingName) {
+		t.Errorf("file is not new but reported as such: %s", existingName)
+	}
+	if !isNewFile(&release, wantTag, newName) {
+		t.Errorf("file is new but not reported as such: %s", newName)
+	}
+}
+
+func TestIsNewFileDiffError(t *testing.T) {
+	const wantTag = "new-file-success"
+	release := config.Release{
+		Remote:       "origin",
+		Branch:       "main",
+		Preinstalled: map[string]string{},
+	}
+	setupForVersionBump(t, wantTag)
+	existingName := path.Join("src", "storage", "src", "lib.rs")
+	if isNewFile(&release, "invalid-tag", existingName) {
+		t.Errorf("diff errors should return false for isNewFile(): %s", existingName)
+	}
+}
+
 func TestFilesChangedSuccess(t *testing.T) {
 	const wantTag = "release-2001-02-03"
 

internal/sidekick/internal/rust_release/preflight.go

@@ -16,6 +16,7 @@ package rustrelease
 
 import (
 	"fmt"
+	"log/slog"
 
 	"github.com/googleapis/librarian/internal/sidekick/internal/config"
 	"github.com/googleapis/librarian/internal/sidekick/internal/external"
@@ -37,6 +38,7 @@ func PreFlight(config *config.Release) error {
 		return nil
 	}
 	for _, tool := range tools {
+		slog.Info("installing cargo tool", "name", tool.Name, "version", tool.Version)
 		spec := fmt.Sprintf("%s@%s", tool.Name, tool.Version)
 		if err := external.Run(cargoExe(config), "install", "--locked", spec); err != nil {
 			return err

internal/sidekick/internal/rust_release/publish.go

@@ -0,0 +1,97 @@
+// 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 rustrelease
+
+import (
+	"fmt"
+	"log/slog"
+	"maps"
+	"os"
+	"os/exec"
+	"slices"
+	"strings"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/googleapis/librarian/internal/sidekick/internal/config"
+	"github.com/googleapis/librarian/internal/sidekick/internal/external"
+)
+
+// Publish finds all the crates that should be published, runs
+// `cargo semver-checks` and (optionally) publishes them.
+func Publish(config *config.Release, dryRun bool) error {
+	if err := PreFlight(config); err != nil {
+		return err
+	}
+	lastTag, err := getLastTag(config)
+	if err != nil {
+		return err
+	}
+	if err := matchesBranchPoint(config); err != nil {
+		return err
+	}
+	files, err := filesChangedSince(config, lastTag)
+	if err != nil {
+		return err
+	}
+	manifests := map[string]string{}
+	for _, manifest := range findCargoManifests(files) {
+		names, err := publishedCrate(manifest)
+		if err != nil {
+			return err
+		}
+		for _, name := range names {
+			manifests[name] = manifest
+		}
+	}
+	slog.Info("computing publication plan with: cargo workspaces plan")
+	cmd := exec.Command(cargoExe(config), "workspaces", "plan", "--skip-published")
+	if config.RootsPem != "" {
+		cmd.Env = append(os.Environ(), fmt.Sprintf("CARGO_HTTP_CAINFO=%s", config.RootsPem))
+	}
+	cmd.Dir = "."
+	output, err := cmd.Output()
+	if err != nil {
+		return err
+	}
+	plannedCrates := strings.Split(string(output), "\n")
+	plannedCrates = slices.DeleteFunc(plannedCrates, func(a string) bool { return a == "" })
+	changedCrates := slices.Collect(maps.Keys(manifests))
+	slices.Sort(plannedCrates)
+	slices.Sort(changedCrates)
+	if diff := cmp.Diff(changedCrates, plannedCrates); diff != "" && cargoExe(config) != "/bin/echo" {
+		return fmt.Errorf("mismatched workspace plan vs. changed crates, probably missing some version bumps (-plan, +changed):\n%s", diff)
+	}
+
+	for name, manifest := range manifests {
+		if isNewFile(config, lastTag, manifest) {
+			continue
+		}
+		slog.Info("runnning cargo semver-checks to detect breaking changes", "crate", name)
+		if err := external.Run(cargoExe(config), "semver-checks", "--all-features", "-p", name); err != nil {
+			return err
+		}
+	}
+	slog.Info("publishing crates with: cargo workspaces publish --skip-published ...")
+	args := []string{"workspaces", "publish", "--skip-published", "--publish-interval=60", "--no-git-commit", "--from-git", "skip"}
+	if dryRun {
+		args = append(args, "--dry-run")
+	}
+	cmd = exec.Command(cargoExe(config), args...)
+	if config.RootsPem != "" {
+		cmd.Env = append(os.Environ(), fmt.Sprintf("CARGO_HTTP_CAINFO=%s", config.RootsPem))
+	}
+	cmd.Dir = "."
+	return cmd.Run()
+}