Use producer validation in cache

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

Author: elezar

pkg/cdi/cache.go

@@ -282,35 +282,31 @@ func (c *Cache) highestPrioritySpecDir() (string, int) {
 // WriteSpec writes a Spec file with the given content into the highest
 // priority Spec directory. If name has a "json" or "yaml" extension it
 // choses the encoding. Otherwise the default YAML encoding is used.
+//
+// Deprecated: use producer.NewSpecWriter instead.
 func (c *Cache) WriteSpec(raw *cdi.Spec, name string) error {
 	var (
 		specDir string
-		prio    int
-		spec    *Spec
 		err     error
 	)
-	specDir, prio = c.highestPrioritySpecDir()
+	specDir, _ = c.highestPrioritySpecDir()
 	if specDir == "" {
 		return errors.New("no Spec directories to write to")
 	}
 
 	path := filepath.Join(specDir, name)
-
-	// We call newSpec to perform the required validation.
-	// This also sets the extension of the path.
-	spec, err = newSpec(raw, path, prio)
-	if err != nil {
-		return err
+	if ext := filepath.Ext(path); ext != ".yaml" && ext != ".json" {
+		path += defaultSpecExt
 	}
+	path = filepath.Clean(path)
 
 	p, err := producer.NewSpecWriter(
-		producer.WithSpecFormat(producer.SpecFormatYAML),
 		producer.WithOverwrite(true),
 	)
 	if err != nil {
 		return err
 	}
-	if _, err := p.Save(spec.Spec, spec.path); err != nil {
+	if _, err := p.Save(raw, path); err != nil {
 		return err
 	}
 	return nil

pkg/cdi/device.go

@@ -17,11 +17,8 @@
 package cdi
 
 import (
-	"fmt"
-
 	oci "github.com/opencontainers/runtime-spec/specs-go"
-	"tags.cncf.io/container-device-interface/internal/validation"
-	"tags.cncf.io/container-device-interface/pkg/parser"
+	"tags.cncf.io/container-device-interface/api/producer"
 	cdi "tags.cncf.io/container-device-interface/specs-go"
 )
 
@@ -52,6 +49,9 @@ func (d *Device) GetSpec() *Spec {
 
 // GetQualifiedName returns the qualified name for this device.
 func (d *Device) GetQualifiedName() string {
+	if d.spec == nil {
+		return d.Name
+	}
 	return d.spec.Kind + "=" + d.Name
 }
 
@@ -67,22 +67,9 @@ func (d *Device) edits() *ContainerEdits {
 
 // Validate the device.
 func (d *Device) validate() error {
-	if err := parser.ValidateDeviceName(d.Name); err != nil {
-		return err
-	}
-	name := d.Name
+	var kind string
 	if d.spec != nil {
-		name = d.GetQualifiedName()
-	}
-	if err := validation.ValidateSpecAnnotations(name, d.Annotations); err != nil {
-		return err
-	}
-	edits := d.edits()
-	if edits.isEmpty() {
-		return fmt.Errorf("invalid device, empty device edits")
-	}
-	if err := edits.Validate(); err != nil {
-		return fmt.Errorf("invalid device %q: %w", d.Name, err)
+		kind = d.spec.Kind
 	}
-	return nil
+	return producer.DefaultValidator.ValidateDevice(d.Device, kind)
 }

pkg/cdi/spec.go

@@ -26,7 +26,7 @@ import (
 	oci "github.com/opencontainers/runtime-spec/specs-go"
 	"sigs.k8s.io/yaml"
 
-	"tags.cncf.io/container-device-interface/internal/validation"
+	"tags.cncf.io/container-device-interface/api/producer"
 	"tags.cncf.io/container-device-interface/pkg/parser"
 	cdi "tags.cncf.io/container-device-interface/specs-go"
 )
@@ -161,22 +161,11 @@ func MinimumRequiredVersion(spec *cdi.Spec) (string, error) {
 
 // Validate the Spec.
 func (s *Spec) validate() (map[string]*Device, error) {
-	if err := cdi.ValidateVersion(s.Spec); err != nil {
-		return nil, err
-	}
-	if err := parser.ValidateVendorName(s.vendor); err != nil {
-		return nil, err
-	}
-	if err := parser.ValidateClassName(s.class); err != nil {
-		return nil, err
-	}
-	if err := validation.ValidateSpecAnnotations(s.Kind, s.Annotations); err != nil {
-		return nil, err
-	}
-	if err := s.edits().Validate(); err != nil {
+	if err := producer.DefaultValidator.Validate(s.Spec); err != nil {
 		return nil, err
 	}
 
+	// We construct a list of devices associated with the spec.
 	devices := make(map[string]*Device)
 	for _, d := range s.Devices {
 		dev, err := newDevice(s, d)