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

     1  // Copyright 2020 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 aip0148
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestUseUid(t *testing.T) {
    24  	for _, test := range []struct {
    25  		FieldName string
    26  		problems  testutils.Problems
    27  	}{
    28  		{"uid", nil},
    29  		{"id", testutils.Problems{{Suggestion: "uid"}}},
    30  		{"foo_id", nil},
    31  	} {
    32  		t.Run(test.FieldName, func(t *testing.T) {
    33  			f := testutils.ParseProto3Tmpl(t, `
    34  				import "google/api/resource.proto";
    35  
    36  				message Person {
    37  					option (google.api.resource) = {
    38  						type: "foo.googleapis.com/Person"
    39  						pattern: "people/{person}"
    40  					};
    41  					string name = 1;
    42  
    43  					string {{.FieldName}} = 2;
    44  				}
    45  			`, test)
    46  			field := f.GetMessageTypes()[0].GetFields()[1]
    47  			if diff := test.problems.SetDescriptor(field).Diff(useUid.Lint(f)); diff != "" {
    48  				t.Errorf(diff)
    49  			}
    50  		})
    51  	}
    52  }