github.com/googleapis/api-linter@v1.65.2/rules/aip0155/request_id_format_test.go (about)

     1  // Copyright 2023 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 aip0155
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestRequestIdFormat(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name, Annotation, FieldName, Type string
    26  		problems                          testutils.Problems
    27  	}{
    28  		{
    29  			name:       "ValidRequestIdFormat",
    30  			FieldName:  "request_id",
    31  			Annotation: "[(google.api.field_info).format = UUID4]",
    32  			Type:       "string",
    33  		},
    34  		{
    35  			name:      "SkipNonRequestId",
    36  			FieldName: "other",
    37  			Type:      "string",
    38  		},
    39  		{
    40  			name:      "SkipNonStringRequestId",
    41  			FieldName: "request_id",
    42  			Type:      "Foo",
    43  		},
    44  		{
    45  			name:      "InvalidMissingFormat",
    46  			FieldName: "request_id",
    47  			Type:      "string",
    48  			problems:  testutils.Problems{{Message: "format = UUID4"}},
    49  		},
    50  		{
    51  			name:       "InvalidWrongFormat",
    52  			FieldName:  "request_id",
    53  			Annotation: "[(google.api.field_info).format = IPV4]",
    54  			Type:       "string",
    55  			problems:   testutils.Problems{{Message: "format = UUID4"}},
    56  		},
    57  	} {
    58  		t.Run(test.name, func(t *testing.T) {
    59  			f := testutils.ParseProto3Tmpl(t, `
    60  				import "google/api/field_info.proto";
    61  				message Person {
    62  					{{.Type}} {{.FieldName}} = 2 {{.Annotation}};
    63  				}
    64  				message Foo {}
    65  			`, test)
    66  			field := f.GetMessageTypes()[0].GetFields()[0]
    67  			if diff := test.problems.SetDescriptor(field).Diff(requestIdFormat.Lint(f)); diff != "" {
    68  				t.Errorf(diff)
    69  			}
    70  		})
    71  	}
    72  }