pkg/cdi: default to YAML spec encoding.

Signed-off-by: Krisztian Litkey <[email protected]>

Author: klihub

pkg/cdi/cache.go

@@ -274,8 +274,7 @@ 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 JSON encoding is used with a "json"
-// extension appended.
+// choses the encoding. Otherwise the default YAML encoding is used.
 func (c *Cache) WriteSpec(raw *cdi.Spec, name string) error {
 	var (
 		specDir string
@@ -292,7 +291,7 @@ func (c *Cache) WriteSpec(raw *cdi.Spec, name string) error {
 
 	path = filepath.Join(specDir, name)
 	if ext := filepath.Ext(path); ext != ".json" && ext != ".yaml" {
-		path += ".json"
+		path += defaultSpecExt
 	}
 
 	spec, err = NewSpec(raw, path, prio)
@@ -321,7 +320,7 @@ func (c *Cache) RemoveSpec(name string) error {
 
 	path = filepath.Join(specDir, name)
 	if ext := filepath.Ext(path); ext != ".json" && ext != ".yaml" {
-		path += ".json"
+		path += defaultSpecExt
 	}
 
 	err = os.Remove(path)

pkg/cdi/spec.go

@@ -31,6 +31,11 @@ import (
 	cdi "github.com/container-orchestrated-devices/container-device-interface/specs-go"
 )
 
+const (
+	// defaultSpecExt is the file extension for the default encoding.
+	defaultSpecExt = ".yaml"
+)
+
 var (
 	// Valid CDI Spec versions.
 	validSpecVersions = map[string]struct{}{
@@ -105,6 +110,10 @@ func NewSpec(raw *cdi.Spec, path string, priority int) (*Spec, error) {
 		priority: priority,
 	}
 
+	if ext := filepath.Ext(spec.path); ext != ".yaml" && ext != ".json" {
+		spec.path += defaultSpecExt
+	}
+
 	spec.vendor, spec.class = ParseQualifier(spec.Kind)
 
 	if spec.devices, err = spec.validate(); err != nil {

pkg/cdi/spec_test.go

@@ -20,6 +20,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 
 	"github.com/pkg/errors"
@@ -77,7 +78,7 @@ devices:
 		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
-			file, err := mkTestFile(t, []byte(tc.data))
+			file, err := mkTestSpec(t, []byte(tc.data))
 			if err != nil {
 				t.Errorf("failed to create CDI Spec test file: %v", err)
 				return
@@ -461,7 +462,7 @@ devices:
 		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
-			file, err := mkTestFile(t, []byte(tc.data))
+			file, err := mkTestSpec(t, []byte(tc.data))
 			if err != nil {
 				t.Errorf("failed to create CDI Spec test file: %v", err)
 				return
@@ -493,8 +494,8 @@ devices:
 }
 
 // Create an automatically cleaned up temporary file for a test.
-func mkTestFile(t *testing.T, data []byte) (string, error) {
-	tmp, err := ioutil.TempFile("", ".cdi-test.*")
+func mkTestSpec(t *testing.T, data []byte) (string, error) {
+	tmp, err := ioutil.TempFile("", ".cdi-test.*."+specType(data))
 	if err != nil {
 		return "", errors.Wrapf(err, "failed to create test file")
 	}
@@ -515,6 +516,14 @@ func mkTestFile(t *testing.T, data []byte) (string, error) {
 	return file, nil
 }
 
+func specType(content []byte) string {
+	spec := strings.TrimSpace(string(content))
+	if spec != "" && spec[0] == '{' {
+		return "json"
+	}
+	return "yaml"
+}
+
 func TestCurrentVersionIsValid(t *testing.T) {
 	require.NoError(t, validateVersion(cdi.CurrentVersion))
 }