github.com/googleapis/api-linter@v1.65.2/rules/aip0231/request_names_behavior_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 aip0231
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestRequestNamesBehavior(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name          string
    26  		MessageName   string
    27  		FieldName     string
    28  		FieldBehavior string
    29  		problems      testutils.Problems
    30  	}{
    31  		{"Valid", "BatchGetBooks", "names", " [(google.api.field_behavior) = REQUIRED]", testutils.Problems{}},
    32  		{"Missing", "BatchGetBooks", "names", "", testutils.Problems{{Message: "(google.api.field_behavior) = REQUIRED"}}},
    33  		{"IrrelevantMessage", "GetBooks", "names", "", testutils.Problems{}},
    34  		{"IrrelevantField", "BatchGetBooks", "something_else", "", testutils.Problems{}},
    35  	} {
    36  		t.Run(test.name, func(t *testing.T) {
    37  			f := testutils.ParseProto3Tmpl(t, `
    38  				import "google/api/field_behavior.proto";
    39  				message {{.MessageName}}Request {
    40  					repeated string {{.FieldName}} = 1{{.FieldBehavior}};
    41  				}
    42  			`, test)
    43  			field := f.GetMessageTypes()[0].GetFields()[0]
    44  			if diff := test.problems.SetDescriptor(field).Diff(requestNamesBehavior.Lint(f)); diff != "" {
    45  				t.Errorf(diff)
    46  			}
    47  		})
    48  	}
    49  }