Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-06-20 20:24:22 -04:00
Code Issues Projects Releases Packages Wiki Activity

config: detailed validation errors for k8s version (#1018)

Browse source 
These extended error messages help users in understanding
what is wrong with the current configuration and how to
remediate the issue.
This commit is contained in:
Otto Bittner 2023-01-23 11:21:06 +01:00 • committed by GitHub
parent 03154c6e64
commit 3b59ebfd53
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
internal/config/config.go
View file

@ -489,6 +489,10 @@ func (c *Config) Validate() error {
return err return err
} }
if err := validate.RegisterTranslation("supported_k8s_version", trans, registerInvalidK8sVersionError, translateInvalidK8sVersionError); err != nil {
return err
}
if err := validate.RegisterValidation("no_placeholders", validateNoPlaceholder); err != nil { if err := validate.RegisterValidation("no_placeholders", validateNoPlaceholder); err != nil {
return err return err
} }

37
internal/config/validation.go
View file

@ -9,6 +9,7 @@ package config
import ( import (
"bytes" "bytes"
"fmt" "fmt"
"sort"
"strings" "strings"
"github.com/edgelesssys/constellation/v2/internal/attestation/measurements" "github.com/edgelesssys/constellation/v2/internal/attestation/measurements"
@ -17,12 +18,48 @@ import (
"github.com/edgelesssys/constellation/v2/internal/versions" "github.com/edgelesssys/constellation/v2/internal/versions"
ut "github.com/go-playground/universal-translator" ut "github.com/go-playground/universal-translator"
"github.com/go-playground/validator/v10" "github.com/go-playground/validator/v10"
"golang.org/x/mod/semver"
) )
func validateK8sVersion(fl validator.FieldLevel) bool { func validateK8sVersion(fl validator.FieldLevel) bool {
return versions.IsSupportedK8sVersion(fl.Field().String()) return versions.IsSupportedK8sVersion(fl.Field().String())
} }
func registerInvalidK8sVersionError(ut ut.Translator) error {
return ut.Add("invalid_k8s_version", "{0} specifies an unsupported Kubernetes version. {1}", true)
}
func translateInvalidK8sVersionError(ut ut.Translator, fe validator.FieldError) string {
validVersions := make([]string, len(versions.VersionConfigs))
i := 0
for k := range versions.VersionConfigs {
validVersions[i] = string(k)
i++
}
validVersionsSorted := semver.ByVersion(validVersions)
sort.Sort(validVersionsSorted)
var errorMsg string
configured, ok := fe.Value().(string)
if !ok {
errorMsg = "The configured version is not a valid string"
}
maxVersion := validVersionsSorted[len(validVersionsSorted)-1]
minVersion := validVersionsSorted[0]
if configured < minVersion {
errorMsg = fmt.Sprintf("The configured version %s is older than the oldest version supported by this CLI: %s.", configured, minVersion)
}
if configured > maxVersion {
errorMsg = fmt.Sprintf("The configured version %s is newer than the newest version supported by this CLI: %s.", configured, maxVersion)
}
t, _ := ut.T("invalid_k8s_version", fe.Field(), errorMsg)
return t
}
func validateAWSInstanceType(fl validator.FieldLevel) bool { func validateAWSInstanceType(fl validator.FieldLevel) bool {
return validInstanceTypeForProvider(fl.Field().String(), false, cloudprovider.AWS) return validInstanceTypeForProvider(fl.Field().String(), false, cloudprovider.AWS)
} }