Repository: googleapis/api-linter
Pull request #419 (2019-12-06 01:25:36)

[AIP-131] Require google.api.resource_reference on Get methods.


Patch:
diff --git a/docs/rules/0131/request-name-field.md b/docs/rules/0131/request-name-field.md
index 1dbb7ac..062c842 100644
--- a/docs/rules/0131/request-name-field.md
+++ b/docs/rules/0131/request-name-field.md
@@ -25,14 +25,20 @@ the `name` field is missing, or if it has any type other than `string`.
 ```proto
 // Incorrect.
 message GetBookRequest {
-  string book = 1;  // Field name should be `name`.
+  string book = 1 [  // Field name should be `name`.
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference).type = "library.googleapis.com/Book"
+  ];
 }
 ```
 
 ```proto
 // Incorrect.
 message GetBookRequest {
-  bytes name = 1;  // Field type should be `string`.
+  bytes name = 1 [  // Field type should be `string`.
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference).type = "library.googleapis.com/Book"
+  ];
 }
 ```
 
@@ -41,7 +47,10 @@ message GetBookRequest {
 ```proto
 // Correct.
 message GetBookRequest {
-  string name = 1;
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference).type = "library.googleapis.com/Book"
+  ];
 }
 ```
 
diff --git a/docs/rules/0131/request-name-reference.md b/docs/rules/0131/request-name-reference.md
new file mode 100644
index 0000000..963b31b
--- /dev/null
+++ b/docs/rules/0131/request-name-reference.md
@@ -0,0 +1,64 @@
+---
+rule:
+  aip: 131
+  name: [core, '0131', request-name-reference]
+  summary: |
+    Get RPCs should annotate the `name` field with `google.api.resource_reference`.
+permalink: /131/request-name-reference
+redirect_from:
+  - /0131/request-name-reference
+---
+
+# Get methods: Resource reference
+
+This rule enforces that all `Get` standard methods have
+`google.api.resource_reference` on their `string name` field, as mandated in
+[AIP-131][].
+
+## Details
+
+This rule looks at the `name` field of any message matching `Get*Request` and
+complains if it does not have a `google.api.resource_reference` annotation.
+
+## Examples
+
+**Incorrect** code for this rule:
+
+```proto
+// Incorrect.
+message GetBookRequest {
+  // The `google.api.resource_reference` annotation should also be included.
+  string book = 1 [(google.api.field_behavior) = REQUIRED];
+}
+```
+
+**Correct** code for this rule:
+
+```proto
+// Correct.
+message GetBookRequest {
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference).type = "library.googleapis.com/Book"
+  ];
+}
+```
+
+## Disabling
+
+If you need to violate this rule, use a leading comment above the field.
+Remember to also include an [aip.dev/not-precedent][] comment explaining why.
+
+```proto
+// (-- api-linter: core::0131::request-name-reference=disabled
+//     aip.dev/not-precedent: This is named "book" for historical reasons. --)
+message GetBookRequest {
+  string book = 1 [(google.api.field_behavior) = REQUIRED];
+}
+```
+
+If you need to violate this rule for an entire file, place the comment at the
+top of the file.
+
+[aip-131]: https://aip.dev/131
+[aip.dev/not-precedent]: https://aip.dev/not-precedent
diff --git a/rules/aip0131/aip0131.go b/rules/aip0131/aip0131.go
index 0c6a44f..adfaf55 100644
--- a/rules/aip0131/aip0131.go
+++ b/rules/aip0131/aip0131.go
@@ -32,6 +32,7 @@ func AddRules(r lint.RuleRegistry) error {
 		httpNameField,
 		responseMessageName,
 		requestMessageName,
+		requestNameReference,
 		standardFields,
 		synonyms,
 		unknownFields,
diff --git a/rules/aip0131/request_name_reference.go b/rules/aip0131/request_name_reference.go
new file mode 100644
index 0000000..20add0c
--- /dev/null
+++ b/rules/aip0131/request_name_reference.go
@@ -0,0 +1,37 @@
+// Copyright 2019 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.
+
+package aip0131
+
+import (
+	"github.com/googleapis/api-linter/lint"
+	"github.com/googleapis/api-linter/rules/internal/utils"
+	"github.com/jhump/protoreflect/desc"
+)
+
+var requestNameReference = &lint.FieldRule{
+	Name: lint.NewRuleName(131, "request-name-reference"),
+	OnlyIf: func(f *desc.FieldDescriptor) bool {
+		return isGetRequestMessage(f.GetOwner()) && f.GetName() == "name"
+	},
+	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
+		if ref := utils.GetResourceReference(f); ref == nil {
+			return []lint.Problem{{
+				Message:    "Get methods: The `name` field should include a `google.api.resource_reference` annotation.",
+				Descriptor: f,
+			}}
+		}
+		return nil
+	},
+}


Test patch:
diff --git a/rules/aip0131/request_name_reference_test.go b/rules/aip0131/request_name_reference_test.go
new file mode 100644
index 0000000..bf617e8
--- /dev/null
+++ b/rules/aip0131/request_name_reference_test.go
@@ -0,0 +1,60 @@
+// Copyright 2019 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.
+
+package aip0131
+
+import (
+	"testing"
+
+	"github.com/googleapis/api-linter/rules/internal/testutils"
+)
+
+func TestRequestNameReference(t *testing.T) {
+	t.Run("Present", func(t *testing.T) {
+		f := testutils.ParseProto3String(t, `
+			import "google/api/resource.proto";
+			message GetBookRequest {
+				string name = 1 [(google.api.resource_reference) = {
+					type: "library.googleapis.com/Book"
+				}];
+			}
+		`)
+		if diff := (testutils.Problems{}).Diff(requestNameReference.Lint(f)); diff != "" {
+			t.Errorf(diff)
+		}
+	})
+	t.Run("Absent", func(t *testing.T) {
+		for _, test := range []struct {
+			name      string
+			FieldName string
+			problems  testutils.Problems
+		}{
+			{"Error", "name", testutils.Problems{{Message: "google.api.resource_reference"}}},
+			{"Irrelevant", "something_else", testutils.Problems{}},
+		} {
+			t.Run(test.name, func(t *testing.T) {
+				f := testutils.ParseProto3Tmpl(t, `
+					import "google/api/resource.proto";
+					message GetBookRequest {
+						string {{.FieldName}} = 1;
+					}
+				`, test)
+				field := f.GetMessageTypes()[0].GetFields()[0]
+				if diff := test.problems.SetDescriptor(field).Diff(requestNameReference.Lint(f)); diff != "" {
+					t.Errorf(diff)
+				}
+			})
+		}
+	})
+}