feat(sidekick): allow skipping semver checks for rust-publish (#2584)

Running `cargo semver-checks` takes hours to run. This makes testing the
release process difficult. Add a flag to skip the checks to make it
easier to test later parts of the release process.

For #2514

Author: suzmue

internal/sidekick/internal/rust_release/publish.go

@@ -28,9 +28,9 @@ import (
 	"github.com/googleapis/librarian/internal/sidekick/internal/external"
 )
 
-// Publish finds all the crates that should be published, runs
+// Publish finds all the crates that should be published, (optionally) runs
 // `cargo semver-checks` and (optionally) publishes them.
-func Publish(config *config.Release, dryRun bool) error {
+func Publish(config *config.Release, dryRun bool, skipSemverChecks bool) error {
 	if err := PreFlight(config); err != nil {
 		return err
 	}
@@ -74,13 +74,15 @@ func Publish(config *config.Release, dryRun bool) error {
 		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
+	if !skipSemverChecks {
+		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 ...")

internal/sidekick/internal/rust_release/publish_test.go

@@ -17,6 +17,7 @@ package rustrelease
 import (
 	"os"
 	"path"
+	"runtime"
 	"testing"
 
 	"github.com/googleapis/librarian/internal/sidekick/internal/config"
@@ -42,7 +43,7 @@ func TestPublishSuccess(t *testing.T) {
 	}
 	remoteDir := setupForPublish(t, "release-2001-02-03")
 	cloneRepository(t, remoteDir)
-	if err := Publish(config, true); err != nil {
+	if err := Publish(config, true, false); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -73,7 +74,7 @@ func TestPublishWithNewCrate(t *testing.T) {
 		t.Fatal(err)
 	}
 	cloneRepository(t, remoteDir)
-	if err := Publish(config, true); err != nil {
+	if err := Publish(config, true, false); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -103,7 +104,7 @@ func TestPublishWithRootsPem(t *testing.T) {
 	}
 	remoteDir := setupForPublish(t, "release-with-roots-pem")
 	cloneRepository(t, remoteDir)
-	if err := Publish(config, true); err != nil {
+	if err := Publish(config, true, false); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -134,7 +135,7 @@ func TestPublishWithLocalChangesError(t *testing.T) {
 	if err := external.Run("git", "commit", "-m", "feat: created pubsub", "."); err != nil {
 		t.Fatal(err)
 	}
-	if err := Publish(config, true); err == nil {
+	if err := Publish(config, true, false); err == nil {
 		t.Errorf("expected an error publishing a dirty local repository")
 	}
 }
@@ -145,7 +146,7 @@ func TestPublishPreflightError(t *testing.T) {
 			"git": "git-not-found",
 		},
 	}
-	if err := Publish(config, true); err == nil {
+	if err := Publish(config, true, false); err == nil {
 		t.Errorf("expected an error in BumpVersions() with a bad git command")
 	}
 }
@@ -163,7 +164,7 @@ func TestPublishLastTagError(t *testing.T) {
 	}
 	remoteDir := setupForPublish(t, "release-2001-02-03")
 	cloneRepository(t, remoteDir)
-	if err := Publish(&config, true); err == nil {
+	if err := Publish(&config, true, false); err == nil {
 		t.Fatalf("expected an error during GetLastTag")
 	}
 }
@@ -198,7 +199,7 @@ func TestPublishBadManifest(t *testing.T) {
 		t.Fatal(err)
 	}
 	cloneRepository(t, remoteDir)
-	if err := Publish(config, true); err == nil {
+	if err := Publish(config, true, false); err == nil {
 		t.Errorf("expected an error with a bad manifest file")
 	}
 }
@@ -215,7 +216,7 @@ func TestPublishGetPlanError(t *testing.T) {
 	}
 	remoteDir := setupForPublish(t, "release-2001-02-03")
 	cloneRepository(t, remoteDir)
-	if err := Publish(config, true); err == nil {
+	if err := Publish(config, true, false); err == nil {
 		t.Fatalf("expected an error during plan generation")
 	}
 }
@@ -239,7 +240,52 @@ func TestPublishPlanMismatchError(t *testing.T) {
 	}
 	remoteDir := setupForPublish(t, "release-2001-02-03")
 	cloneRepository(t, remoteDir)
-	if err := Publish(config, true); err == nil {
+	if err := Publish(config, true, false); err == nil {
 		t.Fatalf("expected an error during plan comparison")
 	}
 }
+
+func TestPublishSkipSemverChecks(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.Skip("skipping on windows, bash script set up does not work")
+	}
+
+	requireCommand(t, "git")
+	requireCommand(t, "/bin/echo")
+	tmpDir := t.TempDir()
+	// Create a fake cargo that fails on `semver-checks`
+	cargoScript := path.Join(tmpDir, "cargo")
+	script := `#!/bin/bash
+if [ "$1" == "semver-checks" ]; then
+	exit 1
+elif [ "$1" == "workspaces" ] && [ "$2" == "plan" ]; then
+	echo "google-cloud-storage"
+else
+	/bin/echo $@
+fi
+`
+	if err := os.WriteFile(cargoScript, []byte(script), 0755); err != nil {
+		t.Fatal(err)
+	}
+
+	config := &config.Release{
+		Remote: "origin",
+		Branch: "main",
+		Preinstalled: map[string]string{
+			"git":   "git",
+			"cargo": cargoScript,
+		},
+	}
+	remoteDir := setupForPublish(t, "release-2001-02-03")
+	cloneRepository(t, remoteDir)
+
+	// This should fail because semver-checks fails.
+	if err := Publish(config, true, false); err == nil {
+		t.Fatal("expected an error from semver-checks")
+	}
+
+	// Skipping the checks should succeed.
+	if err := Publish(config, true, true); err != nil {
+		t.Fatal(err)
+	}
+}

internal/sidekick/rust_publish.go

@@ -19,6 +19,10 @@ import (
 	rustrelease "github.com/googleapis/librarian/internal/sidekick/internal/rust_release"
 )
 
+var (
+	skipSemverChecks bool
+)
+
 func init() {
 	newCommand(
 		"sidekick rust-publish",
@@ -32,10 +36,11 @@ the dependency order.
 `,
 		cmdSidekick,
 		rustPublish,
-	)
+	).addFlagBool(&skipSemverChecks, "skip-semver-checks", false, "skip 'cargo semver-checks' for changed crates.")
 }
 
-// rustBumpVersions increments the version numbers as needed.
+// rustPublish finds all the crates that should be published, (optionally) runs
+// `cargo semver-checks` and (optionally) publishes them.
 func rustPublish(rootConfig *config.Config, cmdLine *CommandLine) error {
-	return rustrelease.Publish(rootConfig.Release, cmdLine.DryRun)
+	return rustrelease.Publish(rootConfig.Release, cmdLine.DryRun, skipSemverChecks)
 }