|
| 1 | +package bundle |
| 2 | + |
| 3 | +import ( |
| 4 | + "encoding/json" |
| 5 | + "errors" |
| 6 | + "fmt" |
| 7 | + "strings" |
| 8 | + |
| 9 | + "github.com/invopop/jsonschema" |
| 10 | + schemavalidation "github.com/santhosh-tekuri/jsonschema/v6" |
| 11 | + "github.com/santhosh-tekuri/jsonschema/v6/kind" |
| 12 | + "k8s.io/apimachinery/pkg/util/sets" |
| 13 | + "k8s.io/apimachinery/pkg/util/validation" |
| 14 | + |
| 15 | + "github.com/operator-framework/api/pkg/operators/v1alpha1" |
| 16 | +) |
| 17 | + |
| 18 | +const ( |
| 19 | + dns1123SubdomainFormat = "Namespace" |
| 20 | + notOwnNamespaceFormat = "NotOwnNamespace" |
| 21 | +) |
| 22 | + |
| 23 | +var ( |
| 24 | + // unsupportedInstallModes set of unsupported ClusterServiceVersion install modes |
| 25 | + unsupportedInstallModes = sets.New[v1alpha1.InstallModeType](v1alpha1.InstallModeTypeMultiNamespace) |
| 26 | + |
| 27 | + // dnsFormat checks conformity to RFC1213 lowercase dns subdomain format by any field with format 'RFC-1123' |
| 28 | + dnsFormat = &schemavalidation.Format{ |
| 29 | + Name: dns1123SubdomainFormat, |
| 30 | + Validate: func(v any) error { |
| 31 | + if v == nil { |
| 32 | + return nil |
| 33 | + } |
| 34 | + s, ok := v.(string) |
| 35 | + if !ok { |
| 36 | + return fmt.Errorf("invalid type %T, expected string", v) |
| 37 | + } |
| 38 | + errs := validation.IsDNS1123Subdomain(s) |
| 39 | + if len(errs) > 0 { |
| 40 | + return fmt.Errorf("%q is not a valid namespace name: %s", v, strings.Join(errs, ", ")) |
| 41 | + } |
| 42 | + return nil |
| 43 | + }, |
| 44 | + } |
| 45 | +) |
| 46 | + |
| 47 | +// Config is a registry+v1 bundle configuration surface |
| 48 | +type Config struct { |
| 49 | + // WatchNamespace is supported for certain bundles to allow the user to configure installation in Single- or OwnNamespace modes |
| 50 | + // The validation behavior of this field is determined by the install modes supported by the bundle, e.g.: |
| 51 | + // - If a bundle only supports AllNamespaces mode (or only OwnNamespace mode): this field will be unknown |
| 52 | + // - If a bundle supports AllNamespaces and SingleNamespace install modes: this field is optional |
| 53 | + // - If a bundle supports AllNamespaces and OwnNamespace: this field is optional, but if set must be equal to the install namespace |
| 54 | + WatchNamespace string `json:"watchNamespace,omitempty"` |
| 55 | +} |
| 56 | + |
| 57 | +// ValidatedBundleConfigFromRaw returns a validated Config struct from the values given in rawConfig. |
| 58 | +// The applied validation will be determined by the install modes supported by the bundle |
| 59 | +func ValidatedBundleConfigFromRaw(rv1 RegistryV1, installNamespace string, rawConfig map[string]interface{}) (*Config, error) { |
| 60 | + if len(rawConfig) == 0 { |
| 61 | + return nil, nil |
| 62 | + } |
| 63 | + |
| 64 | + rawSchema := bundleConfigSchema(rv1, installNamespace) |
| 65 | + customFormats := []*schemavalidation.Format{ |
| 66 | + dnsFormat, |
| 67 | + notOwnNamespaceFmt(installNamespace), |
| 68 | + } |
| 69 | + |
| 70 | + if err := validateBundleConfig(rawSchema, customFormats, rawConfig); err != nil { |
| 71 | + return nil, fmt.Errorf("invalid configuration: %v", err) |
| 72 | + } |
| 73 | + |
| 74 | + return toConfig(rawConfig) |
| 75 | +} |
| 76 | + |
| 77 | +// bundleConfigSchema generates a jsonschema used to validate bundle configuration |
| 78 | +func bundleConfigSchema(rv1 RegistryV1, installNamespace string) []byte { |
| 79 | + // configure reflector |
| 80 | + r := new(jsonschema.Reflector) |
| 81 | + r.ExpandedStruct = true |
| 82 | + r.AllowAdditionalProperties = false |
| 83 | + |
| 84 | + // generate base schema |
| 85 | + schema := r.Reflect(&Config{}) |
| 86 | + |
| 87 | + // apply bundle rawConfig based mutations for watchNamespace |
| 88 | + configureWatchNamespaceProperty(rv1, installNamespace, schema) |
| 89 | + |
| 90 | + // return schema |
| 91 | + out, err := schema.MarshalJSON() |
| 92 | + if err != nil { |
| 93 | + panic(err) |
| 94 | + } |
| 95 | + return out |
| 96 | +} |
| 97 | + |
| 98 | +// configureWatchNamespaceProperty modifies schema to configure the watchNamespace config property based on |
| 99 | +// the install modes supported by the bundle marking the field required or optional, or restricting the possible values |
| 100 | +// it can take |
| 101 | +func configureWatchNamespaceProperty(rv1 RegistryV1, installNamespace string, schema *jsonschema.Schema) { |
| 102 | + supportedInstallModes := sets.New[v1alpha1.InstallModeType]() |
| 103 | + for _, im := range rv1.CSV.Spec.InstallModes { |
| 104 | + if im.Supported && !unsupportedInstallModes.Has(im.Type) { |
| 105 | + supportedInstallModes.Insert(im.Type) |
| 106 | + } |
| 107 | + } |
| 108 | + |
| 109 | + allSupported := supportedInstallModes.Has(v1alpha1.InstallModeTypeAllNamespaces) |
| 110 | + singleSupported := supportedInstallModes.Has(v1alpha1.InstallModeTypeSingleNamespace) |
| 111 | + ownSupported := supportedInstallModes.Has(v1alpha1.InstallModeTypeOwnNamespace) |
| 112 | + |
| 113 | + if len(supportedInstallModes) == 0 { |
| 114 | + panic("bundle does not support any supported install modes") |
| 115 | + } |
| 116 | + |
| 117 | + // no watchNamespace rawConfig parameter if bundle only supports AllNamespaces or OwnNamespace install modes |
| 118 | + if len(supportedInstallModes) == 1 && (allSupported || ownSupported) { |
| 119 | + schema.Properties.Delete("watchNamespace") |
| 120 | + return |
| 121 | + } |
| 122 | + |
| 123 | + watchNamespaceProperty, ok := schema.Properties.Get("watchNamespace") |
| 124 | + if !ok { |
| 125 | + panic("watchNamespace not found in schema") |
| 126 | + } |
| 127 | + |
| 128 | + watchNamespaceProperty.Format = dns1123SubdomainFormat |
| 129 | + |
| 130 | + // required or optional |
| 131 | + if !allSupported && singleSupported { |
| 132 | + schema.Required = append(schema.Required, "watchNamespace") |
| 133 | + } else { |
| 134 | + // note: the library currently doesn't support jsonschema.Types |
| 135 | + // this is the current workaround for declaring optional/nullable fields |
| 136 | + // https://github.com/invopop/jsonschema/issues/115 |
| 137 | + watchNamespaceProperty.Extras = map[string]any{ |
| 138 | + "type": []string{"string", "null"}, |
| 139 | + } |
| 140 | + if !ownSupported { |
| 141 | + // if own namespace is not supported validate that it is not being used |
| 142 | + watchNamespaceProperty.Format = notOwnNamespaceFormat |
| 143 | + } |
| 144 | + } |
| 145 | + |
| 146 | + // must be the install namespace |
| 147 | + if allSupported && ownSupported && !singleSupported { |
| 148 | + watchNamespaceProperty.Enum = []any{ |
| 149 | + installNamespace, |
| 150 | + nil, |
| 151 | + } |
| 152 | + } |
| 153 | +} |
| 154 | + |
| 155 | +// validateBundleConfig validates the bundle rawConfig |
| 156 | +func validateBundleConfig(rawSchema []byte, customFormats []*schemavalidation.Format, rawConfig map[string]interface{}) error { |
| 157 | + schema, err := schemavalidation.UnmarshalJSON(strings.NewReader(string(rawSchema))) |
| 158 | + if err != nil { |
| 159 | + return err |
| 160 | + } |
| 161 | + |
| 162 | + compiler := schemavalidation.NewCompiler() |
| 163 | + for _, format := range customFormats { |
| 164 | + compiler.RegisterFormat(format) |
| 165 | + } |
| 166 | + compiler.AssertFormat() |
| 167 | + if err := compiler.AddResource("schema.json", schema); err != nil { |
| 168 | + return err |
| 169 | + } |
| 170 | + compiledSchema, err := compiler.Compile("schema.json") |
| 171 | + if err != nil { |
| 172 | + return err |
| 173 | + } |
| 174 | + |
| 175 | + return formatJSONSchemaValidationError(compiledSchema.Validate(rawConfig)) |
| 176 | +} |
| 177 | + |
| 178 | +// toConfig converts rawConfig into a Config struct |
| 179 | +func toConfig(rawConfig map[string]interface{}) (*Config, error) { |
| 180 | + cfg := Config{} |
| 181 | + dataBytes, err := json.Marshal(rawConfig) |
| 182 | + if err != nil { |
| 183 | + return nil, err |
| 184 | + } |
| 185 | + err = json.Unmarshal(dataBytes, &cfg) |
| 186 | + if err != nil { |
| 187 | + return nil, err |
| 188 | + } |
| 189 | + |
| 190 | + return &cfg, nil |
| 191 | +} |
| 192 | + |
| 193 | +// formatJSONSchemaValidationError extracts and formats the jsonschema validation errors given by the underlying library |
| 194 | +func formatJSONSchemaValidationError(err error) error { |
| 195 | + var validationErr *schemavalidation.ValidationError |
| 196 | + if !errors.As(err, &validationErr) { |
| 197 | + return err |
| 198 | + } |
| 199 | + var errs []error |
| 200 | + for _, cause := range validationErr.Causes { |
| 201 | + if cause == nil || cause.ErrorKind == nil { |
| 202 | + continue |
| 203 | + } |
| 204 | + |
| 205 | + var errMsg string |
| 206 | + switch e := cause.ErrorKind.(type) { |
| 207 | + case *kind.Format: |
| 208 | + errMsg = e.Err.Error() |
| 209 | + default: |
| 210 | + errMsg = cause.Error() |
| 211 | + } |
| 212 | + |
| 213 | + instanceLocation := "." + strings.Join(cause.InstanceLocation, ".") |
| 214 | + if instanceLocation == "." { |
| 215 | + errs = append(errs, fmt.Errorf("%v", errMsg)) |
| 216 | + } else { |
| 217 | + errs = append(errs, fmt.Errorf("at path %q: %s", instanceLocation, errMsg)) |
| 218 | + } |
| 219 | + } |
| 220 | + if len(errs) > 0 { |
| 221 | + return errors.Join(errs...) |
| 222 | + } |
| 223 | + return err |
| 224 | +} |
| 225 | + |
| 226 | +// notOwnNamespaceFmt returns a dynamically generated format specifically for the case where |
| 227 | +// a bundle does not support own namespace installation but a watch namespace can be optionally given |
| 228 | +func notOwnNamespaceFmt(installNamespace string) *schemavalidation.Format { |
| 229 | + return &schemavalidation.Format{ |
| 230 | + Name: notOwnNamespaceFormat, |
| 231 | + Validate: func(v any) error { |
| 232 | + if err := dnsFormat.Validate(v); err != nil { |
| 233 | + return err |
| 234 | + } |
| 235 | + if v == installNamespace { |
| 236 | + return fmt.Errorf("unsupported value %q, watchNamespace cannot be install namespace", v) |
| 237 | + } |
| 238 | + return nil |
| 239 | + }, |
| 240 | + } |
| 241 | +} |
0 commit comments