github.com/googleapis/api-linter@v1.65.2/rules/aip0152/request_name_field_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 aip0152
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  	"github.com/jhump/protoreflect/desc"
    22  )
    23  
    24  func TestRequestNameField(t *testing.T) {
    25  	tests := []struct {
    26  		name        string
    27  		MessageName string
    28  		Field       string
    29  		problems    testutils.Problems
    30  	}{
    31  		{"Valid", "RunWriteBookJobRequest", `string name = 1;`, nil},
    32  		{"InvalidMissing", "RunWriteBookJobRequest", "", testutils.Problems{{Message: "has no"}}},
    33  		{"InvalidType", "RunWriteBookJobRequest", "bytes name = 1;", testutils.Problems{{Suggestion: "string"}}},
    34  		{"InvalidRepeated", "RunWriteBookJobRequest", "repeated string name = 1;", testutils.Problems{{Suggestion: "string"}}},
    35  		{"IrrelevantMessage", "RemoveBookRequest", "", nil},
    36  	}
    37  
    38  	for _, test := range tests {
    39  		t.Run(test.name, func(t *testing.T) {
    40  			f := testutils.ParseProto3Tmpl(t, `
    41  				message {{.MessageName}} {
    42  					{{.Field}}
    43  					bytes other_field = 2;
    44  				}
    45  			`, test)
    46  			var d desc.Descriptor = f.GetMessageTypes()[0]
    47  			if test.name == "InvalidType" || test.name == "InvalidRepeated" {
    48  				d = f.GetMessageTypes()[0].GetFields()[0]
    49  			}
    50  			problems := requestNameField.Lint(f)
    51  			if diff := test.problems.SetDescriptor(d).Diff(problems); diff != "" {
    52  				t.Errorf("Problems did not match: %v", diff)
    53  			}
    54  		})
    55  	}
    56  }