github.com/googleapis/api-linter@v1.65.2/rules/aip0133/request_parent_field_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 aip0133
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestRequestParentField(t *testing.T) {
    24  	// Set up the testing permutations.
    25  	tests := []struct {
    26  		name        string
    27  		MessageName string
    28  		FieldName   string
    29  		FieldType   string
    30  		problems    testutils.Problems
    31  	}{
    32  		{"Valid", "CreateBookRequest", "parent", "string", nil},
    33  		{"InvalidType", "CreateBookRequest", "parent", "bytes", testutils.Problems{{Suggestion: "string"}}},
    34  		{"IrrelevantMessage", "AddBookRequest", "parent", "bytes", nil},
    35  		{"IrrelevantField", "CreateBookRequest", "id", "bytes", nil},
    36  	}
    37  
    38  	// Run each test individually.
    39  	for _, test := range tests {
    40  		t.Run(test.name, func(t *testing.T) {
    41  			f := testutils.ParseProto3Tmpl(t, `
    42  				message {{.MessageName}} {
    43  					{{.FieldType}} {{.FieldName}} = 1;
    44  				}
    45  			`, test)
    46  
    47  			problems := requestParentField.Lint(f)
    48  			field := f.GetMessageTypes()[0].GetFields()[0]
    49  			if diff := test.problems.SetDescriptor(field).Diff(problems); diff != "" {
    50  				t.Errorf(diff)
    51  			}
    52  		})
    53  	}
    54  }