github.com/googleapis/api-linter@v1.65.2/rules/aip0148/ip_address_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 aip0148
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestIpAddressFormat(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name, Annotation, FieldName, Type string
    26  		problems                          testutils.Problems
    27  	}{
    28  		{
    29  			name:       "ValidIpAddressFormat",
    30  			FieldName:  "ip_address",
    31  			Annotation: "[(google.api.field_info).format = IPV4_OR_IPV6]",
    32  			Type:       "string",
    33  		},
    34  		{
    35  			name:       "ValidIpAddressSuffixFormat",
    36  			FieldName:  "incoming_ip_address",
    37  			Annotation: "[(google.api.field_info).format = IPV4_OR_IPV6]",
    38  			Type:       "string",
    39  		},
    40  		{
    41  			name:      "SkipNonIpAddress",
    42  			FieldName: "other",
    43  			Type:      "string",
    44  		},
    45  		{
    46  			name:      "SkipNonIpAddressSuffix",
    47  			FieldName: "zip_address",
    48  			Type:      "string",
    49  		},
    50  		{
    51  			name:      "SkipNonStringIpAddress",
    52  			FieldName: "ip_address",
    53  			Type:      "Foo",
    54  		},
    55  		{
    56  			name:      "InvalidMissingFormat",
    57  			FieldName: "ip_address",
    58  			Type:      "string",
    59  			problems:  testutils.Problems{{Message: "must specify one of"}},
    60  		},
    61  		{
    62  			name:       "InvalidWrongFormat",
    63  			FieldName:  "ip_address",
    64  			Annotation: "[(google.api.field_info).format = UUID4]",
    65  			Type:       "string",
    66  			problems:   testutils.Problems{{Message: "must specify one of"}},
    67  		},
    68  	} {
    69  		t.Run(test.name, func(t *testing.T) {
    70  			f := testutils.ParseProto3Tmpl(t, `
    71  				import "google/api/field_info.proto";
    72  
    73  				message Person {
    74  					{{.Type}} {{.FieldName}} = 2 {{.Annotation}};
    75  				}
    76  
    77  				message Foo {}
    78  			`, test)
    79  			field := f.GetMessageTypes()[0].GetFields()[0]
    80  			if diff := test.problems.SetDescriptor(field).Diff(ipAddressFormat.Lint(f)); diff != "" {
    81  				t.Errorf(diff)
    82  			}
    83  		})
    84  	}
    85  }