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

     1  // Copyright 2019 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 aip0122
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestNameSuffix(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name      string
    26  		FieldName string
    27  		problems  testutils.Problems
    28  	}{
    29  		{"Valid", "publisher", testutils.Problems{}},
    30  		{"ValidStandardDisplay", "display_name", testutils.Problems{}},
    31  		{"ValidStandardGiven", "given_name", testutils.Problems{}},
    32  		{"ValidStandardFamily", "family_name", testutils.Problems{}},
    33  		{"ValidStandardFull", "full_resource_name", testutils.Problems{}},
    34  		{"SkipValidDisplayNameSuffix", "foo_display_name", testutils.Problems{}},
    35  		{"Invalid", "author_name", testutils.Problems{{Suggestion: "author"}}},
    36  	} {
    37  		f := testutils.ParseProto3Tmpl(t, `
    38  			message Book {
    39  				string name = 1;
    40  				string {{.FieldName}} = 2;
    41  			}
    42  		`, test)
    43  		field := f.GetMessageTypes()[0].GetFields()[1]
    44  		if diff := test.problems.SetDescriptor(field).Diff(nameSuffix.Lint(f)); diff != "" {
    45  			t.Errorf(diff)
    46  		}
    47  	}
    48  }