impl(sidekick): check version bumps (#2167)

Author: coryan

internal/sidekick/internal/rust_release/bump_versions.go

@@ -14,7 +14,13 @@
 
 package rustrelease
 
-import "github.com/googleapis/librarian/internal/sidekick/internal/config"
+import (
+	"log/slog"
+	"slices"
+
+	"github.com/googleapis/librarian/internal/sidekick/internal/config"
+	"github.com/googleapis/librarian/internal/sidekick/internal/external"
+)
 
 // BumpVersions finds all the crates that need a version bump and performs the
 // bump, changing both the Cargo.toml and sidekick.toml files.
@@ -30,14 +36,30 @@ func BumpVersions(config *config.Release) error {
 	if err != nil {
 		return err
 	}
-	var packages []string
+	var crates []string
 	for _, manifest := range findCargoManifests(files) {
 		names, err := updateManifest(config, lastTag, manifest)
 		if err != nil {
 			return err
 		}
-		packages = append(packages, names...)
+		crates = append(crates, names...)
+	}
+	if tools, ok := config.Tools["cargo"]; ok {
+		if !slices.ContainsFunc(tools, containsSemverChecks) {
+			return nil
+		}
+	} else {
+		return nil
+	}
+	for _, name := range crates {
+		slog.Info("runnning cargo semver-checks", "crate", name)
+		if err := external.Run(cargoExe(config), "semver-checks", "--all-features", "-p", name); err != nil {
+			return err
+		}
 	}
-	_ = packages
 	return nil
 }
+
+func containsSemverChecks(a config.Tool) bool {
+	return a.Name == "cargo-semver-checks"
+}

internal/sidekick/internal/rust_release/bump_versions_test.go

@@ -37,12 +37,76 @@ version = "1.0.0"
 
 func TestBumpVersionsSuccess(t *testing.T) {
 	requireCommand(t, "git")
+	requireCommand(t, "/bin/echo")
 	config := &config.Release{
 		Remote: "origin",
 		Branch: "main",
 		Preinstalled: map[string]string{
 			"git":   "git",
-			"cargo": "git",
+			"cargo": "/bin/echo",
+		},
+		Tools: map[string][]config.Tool{
+			"cargo": {
+				{Name: "cargo-semver-checks", Version: "1.2.3"},
+			},
+		},
+	}
+	setupForVersionBump(t, "release-2001-02-03")
+	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)
+	}
+	if err := BumpVersions(config); err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestBumpVersionsNoCargoTools(t *testing.T) {
+	requireCommand(t, "git")
+	requireCommand(t, "/bin/echo")
+	config := &config.Release{
+		Remote: "origin",
+		Branch: "main",
+		Preinstalled: map[string]string{
+			"git":   "git",
+			"cargo": "/bin/echo",
+		},
+		Tools: map[string][]config.Tool{
+			"not-cargo": {
+				{Name: "semver-checks", Version: "1.2.3"},
+			},
+		},
+	}
+	setupForVersionBump(t, "release-2001-02-03")
+	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)
+	}
+	if err := BumpVersions(config); err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestBumpVersionsNoSemverChecks(t *testing.T) {
+	requireCommand(t, "git")
+	requireCommand(t, "/bin/echo")
+	config := &config.Release{
+		Remote: "origin",
+		Branch: "main",
+		Preinstalled: map[string]string{
+			"git":   "git",
+			"cargo": "/bin/echo",
+		},
+		Tools: map[string][]config.Tool{
+			"cargo": {
+				{Name: "some-other-tool", Version: "1.2.3"},
+			},
 		},
 	}
 	setupForVersionBump(t, "release-2001-02-03")

internal/sidekick/internal/rust_release/preflight.go

@@ -15,6 +15,8 @@
 package rustrelease
 
 import (
+	"fmt"
+
 	"github.com/googleapis/librarian/internal/sidekick/internal/config"
 	"github.com/googleapis/librarian/internal/sidekick/internal/external"
 )
@@ -30,6 +32,16 @@ func PreFlight(config *config.Release) error {
 	if err := external.Run(gitExe(config), "remote", "get-url", config.Remote); err != nil {
 		return err
 	}
+	tools, ok := config.Tools["cargo"]
+	if !ok {
+		return nil
+	}
+	for _, tool := range tools {
+		spec := fmt.Sprintf("%s@%s", tool.Name, tool.Version)
+		if err := external.Run(cargoExe(config), "install", "--locked", spec); err != nil {
+			return err
+		}
+	}
 	return nil
 }
 

internal/sidekick/internal/rust_release/preflight_test.go

@@ -58,6 +58,54 @@ func TestPreflightMissingUpstream(t *testing.T) {
 	}
 }
 
+func TestPreflightWithTools(t *testing.T) {
+	requireCommand(t, "git")
+	requireCommand(t, "/bin/echo")
+	release := config.Release{
+		Remote: "origin",
+		Branch: "main",
+		Preinstalled: map[string]string{
+			"cargo": "/bin/echo",
+		},
+		Tools: map[string][]config.Tool{
+			"cargo": {
+				{
+					Name:    "cargo-semver-checks",
+					Version: "0.42.0",
+				},
+			},
+		},
+	}
+	setupForVersionBump(t, "test-preflight-with-tools")
+	if err := PreFlight(&release); err != nil {
+		t.Errorf("expected a successful run, got=%v", err)
+	}
+}
+
+func TestPreflightToolFailure(t *testing.T) {
+	requireCommand(t, "git")
+	release := config.Release{
+		Remote: "origin",
+		Branch: "main",
+		Preinstalled: map[string]string{
+			// Using `git install blah blah` will fail.
+			"cargo": "git",
+		},
+		Tools: map[string][]config.Tool{
+			"cargo": {
+				{
+					Name:    "invalid-tool-name---",
+					Version: "a.b.c",
+				},
+			},
+		},
+	}
+	setupForVersionBump(t, "test-preflight-with-tools")
+	if err := PreFlight(&release); err == nil {
+		t.Errorf("expected an error installing cargo-semver-checks")
+	}
+}
+
 func TestGitExe(t *testing.T) {
 	release := config.Release{}
 	if got := gitExe(&release); got != "git" {

internal/sidekick/internal/rust_release/update_manifest.go

@@ -42,9 +42,6 @@ func updateManifest(config *config.Release, lastTag, manifest string) ([]string,
 	if err != nil {
 		return nil, err
 	}
-	if updated {
-		return nil, nil
-	}
 	contents, err := os.ReadFile(manifest)
 	if err != nil {
 		return nil, err
@@ -60,6 +57,9 @@ func updateManifest(config *config.Release, lastTag, manifest string) ([]string,
 	if !info.Package.Publish {
 		return nil, nil
 	}
+	if updated {
+		return []string{info.Package.Name}, nil
+	}
 	newVersion, err := bumpPackageVersion(info.Package.Version)
 	if err != nil {
 		return nil, err

internal/sidekick/internal/rust_release/update_manifest_test.go

@@ -63,10 +63,17 @@ func TestUpdateManifestSuccess(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	want = nil
 	if diff := cmp.Diff(want, got); diff != "" {
 		t.Errorf("mismatch (-want, +got):\n%s", diff)
 	}
+	contents, err = os.ReadFile(name)
+	if err != nil {
+		t.Fatal(err)
+	}
+	idx = bytes.Index(contents, []byte("version = \"1.1.0\"\n"))
+	if idx == -1 {
+		t.Errorf("expected version = 1.1.0 in new file, got=%s", contents)
+	}
 }
 
 func TestUpdateManifestBadDelta(t *testing.T) {