fix(AIP-121): ignore standard method lookalikes (googleapis#1250)

aep-dev · Sep 12, 2023 · 34aa3c8 · 34aa3c8
1 parent 2c2abff
commit 34aa3c8
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/rules/aip0121/resource_must_support_get.go b/rules/aip0121/resource_must_support_get.go
@@ -33,16 +33,16 @@ var resourceMustSupportGet = &lint.ServiceRule{
  // Iterate all RPCs and try to find resources. Mark the
  // resources which have a Get method, and which ones do not.
  for _, m := range s.GetMethods() {
- if utils.IsGetMethod(m) {
+ if utils.IsGetMethod(m) && utils.IsResource(utils.GetResponseType(m)) {
  t := utils.GetResource(m.GetOutputType()).GetType()
  resourcesWithGet.Add(t)
  } else if utils.IsCreateMethod(m) || utils.IsUpdateMethod(m) {
- if msg := utils.GetResponseType(m); msg != nil {
+ if msg := utils.GetResponseType(m); msg != nil && utils.IsResource(msg) {
  t := utils.GetResource(msg).GetType()
  resourcesWithOtherMethods.Add(t)
  }
  } else if utils.IsListMethod(m) {
- if msg := utils.GetListResourceMessage(m); msg != nil {
+ if msg := utils.GetListResourceMessage(m); msg != nil && utils.IsResource(msg) {
  t := utils.GetResource(msg).GetType()
  resourcesWithOtherMethods.Add(t)
  }

diff --git a/rules/aip0121/resource_must_support_get_test.go b/rules/aip0121/resource_must_support_get_test.go
@@ -51,6 +51,15 @@ func TestResourceMustSupportGet(t *testing.T) {
  rpc GetBook(GetBookRequest) returns (Book) {};
  rpc UpdateBook(UpdateBookRequest) returns (Book) {};
  `, nil},
+ {"ValidIgnoreNonResourceUpdate", `
+ rpc UpdateBook(UpdateBookRequest) returns (Other) {};
+ `, nil},
+ {"ValidIgnoreNonResourceCreate", `
+ rpc CreateBook(CreateBookRequest) returns (Other) {};
+ `, nil},
+ {"ValidIgnoreNonResourceList", `
+ rpc ListBooks(ListBooksRequest) returns (RepeatedOther) {};
+ `, nil},
  {"InvalidCreateOnly", `
  rpc CreateBook(CreateBookRequest) returns (Book) {};
  `, []lint.Problem{
@@ -124,6 +133,12 @@ func TestResourceMustSupportGet(t *testing.T) {
  repeated Book books = 1;
  string next_page_token = 2;
  }
+
+ message Other {}
+
+ message RepeatedOther {
+ repeated Other others = 1;
+ }
  `, test)
  s := file.GetServices()[0]
  got := resourceMustSupportGet.Lint(file)