github.com/googleapis/api-linter@v1.65.2/rules/aip0135/force_field.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 aip0135
    16  
    17  import (
    18  	"github.com/googleapis/api-linter/lint"
    19  	"github.com/googleapis/api-linter/rules/internal/utils"
    20  	"github.com/jhump/protoreflect/desc"
    21  )
    22  
    23  // Delete methods for resources that are parents should have a bool force field.
    24  var forceField = &lint.MessageRule{
    25  	Name: lint.NewRuleName(135, "force-field"),
    26  	OnlyIf: func(m *desc.MessageDescriptor) bool {
    27  		name := m.FindFieldByName("name")
    28  		ref := utils.GetResourceReference(name)
    29  		validRef := ref != nil && ref.GetType() != "" && utils.FindResource(ref.GetType(), m.GetFile()) != nil
    30  
    31  		return utils.IsDeleteRequestMessage(m) && validRef
    32  	},
    33  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    34  		force := m.FindFieldByName("force")
    35  		name := m.FindFieldByName("name")
    36  		ref := utils.GetResourceReference(name)
    37  		res := utils.FindResource(ref.GetType(), m.GetFile())
    38  
    39  		children := utils.FindResourceChildren(res, m.GetFile())
    40  		if len(children) > 0 && force == nil {
    41  			return []lint.Problem{
    42  				{
    43  					Message:    "Delete requests for resources with children should have a `bool force` field",
    44  					Descriptor: m,
    45  				},
    46  			}
    47  		}
    48  
    49  		return nil
    50  	},
    51  }