-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
bundle validate: implement bundle content validation to extract warnings
- Loading branch information
Showing
3 changed files
with
230 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| // Copyright 2020 The Operator-SDK 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 registry | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| apimanifests "github.com/operator-framework/api/pkg/manifests" | ||
| apivalidation "github.com/operator-framework/api/pkg/validation" | ||
| apierrors "github.com/operator-framework/api/pkg/validation/errors" | ||
| registrybundle "github.com/operator-framework/operator-registry/pkg/lib/bundle" | ||
| log "github.com/sirupsen/logrus" | ||
| k8svalidation "k8s.io/apimachinery/pkg/api/validation" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/util/validation/field" | ||
| ) | ||
|
|
||
| // ValidateBundleContent confirms that the CSV and CRD files inside the bundle | ||
| // directory are valid and can be installed in a cluster. Other GVK types are | ||
| // also validated to confirm if they are "kubectl-able" to a cluster meaning | ||
| // if they can be applied to a cluster using `kubectl` provided users have all | ||
| // necessary permissions and configurations. | ||
| func ValidateBundleContent(logger *log.Entry, bundle *apimanifests.Bundle, | ||
| mediaType string) []apierrors.ManifestResult { | ||
|
|
||
| // Use errs to collect bundle-level validation errors. | ||
| errs := apierrors.ManifestResult{ | ||
| Name: bundle.Name, | ||
| } | ||
|
|
||
| logger.Debug("Validating bundle contents") | ||
|
|
||
| // helm+vX media types are not supported by this validation function. | ||
| switch mediaType { | ||
| case registrybundle.HelmType: | ||
| return []apierrors.ManifestResult{errs} | ||
| } | ||
|
|
||
| for _, u := range bundle.Objects { | ||
| // CSVs and CRDs will be validated separately. | ||
| gvk := u.GetObjectKind().GroupVersionKind() | ||
| if gvk.Kind == "ClusterServiceVersion" || gvk.Kind == "CustomResourceDefinition" { | ||
| continue | ||
| } | ||
|
|
||
| logger.Debugf("Validating %s %q", gvk, u.GetName()) | ||
|
|
||
| // Verify if the object kind is supported for registry+v1 format. | ||
| supported, _ := registrybundle.IsSupported(gvk.Kind) | ||
| if mediaType == registrybundle.RegistryV1Type && !supported { | ||
| errs.Add(apierrors.ErrInvalidBundle(fmt.Sprintf("unsupported media type %s for bundle object", mediaType), gvk)) | ||
| continue | ||
| } | ||
|
|
||
| if err := validateObject(metav1.Object(u)); err != nil { | ||
| errs.Add(apierrors.ErrFailedValidation(err.Error(), u.GetName())) | ||
| } | ||
| } | ||
|
|
||
| // Validate bundle itself. | ||
| results := apivalidation.BundleValidator.Validate(bundle) | ||
|
|
||
| // All bundles must have a CSV currently. | ||
| if bundle.CSV != nil { | ||
| results = append(results, apivalidation.ClusterServiceVersionValidator.Validate(bundle.CSV)...) | ||
| } else { | ||
| errs.Add(apierrors.ErrInvalidBundle("no ClusterServiceVersion in bundle", bundle.Name)) | ||
| } | ||
|
|
||
| // Validate all CRD versions in the bundle together. | ||
| var crds []interface{} | ||
| for _, crd := range bundle.V1beta1CRDs { | ||
| crds = append(crds, crd) | ||
| } | ||
| for _, crd := range bundle.V1CRDs { | ||
| crds = append(crds, crd) | ||
| } | ||
| if len(crds) != 0 { | ||
| results = append(results, apivalidation.CustomResourceDefinitionValidator.Validate(crds...)...) | ||
| } | ||
|
|
||
| // Add all other results/errors to the bundle validation results. | ||
| results = appendResult(results, errs) | ||
|
|
||
| return results | ||
| } | ||
|
|
||
| // validateObject validates an arbitrary metav1.Object's metadata. | ||
| func validateObject(obj metav1.Object) error { | ||
| f := func(string, bool) []string { return nil } | ||
| errs := k8svalidation.ValidateObjectMetaAccessor(obj, false, f, field.NewPath("metadata")) | ||
| if len(errs) > 0 { | ||
| return fmt.Errorf("error validating object: %s. %v", errs.ToAggregate(), obj) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // appendResult attempts to find a result in results that matches r.Name, and | ||
| // if found appends errors and warnings to that result. Otherwise r is added | ||
| // to the end of results. | ||
| func appendResult(results []apierrors.ManifestResult, r apierrors.ManifestResult) []apierrors.ManifestResult { | ||
| resultIdx := -1 | ||
| for i, result := range results { | ||
| if result.Name == r.Name { | ||
| resultIdx = i | ||
| break | ||
| } | ||
| } | ||
| if resultIdx < 0 { | ||
| results = append(results, r) | ||
| } else { | ||
| results[resultIdx].Add(r.Errors...) | ||
| results[resultIdx].Add(r.Warnings...) | ||
| } | ||
|
|
||
| return results | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters