github.com/SamarSidharth/kpt@v0.0.0-20231122062228-c7d747ae3ace/internal/errors/validate.go (about)

     1  // Copyright 2021 The kpt Authors
     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  //      http://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 errors
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"github.com/GoogleContainerTools/kpt/internal/util/strings"
    21  )
    22  
    23  // ValidationError is an error type used when validation fails.
    24  type ValidationError struct {
    25  	Violations Violations
    26  }
    27  
    28  func (e *ValidationError) Error() string {
    29  	return fmt.Sprintf("validation failed for fields %s",
    30  		strings.JoinStringsWithQuotes(e.Violations.Fields()))
    31  }
    32  
    33  type ViolationType string
    34  
    35  const (
    36  	Missing ViolationType = "missing"
    37  	Invalid ViolationType = "invalid"
    38  )
    39  
    40  type Violations []Violation
    41  
    42  func (v Violations) Fields() []string {
    43  	var fields []string
    44  	for _, v := range v {
    45  		fields = append(fields, v.Field)
    46  	}
    47  	return fields
    48  }
    49  
    50  type Violation struct {
    51  	Field  string
    52  	Value  string
    53  	Type   ViolationType
    54  	Reason string
    55  }