pkg/validation/interfaces: Validator's implement WithValidators to append non-default Validators to the Validator; ValidatorFunc implements Validator

Author: estroz

pkg/manifests/directory.go

@@ -26,6 +26,6 @@ func GetManifestsDir(dir string) (registry.PackageManifest, []*registry.Bundle,
 	for _, obj := range bundles {
 		objs = append(objs, obj)
 	}
-	results := validation.DefaultValidators().Apply(objs...)
+	results := validation.AllValidators.Validate(objs...)
 	return pkg, bundles, results
 }

pkg/validation/doc.go

@@ -1,11 +1,11 @@
 // This package defines the valid Operator manifests directory format
-// by exposing a set of interfaces.Validator's to verify a directory and
+// by exposing a set of Validator's to verify a directory and
 // its constituent manifests. A manifests directory consists of a
-// Package Manifest and a set of versioned Bundles. Each Bundle contains a
+// package manifest and a set of versioned Bundles. Each Bundle contains a
 // ClusterServiceVersion and one or more CustomResourceDefinition's.
 //
-// Errors and warnings, both represented by the errors.Error type, are
-// returned by exported functions for missing mandatory and optional fields,
+// Errors and warnings, both represented by the Error type, are returned
+// by exported functions for missing mandatory and optional fields,
 // respectively. Each Error implements the error interface.
 //
 // Manifest and Bundle format: https://github.com/operator-framework/operator-registry/#manifest-format

pkg/validation/interfaces/validator.go

@@ -9,16 +9,38 @@ type Validator interface {
 	// Validate takes a list of arbitrary objects and returns a slice of results,
 	// one for each object validated.
 	Validate(...interface{}) []errors.ManifestResult
+	// WithValidators returns a Validator appended to a variable number of
+	// Validator's.
+	WithValidators(...Validator) Validators
 }
 
-// Validators is a set of Validator's that can be run via Apply.
+// ValidatorFunc implements Validator. ValidatorFunc can be used as a wrapper
+// for functions that run object validators.
+type ValidatorFunc func(...interface{}) []errors.ManifestResult
+
+// Validate runs the ValidatorFunc on objs.
+func (f ValidatorFunc) Validate(objs ...interface{}) (results []errors.ManifestResult) {
+	return f(objs...)
+}
+
+// WithValidators appends the ValidatorFunc to vals.
+func (f ValidatorFunc) WithValidators(vals ...Validator) Validators {
+	return append(vals, f)
+}
+
+// Validators is a set of Validator's that implements Validate.
 type Validators []Validator
 
-// ApplyParallel invokes each Validator in vals, and collects and returns
+// Validate invokes each Validator in Validators, collecting and returning
 // the results.
