mirror of https://github.com/helm/helm
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
114 lines
3.4 KiB
114 lines
3.4 KiB
/*
|
|
Copyright The Helm Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package util
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"fmt"
|
|
"log/slog"
|
|
"strings"
|
|
|
|
"github.com/santhosh-tekuri/jsonschema/v6"
|
|
|
|
chart "helm.sh/helm/v4/internal/chart/v3"
|
|
)
|
|
|
|
// ValidateAgainstSchema checks that values does not violate the structure laid out in schema
|
|
func ValidateAgainstSchema(chrt *chart.Chart, values map[string]interface{}) error {
|
|
var sb strings.Builder
|
|
if chrt.Schema != nil {
|
|
slog.Debug("chart name", "chart-name", chrt.Name())
|
|
err := ValidateAgainstSingleSchema(values, chrt.Schema)
|
|
if err != nil {
|
|
sb.WriteString(fmt.Sprintf("%s:\n", chrt.Name()))
|
|
sb.WriteString(err.Error())
|
|
}
|
|
}
|
|
slog.Debug("number of dependencies in the chart", "dependencies", len(chrt.Dependencies()))
|
|
// For each dependency, recursively call this function with the coalesced values
|
|
for _, subchart := range chrt.Dependencies() {
|
|
subchartValues := values[subchart.Name()].(map[string]interface{})
|
|
if err := ValidateAgainstSchema(subchart, subchartValues); err != nil {
|
|
sb.WriteString(err.Error())
|
|
}
|
|
}
|
|
|
|
if sb.Len() > 0 {
|
|
return errors.New(sb.String())
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// ValidateAgainstSingleSchema checks that values does not violate the structure laid out in this schema
|
|
func ValidateAgainstSingleSchema(values Values, schemaJSON []byte) (reterr error) {
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
reterr = fmt.Errorf("unable to validate schema: %s", r)
|
|
}
|
|
}()
|
|
|
|
// This unmarshal function leverages UseNumber() for number precision. The parser
|
|
// used for values does this as well.
|
|
schema, err := jsonschema.UnmarshalJSON(bytes.NewReader(schemaJSON))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
slog.Debug("unmarshalled JSON schema", "schema", schemaJSON)
|
|
|
|
compiler := jsonschema.NewCompiler()
|
|
err = compiler.AddResource("file:///values.schema.json", schema)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
validator, err := compiler.Compile("file:///values.schema.json")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = validator.Validate(values.AsMap())
|
|
if err != nil {
|
|
return JSONSchemaValidationError{err}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Note, JSONSchemaValidationError is used to wrap the error from the underlying
|
|
// validation package so that Helm has a clean interface and the validation package
|
|
// could be replaced without changing the Helm SDK API.
|
|
|
|
// JSONSchemaValidationError is the error returned when there is a schema validation
|
|
// error.
|
|
type JSONSchemaValidationError struct {
|
|
embeddedErr error
|
|
}
|
|
|
|
// Error prints the error message
|
|
func (e JSONSchemaValidationError) Error() string {
|
|
errStr := e.embeddedErr.Error()
|
|
|
|
// This string prefixes all of our error details. Further up the stack of helm error message
|
|
// building more detail is provided to users. This is removed.
|
|
errStr = strings.TrimPrefix(errStr, "jsonschema validation failed with 'file:///values.schema.json#'\n")
|
|
|
|
// The extra new line is needed for when there are sub-charts.
|
|
return errStr + "\n"
|
|
}
|