feat(devtools/cmd/migrate-sidekick): create a sidekick migration tool (#3095)

JoeWang1127 · web-flow · commit 403ea7abf93f · 2025-12-02T17:47:21.000-05:00
Add a devtool to migrate `.sidekick.toml` and `Cargo.toml` to librarian configuration. To use the tool: ```sh go run devtools/cmd/migrate-sidekick/main.go migrate-sidekick -repo=../google-cloud-rust` ``` Fixes #3064
diff --git a/devtools/cmd/migrate-sidekick/main.go b/devtools/cmd/migrate-sidekick/main.go
diff --git a/devtools/cmd/migrate-sidekick/main_test.go b/devtools/cmd/migrate-sidekick/main_test.go
diff --git a/devtools/cmd/migrate-sidekick/testdata/find-sidekick-files/success/src/generated/sub-1/.sidekick.toml b/devtools/cmd/migrate-sidekick/testdata/find-sidekick-files/success/src/generated/sub-1/.sidekick.toml
diff --git a/devtools/cmd/migrate-sidekick/testdata/find-sidekick-files/success/src/generated/sub-1/subsub-1/.sidekick.toml b/devtools/cmd/migrate-sidekick/testdata/find-sidekick-files/success/src/generated/sub-1/subsub-1/.sidekick.toml
diff --git a/devtools/cmd/migrate-sidekick/testdata/find-sidekick-files/success/src/generated/sub-1/subsub-1/unrelevant.txt b/devtools/cmd/migrate-sidekick/testdata/find-sidekick-files/success/src/generated/sub-1/subsub-1/unrelevant.txt
diff --git a/devtools/cmd/migrate-sidekick/testdata/get-git-commit/branch-not-found/test-git/HEAD b/devtools/cmd/migrate-sidekick/testdata/get-git-commit/branch-not-found/test-git/HEAD
@@ -0,0 +1 @@
+ref: refs/heads/main
diff --git a/devtools/cmd/migrate-sidekick/testdata/get-git-commit/branch-not-found/test-git/refs/heads/another-branch b/devtools/cmd/migrate-sidekick/testdata/get-git-commit/branch-not-found/test-git/refs/heads/another-branch
@@ -0,0 +1 @@
+12345678abcdefg
diff --git a/devtools/cmd/migrate-sidekick/testdata/get-git-commit/branch/test-git/HEAD b/devtools/cmd/migrate-sidekick/testdata/get-git-commit/branch/test-git/HEAD
@@ -0,0 +1 @@
+ref: refs/heads/main
diff --git a/devtools/cmd/migrate-sidekick/testdata/get-git-commit/branch/test-git/refs/heads/another-branch b/devtools/cmd/migrate-sidekick/testdata/get-git-commit/branch/test-git/refs/heads/another-branch
@@ -0,0 +1 @@
+12345678abcdefg
diff --git a/devtools/cmd/migrate-sidekick/testdata/get-git-commit/branch/test-git/refs/heads/main b/devtools/cmd/migrate-sidekick/testdata/get-git-commit/branch/test-git/refs/heads/main
@@ -0,0 +1 @@
+95bdc62f7448ffb183aada62de1be5a704e54a8c
diff --git a/devtools/cmd/migrate-sidekick/testdata/get-git-commit/direct-commit-sha/test-git/HEAD b/devtools/cmd/migrate-sidekick/testdata/get-git-commit/direct-commit-sha/test-git/HEAD
@@ -0,0 +1 @@
+1234567abcdefg
diff --git a/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/no-api-path/.sidekick.toml b/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/no-api-path/.sidekick.toml
@@ -0,0 +1 @@
+[general]
diff --git a/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/no-package-name/.sidekick.toml b/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/no-package-name/.sidekick.toml
@@ -0,0 +1,3 @@
+[general]
+specification-source = 'google/cloud/sql/v1'
+service-config       = 'google/cloud/sql/v1/sqladmin_v1.yaml'
diff --git a/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/no-package-name/Cargo.toml b/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/no-package-name/Cargo.toml
@@ -0,0 +1 @@
+[package]
diff --git a/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/success-read/.sidekick.toml b/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/success-read/.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'
diff --git a/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/success-read/Cargo.toml b/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/success-read/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
diff --git a/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/success-read/nested/.sidekick.toml b/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/success-read/nested/.sidekick.toml
@@ -0,0 +1,31 @@
+[general]
+specification-source = 'google/cloud/security/publicca/v1'
+service-config = 'google/cloud/security/publicca/v1/publicca_v1.yaml'
+
+[source]
+title-override = 'Google Apps Script Types'
+description-override = 'Description override'
+roots = 'discovery,googleapis'
+include-list = "api.proto,source_context.proto,type.proto,descriptor.proto"
+include-ids = ".google.iam.v2.Resource"
+skipped-ids = ".google.iam.v1.ResourcePolicyMember"
+
+[codec]
+version        = '1.1.0'
+copyright-year = '2025'
+per-service-features      = 'true'
+disabled-rustdoc-warnings = "bare_urls,broken_intra_doc_links,redundant_explicit_links"
+generate-setter-samples = 'true'
+name-overrides            = '.google.cloud.security/publicca.v1.Storage=StorageControl'
+module-path           = 'crate'
+template-override     = 'templates/mod'
+package-name-override = 'google-cloud-security-publicca-v1'
+root-name         = 'conformance-root'
+default-features          = 'instances,projects'
+extra-modules             = 'errors,operation'
+disabled-clippy-warnings  = "doc_lazy_continuation"
+has-veneer                = 'true'
+routing-required          = 'true'
+include-grpc-only-methods = 'true'
+post-process-protos = 'example post processing'
+detailed-tracing-attributes = 'true'
diff --git a/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/success-read/nested/Cargo.toml b/devtools/cmd/migrate-sidekick/testdata/read-sidekick-files/success-read/nested/Cargo.toml
@@ -0,0 +1,27 @@
+[package]
+name                   = "google-cloud-security-publicca-v1"
+version                = "1.1.0"
+description            = "Google Cloud Client Libraries for Rust - Public Certificate Authority API"
+edition.workspace      = true
+authors.workspace      = true
+license.workspace      = true
+repository.workspace   = true
+keywords.workspace     = true
+categories.workspace   = true
+rust-version.workspace = true
+
+[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
diff --git a/devtools/cmd/migrate-sidekick/testdata/root-sidekick/success/.sidekick.toml b/devtools/cmd/migrate-sidekick/testdata/root-sidekick/success/.sidekick.toml
@@ -0,0 +1,33 @@
+# Copyright 2024 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.
+
+[codec]
+# The default version for all crates. This can be overridden in the crate's
+# `.sidekick.toml` file.
+version = "1.0.0"
+# The default release level for all crates.
+release-level = "stable"
+# Disable a number of warnings.
+# TODO(#1285) - remove `redundant_explicit_links` workaround when no longer needed
+# TODO(#742) - remove `broken_intro_doc_links` workaround when no longer needed
+disabled-rustdoc-warnings = "redundant_explicit_links,broken_intra_doc_links"
+# These are external (not part of `google-cloud-rust`) crates used by (nearly
+# all) generated crates.
+'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'
+
+[release]
+remote          = 'upstream'
+branch          = 'main'
+ignored-changes = ['.repo-metadata.json', '.sidekick.toml']
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -130,7 +130,7 @@ type Library struct {
 	Rust *RustCrate `yaml:"rust,omitempty"`
 }
 
-// Channel describes an Channel to include in a library.
+// Channel describes a Channel to include in a library.
 type Channel struct {
 	// Path specifies which googleapis Path to generate from (for generated
 	// libraries).
diff --git a/internal/config/language.go b/internal/config/language.go
@@ -82,7 +82,7 @@ type RustCrate struct {
 	GenerateSetterSamples bool `yaml:"generate_setter_samples,omitempty"`
 
 	// PostProcessProtos indicates whether to post-process protos.
-	PostProcessProtos bool `yaml:"post_process_protos,omitempty"`
+	PostProcessProtos string `yaml:"post_process_protos,omitempty"`
 
 	// DetailedTracingAttributes indicates whether to include detailed tracing attributes.
 	DetailedTracingAttributes bool `yaml:"detailed_tracing_attributes,omitempty"`

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+95bdc62f7448ffb183aada62de1be5a704e54a8c`