exclude kustomization files from KRM check (#2409)

droot · web-flow · commit ed64123ce2ab · 2021-07-22T19:50:12.000-07:00
diff --git a/e2e/testdata/fn-eval/krm-check-exclude-kustomize/.expected/config.yaml b/e2e/testdata/fn-eval/krm-check-exclude-kustomize/.expected/config.yaml
@@ -0,0 +1,18 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+testType: eval
+image: gcr.io/kpt-fn/set-labels:v0.1
+args:
+  tier: backend
diff --git a/e2e/testdata/fn-eval/krm-check-exclude-kustomize/.expected/diff.patch b/e2e/testdata/fn-eval/krm-check-exclude-kustomize/.expected/diff.patch
@@ -0,0 +1,43 @@
+diff --git a/kustomization.yaml b/kustomization.yaml
+index f91c46a..94769e0 100644
+--- a/kustomization.yaml
++++ b/kustomization.yaml
+@@ -11,7 +11,9 @@
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ # limitations under the License.
+-
+ # kustomization.yaml contents
+ resources:
+ - resources.yaml
++metadata:
++  labels:
++    tier: backend
+diff --git a/resources.yaml b/resources.yaml
+index f6f4685..b11c929 100644
+--- a/resources.yaml
++++ b/resources.yaml
+@@ -15,12 +15,23 @@ apiVersion: apps/v1
+ kind: Deployment
+ metadata:
+   name: nginx-deployment
++  labels:
++    tier: backend
+ spec:
+   replicas: 3
++  selector:
++    matchLabels:
++      tier: backend
++  template:
++    metadata:
++      labels:
++        tier: backend
+ ---
+ apiVersion: custom.io/v1
+ kind: Custom
+ metadata:
+   name: custom
++  labels:
++    tier: backend
+ spec:
+   image: nginx:1.2.3 # kpt-set: {something}
diff --git a/e2e/testdata/fn-eval/krm-check-exclude-kustomize/.krmignore b/e2e/testdata/fn-eval/krm-check-exclude-kustomize/.krmignore
@@ -0,0 +1 @@
+.expected
diff --git a/e2e/testdata/fn-eval/krm-check-exclude-kustomize/Kptfile b/e2e/testdata/fn-eval/krm-check-exclude-kustomize/Kptfile
@@ -0,0 +1,9 @@
+apiVersion: kpt.dev/v1
+kind: Kptfile
+metadata:
+  name: app
+pipeline:
+  mutators:
+    - image: set-labels:v0.1
+      configMap:
+        tier: backend
diff --git a/e2e/testdata/fn-eval/krm-check-exclude-kustomize/kustomization.yaml b/e2e/testdata/fn-eval/krm-check-exclude-kustomize/kustomization.yaml
@@ -0,0 +1,17 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# kustomization.yaml contents
+resources:
+- resources.yaml
diff --git a/e2e/testdata/fn-eval/krm-check-exclude-kustomize/resources.yaml b/e2e/testdata/fn-eval/krm-check-exclude-kustomize/resources.yaml
@@ -0,0 +1,26 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+spec:
+  replicas: 3
+---
+apiVersion: custom.io/v1
+kind: Custom
+metadata:
+  name: custom
+spec:
+  image: nginx:1.2.3 # kpt-set: {something}
diff --git a/e2e/testdata/fn-render/krm-check-exclude-kustomize/.expected/diff.patch b/e2e/testdata/fn-render/krm-check-exclude-kustomize/.expected/diff.patch
@@ -0,0 +1,43 @@
+diff --git a/kustomization.yaml b/kustomization.yaml
+index f91c46a..94769e0 100644
+--- a/kustomization.yaml
++++ b/kustomization.yaml
+@@ -11,7 +11,9 @@
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ # See the License for the specific language governing permissions and
+ # limitations under the License.
+-
+ # kustomization.yaml contents
+ resources:
+ - resources.yaml
++metadata:
++  labels:
++    tier: backend
+diff --git a/resources.yaml b/resources.yaml
+index f6f4685..b11c929 100644
+--- a/resources.yaml
++++ b/resources.yaml
+@@ -15,12 +15,23 @@ apiVersion: apps/v1
+ kind: Deployment
+ metadata:
+   name: nginx-deployment
++  labels:
++    tier: backend
+ spec:
+   replicas: 3
++  selector:
++    matchLabels:
++      tier: backend
++  template:
++    metadata:
++      labels:
++        tier: backend
+ ---
+ apiVersion: custom.io/v1
+ kind: Custom
+ metadata:
+   name: custom
++  labels:
++    tier: backend
+ spec:
+   image: nginx:1.2.3 # kpt-set: {something}
diff --git a/e2e/testdata/fn-render/krm-check-exclude-kustomize/Kptfile b/e2e/testdata/fn-render/krm-check-exclude-kustomize/Kptfile
@@ -0,0 +1,9 @@
+apiVersion: kpt.dev/v1
+kind: Kptfile
+metadata:
+  name: app
+pipeline:
+  mutators:
+    - image: set-labels:v0.1
+      configMap:
+        tier: backend
diff --git a/e2e/testdata/fn-render/krm-check-exclude-kustomize/kustomization.yaml b/e2e/testdata/fn-render/krm-check-exclude-kustomize/kustomization.yaml
@@ -0,0 +1,17 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# kustomization.yaml contents
+resources:
+- resources.yaml
diff --git a/e2e/testdata/fn-render/krm-check-exclude-kustomize/resources.yaml b/e2e/testdata/fn-render/krm-check-exclude-kustomize/resources.yaml
@@ -0,0 +1,26 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-deployment
+spec:
+  replicas: 3
+---
+apiVersion: custom.io/v1
+kind: Custom
+metadata:
+  name: custom
+spec:
+  image: nginx:1.2.3 # kpt-set: {something}
diff --git a/go.mod b/go.mod
@@ -23,6 +23,6 @@ require (
 	k8s.io/kubectl v0.21.1
 	k8s.io/utils v0.0.0-20210707171843-4b05e18ac7d9
 	sigs.k8s.io/cli-utils v0.25.1-0.20210702190410-c1a7c2d0409d
-	sigs.k8s.io/kustomize/api v0.8.10 // indirect
+	sigs.k8s.io/kustomize/api v0.8.10
 	sigs.k8s.io/kustomize/kyaml v0.11.1-0.20210715213702-35d1c3f9b418
 )
diff --git a/internal/util/merge/merge3_test.go b/internal/util/merge/merge3_test.go
@@ -473,6 +473,68 @@ metadata: # kpt-merge: default/nginx-deployment
 spec:
   replicas: 5
 `},
+		`Publisher adds metadata.annotations in upstream in a non-identity kustomization resource, consumer adds changes to resource body
+on local, fetch upstream changes`: {
+			origin: `
+apiVersion: kustomize.config.k8s.io/v1beta1
+metadata:
+  labels:
+    color: blue
+commonLabels:
+  app: dev`,
+			update: `
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+metadata:
+  labels:
+    color: blue
+  annotations:
+    id.example.org: abcd
+commonLabels:
+  app: dev`,
+			local: `
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+metadata:
+  labels:
+    color: blue
+commonLabels:
+  app: dev
+  tier: backend
+`,
+			expected: `
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+metadata:
+  labels:
+    color: blue
+  annotations:
+    id.example.org: abcd
+commonLabels:
+  app: dev
+  tier: backend
+`},
+		`Publisher adds commonLabels in upstream in a non-identity kustomization resource, consumer adds changes to resource body
+on local, fetch upstream changes`: {
+			origin: `
+commonLabels:
+  app: dev`,
+			update: `
+commonLabels:
+  tier: backend
+  app: dev`,
+			local: `
+commonLabels:
+  app: dev
+  tier: backend
+  db: mysql
+`,
+			expected: `
+commonLabels:
+  app: dev
+  tier: backend
+  db: mysql
+`},
 
 		`Version changes are just like any other changes`: {
 			origin: `
diff --git a/pkg/api/kptfile/v1/validation.go b/pkg/api/kptfile/v1/validation.go
@@ -22,11 +22,18 @@ import (
 	"strings"
 
 	"github.com/GoogleContainerTools/kpt/internal/types"
+	"sigs.k8s.io/kustomize/api/konfig"
+	kustomizetypes "sigs.k8s.io/kustomize/api/types"
 	"sigs.k8s.io/kustomize/kyaml/kio"
 	"sigs.k8s.io/kustomize/kyaml/kio/kioutil"
 	"sigs.k8s.io/kustomize/kyaml/yaml"
 )
 
+const (
+	// constants related to kustomize
+	kustomizationAPIGroup = "kustomize.config.k8s.io"
+)
+
 func (kf *KptFile) Validate(pkgPath types.UniquePath) error {
 	if err := kf.Pipeline.validate(pkgPath); err != nil {
 		return fmt.Errorf("invalid pipeline: %w", err)
@@ -169,7 +176,26 @@ func GetValidatedFnConfigFromPath(pkgPath types.UniquePath, configPath string) (
 	return nodes[0], nil
 }
 
+// AreKRM validates if given resources are valid KRM resources.
+func AreKRM(nodes []*yaml.RNode) error {
+	for i := range nodes {
+		if err := IsKRM(nodes[i]); err != nil {
+			path, _, _ := kioutil.GetFileAnnotations(nodes[i])
+			return fmt.Errorf("%s: %s", path, err.Error())
+		}
+	}
+	return nil
+}
+
+// IsKRM validates if given resource is a valid KRM resource by ensuring
+// that resource has a valid apiVersion, kind and metadata.name field.
+// It excludes kustomization resource from KRM check.
 func IsKRM(n *yaml.RNode) error {
+	if isKustomization(n) {
+		// exclude kustomization files from KRM check
+		// https://github.com/GoogleContainerTools/kpt/issues/2388
+		return nil
+	}
 	meta, err := n.GetMeta()
 	if err != nil {
 		return fmt.Errorf("resource must have `apiVersion`, `kind`, and `name`")
@@ -186,14 +212,35 @@ func IsKRM(n *yaml.RNode) error {
 	return nil
 }
 
-func AreKRM(nodes []*yaml.RNode) error {
-	for i := range nodes {
-		if err := IsKRM(nodes[i]); err != nil {
-			path, _, _ := kioutil.GetFileAnnotations(nodes[i])
-			return fmt.Errorf("%s: %s", path, err.Error())
+// isKustomization determines if given YAML is a kustomization file
+// or a kustomization resource.
+func isKustomization(n *yaml.RNode) bool {
+	resourcePath, _, err := kioutil.GetFileAnnotations(n)
+	if err == nil {
+		// perform the check only if we are able to reliably
+		// read the file path of the resource
+		resourceFile := filepath.Base(resourcePath)
+
+		for _, kustomizationFileName := range konfig.RecognizedKustomizationFileNames() {
+			if resourceFile == kustomizationFileName {
+				return true
+			}
 		}
 	}
-	return nil
+	meta, err := n.GetMeta()
+	if err != nil {
+		return false
+	}
+
+	if strings.HasPrefix(meta.APIVersion, kustomizationAPIGroup) {
+		return true
+	}
+
+	if meta.APIVersion == "" && meta.Kind == kustomizetypes.KustomizationKind {
+		return true
+	}
+
+	return false
 }
 
 // ValidateError is the error returned when validation fails.
diff --git a/pkg/api/kptfile/v1/validation_test.go b/pkg/api/kptfile/v1/validation_test.go
