github.com/googleapis/api-linter@v1.65.2/rules/aip0152/request_resource_suffix_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 aip0152
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestRequestResourceSuffix(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name      string
    26  		RPC       string
    27  		Field     string
    28  		FieldOpts string
    29  		problems  testutils.Problems
    30  	}{
    31  		{"ValidPresent", "RunWriteBookJob", "name", ` [(google.api.resource_reference) = { type: "WriteBookJob" }]`, nil},
    32  		{"ValidMissing", "RunWriteBookJob", "name", "", nil},
    33  		{
    34  			"IncorrectSuffix", "RunWriteBookJob", "name", ` [(google.api.resource_reference) = { type: "Book" }]`,
    35  			testutils.Problems{{Message: "google.api.resource_reference", Suggestion: "WriteBookJob"}},
    36  		},
    37  		{"IrrelevantMessage", "PurgeBooks", "name", "", nil},
    38  		{"IrrelevantField", "RunWriteBookJob", "something_else", "", nil},
    39  	} {
    40  		t.Run(test.name, func(t *testing.T) {
    41  			f := testutils.ParseProto3Tmpl(t, `
    42  				import "google/api/resource.proto";
    43  				message {{.RPC}}Request {
    44  					string {{.Field}} = 1{{.FieldOpts}};
    45  				}
    46  			`, test)
    47  			field := f.GetMessageTypes()[0].GetFields()[0]
    48  			if diff := test.problems.SetDescriptor(field).Diff(requestResourceSuffix.Lint(f)); diff != "" {
    49  				t.Errorf(diff)
    50  			}
    51  		})
    52  	}
    53  }