🌱 Add registry+v1 bundle config unmarshal and validation layer #2278
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| package bundle | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "k8s.io/apimachinery/pkg/util/sets" | ||
| "k8s.io/apimachinery/pkg/util/validation" | ||
| "sigs.k8s.io/yaml" | ||
|
|
||
| "github.com/operator-framework/api/pkg/operators/v1alpha1" | ||
| ) | ||
|
|
||
| type Config struct { | ||
| WatchNamespace string `json:"watchNamespace"` | ||
| } | ||
|
|
||
| // UnmarshallConfig returns a deserialized and validated *bundle.Config based on bytes and validated | ||
| // against rv1 and the desired install namespaces. It will error if: | ||
| // - rv is nil | ||
| // - bytes is not a valid YAML/JSON object | ||
| // - bytes is a valid YAML/JSON object but does not follow the registry+v1 schema | ||
| // if bytes is nil a nil bundle.Config is returned | ||
| func UnmarshallConfig(bytes []byte, rv1 *RegistryV1, installNamespace string) (*Config, error) { | ||
| if bytes == nil { | ||
| return nil, nil | ||
| } | ||
| if rv1 == nil { | ||
| return nil, errors.New("bundle is nil") | ||
perdasilva marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| bundleConfig := &Config{} | ||
| if err := yaml.UnmarshalStrict(bytes, bundleConfig); err != nil { | ||
| return nil, fmt.Errorf("error unmarshalling registry+v1 configuration: %w", formatUnmarshallError(err)) | ||
| } | ||
|
|
||
| if err := validateConfig(bundleConfig, rv1, installNamespace); err != nil { | ||
| return nil, fmt.Errorf("error unmarshalling registry+v1 configuration: %w", err) | ||
| } | ||
|
|
||
| return bundleConfig, nil | ||
| } | ||
|
|
||
| func validateConfig(config *Config, rv1 *RegistryV1, installNamespace string) error { | ||
| // no config, no problem | ||
| if config == nil { | ||
| return nil | ||
| } | ||
|
|
||
| // collect bundle install modes | ||
| installModeSet := sets.New(rv1.CSV.Spec.InstallModes...) | ||
|
||
|
|
||
| // only accept a non-empty value for watchNamespace if the bundle configuration accepts the watchNamespace config | ||
| if config.WatchNamespace != "" && !hasWatchNamespaceAsConfig(installModeSet) { | ||
| return errors.New(`unknown field "watchNamespace"`) | ||
pedjak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // validate input format | ||
| if errs := validation.IsDNS1123Subdomain(config.WatchNamespace); len(errs) > 0 { | ||
| return fmt.Errorf("invalid 'watchNamespace' %q: namespace must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character", config.WatchNamespace) | ||
| } | ||
|
|
||
| // only accept install namespace if OwnNamespace install mode is supported | ||
| if config.WatchNamespace == installNamespace && | ||
| !installModeSet.Has(v1alpha1.InstallMode{Type: v1alpha1.InstallModeTypeOwnNamespace, Supported: true}) { | ||
| return fmt.Errorf("invalid 'watchNamespace' %q: must not be install namespace (%s)", config.WatchNamespace, installNamespace) | ||
| } | ||
|
|
||
| if config.WatchNamespace != installNamespace && | ||
| !installModeSet.Has(v1alpha1.InstallMode{Type: v1alpha1.InstallModeTypeSingleNamespace, Supported: true}) { | ||
| return fmt.Errorf("invalid 'watchNamespace' %q: must be install namespace (%s)", config.WatchNamespace, installNamespace) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func hasWatchNamespaceAsConfig(bundleInstallModeSet sets.Set[v1alpha1.InstallMode]) bool { | ||
|
||
| return bundleInstallModeSet.Has(v1alpha1.InstallMode{Type: v1alpha1.InstallModeTypeSingleNamespace, Supported: true}) || | ||
| bundleInstallModeSet.HasAll( | ||
| v1alpha1.InstallMode{Type: v1alpha1.InstallModeTypeOwnNamespace, Supported: true}, | ||
| v1alpha1.InstallMode{Type: v1alpha1.InstallModeTypeAllNamespaces, Supported: true}) | ||
| } | ||
|
|
||
| func formatUnmarshallError(err error) error { | ||
| var unmarshalErr *json.UnmarshalTypeError | ||
| if errors.As(err, &unmarshalErr) { | ||
| if unmarshalErr.Field == "" { | ||
| return errors.New("input is not a valid JSON object") | ||
| } else { | ||
| return fmt.Errorf("invalid value type for field %q: expected %q but got %q", unmarshalErr.Field, unmarshalErr.Type.String(), unmarshalErr.Value) | ||
| } | ||
| } | ||
|
|
||
| // unwrap error until the core and process it | ||
| for { | ||
| unwrapped := errors.Unwrap(err) | ||
| if unwrapped == nil { | ||
| // usually the errors present in the form json: <message> or yaml: <message> | ||
| // we want to extract <message> if we can | ||
| errMessageComponents := strings.Split(err.Error(), ":") | ||
| coreErrMessage := strings.TrimSpace(errMessageComponents[len(errMessageComponents)-1]) | ||
| return errors.New(coreErrMessage) | ||
| } | ||
| err = unwrapped | ||
| } | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.