-func (vals Validators) Apply(objs ...interface{}) (results []errors.ManifestResult) {
-	for _, validator := range vals {
+func (validators Validators) Validate(objs ...interface{}) (results []errors.ManifestResult) {
+	for _, validator := range validators {
 		results = append(results, validator.Validate(objs...)...)
 	}
 	return results
 }
+
+// WithValidators appends vals to Validators.
+func (validators Validators) WithValidators(vals ...Validator) Validators {
+	return append(vals, validators...)
+}

pkg/validation/internal/bundle.go

@@ -5,14 +5,15 @@ import (
 	"fmt"
 
 	"github.com/operator-framework/api/pkg/validation/errors"
+	interfaces "github.com/operator-framework/api/pkg/validation/interfaces"
 
 	operatorsv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
 	"github.com/operator-framework/operator-registry/pkg/registry"
 )
 
-type BundleValidator struct{}
+var BundleValidator interfaces.Validator = interfaces.ValidatorFunc(validateBundles)
 
-func (f BundleValidator) Validate(objs ...interface{}) (results []errors.ManifestResult) {
+func validateBundles(objs ...interface{}) (results []errors.ManifestResult) {
 	for _, obj := range objs {
 		switch v := obj.(type) {
 		case *registry.Bundle:

pkg/validation/internal/crd.go

@@ -4,6 +4,7 @@ import (
 	"strings"
 
 	"github.com/operator-framework/api/pkg/validation/errors"
+	interfaces "github.com/operator-framework/api/pkg/validation/interfaces"
 
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/install"
@@ -19,9 +20,9 @@ func init() {
 	install.Install(Scheme)
 }
 
-type CRDValidator struct{}
+var CRDValidator interfaces.Validator = interfaces.ValidatorFunc(validateCRDs)
 
-func (f CRDValidator) Validate(objs ...interface{}) (results []errors.ManifestResult) {
+func validateCRDs(objs ...interface{}) (results []errors.ManifestResult) {
 	for _, obj := range objs {
 		switch v := obj.(type) {
 		case *v1beta1.CustomResourceDefinition:

pkg/validation/internal/csv.go

@@ -7,19 +7,20 @@ import (
 	"strings"
 
 	"github.com/operator-framework/api/pkg/validation/errors"
-	"github.com/operator-framework/operator-registry/pkg/registry"
+	interfaces "github.com/operator-framework/api/pkg/validation/interfaces"
 
 	"github.com/blang/semver"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
+	"github.com/operator-framework/operator-registry/pkg/registry"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	k8svalidation "k8s.io/apimachinery/pkg/util/validation"
 	"k8s.io/apimachinery/pkg/util/yaml"
 )
 
-type CSVValidator struct{}
+var CSVValidator interfaces.Validator = interfaces.ValidatorFunc(validateCSVs)
 
-func (f CSVValidator) Validate(objs ...interface{}) (results []errors.ManifestResult) {
+func validateCSVs(objs ...interface{}) (results []errors.ManifestResult) {
 	for _, obj := range objs {
 		switch v := obj.(type) {
 		case *v1alpha1.ClusterServiceVersion:

pkg/validation/internal/manifests.go

@@ -4,16 +4,17 @@ import (
 	"fmt"
 
 	"github.com/operator-framework/api/pkg/validation/errors"
+	interfaces "github.com/operator-framework/api/pkg/validation/interfaces"
 
 	"github.com/blang/semver"
 	"github.com/operator-framework/operator-registry/pkg/registry"
 )
 
 const skipPackageAnnotationKey = "olm.skipRange"
 
-type ManifestsValidator struct{}
+var PackageUpdateGraphValidator interfaces.Validator = interfaces.ValidatorFunc(validatePackageUpdateGraphs)
 
-func (f ManifestsValidator) Validate(objs ...interface{}) (results []errors.ManifestResult) {
+func validatePackageUpdateGraphs(objs ...interface{}) (results []errors.ManifestResult) {
 	var pkg *registry.PackageManifest
 	bundles := []*registry.Bundle{}
 	for _, obj := range objs {
@@ -27,12 +28,12 @@ func (f ManifestsValidator) Validate(objs ...interface{}) (results []errors.Mani
 		}
 	}
 	if pkg != nil && len(bundles) > 0 {
-		results = append(results, validateManifests(pkg, bundles))
+		results = append(results, validatePackageUpdateGraph(pkg, bundles))
 	}
 	return results
 }
 
-func validateManifests(pkg *registry.PackageManifest, bundles []*registry.Bundle) (result errors.ManifestResult) {
+func validatePackageUpdateGraph(pkg *registry.PackageManifest, bundles []*registry.Bundle) (result errors.ManifestResult) {
 	// Collect all CSV names and ensure no duplicates. We will use these names
 	// to check whether a spec.replaces references an existing CSV in bundles.
 	csvNameMap := map[string]struct{}{}

pkg/validation/internal/package_manifest.go

@@ -4,13 +4,14 @@ import (
 	"fmt"
 
 	"github.com/operator-framework/api/pkg/validation/errors"
+	interfaces "github.com/operator-framework/api/pkg/validation/interfaces"
 
 	"github.com/operator-framework/operator-registry/pkg/registry"
 )
 
-type PackageManifestValidator struct{}
+var PackageManifestValidator interfaces.Validator = interfaces.ValidatorFunc(validatePackageManifests)
 
-func (f PackageManifestValidator) Validate(objs ...interface{}) (results []errors.ManifestResult) {
+func validatePackageManifests(objs ...interface{}) (results []errors.ManifestResult) {
 	for _, obj := range objs {
 		switch v := obj.(type) {
 		case *registry.PackageManifest:

pkg/validation/validation.go

@@ -3,8 +3,8 @@
 // implemented by this validation library.
 //
 // Each default Validator runs an independent set of validation functions on
-// a set of objects. To run all implemented Validator's, use DefaultValidators().
-// The Validator will not be run on objects not of the appropriate type.
+// a set of objects. To run all implemented Validator's, use AllValidators.
+// The Validator will not be run on objects of an inappropriate type.
 
 package validation
 
@@ -13,50 +13,29 @@ import (
 	"github.com/operator-framework/api/pkg/validation/internal"
 )
 
-// DefaultPackageManifestValidators returns a package manifest Validator that
-// can be run directly with Apply(objs...). Optionally, any additional
-// Validator's can be added to the returned Validators set.
-func DefaultPackageManifestValidators(vals ...interfaces.Validator) interfaces.Validators {
-	return append(vals, internal.PackageManifestValidator{})
-}
+// PackageManifestValidator implements Validator to validate package manifests.
+var PackageManifestValidator = internal.PackageManifestValidator
 
-// DefaultClusterServiceVersionValidators returns a ClusterServiceVersion
-// Validator that can be run directly with Apply(objs...). Optionally, any
-// additional Validator's can be added to the returned Validators set.
-func DefaultClusterServiceVersionValidators(vals ...interfaces.Validator) interfaces.Validators {
-	return append(vals, internal.CSVValidator{})
-}
+// ClusterServiceVersionValidator implements Validator to validate
+// ClusterServiceVersions.
+var ClusterServiceVersionValidator = internal.CSVValidator
 
-// DefaultCustomResourceDefinitionValidators returns a CustomResourceDefinition
-// Validator that can be run directly with Apply(objs...). Optionally, any
-// additional Validator's can be added to the returned Validators set.
-func DefaultCustomResourceDefinitionValidators(vals ...interfaces.Validator) interfaces.Validators {
-	return append(vals, internal.CRDValidator{})
-}
+// CustomResourceDefinitionValidator implements Validator to validate
+// CustomResourceDefinitions.
+var CustomResourceDefinitionValidator = internal.CRDValidator
 
-// DefaultBundleValidators returns a bundle Validator that can be run directly
-// with Apply(objs...). Optionally, any additional Validator's can be added to
-// the returned Validators set.
-func DefaultBundleValidators(vals ...interfaces.Validator) interfaces.Validators {
-	return append(vals, internal.BundleValidator{})
-}
+// BundleValidator implements Validator to validate Bundles.
+var BundleValidator = internal.BundleValidator
 
-// DefaultManifestsValidators returns a manifests Validator that can be run
-// directly with Apply(objs...). Optionally, any additional Validator's can be
-// added to the returned Validators set.
-func DefaultManifestsValidators(vals ...interfaces.Validator) interfaces.Validators {
-	return append(vals, internal.ManifestsValidator{})
-}
+// PackageUpdateGraphValidator implements Validator to validate the
+// package update graph between a package manifest and Bundles.
+var PackageUpdateGraphValidator = internal.PackageUpdateGraphValidator
 
-// DefaultValidators returns all default Validator's, which can be run directly
-// with Apply(objs...). Optionally, any additional Validator's can be added to
-// the returned Validators set.
-func DefaultValidators(vals ...interfaces.Validator) interfaces.Validators {
-	return append(vals,
-		internal.PackageManifestValidator{},
-		internal.CSVValidator{},
-		internal.CRDValidator{},
-		internal.BundleValidator{},
-		internal.ManifestsValidator{},
-	)
+// AllValidators implements Validator to validate all Operator manifest types.
+var AllValidators = interfaces.Validators{
+	PackageManifestValidator,
+	ClusterServiceVersionValidator,
+	CustomResourceDefinitionValidator,
+	BundleValidator,
+	PackageUpdateGraphValidator,
 }