Skip to content

Commit 11b0538

Browse files
crandlescrandles
committed
feat: add lint error output
1 parent ce13d95 commit 11b0538

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+14422
-7
lines changed

‎go.mod

+5
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ toolchain go1.22.1
66

77
require (
88
github.com/evanphx/json-patch v5.6.0+incompatible
9+
github.com/goccy/go-yaml v1.12.0
910
github.com/spf13/cobra v1.8.1
1011
github.com/stretchr/testify v1.9.0
1112
golang.org/x/exp v0.0.0-20230905200255-921286631fa9
@@ -29,6 +30,7 @@ require (
2930
github.com/coreos/go-systemd/v22 v22.5.0 // indirect
3031
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
3132
github.com/emicklei/go-restful/v3 v3.11.0 // indirect
33+
github.com/fatih/color v1.10.0 // indirect
3234
github.com/felixge/httpsnoop v1.0.4 // indirect
3335
github.com/fsnotify/fsnotify v1.7.0 // indirect
3436
github.com/fxamacker/cbor/v2 v2.7.0 // indirect
@@ -52,6 +54,8 @@ require (
5254
github.com/josharian/intern v1.0.0 // indirect
5355
github.com/json-iterator/go v1.1.12 // indirect
5456
github.com/mailru/easyjson v0.7.7 // indirect
57+
github.com/mattn/go-colorable v0.1.8 // indirect
58+
github.com/mattn/go-isatty v0.0.12 // indirect
5559
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
5660
github.com/modern-go/reflect2 v1.0.2 // indirect
5761
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
@@ -86,6 +90,7 @@ require (
8690
golang.org/x/term v0.21.0 // indirect
8791
golang.org/x/text v0.16.0 // indirect
8892
golang.org/x/time v0.3.0 // indirect
93+
golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
8994
google.golang.org/genproto/googleapis/api v0.0.0-20240528184218-531527333157 // indirect
9095
google.golang.org/genproto/googleapis/rpc v0.0.0-20240701130421-f6361c86f094 // indirect
9196
google.golang.org/grpc v1.65.0 // indirect

‎go.sum

+20
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ github.com/emicklei/go-restful/v3 v3.11.0 h1:rAQeMHw1c7zTmncogyy8VvRZwtkmkZ4FxER
2828
github.com/emicklei/go-restful/v3 v3.11.0/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
2929
github.com/evanphx/json-patch v5.6.0+incompatible h1:jBYDEEiFBPxA0v50tFdvOzQQTCvpL6mnFh5mB2/l16U=
3030
github.com/evanphx/json-patch v5.6.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk=
31+
github.com/fatih/color v1.10.0 h1:s36xzo75JdqLaaWoiEHk767eHiwo0598uUxyfiPkDsg=
32+
github.com/fatih/color v1.10.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM=
3133
github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg=
3234
github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
3335
github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA=
@@ -49,8 +51,16 @@ github.com/go-openapi/jsonreference v0.20.2/go.mod h1:Bl1zwGIM8/wsvqjsOQLJ/SH+En
4951
github.com/go-openapi/swag v0.22.3/go.mod h1:UzaqsxGiab7freDnrUUra0MwWfN/q7tE4j+VcZ0yl14=
5052
github.com/go-openapi/swag v0.22.4 h1:QLMzNJnMGPRNDCbySlcj1x01tzU8/9LTTL9hZZZogBU=
5153
github.com/go-openapi/swag v0.22.4/go.mod h1:UzaqsxGiab7freDnrUUra0MwWfN/q7tE4j+VcZ0yl14=
54+
github.com/go-playground/locales v0.13.0 h1:HyWk6mgj5qFqCT5fjGBuRArbVDfE4hi8+e8ceBS/t7Q=
55+
github.com/go-playground/locales v0.13.0/go.mod h1:taPMhCMXrRLJO55olJkUXHZBHCxTMfnGwq/HNwmWNS8=
56+
github.com/go-playground/universal-translator v0.17.0 h1:icxd5fm+REJzpZx7ZfpaD876Lmtgy7VtROAbHHXk8no=
57+
github.com/go-playground/universal-translator v0.17.0/go.mod h1:UkSxE5sNxxRwHyU+Scu5vgOQjsIJAF8j9muTVoKLVtA=
58+
github.com/go-playground/validator/v10 v10.4.1 h1:pH2c5ADXtd66mxoE0Zm9SUhxE20r7aM3F26W0hOn+GE=
59+
github.com/go-playground/validator/v10 v10.4.1/go.mod h1:nlOn6nFhuKACm19sB/8EGNn9GlaMV7XkbRSipzJ0Ii4=
5260
github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI=
5361
github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8=
62+
github.com/goccy/go-yaml v1.12.0 h1:/1WHjnMsI1dlIBQutrvSMGZRQufVO3asrHfTwfACoPM=
63+
github.com/goccy/go-yaml v1.12.0/go.mod h1:wKnAMd44+9JAAnGQpWVEgBzGt3YuTaQ4uXoHvE4m7WU=
5464
github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
5565
github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
5666
github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
@@ -105,8 +115,14 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
105115
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
106116
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
107117
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
118+
github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y=
119+
github.com/leodido/go-urn v1.2.0/go.mod h1:+8+nEpDfqqsY+g338gtMEUOtuK+4dEMhiQEgxpxOKII=
108120
github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0=
109121
github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
122+
github.com/mattn/go-colorable v0.1.8 h1:c1ghPdyEDarC70ftn0y+A/Ee++9zz8ljHG1b13eJ0s8=
123+
github.com/mattn/go-colorable v0.1.8/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
124+
github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
125+
github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
110126
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
111127
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg=
112128
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
@@ -225,6 +241,8 @@ golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
225241
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
226242
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
227243
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
244+
golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
245+
golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
228246
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
229247
golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
230248
golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
@@ -246,6 +264,8 @@ golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8T
246264
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
247265
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
248266
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
267+
golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 h1:H2TDz8ibqkAF6YGhCdN3jS9O0/s90v0rJh3X/OLHEUk=
268+
golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2/go.mod h1:K8+ghG5WaK9qNqU5K3HdILfMLy1f3aNYFI/wnl100a8=
249269
google.golang.org/genproto v0.0.0-20230822172742-b8732ec3820d h1:VBu5YqKPv6XiJ199exd8Br+Aetz+o08F+PLMnwJQHAY=
250270
google.golang.org/genproto v0.0.0-20230822172742-b8732ec3820d/go.mod h1:yZTlhN0tQnXo3h00fuXNCxJdLdIdnVFVBaRJ5LWBbw4=
251271
google.golang.org/genproto/googleapis/api v0.0.0-20240528184218-531527333157 h1:7whR9kGa5LUwFtpLm2ArCEejtnxlGeLbAyjFY8sGNFw=

‎pkg/cmd/lint.go

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
package cmd
2+
3+
import (
4+
"cmp"
5+
"fmt"
6+
"os"
7+
"slices"
8+
"strings"
9+
10+
"github.com/goccy/go-yaml"
11+
"github.com/goccy/go-yaml/parser"
12+
"golang.org/x/exp/maps"
13+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
14+
)
15+
16+
// convert the given map of filenames to validation errors into a lint output format: '%f:%l:%c: %m'
17+
// %f - file, %l - line, %c - column, %m - message
18+
func lintMarshal(details map[string][]metav1.Status) ([]byte, error) {
19+
const (
20+
nilValue = "<nil>"
21+
)
22+
files := maps.Keys(details)
23+
slices.Sort(files)
24+
25+
results := []string{}
26+
DETAILS:
27+
for _, file := range files {
28+
status := details[file]
29+
causes := make(map[string][]metav1.StatusCause)
30+
for _, s := range status {
31+
if s.Status == metav1.StatusSuccess {
32+
continue DETAILS // only lint errors
33+
}
34+
for _, c := range s.Details.Causes {
35+
if c.Field == nilValue {
36+
continue // no field to lookup/annotate
37+
}
38+
key := string(c.Type)
39+
causes[key] = append(causes[key], c)
40+
}
41+
}
42+
if len(causes) == 0 {
43+
continue // nothing to do, no causes deemed problematic
44+
}
45+
b, err := os.ReadFile(file)
46+
if err != nil {
47+
return nil, err
48+
}
49+
// group causes by position, so that we can group them together in the same output line
50+
errors := make(map[Position][]metav1.StatusCause)
51+
for _, items := range causes {
52+
for _, c := range items {
53+
path, err := yaml.PathString(fmt.Sprintf("$.%s", c.Field))
54+
if err != nil {
55+
return nil, err
56+
}
57+
position, err := getPosition(path, b)
58+
if err != nil {
59+
return nil, err
60+
}
61+
errors[position] = append(errors[position], c)
62+
}
63+
}
64+
keys := maps.Keys(errors)
65+
slices.SortFunc(keys, func(i, j Position) int {
66+
return cmp.Or(
67+
cmp.Compare(i.Line, j.Line),
68+
cmp.Compare(i.Column, j.Column),
69+
)
70+
})
71+
for _, position := range keys {
72+
causes := errors[position]
73+
messages := make(map[string][]string)
74+
for _, c := range causes {
75+
messages[c.Field] = append(messages[c.Field], fmt.Sprintf("(reason: %q; %s)", c.Type, c.Message))
76+
}
77+
fieldMessages := []string{}
78+
for field, msgs := range messages {
79+
fieldMessages = append(fieldMessages, fmt.Sprintf("field %q: %s", field, strings.Join(msgs, ", ")))
80+
}
81+
le := LintError{
82+
File: file,
83+
Line: position.Line,
84+
Column: position.Column,
85+
Message: strings.Join(fieldMessages, ", "),
86+
}
87+
results = append(results, le.String())
88+
}
89+
}
90+
return []byte(strings.Join(results, "\n")), nil
91+
}
92+
93+
type Position struct {
94+
Line int
95+
Column int
96+
}
97+
98+
type Reason struct {
99+
Type string
100+
Message string
101+
}
102+
103+
type LintError struct {
104+
File string
105+
Line int
106+
Column int
107+
Message string
108+
}
109+
110+
func (e LintError) String() string {
111+
return fmt.Sprintf("%s:%d:%d: %s", e.File, e.Line, e.Column, e.Message)
112+
}
113+
114+
func getPosition(p *yaml.Path, source []byte) (Position, error) {
115+
file, err := parser.ParseBytes([]byte(source), 0)
116+
if err != nil {
117+
return Position{}, err
118+
}
119+
node, err := p.FilterFile(file)
120+
if err != nil {
121+
return Position{}, err
122+
}
123+
return Position{
124+
Line: node.GetToken().Position.Line,
125+
Column: node.GetToken().Position.Column,
126+
}, nil
127+
}

‎pkg/cmd/lint_test.go

+135
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
package cmd
2+
3+
import (
4+
"strings"
5+
"testing"
6+
7+
"github.com/stretchr/testify/require"
8+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
9+
)
10+
11+
func TestLintMarshal(t *testing.T) {
12+
cases := []struct {
13+
name string
14+
input map[string][]metav1.Status
15+
expected string
16+
}{
17+
{
18+
name: "empty",
19+
input: map[string][]metav1.Status{},
20+
expected: ``,
21+
},
22+
{
23+
name: "success",
24+
input: map[string][]metav1.Status{
25+
"file.yaml": {
26+
{Status: metav1.StatusSuccess, Reason: "valid"},
27+
},
28+
},
29+
expected: ``,
30+
},
31+
{
32+
name: "single error, single cause",
33+
input: map[string][]metav1.Status{
34+
"../../testcases/manifests/configmap.yaml": {
35+
{Status: metav1.StatusFailure, Reason: "invalid", Details: &metav1.StatusDetails{
36+
Causes: []metav1.StatusCause{
37+
{
38+
Type: "FailureType",
39+
Field: "metadata.name",
40+
Message: "name is required or invalid somehow",
41+
},
42+
},
43+
}},
44+
},
45+
},
46+
expected: `../../testcases/manifests/configmap.yaml:8:9: field "metadata.name": (reason: "FailureType"; name is required or invalid somehow)`,
47+
},
48+
{
49+
name: "single error with ignored success",
50+
input: map[string][]metav1.Status{
51+
"../../testcases/manifests/configmap.yaml": {
52+
{Status: metav1.StatusSuccess, Reason: "valid"},
53+
},
54+
"../../testcases/manifests/apiservice.yaml": {
55+
{Status: metav1.StatusFailure, Reason: "invalid", Details: &metav1.StatusDetails{
56+
Causes: []metav1.StatusCause{
57+
{
58+
Type: "FailureType",
59+
Field: "metadata.name",
60+
Message: "name is required or invalid somehow but specific to apiservices",
61+
},
62+
},
63+
}},
64+
},
65+
},
66+
expected: `../../testcases/manifests/apiservice.yaml:14:9: field "metadata.name": (reason: "FailureType"; name is required or invalid somehow but specific to apiservices)`,
67+
},
68+
{
69+
name: "multiple errors, multiple causes",
70+
input: map[string][]metav1.Status{
71+
"../../testcases/manifests/configmap.yaml": {
72+
{Status: metav1.StatusFailure, Reason: "invalid", Details: &metav1.StatusDetails{
73+
Causes: []metav1.StatusCause{
74+
{
75+
Type: "FailureType",
76+
Field: "metadata.name",
77+
Message: "name is required or invalid somehow 1x1",
78+
},
79+
{
80+
Type: "FailureType",
81+
Field: "metadata.finalizers",
82+
Message: "something wrong with finalizers 1x2",
83+
},
84+
},
85+
}},
86+
},
87+
"../../testcases/manifests/apiservice.yaml": {
88+
{Status: metav1.StatusFailure, Reason: "invalid", Details: &metav1.StatusDetails{
89+
Causes: []metav1.StatusCause{
90+
{
91+
Type: "FailureType",
92+
Field: "metadata.name",
93+
Message: "name is required or invalid somehow 2x1",
94+
},
95+
{
96+
Type: "FailureType",
97+
Field: "metadata.name",
98+
Message: "name is required or invalid somehow 2x2",
99+
},
100+
},
101+
}},
102+
},
103+
},
104+
expected: strings.Join([]string{
105+
`../../testcases/manifests/apiservice.yaml:14:9: field "metadata.name": (reason: "FailureType"; name is required or invalid somehow 2x1), (reason: "FailureType"; name is required or invalid somehow 2x2)`,
106+
`../../testcases/manifests/configmap.yaml:8:9: field "metadata.name": (reason: "FailureType"; name is required or invalid somehow 1x1)`,
107+
`../../testcases/manifests/configmap.yaml:10:3: field "metadata.finalizers": (reason: "FailureType"; something wrong with finalizers 1x2)`,
108+
}, "\n"),
109+
},
110+
{
111+
name: "single error, single cause",
112+
input: map[string][]metav1.Status{
113+
"../../testcases/manifests/error_x_list_map_duplicate_key.yaml": {
114+
{Status: metav1.StatusFailure, Reason: "invalid", Details: &metav1.StatusDetails{
115+
Causes: []metav1.StatusCause{
116+
{
117+
Type: "FieldValueDuplicate",
118+
Field: "spec.containers[0].ports[2]",
119+
Message: `Duplicate value: map[string]interface{}{"key":"value"}`,
120+
},
121+
},
122+
}},
123+
},
124+
},
125+
expected: `../../testcases/manifests/error_x_list_map_duplicate_key.yaml:51:19: field "spec.containers[0].ports[2]": (reason: "FieldValueDuplicate"; Duplicate value: map[string]interface{}{"key":"value"})`,
126+
},
127+
}
128+
for _, tc := range cases {
129+
t.Run(tc.name, func(t *testing.T) {
130+
actual, err := lintMarshal(tc.input)
131+
require.NoError(t, err)
132+
require.Equal(t, tc.expected, string(actual))
133+
})
134+
}
135+
}

0 commit comments

Comments
 (0)