github.com/googleapis/api-linter@v1.65.2/rules/aip0123/resource_name_field_test.go (about)

     1  // Copyright 2021 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package aip0123
    16  
    17  import (
    18  	"strings"
    19  	"testing"
    20  
    21  	"github.com/googleapis/api-linter/rules/internal/testutils"
    22  	"github.com/jhump/protoreflect/desc"
    23  )
    24  
    25  func TestResourceNameField(t *testing.T) {
    26  	for _, test := range []struct {
    27  		name     string
    28  		Options  string
    29  		Field    string
    30  		problems testutils.Problems
    31  	}{
    32  		{"ValidBothPresent", `option (google.api.resource) = { type: "foo" };`, `string name = 1;`, nil},
    33  		{"InvalidNoField", `option (google.api.resource) = { type: "foo" };`, ``, testutils.Problems{{Message: "`name`"}}},
    34  		{"InvalidTypeNotString", `option (google.api.resource) = { type: "foo" };`, `int32 name = 1;`, testutils.Problems{{Suggestion: "string"}}},
    35  		{"InvalidTypeRepeated", `option (google.api.resource) = { type: "foo" };`, `repeated string name = 1;`, testutils.Problems{{Suggestion: "string"}}},
    36  		{"IrrelevantNoAnnotation", ``, ``, nil},
    37  		{"ValidNameField", `option (google.api.resource) = { type: "foo" name_field: "other_name"};`, "string other_name = 1;", nil},
    38  	} {
    39  		t.Run(test.name, func(t *testing.T) {
    40  			f := testutils.ParseProto3Tmpl(t, `
    41  				import "google/api/resource.proto";
    42  				message Book {
    43  					{{.Options}}
    44  					{{.Field}}
    45  				}
    46  			`, test)
    47  			var d desc.Descriptor = f.GetMessageTypes()[0]
    48  			if strings.HasPrefix(test.name, "InvalidType") {
    49  				d = f.GetMessageTypes()[0].GetFields()[0]
    50  			}
    51  			if diff := test.problems.SetDescriptor(d).Diff(resourceNameField.Lint(f)); diff != "" {
    52  				t.Error(diff)
    53  			}
    54  		})
    55  	}
    56  }