fix(AIP-123): multiword singleton reduction (#1417)

googleapis · Aug 14, 2024 · 7868552 · 7868552
1 parent 6bfbcdf
commit 7868552
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/rules/aip0123/resource_pattern_singular.go b/rules/aip0123/resource_pattern_singular.go
@@ -46,6 +46,11 @@ var resourcePatternSingular = &lint.MessageRule{
 		if !utils.IsSingletonResource(m) {
 			singular = fmt.Sprintf("{%s}", strcase.SnakeCase(singular))
 			nn = fmt.Sprintf("{%s}", nn)
+		} else {
+			// singular is already in lower camel case
+			// but nested name is returned in snake_case form
+			// and final segment of singleton is lowerCamelCase
+			nn = strcase.LowerCamelCase(nn)
 		}
 
 		// If the first pattern is reduced or non-compliant, but is nested name eligible, we want to recommend the nested name.

diff --git a/rules/aip0123/resource_pattern_singular_test.go b/rules/aip0123/resource_pattern_singular_test.go
@@ -54,6 +54,41 @@ func TestResourcePatternSingularSimple(t *testing.T) {
 	}
 }
 
+func TestResourcePatternSingularMultiWord(t *testing.T) {
+	for _, test := range []struct {
+		name     string
+		Pattern  string
+		problems testutils.Problems
+	}{
+		{"Valid", "fooBars/{foo_bar}/fooBarBazBuzzes/{foo_bar_baz_buz}", testutils.Problems{}},
+		{"ValidReduced", "fooBars/{foo_bar}/bazBuzzes/{baz_buz}", testutils.Problems{}},
+		{"ValidSingleton", "fooBars/{foo_bar}/fooBarBazBuz", testutils.Problems{}},
+		{"ValidSingletonReduced", "fooBars/{foo_bar}/bazBuz", testutils.Problems{}},
+		{"Invalid", "fooBars/{foo_bar}/fooBarBazBuzzes/{buz}", testutils.Problems{{Message: "baz_buz"}}},
+		{"InvalidSingleton", "fooBars/{foo_bar}/buz", testutils.Problems{{Message: "bazBuz"}}},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			f := testutils.ParseProto3Tmpl(t, `
+				import "google/api/resource.proto";
+
+				message FooBarBazBuz {
+					option (google.api.resource) = {
+						type: "foo.googleapis.com/FooBarBazBuz"
+						singular: "fooBarBazBuz"
+						plural: "fooBarBazBuzzes"
+						pattern: "{{.Pattern}}"
+					};
+					string name = 1;
+				}
+			`, test)
+			m := f.GetMessageTypes()[0]
+			if diff := test.problems.SetDescriptor(m).Diff(resourcePatternSingular.Lint(f)); diff != "" {
+				t.Errorf(diff)
+			}
+		})
+	}
+}
+
 func TestResourcePatternSingularNested(t *testing.T) {
 	for _, test := range []struct {
 		name          string