Use validator interface instead of function

Signed-off-by: Evan Lezar <[email protected]>

Author: elezar

pkg/cdi/spec.go

@@ -37,9 +37,13 @@ const (
 	defaultSpecExt = ".yaml"
 )
 
+type validator interface {
+	Validate(*cdi.Spec) error
+}
+
 var (
 	// Externally set CDI Spec validation function.
-	specValidator func(*cdi.Spec) error
+	specValidator validator
 	validatorLock sync.RWMutex
 )
 
@@ -256,10 +260,10 @@ func ParseSpec(data []byte) (*cdi.Spec, error) {
 // SetSpecValidator sets a CDI Spec validator function. This function
 // is used for extra CDI Spec content validation whenever a Spec file
 // loaded (using ReadSpec() or written (using WriteSpec()).
-func SetSpecValidator(fn func(*cdi.Spec) error) {
+func SetSpecValidator(v validator) {
 	validatorLock.Lock()
 	defer validatorLock.Unlock()
-	specValidator = fn
+	specValidator = v
 }
 
 // validateSpec validates the Spec using the external validator.
@@ -270,7 +274,7 @@ func validateSpec(raw *cdi.Spec) error {
 	if specValidator == nil {
 		return nil
 	}
-	err := specValidator(raw)
+	err := specValidator.Validate(raw)
 	if err != nil {
 		return fmt.Errorf("Spec validation failed: %w", err)
 	}

schema/schema.go

@@ -32,6 +32,7 @@ import (
 
 	schema "github.com/xeipuuv/gojsonschema"
 	"tags.cncf.io/container-device-interface/internal/validation"
+	cdi "tags.cncf.io/container-device-interface/specs-go"
 )
 
 const (
@@ -48,6 +49,15 @@ type Schema struct {
 	schema *schema.Schema
 }
 
+// Validate applies a schema validation on the supplied CDI specification.
+// If the Schema is nil, no validation is performed.
+func (s *Schema) Validate(spec *cdi.Spec) error {
+	if s == nil {
+		return nil
+	}
+	return s.ValidateType(spec)
+}
+
 // Error wraps a JSON validation result.
 type Error struct {
 	Result *schema.Result
@@ -96,9 +106,9 @@ func ReadAndValidate(r io.Reader) ([]byte, error) {
 	return current.ReadAndValidate(r)
 }
 
-// Validate validates the data read from an io.Reader against the active schema.
-func Validate(r io.Reader) error {
-	return current.Validate(r)
+// ValidateReader validates the data read from an io.Reader against the active schema.
+func ValidateReader(r io.Reader) error {
+	return current.ValidateReader(r)
 }
 
 // ValidateData validates the given JSON document against the active schema.
@@ -165,8 +175,8 @@ func (s *Schema) ReadAndValidate(r io.Reader) ([]byte, error) {
 	return data, s.validate(loader)
 }
 
-// Validate validates the data read from an io.Reader against the schema.
-func (s *Schema) Validate(r io.Reader) error {
+// ValidateReader validates the data read from an io.Reader against the schema.
+func (s *Schema) ValidateReader(r io.Reader) error {
 	_, err := s.ReadAndValidate(r)
 	return err
 }

schema/schema_test.go

@@ -298,9 +298,9 @@ func readAndValidate(t *testing.T, scm *schema.Schema, path string, shouldLoad,
 	verifyResult(t, scm, err, shouldLoad, isValid)
 
 	if scm != nil {
-		err = scm.Validate(bytes.NewReader(data))
+		err = scm.ValidateReader(bytes.NewReader(data))
 	} else {
-		err = schema.Validate(bytes.NewReader(data))
+		err = schema.ValidateReader(bytes.NewReader(data))
 	}
 
 	verifyResult(t, scm, err, shouldLoad, isValid)
@@ -315,17 +315,17 @@ func validateRead(t *testing.T, scm *schema.Schema, path string, shouldLoad, isV
 	r := io.TeeReader(f, buf)
 
 	if scm != nil {
-		err = scm.Validate(r)
+		err = scm.ValidateReader(r)
 	} else {
-		err = schema.Validate(r)
+		err = schema.ValidateReader(r)
 	}
 
 	verifyResult(t, scm, err, shouldLoad, isValid)
 
 	if scm != nil {
-		err = scm.Validate(bytes.NewReader(buf.Bytes()))
+		err = scm.ValidateReader(bytes.NewReader(buf.Bytes()))
 	} else {
-		err = schema.Validate(bytes.NewReader(buf.Bytes()))
+		err = schema.ValidateReader(bytes.NewReader(buf.Bytes()))
 	}
 
 	verifyResult(t, scm, err, shouldLoad, isValid)

schema/validate.go

@@ -16,42 +16,31 @@
 
 package schema
 
-import (
-	cdi "tags.cncf.io/container-device-interface/specs-go"
-)
-
 const (
 	// DefaultExternalSchema is the default JSON schema to load for validation.
 	DefaultExternalSchema = "/etc/cdi/schema/schema.json"
 )
 
 // WithSchema returns a CDI Spec validator that uses the given Schema.
-func WithSchema(s *Schema) func(*cdi.Spec) error {
-	if s == nil {
-		return func(*cdi.Spec) error {
-			return nil
-		}
-	}
-	return func(spec *cdi.Spec) error {
-		return s.ValidateType(spec)
-	}
+func WithSchema(s *Schema) *Schema {
+	return s
 }
 
 // WithNamedSchema loads the named JSON schema and returns a CDI Spec
 // validator for it. If loading the schema fails a dummy validator is
 // returned.
-func WithNamedSchema(name string) func(*cdi.Spec) error {
+func WithNamedSchema(name string) *Schema {
 	s, _ := Load(name)
 	return WithSchema(s)
 }
 
 // WithDefaultSchema returns a CDI Spec validator that uses the default
 // external JSON schema, or the default builtin one if the external one
 // fails to load.
-func WithDefaultSchema() func(*cdi.Spec) error {
+func WithDefaultSchema() *Schema {
 	s, err := Load(DefaultExternalSchema)
 	if err == nil {
 		return WithSchema(s)
 	}
-	return WithSchema(BuiltinSchema())
+	return BuiltinSchema()
 }