github.com/googleapis/api-linter@v1.65.2/rules/aip0124/aip0124.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 aip0124 contains rules defined in https://aip.dev/124.
    16  package aip0124
    17  
    18  import (
    19  	"bitbucket.org/creachadair/stringset"
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/rules/internal/utils"
    22  	"github.com/jhump/protoreflect/desc"
    23  )
    24  
    25  // AddRules accepts a register function and registers each of
    26  // this AIP's rules to it.
    27  func AddRules(r lint.RuleRegistry) error {
    28  	return r.Register(
    29  		124,
    30  		referenceSamePackage,
    31  	)
    32  }
    33  
    34  // isUnknownType returns true if and only if the type is not a common,
    35  // well known type.
    36  func isUnknownType(f *desc.FieldDescriptor) bool {
    37  	if ref := utils.GetResourceReference(f); ref != nil {
    38  		urt := ref.GetType()
    39  		if urt == "" {
    40  			urt = ref.GetChildType()
    41  		}
    42  		return !stringset.New(
    43  			// Allow the common resource types in GCP.
    44  			// FIXME: Modularize this.
    45  			"cloudresourcemanager.googleapis.com/Project",
    46  			"cloudresourcemanager.googleapis.com/Organization",
    47  			"cloudresourcemanager.googleapis.com/Folder",
    48  			"billing.googleapis.com/BillingAccount",
    49  			"locations.googleapis.com/Location",
    50  
    51  			// Allow *.
    52  			"*",
    53  
    54  			// If no type is declared, ignore this.
    55  			"",
    56  		).Contains(urt)
    57  	}
    58  	return false
    59  }