Skip to content

Commit 5dd89b7

Browse files
committed
Ensure that YAML fields are sorted
Signed-off-by: Evan Lezar <[email protected]>
1 parent 4149a8a commit 5dd89b7

File tree

13 files changed

+46
-55
lines changed

13 files changed

+46
-55
lines changed

Diff for: cmd/cdi/cmd/format.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import (
2222
"path/filepath"
2323
"strings"
2424

25-
"sigs.k8s.io/yaml"
25+
"gopkg.in/yaml.v2"
2626
)
2727

2828
func chooseFormat(format string, path string) string {

Diff for: cmd/cdi/cmd/inject.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import (
2222
"os"
2323

2424
oci "github.com/opencontainers/runtime-spec/specs-go"
25-
"sigs.k8s.io/yaml"
25+
"gopkg.in/yaml.v2"
2626

2727
"github.com/spf13/cobra"
2828
)

Diff for: cmd/cdi/go.mod

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ require (
77
github.com/opencontainers/runtime-spec v1.1.0
88
github.com/opencontainers/runtime-tools v0.9.1-0.20221107090550-2e043c6bd626
99
github.com/spf13/cobra v1.6.0
10-
sigs.k8s.io/yaml v1.3.0
10+
gopkg.in/yaml.v2 v2.4.0
1111
tags.cncf.io/container-device-interface v0.0.0
1212
)
1313

@@ -21,7 +21,6 @@ require (
2121
github.com/xeipuuv/gojsonschema v1.2.0 // indirect
2222
golang.org/x/mod v0.19.0 // indirect
2323
golang.org/x/sys v0.19.0 // indirect
24-
gopkg.in/yaml.v2 v2.4.0 // indirect
2524
tags.cncf.io/container-device-interface/specs-go v0.8.0 // indirect
2625
)
2726

Diff for: cmd/cdi/go.sum

-2
Original file line numberDiff line numberDiff line change
@@ -58,5 +58,3 @@ gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
5858
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
5959
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
6060
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
61-
sigs.k8s.io/yaml v1.3.0 h1:a2VclLzOGrwOHDiV8EfBGhvjHvP46CtW5j6POvhYGGo=
62-
sigs.k8s.io/yaml v1.3.0/go.mod h1:GeOyir5tyXNByN85N/dRIT9es5UQNerPYEKK56eTBm8=

Diff for: cmd/validate/go.mod

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ require (
99
github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
1010
github.com/xeipuuv/gojsonschema v1.2.0 // indirect
1111
gopkg.in/yaml.v2 v2.4.0 // indirect
12-
sigs.k8s.io/yaml v1.3.0 // indirect
1312
)
1413

1514
replace tags.cncf.io/container-device-interface => ../..

Diff for: cmd/validate/go.sum

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
22
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
3-
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
43
github.com/fsnotify/fsnotify v1.5.1 h1:mZcQUHVQUQWoPXXtuf9yuEXKudkV2sx1E06UadKWpgI=
54
github.com/opencontainers/runtime-spec v1.1.0 h1:HHUyrt9mwHUjtasSbXSMvs4cyFxh+Bll4AjJ9odEGpg=
65
github.com/opencontainers/runtime-tools v0.9.1-0.20221107090550-2e043c6bd626 h1:DmNGcqH3WDbV5k8OJ+esPWbqUOX5rMLR2PMvziDMJi0=
@@ -23,5 +22,3 @@ gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8
2322
gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
2423
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
2524
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
26-
sigs.k8s.io/yaml v1.3.0 h1:a2VclLzOGrwOHDiV8EfBGhvjHvP46CtW5j6POvhYGGo=
27-
sigs.k8s.io/yaml v1.3.0/go.mod h1:GeOyir5tyXNByN85N/dRIT9es5UQNerPYEKK56eTBm8=

Diff for: go.mod

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ require (
99
github.com/stretchr/testify v1.7.0
1010
github.com/xeipuuv/gojsonschema v1.2.0
1111
golang.org/x/sys v0.19.0
12-
sigs.k8s.io/yaml v1.3.0
12+
gopkg.in/yaml.v2 v2.4.0
1313
tags.cncf.io/container-device-interface/specs-go v0.8.0
1414
)
1515

@@ -20,7 +20,6 @@ require (
2020
github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f // indirect
2121
github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
2222
golang.org/x/mod v0.19.0 // indirect
23-
gopkg.in/yaml.v2 v2.4.0 // indirect
2423
gopkg.in/yaml.v3 v3.0.1 // indirect
2524
)
2625

Diff for: go.sum

-2
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,3 @@ gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
5151
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
5252
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
5353
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
54-
sigs.k8s.io/yaml v1.3.0 h1:a2VclLzOGrwOHDiV8EfBGhvjHvP46CtW5j6POvhYGGo=
55-
sigs.k8s.io/yaml v1.3.0/go.mod h1:GeOyir5tyXNByN85N/dRIT9es5UQNerPYEKK56eTBm8=

Diff for: pkg/cdi/cache_test.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ import (
2929

3030
oci "github.com/opencontainers/runtime-spec/specs-go"
3131
"github.com/stretchr/testify/require"
32-
"sigs.k8s.io/yaml"
32+
"gopkg.in/yaml.v2"
33+
3334
"tags.cncf.io/container-device-interface/pkg/cdi/validate"
3435
cdi "tags.cncf.io/container-device-interface/specs-go"
3536
)

Diff for: pkg/cdi/spec.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import (
2525
"sync"
2626

2727
oci "github.com/opencontainers/runtime-spec/specs-go"
28-
"sigs.k8s.io/yaml"
28+
"gopkg.in/yaml.v2"
2929

3030
"tags.cncf.io/container-device-interface/internal/validation"
3131
"tags.cncf.io/container-device-interface/pkg/parser"

Diff for: pkg/cdi/spec_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import (
2323
"strings"
2424
"testing"
2525

26-
"sigs.k8s.io/yaml"
26+
"gopkg.in/yaml.v2"
2727

2828
"github.com/stretchr/testify/require"
2929
"tags.cncf.io/container-device-interface/pkg/cdi/validate"

Diff for: schema/schema.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import (
2828
"path/filepath"
2929
"strings"
3030

31-
"sigs.k8s.io/yaml"
31+
"gopkg.in/yaml.v2"
3232

3333
schema "github.com/xeipuuv/gojsonschema"
3434
"tags.cncf.io/container-device-interface/internal/validation"

Diff for: specs-go/config.go

+37-37
Original file line numberDiff line numberDiff line change
@@ -4,69 +4,69 @@ import "os"
44

55
// Spec is the base configuration for CDI
66
type Spec struct {
7-
Version string `json:"cdiVersion"`
8-
Kind string `json:"kind"`
7+
Version string `json:"cdiVersion" yaml:"cdiVersion"`
8+
Kind string `json:"kind" yaml:"kind"`
99
// Annotations add meta information per CDI spec. Note these are CDI-specific and do not affect container metadata.
1010
// Added in v0.6.0.
11-
Annotations map[string]string `json:"annotations,omitempty"`
12-
Devices []Device `json:"devices"`
13-
ContainerEdits ContainerEdits `json:"containerEdits,omitempty"`
11+
Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
12+
Devices []Device `json:"devices" yaml:"devices"`
13+
ContainerEdits ContainerEdits `json:"containerEdits,omitempty" yaml:"containerEdits,omitempty"`
1414
}
1515

1616
// Device is a "Device" a container runtime can add to a container
1717
type Device struct {
18-
Name string `json:"name"`
18+
Name string `json:"name" yaml:"name"`
1919
// Annotations add meta information per device. Note these are CDI-specific and do not affect container metadata.
2020
// Added in v0.6.0.
21-
Annotations map[string]string `json:"annotations,omitempty"`
22-
ContainerEdits ContainerEdits `json:"containerEdits"`
21+
Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
22+
ContainerEdits ContainerEdits `json:"containerEdits" yaml:"containerEdits"`
2323
}
2424

2525
// ContainerEdits are edits a container runtime must make to the OCI spec to expose the device.
2626
type ContainerEdits struct {
27-
Env []string `json:"env,omitempty"`
28-
DeviceNodes []*DeviceNode `json:"deviceNodes,omitempty"`
29-
Hooks []*Hook `json:"hooks,omitempty"`
30-
Mounts []*Mount `json:"mounts,omitempty"`
31-
IntelRdt *IntelRdt `json:"intelRdt,omitempty"` // Added in v0.7.0
32-
AdditionalGIDs []uint32 `json:"additionalGids,omitempty"` // Added in v0.7.0
27+
Env []string `json:"env,omitempty" yaml:"env,omitempty"`
28+
DeviceNodes []*DeviceNode `json:"deviceNodes,omitempty" yaml:"deviceNodes,omitempty"`
29+
Hooks []*Hook `json:"hooks,omitempty" yaml:"hooks,omitempty"`
30+
Mounts []*Mount `json:"mounts,omitempty" yaml:"mounts,omitempty"`
31+
IntelRdt *IntelRdt `json:"intelRdt,omitempty" yaml:"intelRdt,omitempty"` // Added in v0.7.0
32+
AdditionalGIDs []uint32 `json:"additionalGids,omitempty" yaml:"additionalGids,omitempty"` // Added in v0.7.0
3333
}
3434

3535
// DeviceNode represents a device node that needs to be added to the OCI spec.
3636
type DeviceNode struct {
37-
Path string `json:"path"`
38-
HostPath string `json:"hostPath,omitempty"` // Added in v0.5.0
39-
Type string `json:"type,omitempty"`
40-
Major int64 `json:"major,omitempty"`
41-
Minor int64 `json:"minor,omitempty"`
42-
FileMode *os.FileMode `json:"fileMode,omitempty"`
43-
Permissions string `json:"permissions,omitempty"`
44-
UID *uint32 `json:"uid,omitempty"`
45-
GID *uint32 `json:"gid,omitempty"`
37+
Path string `json:"path" yaml:"path"`
38+
HostPath string `json:"hostPath,omitempty" yaml:"hostPath,omitempty"` // Added in v0.5.0
39+
Type string `json:"type,omitempty" yaml:"type,omitempty"`
40+
Major int64 `json:"major,omitempty" yaml:"major,omitempty"`
41+
Minor int64 `json:"minor,omitempty" yaml:"minor,omitempty"`
42+
FileMode *os.FileMode `json:"fileMode,omitempty" yaml:"fileMode,omitempty"`
43+
Permissions string `json:"permissions,omitempty" yaml:"permissions,omitempty"`
44+
UID *uint32 `json:"uid,omitempty" yaml:"uid,omitempty"`
45+
GID *uint32 `json:"gid,omitempty" yaml:"gid,omitempty"`
4646
}
4747

4848
// Mount represents a mount that needs to be added to the OCI spec.
4949
type Mount struct {
50-
HostPath string `json:"hostPath"`
51-
ContainerPath string `json:"containerPath"`
52-
Options []string `json:"options,omitempty"`
53-
Type string `json:"type,omitempty"` // Added in v0.4.0
50+
HostPath string `json:"hostPath" yaml:"hostPath"`
51+
ContainerPath string `json:"containerPath" yaml:"containerPath"`
52+
Options []string `json:"options,omitempty" yaml:"options,omitempty"`
53+
Type string `json:"type,omitempty" yaml:"type,omitempty"` // Added in v0.4.0
5454
}
5555

5656
// Hook represents a hook that needs to be added to the OCI spec.
5757
type Hook struct {
58-
HookName string `json:"hookName"`
59-
Path string `json:"path"`
60-
Args []string `json:"args,omitempty"`
61-
Env []string `json:"env,omitempty"`
62-
Timeout *int `json:"timeout,omitempty"`
58+
HookName string `json:"hookName" yaml:"hookName"`
59+
Path string `json:"path" yaml:"path"`
60+
Args []string `json:"args,omitempty" yaml:"args,omitempty"`
61+
Env []string `json:"env,omitempty" yaml:"env,omitempty"`
62+
Timeout *int `json:"timeout,omitempty" yaml:"timeout,omitempty"`
6363
}
6464

6565
// IntelRdt describes the Linux IntelRdt parameters to set in the OCI spec.
6666
type IntelRdt struct {
67-
ClosID string `json:"closID,omitempty"`
68-
L3CacheSchema string `json:"l3CacheSchema,omitempty"`
69-
MemBwSchema string `json:"memBwSchema,omitempty"`
70-
EnableCMT bool `json:"enableCMT,omitempty"`
71-
EnableMBM bool `json:"enableMBM,omitempty"`
67+
ClosID string `json:"closID,omitempty" yaml:"closID,omitempty"`
68+
L3CacheSchema string `json:"l3CacheSchema,omitempty" yaml:"l3CacheSchema,omitempty"`
69+
MemBwSchema string `json:"memBwSchema,omitempty" yaml:"memBwSchema,omitempty"`
70+
EnableCMT bool `json:"enableCMT,omitempty" yaml:"enableCMT,omitempty"`
71+
EnableMBM bool `json:"enableMBM,omitempty" yaml:"enableMBM,omitempty"`
7272
}

0 commit comments

Comments
 (0)