fix(cli): argo lint with strict should report case-sensitive errors. …

…Fixes #13006 (#13250) - `go.mod` merge conflict fixed by agilgur5 Signed-off-by: Miltiadis Alexis <[email protected]> Co-authored-by: Alan Clucas <[email protected]> (cherry picked from commit c834ef5)
argoproj · Jul 30, 2024 · fbc56d4 · fbc56d4
1 parent e64ee22
commit fbc56d4
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 3 deletions.
diff --git a/cmd/argo/commands/lint_test.go b/cmd/argo/commands/lint_test.go
@@ -169,4 +169,45 @@ spec:
 
 		assert.False(t, fatal, "should not have exited")
 	})
+
+	workflowCaseSensitivePath := filepath.Join(subdir, "workflowCaseSensitive.yaml")
+	err = os.WriteFile(workflowCaseSensitivePath, []byte(`
+apiVersion: argoproj.io/v1alpha1
+kind: Workflow
+metadata:
+  generateName: hello-world-
+spec:
+  entrypoInt: whalesay
+  templates:
+    - name: whalesay
+      container:
+        image: docker/whalesay
+        command: [ cowsay ]
+        args: [ "hello world" ]
+        resources:
+          limits:
+            memory: 32Mi
+            cpu: 100m
+`), 0644)
+	require.NoError(t, err)
+
+	t.Run("linting a workflow with case sensitive fields and strict enabled", func(t *testing.T) {
+		defer func() { logrus.StandardLogger().ExitFunc = nil }()
+		var fatal bool
+		logrus.StandardLogger().ExitFunc = func(int) { fatal = true }
+
+		runLint(context.Background(), []string{workflowCaseSensitivePath}, true, nil, "pretty", true)
+
+		assert.True(t, fatal, "should have exited")
+	})
+
+	t.Run("linting a workflow with case sensitive fields and strict disabled", func(t *testing.T) {
+		defer func() { logrus.StandardLogger().ExitFunc = nil }()
+		var fatal bool
+		logrus.StandardLogger().ExitFunc = func(int) { fatal = true }
+
+		runLint(context.Background(), []string{workflowCaseSensitivePath}, true, nil, "pretty", false)
+
+		assert.False(t, fatal, "should not have exited")
+	})
 }
diff --git a/go.mod b/go.mod
@@ -287,7 +287,7 @@ require (
 	k8s.io/component-helpers v0.24.3 // indirect
 	k8s.io/metrics v0.24.3 // indirect
 	moul.io/http2curl/v2 v2.3.0 // indirect
-	sigs.k8s.io/json v0.0.0-20220713155537-f223a00ba0e2 // indirect
+	sigs.k8s.io/json v0.0.0-20220713155537-f223a00ba0e2
 	sigs.k8s.io/kustomize/api v0.11.4 // indirect
 	sigs.k8s.io/kustomize/kustomize/v4 v4.5.4 // indirect
 	sigs.k8s.io/kustomize/kyaml v0.13.6 // indirect

diff --git a/test/e2e/cli_test.go b/test/e2e/cli_test.go
@@ -1134,7 +1134,7 @@ func (s *CLISuite) TestTemplate() {
 		s.Given().RunCli([]string{"template", "lint", "testdata/workflow-templates"}, func(t *testing.T, output string, err error) {
 			assert.Error(t, err)
 			assert.Contains(t, output, "invalid-workflowtemplate.yaml")
-			assert.Contains(t, output, `unknown field "entrypoints"`)
+			assert.Contains(t, output, `unknown field "spec.entrypoints"`)
 			assert.Contains(t, output, "linting errors found!")
 		})
 	})

diff --git a/workflow/common/parse.go b/workflow/common/parse.go
@@ -8,6 +8,8 @@ import (
 	log "github.com/sirupsen/logrus"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime"
+	kjson "sigs.k8s.io/json"
 	"sigs.k8s.io/yaml"
 
 	wf "github.com/argoproj/argo-workflows/v3/pkg/apis/workflow"
@@ -96,7 +98,19 @@ func toWorkflowTypeYAML(body []byte, kind string, strict bool) (metav1.Object, e
 func toWorkflowTypeJSON(body []byte, kind string, strict bool) (metav1.Object, error) {
 	v := objectForKind(kind)
 	if strict {
-		return v, jsonpkg.UnmarshalStrict(body, v)
+		var strictErrs []error
+		strictJSONErrs, err := kjson.UnmarshalStrict(body, v)
+		if err != nil {
+			// fatal decoding error, not due to strictness
+			return v, err
+		}
+		strictErrs = append(strictErrs, strictJSONErrs...)
+
+		if len(strictErrs) > 0 {
+			// return the successfully decoded object along with the strict errors
+			return v, runtime.NewStrictDecodingError(strictErrs)
+		}
+		return v, err
 	}
 
 	return v, jsonpkg.Unmarshal(body, v)