github.com/googleapis/api-linter@v1.65.2/rules/aip0231/request_unknown_fields_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 TestRequestUnknownFields(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name        string
    26  		MessageName string
    27  		FieldName   string
    28  		problems    testutils.Problems
    29  	}{
    30  		{"Valid-Names", "BatchGetBooks", "names", testutils.Problems{}},
    31  		{"Valid-Parent", "BatchGetBooks", "parent", testutils.Problems{}},
    32  		{"Valid-ReadMask", "BatchGetBooks", "read_mask", testutils.Problems{}},
    33  		{"Valid-Requests", "BatchGetBooks", "requests", testutils.Problems{}},
    34  		{"Valid-View", "BatchGetBooks", "view", testutils.Problems{}},
    35  		{"Invalid", "BatchGetBooks", "foo", testutils.Problems{{Message: "Unexpected field"}}},
    36  		{"IrrelevantMessage", "GetBooks", "foo", testutils.Problems{}},
    37  	} {
    38  		t.Run(test.name, func(t *testing.T) {
    39  			f := testutils.ParseProto3Tmpl(t, `
    40  				message {{.MessageName}}Request {
    41  					repeated string {{.FieldName}} = 1;
    42  				}
    43  			`, test)
    44  			field := f.GetMessageTypes()[0].GetFields()[0]
    45  			if diff := test.problems.SetDescriptor(field).Diff(requestUnknownFields.Lint(f)); diff != "" {
    46  				t.Errorf(diff)
    47  			}
    48  		})
    49  	}
    50  }