Repository: googleapis/api-linter
Pull request #420 (2019-12-06 01:37:54)

[AIP-131] Enforce field behavior annotation.


Patch:
diff --git a/docs/rules/0131/request-name-behavior.md b/docs/rules/0131/request-name-behavior.md
new file mode 100644
index 0000000..af55fe9
--- /dev/null
+++ b/docs/rules/0131/request-name-behavior.md
@@ -0,0 +1,69 @@
+---
+rule:
+  aip: 131
+  name: [core, '0131', request-name-behavior]
+  summary: |
+    Get RPCs should annotate the `name` field with `google.api.field_behavior`.
+permalink: /131/request-name-behavior
+redirect_from:
+  - /0131/request-name-behavior
+---
+
+# Get methods: Field behavior
+
+This rule enforces that all `Get` standard methods have
+`google.api.field_behavior` set to `REQUIRED` on their `string name` field, as
+mandated in [AIP-131][].
+
+## Details
+
+This rule looks at any message matching `Get*Request` and complains if either
+the `name` field does not have a `google.api.field_behavior` annotation with a
+value of `REQUIRED`.
+
+## Examples
+
+**Incorrect** code for this rule:
+
+```proto
+// Incorrect.
+message GetBookRequest {
+  // The `google.api.field_behavior` annotation should also be included.
+  string book = 1 [(google.api.resource_reference) = {
+    type: "library.googleapis.com/Book"
+  }];
+}
+```
+
+**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-behavior=disabled
+//     aip.dev/not-precedent: This is named "book" for historical reasons. --)
+message GetBookRequest {
+  string book = 1 [(google.api.resource_reference) = {
+    type: "library.googleapis.com/Book"
+  }];
+}
+```
+
+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 adfaf55..2025512 100644
--- a/rules/aip0131/aip0131.go
+++ b/rules/aip0131/aip0131.go
@@ -32,6 +32,7 @@ func AddRules(r lint.RuleRegistry) error {
 		httpNameField,
 		responseMessageName,
 		requestMessageName,
+		requestNameBehavior,
 		requestNameReference,
 		standardFields,
 		synonyms,
diff --git a/rules/aip0131/request_name_behavior.go b/rules/aip0131/request_name_behavior.go
new file mode 100644
index 0000000..392ad8f
--- /dev/null
+++ b/rules/aip0131/request_name_behavior.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 requestNameBehavior = &lint.FieldRule{
+	Name: lint.NewRuleName(131, "request-name-behavior"),
+	OnlyIf: func(f *desc.FieldDescriptor) bool {
+		return isGetRequestMessage(f.GetOwner()) && f.GetName() == "name"
+	},
+	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
+		if !utils.GetFieldBehavior(f).Contains("REQUIRED") {
+			return []lint.Problem{{
+				Message:    "Get requests: The `name` field should include `(google.api.field_behavior) = REQUIRED`.",
+				Descriptor: f,
+			}}
+		}
+		return nil
+	},
+}


Test patch:
diff --git a/rules/aip0131/request_name_behavior_test.go b/rules/aip0131/request_name_behavior_test.go
new file mode 100644
index 0000000..7c453a6
--- /dev/null
+++ b/rules/aip0131/request_name_behavior_test.go
@@ -0,0 +1,47 @@
+// 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 TestRequestNameBehavior(t *testing.T) {
+	for _, test := range []struct {
+		name          string
+		FieldName     string
+		FieldBehavior string
+		problems      testutils.Problems
+	}{
+		{"Valid", "name", " [(google.api.field_behavior) = REQUIRED]", testutils.Problems{}},
+		{"Missing", "name", "", testutils.Problems{{Message: "(google.api.field_behavior) = REQUIRED"}}},
+		{"Irrelevant", "something_else", "", testutils.Problems{}},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			f := testutils.ParseProto3Tmpl(t, `
+				import "google/api/field_behavior.proto";
+				message GetBookRequest {
+					string {{.FieldName}} = 1{{.FieldBehavior}};
+				}
+			`, test)
+			field := f.GetMessageTypes()[0].GetFields()[0]
+			if diff := test.problems.SetDescriptor(field).Diff(requestNameBehavior.Lint(f)); diff != "" {
+				t.Errorf(diff)
+			}
+		})
+	}
+}