Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Permit ListRevisions methods to include their resource field. #653

Merged
merged 1 commit into from
Oct 8, 2020
Merged

fix: Permit ListRevisions methods to include their resource field. #653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion rules/aip0132/response_unknown_fields.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,11 @@
package aip0132

import (
"strings"

"bitbucket.org/creachadair/stringset"
"github.com/googleapis/api-linter/lint"
"github.com/googleapis/api-linter/rules/internal/utils"
"github.com/jhump/protoreflect/desc"
"github.com/stoewer/go-strcase"
)
Expand All @@ -37,7 +40,15 @@ var responseUnknownFields = &lint.FieldRule{
},
LintField: func(f *desc.FieldDescriptor) []lint.Problem {
// A repeated variant of the resource should be permitted.
resource := strcase.SnakeCase(listRespMessageRegexp.FindStringSubmatch(f.GetOwner().GetName())[1])
msgName := f.GetOwner().GetName()
resource := strcase.SnakeCase(listRespMessageRegexp.FindStringSubmatch(msgName)[1])
if strings.HasSuffix(resource, "_revisions") {
// This is an AIP-162 ListFooRevisions response, which is subtly
// different from an AIP-132 List response. We need to modify the RPC
// name to what the AIP-132 List response would be in order to permit
// the resource field properly.
resource = utils.ToPlural(strings.TrimSuffix(resource, "_revisions"))
}
if f.GetName() == resource {
return nil
}
Expand Down
16 changes: 9 additions & 7 deletions rules/aip0132/response_unknown_fields_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,19 @@ import (

func TestResponseUnknownFields(t *testing.T) {
for _, test := range []struct {
FieldName string
problems testutils.Problems
MessageName string
FieldName string
problems testutils.Problems
}{
{"total_size", testutils.Problems{}},
{"unreachable", testutils.Problems{}},
{"unreachable_locations", testutils.Problems{}},
{"extra", testutils.Problems{{Message: "List responses"}}},
{"ListBooksResponse", "total_size", nil},
{"ListBooksResponse", "unreachable", nil},
{"ListBooksResponse", "unreachable_locations", nil},
{"ListBookRevisionsResponse", "total_size", nil},
{"ListBooksResponse", "extra", testutils.Problems{{Message: "List responses"}}},
} {
t.Run(strcase.UpperCamelCase(test.FieldName), func(t *testing.T) {
f := testutils.ParseProto3Tmpl(t, `
message ListBooksResponse {
message {{.MessageName}} {
repeated Book books = 1;
string next_page_token = 2;
string {{.FieldName}} = 3;
Expand Down