github.com/googleapis/api-linter@v1.65.2/rules/aip0131/request_name_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 aip0131
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestRequestNameFieldType(t *testing.T) {
    24  	tests := []struct {
    25  		name          string
    26  		MessageName   string
    27  		NameFieldType string
    28  		problems      testutils.Problems
    29  	}{
    30  		{"StringNameFieldType_Valid", "GetBookRequest", "string", nil},
    31  		{"BytesNameFieldType_Invalid", "GetBookRequest", "bytes", testutils.Problems{{Suggestion: "string"}}},
    32  		{"NotGetRequest_BytesNameFieldType_Valid", "SomeMessage", "bytes", nil},
    33  	}
    34  
    35  	for _, test := range tests {
    36  		t.Run(test.name, func(t *testing.T) {
    37  			f := testutils.ParseProto3Tmpl(t, `
    38  			message {{.MessageName}} {
    39  				{{.NameFieldType}} name = 1;
    40  			}`, test)
    41  
    42  			problems := requestNameField.Lint(f)
    43  			if diff := test.problems.SetDescriptor(f.GetMessageTypes()[0].GetFields()[0]).Diff(problems); diff != "" {
    44  				t.Errorf("Problems did not match: %v", diff)
    45  			}
    46  		})
    47  	}
    48  }