Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

more readable errors #1397

Merged
merged 4 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 48 additions & 1 deletion internal/manifest/validate.go
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
package manifest

import (
"bytes"
"errors"
"fmt"

"github.com/go-playground/validator/v10"
"strings"
)

// Validate validates the parsed manifest data.
Expand Down Expand Up @@ -42,3 +44,48 @@ func (m *Manifest) Validate() error {

return nil
}

type validationErrors []error

func (v validationErrors) Error() string {
buffer := bytes.NewBufferString("")

for _, e := range v {
buffer.WriteString(e.Error())
buffer.WriteString("; ")
}

return strings.TrimSpace(buffer.String())
}

func prettyPrintValidationError(err error) error {
var validationErr validator.ValidationErrors
errors.As(err, &validationErr)

if validationErr == nil {
return err
}

var out validationErrors
for _, err := range validationErr {
var nerr error
switch err.Tag() {
case "max":
nerr = fmt.Errorf("field '%s' must have a maximum length of %s", err.StructField(), err.Param())
case "min":
nerr = fmt.Errorf("field '%s' must have a minimum length of %s", err.StructField(), err.Param())
case "len":
nerr = fmt.Errorf("field '%s' must have exact length of %s", err.StructField(), err.Param())
case "required":
nerr = fmt.Errorf("field '%s' is required to be defined", err.StructField())
case "ip_addr":
nerr = fmt.Errorf("field '%s' is required to have a valid IPv4 address value", err.StructField())
case "cidrv4":
nerr = fmt.Errorf("field '%s' is required to have a valid CIDRv4 value", err.StructField())
case "ver":
nerr = fmt.Errorf("field '%s' is required to have a kubernetes version of: 1.27.x, 1.28.x, 1.29.x", err.StructField())
}
out = append(out, nerr)
}
return out
}
15 changes: 4 additions & 11 deletions internal/manifest/validate_kubernetes.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package manifest

import (
"errors"
"fmt"
"regexp"
"strings"
Expand Down Expand Up @@ -33,15 +32,6 @@ func (k *Kubernetes) Validate(m *Manifest) error {

for _, cluster := range k.Clusters {
if err := cluster.Validate(); err != nil {
var ve validator.ValidationErrors
if errors.As(err, &ve) {
for _, fe := range ve {
if fe.Tag() == "ver" {
errMsg := "incorrect Kubernetes version, the supported versions are: 1.25.x, 1.26.x, 1.27.x"
return fmt.Errorf("failed to validate kubernetes cluster %s:%s", cluster.Name, errMsg)
}
}
}
return fmt.Errorf("failed to validate kubernetes cluster %s: %w", cluster.Name, err)
}

Expand Down Expand Up @@ -71,7 +61,10 @@ func (c *Cluster) Validate() error {
return err
}

return validate.Struct(c)
if err := validate.Struct(c); err != nil {
return prettyPrintValidationError(err)
}
return nil
}

func validateVersion(fl validator.FieldLevel) bool {
Expand Down
15 changes: 13 additions & 2 deletions internal/manifest/validate_load_balancer.go
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,19 @@ func (l *LoadBalancer) Validate(m *Manifest) error {
return nil
}

func (r *Role) Validate() error { return validator.New().Struct(r) }
func (c *LoadBalancerCluster) Validate() error { return validator.New().Struct(c) }
func (r *Role) Validate() error {
if err := validator.New().Struct(r); err != nil {
return prettyPrintValidationError(err)
}
return nil
}

func (c *LoadBalancerCluster) Validate() error {
if err := validator.New().Struct(c); err != nil {
return prettyPrintValidationError(err)
}
return nil
}

func validateLBStaticNodePool(m *Manifest, clusters []LoadBalancerCluster) error {
for _, cluster := range clusters {
Expand Down
12 changes: 10 additions & 2 deletions internal/manifest/validate_node_pool.go
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,18 @@ func (d *DynamicNodePool) Validate(m *Manifest) error {
}
}, DynamicNodePool{})

return validate.Struct(d)
if err := validate.Struct(d); err != nil {
return prettyPrintValidationError(err)
}
return nil
}

func (s *StaticNodePool) Validate() error { return validator.New().Struct(s) }
func (s *StaticNodePool) Validate() error {
if err := validator.New().Struct(s); err != nil {
return prettyPrintValidationError(err)
}
return nil
}

func (a *AutoscalerConfig) isDefined() bool { return a.Min >= 0 && a.Max > 0 }

Expand Down
16 changes: 8 additions & 8 deletions manifests/claudie/kustomization.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,20 +58,20 @@ apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
images:
- name: ghcr.io/berops/claudie/ansibler
newTag: 5a44806-2799
newTag: 43f201d-2805
- name: ghcr.io/berops/claudie/autoscaler-adapter
newTag: 688726a-1932
- name: ghcr.io/berops/claudie/builder
newTag: 5a44806-2799
newTag: 43f201d-2805
- name: ghcr.io/berops/claudie/claudie-operator
newTag: 5a44806-2799
newTag: 43f201d-2805
- name: ghcr.io/berops/claudie/context-box
newTag: 5a44806-2799
newTag: 43f201d-2805
- name: ghcr.io/berops/claudie/kube-eleven
newTag: 5a44806-2799
newTag: 43f201d-2805
- name: ghcr.io/berops/claudie/kuber
newTag: 5a44806-2799
newTag: 43f201d-2805
- name: ghcr.io/berops/claudie/scheduler
newTag: 5a44806-2799
newTag: 43f201d-2805
- name: ghcr.io/berops/claudie/terraformer
newTag: 5a44806-2799
newTag: 43f201d-2805
2 changes: 1 addition & 1 deletion manifests/testing-framework/kustomization.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ secretGenerator:

images:
- name: ghcr.io/berops/claudie/testing-framework
newTag: 5a44806-2799
newTag: 43f201d-2805