github.com/googleapis/api-linter@v1.65.2/rules/aip0148/ip_address_format.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  	"strings"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/rules/internal/utils"
    22  	"github.com/jhump/protoreflect/desc"
    23  	"google.golang.org/genproto/googleapis/api/annotations"
    24  	"google.golang.org/protobuf/types/descriptorpb"
    25  )
    26  
    27  var ipAddressFormats = []annotations.FieldInfo_Format{
    28  	annotations.FieldInfo_IPV4,
    29  	annotations.FieldInfo_IPV6,
    30  	annotations.FieldInfo_IPV4_OR_IPV6,
    31  }
    32  
    33  var ipAddressFormat = &lint.FieldRule{
    34  	Name: lint.NewRuleName(148, "ip-address-format"),
    35  	OnlyIf: func(fd *desc.FieldDescriptor) bool {
    36  		return fd.GetType() == descriptorpb.FieldDescriptorProto_TYPE_STRING && (fd.GetName() == "ip_address" || strings.HasSuffix(fd.GetName(), "_ip_address"))
    37  	},
    38  	LintField: func(fd *desc.FieldDescriptor) []lint.Problem {
    39  		if !utils.HasFormat(fd) || !oneofFormats(utils.GetFormat(fd), ipAddressFormats) {
    40  			return []lint.Problem{{
    41  				Message:    "IP Address fields must specify one of the `(google.api.field_info).format` values `IPV4`, `IPV6`, or `IPV4_OR_IPV6`",
    42  				Descriptor: fd,
    43  			}}
    44  		}
    45  		return nil
    46  	},
    47  }
    48  
    49  func oneofFormats(f annotations.FieldInfo_Format, desired []annotations.FieldInfo_Format) bool {
    50  	for _, d := range desired {
    51  		if f == d {
    52  			return true
    53  		}
    54  	}
    55  
    56  	return false
    57  }