github.com/googleapis/api-linter@v1.65.2/rules/aip0217/synonyms_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 aip0217
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  	"github.com/stoewer/go-strcase"
    22  )
    23  
    24  func TestSynonyms(t *testing.T) {
    25  	for _, test := range []struct {
    26  		FieldName string
    27  		problems  testutils.Problems
    28  	}{
    29  		{"unreachable", testutils.Problems{}},
    30  		{"unreachable_locations", testutils.Problems{{Suggestion: "unreachable"}}},
    31  	} {
    32  		t.Run(strcase.UpperCamelCase(test.FieldName), func(t *testing.T) {
    33  			f := testutils.ParseProto3Tmpl(t, `
    34  				message ListBooksResponse {
    35  					repeated Book books = 1;
    36  					string next_page_token = 2;
    37  					repeated string {{.FieldName}} = 3;
    38  				}
    39  				message Book {}
    40  
    41  				// Ignored because next_page_token is not present.
    42  				message Irrelevant {
    43  					repeated string unreachable_locations = 1;
    44  				}
    45  			`, test)
    46  			field := f.GetMessageTypes()[0].GetFields()[2]
    47  			if diff := test.problems.SetDescriptor(field).Diff(synonyms.Lint(f)); diff != "" {
    48  				t.Errorf(diff)
    49  			}
    50  		})
    51  	}
    52  }