fix: add call to librarian tidy from migrate-sidekick command (#3163)

Invoke librarian runTidy from the migrate-sidekick command. This exports
the librarian function runTidy to give migrate-sidekick command access
to it. Additionally it renames the default librarian yaml file in
migrate-sidekick to be librarian.yaml to align with default file in
librarian.go.

---------

Signed-off-by: ldetmer <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Author: ldetmer

devtools/cmd/migrate-sidekick/main.go

@@ -27,6 +27,7 @@ import (
 	"strings"
 
 	"github.com/googleapis/librarian/internal/config"
+	"github.com/googleapis/librarian/internal/librarian"
 	"github.com/googleapis/librarian/internal/yaml"
 	"github.com/pelletier/go-toml/v2"
 )
@@ -39,6 +40,7 @@ var (
 	errRepoNotFound     = errors.New("-repo flag is required")
 	errSidekickNotFound = errors.New(".sidekick.toml not found")
 	errSrcNotFound      = errors.New("src/generated directory not found")
+	errTidyFailed       = errors.New("librarian tidy failed")
 )
 
 // SidekickConfig represents the structure of a .sidekick.toml file.
@@ -79,7 +81,7 @@ func main() {
 func run(args []string) error {
 	flagSet := flag.NewFlagSet("migrate-sidekick", flag.ContinueOnError)
 	repoPath := flagSet.String("repo", "", "Path to the google-cloud-rust repository (required)")
-	outputPath := flagSet.String("output", "./.librarian.yaml", "Output file path (default: ./.librarian.yaml)")
+	outputPath := flagSet.String("output", "./librarian.yaml", "Output file path (default: ./librarian.yaml)")
 	if err := flagSet.Parse(args[1:]); err != nil {
 		return err
 	}
@@ -115,6 +117,11 @@ func run(args []string) error {
 	}
 	slog.Info("Wrote config to output file", "path", outputPath)
 
+	if err := librarian.RunTidy(); err != nil {
+		slog.Error(errTidyFailed.Error(), "error", err)
+		return errTidyFailed
+	}
+
 	return nil
 }
 

devtools/cmd/migrate-sidekick/main_test.go

@@ -16,14 +16,14 @@ package main
 
 import (
 	"errors"
+	"os"
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/googleapis/librarian/internal/config"
 )
 
 func TestReadRootSidekick(t *testing.T) {
-	t.Parallel()
 	for _, test := range []struct {
 		name    string
 		path    string
@@ -73,7 +73,6 @@ func TestReadRootSidekick(t *testing.T) {
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			t.Parallel()
 			got, err := readRootSidekick(test.path)
 			if test.wantErr != nil {
 				if !errors.Is(err, test.wantErr) {
@@ -94,7 +93,6 @@ func TestReadRootSidekick(t *testing.T) {
 }
 
 func TestFindSidekickFiles(t *testing.T) {
-	t.Parallel()
 	for _, test := range []struct {
 		name    string
 		path    string
@@ -116,7 +114,6 @@ func TestFindSidekickFiles(t *testing.T) {
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			t.Parallel()
 			got, err := findSidekickFiles(test.path)
 			if test.wantErr != nil {
 				if !errors.Is(err, test.wantErr) {
@@ -137,7 +134,6 @@ func TestFindSidekickFiles(t *testing.T) {
 }
 
 func TestReadSidekickFiles(t *testing.T) {
-	t.Parallel()
 	for _, test := range []struct {
 		name    string
 		files   []string
@@ -249,7 +245,6 @@ func TestReadSidekickFiles(t *testing.T) {
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			t.Parallel()
 			got, err := readSidekickFiles(test.files)
 			if test.wantErr != nil {
 				if !errors.Is(err, test.wantErr) {
@@ -270,7 +265,6 @@ func TestReadSidekickFiles(t *testing.T) {
 }
 
 func TestDeriveLibraryName(t *testing.T) {
-	t.Parallel()
 	for _, test := range []struct {
 		name string
 		api  string
@@ -308,7 +302,6 @@ func TestDeriveLibraryName(t *testing.T) {
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			t.Parallel()
 			got := deriveLibraryName(test.api)
 			if diff := cmp.Diff(test.want, got); diff != "" {
 				t.Errorf("mismatch (-want +got):\n%s", diff)
@@ -318,7 +311,6 @@ func TestDeriveLibraryName(t *testing.T) {
 }
 
 func TestBuildConfig(t *testing.T) {
-	t.Parallel()
 	for _, test := range []struct {
 		name      string
 		libraries map[string]*config.Library
@@ -406,11 +398,52 @@ func TestBuildConfig(t *testing.T) {
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
-			t.Parallel()
 			got := buildConfig(test.libraries, test.defaults)
 			if diff := cmp.Diff(test.want, got); diff != "" {
 				t.Errorf("mismatch (-want +got):\n%s", diff)
 			}
 		})
 	}
 }
+
+func TestRunMigrateCommand(t *testing.T) {
+	for _, test := range []struct {
+		name    string
+		path    string
+		wantErr error
+	}{
+		{
+			name: "success",
+			path: "testdata/run/success",
+		},
+		{
+			name:    "tidy_command_fails",
+			path:    "testdata/run/tidy-fails",
+			wantErr: errTidyFailed,
+		},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+
+			// ensure librarian.yaml generated is removed after the test,
+			// even if the test fails
+			outputPath := "librarian.yaml"
+			t.Cleanup(func() {
+				if err := os.Remove(outputPath); err != nil && !os.IsNotExist(err) {
+					t.Logf("cleanup: remove %s: %v", outputPath, err)
+				}
+			})
+
+			if err := run([]string{"migrate-sidekick", "-repo", test.path}); err != nil {
+				if test.wantErr == nil {
+					t.Fatal(err)
+				}
+				if !errors.Is(err, test.wantErr) {
+					t.Fatalf("expected error containing %q, got: %v", test.wantErr, err)
+				}
+			} else if test.wantErr != nil {
+				t.Fatalf("expected error containing %q, got nil", test.wantErr)
+			}
+
+		})
+	}
+}

devtools/cmd/migrate-sidekick/testdata/run/success/.sidekick.toml

@@ -0,0 +1,19 @@
+[general]
+specification-source = 'google/cloud/sql/v1'
+service-config       = 'google/cloud/sql/v1/sqladmin_v1.yaml'
+
+[[pagination-overrides]]
+id         = '.google.cloud.sql.v1.SqlInstancesService.List'
+item-field = 'items'
+
+[codec]
+version        = '1.2.0'
+copyright-year = '2025'
+'package:lazy_static' = 'used-if=services,package=lazy_static,force-used=true'
+'package:gaxi'        = 'used-if=services,package=google-cloud-gax-internal,feature=_internal-http-client,source=internal'
+
+
+[[documentation-overrides]]
+id = '.google.api.ProjectProperties'
+match = 'example match'
+replace = 'example replace'

devtools/cmd/migrate-sidekick/testdata/run/success/src/generated/api/.sidekick.toml

@@ -0,0 +1,27 @@
+[package]
+name                   = "google-cloud-sql-v1"
+description            = "Google Cloud Client Libraries for Rust - Cloud SQL Admin API"
+edition.workspace      = true
+authors.workspace      = true
+license.workspace      = true
+repository.workspace   = true
+keywords.workspace     = true
+categories.workspace   = true
+rust-version.workspace = true
+publish                = false
+
+[dependencies]
+async-trait.workspace = true
+bytes.workspace      = true
+gax.workspace        = true
+gaxi                 = { workspace = true, features = ["_internal-http-client"] }
+lazy_static.workspace = true
+reqwest.workspace    = true
+serde.workspace      = true
+serde_json.workspace = true
+serde_with.workspace = true
+tracing.workspace    = true
+wkt.workspace        = true
+
+[dev-dependencies]
+tokio-test.workspace = true

devtools/cmd/migrate-sidekick/testdata/run/success/src/generated/api/Cargo.toml

@@ -0,0 +1,19 @@
+[general]
+specification-source = 'google/cloud/sql/v1'
+service-config       = 'google/cloud/sql/v1/sqladmin_v1.yaml'
+
+[[pagination-overrides]]
+id         = '.google.cloud.sql.v1.SqlInstancesService.List'
+item-field = 'items'
+
+[codec]
+version        = '1.2.0'
+copyright-year = '2025'
+'package:lazy_static' = 'used-if=services,package=lazy_static,force-used=true'
+'package:gaxi'        = 'used-if=services,package=google-cloud-gax-internal,feature=_internal-http-client,source=internal'
+
+
+[[documentation-overrides]]
+id = '.google.api.ProjectProperties'
+match = 'example match'
+replace = 'example replace'

devtools/cmd/migrate-sidekick/testdata/run/tidy-fails/.sidekick.toml

@@ -0,0 +1,27 @@
+[package]
+name                   = "google-cloud-sql-v1"
+description            = "Google Cloud Client Libraries for Rust - Cloud SQL Admin API"
+edition.workspace      = true
+authors.workspace      = true
+license.workspace      = true
+repository.workspace   = true
+keywords.workspace     = true
+categories.workspace   = true
+rust-version.workspace = true
+publish                = false
+
+[dependencies]
+async-trait.workspace = true
+bytes.workspace      = true
+gax.workspace        = true
+gaxi                 = { workspace = true, features = ["_internal-http-client"] }
+lazy_static.workspace = true
+reqwest.workspace    = true
+serde.workspace      = true
+serde_json.workspace = true
+serde_with.workspace = true
+tracing.workspace    = true
+wkt.workspace        = true
+
+[dev-dependencies]
+tokio-test.workspace = true

devtools/cmd/migrate-sidekick/testdata/run/tidy-fails/src/generated/api/.sidekick.toml

@@ -0,0 +1,19 @@
+[general]
+specification-source = 'google/cloud/sql/v1'
+service-config       = 'google/cloud/sql/v1/sqladmin_v1.yaml'
+
+[[pagination-overrides]]
+id         = '.google.cloud.sql.v1.SqlInstancesService.List'
+item-field = 'items'
+
+[codec]
+version        = '1.2.0'
+copyright-year = '2025'
+'package:lazy_static' = 'used-if=services,package=lazy_static,force-used=true'
+'package:gaxi'        = 'used-if=services,package=google-cloud-gax-internal,feature=_internal-http-client,source=internal'
+
+
+[[documentation-overrides]]
+id = '.google.api.ProjectProperties'
+match = 'example match'
+replace = 'example replace'

devtools/cmd/migrate-sidekick/testdata/run/tidy-fails/src/generated/api/Cargo.toml

@@ -0,0 +1,27 @@
+[package]
+name                   = "google-cloud-sql-v1"
+description            = "Google Cloud Client Libraries for Rust - Cloud SQL Admin API"
+edition.workspace      = true
+authors.workspace      = true
+license.workspace      = true
+repository.workspace   = true
+keywords.workspace     = true
+categories.workspace   = true
+rust-version.workspace = true
+publish                = false
+
+[dependencies]
+async-trait.workspace = true
+bytes.workspace      = true
+gax.workspace        = true
+gaxi                 = { workspace = true, features = ["_internal-http-client"] }
+lazy_static.workspace = true
+reqwest.workspace    = true
+serde.workspace      = true
+serde_json.workspace = true
+serde_with.workspace = true
+tracing.workspace    = true
+wkt.workspace        = true
+
+[dev-dependencies]
+tokio-test.workspace = true