Handle kpt fn behavior change (#796)

* updated behavior and tests for ensure-name-substring

* adjusted fix-simple test to not specify include-meta-resources

* kubeval-simple: skip Kptfile validation

* adjusted starlark tests/examples to handle Kptfile and StarlarkRun files

* adjusted search-replace tests to match kpt behavior to include meta resources by default

* adjusted create-setters-simple test to match kpt behavior

* adjusted set-project-id to match the kpt fn behavior

* adjusted generate-kpt-pkg-docs-simple test to match kpt behavior

* adjusted set-annotations tests to match new kpt fn behavior

* adjusted set-labels test to match new kpt fn behavior

* adjusted the golden file for generate-folders function

* using kpt@main

.github/workflows/ci.yaml

@@ -98,7 +98,7 @@ jobs:
         go-version: 1.17
     - name: Install kpt
       run: |
-        go install github.com/GoogleContainerTools/kpt@0faf830e9f0ca2742bf15f3bb4560763eaa5d489
+        go install github.com/GoogleContainerTools/kpt@main
     - name: Build node and Go docker images
       if: matrix.platform == 'ubuntu-latest'
       run: |

contrib/examples/generate-kpt-pkg-docs-simple/.expected/exec.sh

@@ -3,4 +3,4 @@
 set -eo pipefail
 
 kpt fn eval -i gcr.io/kpt-fn-contrib/generate-kpt-pkg-docs:unstable --image-pull-policy never \
---include-meta-resources --mount type=bind,src="$(pwd)",dst=/tmp,rw=true --as-current-user -- readme-path=/tmp/GENERATED.md
+--mount type=bind,src="$(pwd)",dst=/tmp,rw=true --as-current-user -- readme-path=/tmp/GENERATED.md

examples/create-setters-simple/Kptfile

@@ -6,3 +6,6 @@ pipeline:
   mutators:
     - image: gcr.io/kpt-fn/create-setters:unstable
       configPath: setters.yaml
+      selectors:
+        - kind: Deployment
+        - kind: MyKind

examples/ensure-name-substring-advanced/.expected/diff.patch

@@ -1,3 +1,16 @@
+diff --git a/fn-config.yaml b/fn-config.yaml
+index 12939e5..0ee2f64 100644
+--- a/fn-config.yaml
++++ b/fn-config.yaml
+@@ -1,7 +1,7 @@
+ apiVersion: fn.kpt.dev/v1alpha1
+ kind: EnsureNameSubstring
+ metadata:
+-  name: my-config
++  name: prod-my-config
+ additionalNameFields:
+   - kind: MyResource
+     group: dev.example.com
 diff --git a/resources.yaml b/resources.yaml
 index 8e037c3..ffd583b 100644
 --- a/resources.yaml

examples/fix-simple/.expected/config.yaml

@@ -1,3 +1,2 @@
 testType: eval
 image: gcr.io/kpt-fn/fix:unstable
-includeMetaResources: true

examples/generate-folders-resourcehierarchy-v1/.expected/diff.patch

@@ -1,3 +1,13 @@
+diff --git a/Kptfile b/Kptfile
+index bfbf712..6dd3f52 100644
+--- a/Kptfile
++++ b/Kptfile
+@@ -4,4 +4,4 @@ metadata:
+   name: example
+ pipeline:
+   mutators:
+-    - image: gcr.io/kpt-fn/generate-folders:unstable
++    - image: 'gcr.io/kpt-fn/generate-folders:unstable'
 diff --git a/folder_dev.team-2.yaml b/folder_dev.team-2.yaml
 new file mode 100644
 index 0000000..16b9af2

examples/generate-folders-resourcehierarchy-v2/.expected/diff.patch

@@ -1,3 +1,13 @@
+diff --git a/Kptfile b/Kptfile
+index bfbf712..6dd3f52 100644
+--- a/Kptfile
++++ b/Kptfile
+@@ -4,4 +4,4 @@ metadata:
+   name: example
+ pipeline:
+   mutators:
+-    - image: gcr.io/kpt-fn/generate-folders:unstable
++    - image: 'gcr.io/kpt-fn/generate-folders:unstable'
 diff --git a/folder_dev.team-2.yaml b/folder_dev.team-2.yaml
 new file mode 100644
 index 0000000..16b9af2

examples/generate-folders-resourcehierarchy-v3/.expected/diff.patch

@@ -1,3 +1,13 @@
+diff --git a/Kptfile b/Kptfile
+index bfbf712..6dd3f52 100644
+--- a/Kptfile
++++ b/Kptfile
+@@ -4,4 +4,4 @@ metadata:
+   name: example
+ pipeline:
+   mutators:
+-    - image: gcr.io/kpt-fn/generate-folders:unstable
++    - image: 'gcr.io/kpt-fn/generate-folders:unstable'
 diff --git a/folder_dev.team-2.yaml b/folder_dev.team-2.yaml
 new file mode 100644
 index 0000000..badf925

examples/kubeval-simple/Kptfile

@@ -7,4 +7,4 @@ pipeline:
     - image: gcr.io/kpt-fn/kubeval:unstable
       configMap:
         strict: 'true'
-        skip_kinds: MyCustom
+        skip_kinds: MyCustom,Kptfile

examples/set-annotations-advanced/Kptfile

@@ -6,3 +6,6 @@ pipeline:
   mutators:
     - image: gcr.io/kpt-fn/set-annotations:unstable
       configPath: fn-config.yaml
+      selectors:
+        - kind: ConfigMap
+        - kind: MyResource

examples/set-annotations-simple/Kptfile

@@ -8,3 +8,6 @@ pipeline:
       configMap:
         color: orange
         fruit: apple
+      selectors:
+        - kind: ConfigMap
+        - kind: Namespace

examples/set-labels-advanced/Kptfile

@@ -6,3 +6,6 @@ pipeline:
   mutators:
     - image: gcr.io/kpt-fn/set-labels:unstable
       configPath: fn-config.yaml
+      selectors:
+        - kind: ConfigMap
+        - kind: MyResource

examples/set-labels-simple/Kptfile

@@ -8,3 +8,6 @@ pipeline:
       configMap:
         color: orange
         fruit: apple
+      selectors:
+        - kind: ConfigMap
+        - kind: MyResource

examples/set-project-id-advanced/.expected/config.yaml

@@ -1,5 +1,4 @@
 testType: eval
-includeMetaResources: true
 image: gcr.io/kpt-fn/set-project-id:unstable
 args:
   project-id: foo

examples/set-project-id-advanced/README.md

@@ -26,7 +26,7 @@ kpt pkg get https://github.com/GoogleContainerTools/kpt-functions-catalog.git/ex
 Invoke the function with the following command:
 
 ```shell
-kpt fn eval set-project-id-advanced --include-meta-resources --image gcr.io/kpt-fn/set-project-id:unstable -- 'project-id=foo'
+kpt fn eval set-project-id-advanced --image gcr.io/kpt-fn/set-project-id:unstable -- 'project-id=foo'
 ```
 
 ### Expected result

examples/set-project-id-simple/.expected/config.yaml

@@ -1,5 +1,4 @@
 testType: eval
-includeMetaResources: true
 image: gcr.io/kpt-fn/set-project-id:unstable
 args:
   project-id: foo

examples/set-project-id-simple/README.md

@@ -24,7 +24,7 @@ kpt pkg get https://github.com/GoogleContainerTools/kpt-functions-catalog.git/ex
 Invoke the function with the following command:
 
 ```shell
-kpt fn eval set-project-id-simple --include-meta-resources --image gcr.io/kpt-fn/set-project-id:unstable -- 'project-id=foo'
+kpt fn eval set-project-id-simple --image gcr.io/kpt-fn/set-project-id:unstable -- 'project-id=foo'
 ```
 
 ### Expected result

examples/starlark-set-namespace/README.md

@@ -36,11 +36,12 @@ metadata:
   name: set-namespace-to-prod
   annotations:
 source: |
-  # set the namespace on all resources
+  # set the namespace on all resources except StarlarkRun and Kptfile kind.
   def setnamespace(resources, namespace):
     for resource in resources:
       # mutate the resource
-      resource["metadata"]["namespace"] = namespace
+      if resource["kind"] not in ["StarlarkRun", "Kptfile"]:
+        resource["metadata"]["namespace"] = namespace
   setnamespace(ctx.resource_list["items"], "prod")
 ```
 

examples/starlark-set-namespace/fn-config.yaml

@@ -3,7 +3,8 @@ kind: StarlarkRun
 metadata:
   name: set-namespace-to-prod
 source: |
-  # set the namespace on all resources
+  # set the namespace on all resources except Kptfile and StarlarkRun kind.
   for resource in ctx.resource_list["items"]:
     # mutate the resource
-    resource["metadata"]["namespace"] = "prod"
+    if resource.get("kind") not in ["StarlarkRun", "Kptfile"]:
+      resource["metadata"]["namespace"] = "prod"

functions/go/ensure-name-substring/ensure_name_substring.go

@@ -254,6 +254,7 @@ var prefixSuffixFieldSpecsToSkip = types.FsSlice{
 	{Gvk: resid.Gvk{Kind: "CustomResourceDefinition"}},
 	{Gvk: resid.Gvk{Group: "apiregistration.k8s.io", Kind: "APIService"}},
 	{Gvk: resid.Gvk{Kind: "Namespace"}},
+	{Gvk: resid.Gvk{Group: "kpt.dev", Kind: "Kptfile"}},
 }
 
 func shouldSkip(id resid.ResId) bool {

tests/ensure-name-substring/legacy-config/.expected/diff.patch

@@ -1,3 +1,16 @@
+diff --git a/fn-config.yaml b/fn-config.yaml
+index 84f999f..9915f86 100644
+--- a/fn-config.yaml
++++ b/fn-config.yaml
+@@ -1,7 +1,7 @@
+ apiVersion: fn.kpt.dev/v1alpha1
+ kind: EnsureNameSubstring
+ metadata:
+-  name: my-config
++  name: prod-my-config
+ editMode: prepend
+ fieldSpecs:
+   - kind: MyResource
 diff --git a/resources.yaml b/resources.yaml
 index 8e037c3..ffd583b 100644
 --- a/resources.yaml

tests/ensure-name-substring/local-config/.expected/diff.patch

@@ -1,3 +1,16 @@
+diff --git a/fn-config.yaml b/fn-config.yaml
+index d25180f..5842b05 100644
+--- a/fn-config.yaml
++++ b/fn-config.yaml
+@@ -1,7 +1,7 @@
+ apiVersion: fn.kpt.dev/v1alpha1
+ kind: EnsureNameSubstring
+ metadata:
+-  name: my-config
++  name: prod-my-config
+   annotations:
+     config.kubernetes.io/local-config: "true"
+ editMode: prepend
 diff --git a/local-config.yaml b/local-config.yaml
 index b8d83d1..304fc07 100644
 --- a/local-config.yaml

tests/search-replace/file-path-match/.expected/exec.sh

@@ -1,5 +1,5 @@
 #! /bin/bash
 
 # shellcheck disable=SC2016
-kpt fn eval --image gcr.io/kpt-fn/search-replace:unstable --include-meta-resources --image-pull-policy=never -- \
+kpt fn eval --image gcr.io/kpt-fn/search-replace:unstable --image-pull-policy=never -- \
 by-value=project-id by-file-path='**/setters.yaml' put-value=new-project

tests/search-replace/no-results/Kptfile

@@ -7,3 +7,4 @@ pipeline:
     - image: gcr.io/kpt-fn/search-replace:unstable
       configMap:
         by-value: non-existent-value
+        by-file-path: 'resources.yaml'

tests/set-annotations/additional-annotations/Kptfile

@@ -6,3 +6,5 @@ pipeline:
   mutators:
     - image: gcr.io/kpt-fn/set-annotations:unstable
       configPath: fn-config.yaml
+      selectors:
+        - kind: ConfigMap

tests/set-annotations/legacy-config/Kptfile

@@ -6,3 +6,5 @@ pipeline:
   mutators:
     - image: gcr.io/kpt-fn/set-annotations:unstable
       configPath: fn-config.yaml
+      selectors:
+        - kind: ConfigMap

tests/set-annotations/local-config/Kptfile

@@ -6,3 +6,5 @@ pipeline:
   mutators:
     - image: gcr.io/kpt-fn/set-annotations:unstable
       configPath: fn-config.yaml
+      selectors:
+        - kind: ConfigMap

tests/set-labels/additional-labels/Kptfile

@@ -6,3 +6,5 @@ pipeline:
   mutators:
     - image: gcr.io/kpt-fn/set-labels:unstable
       configPath: fn-config.yaml
+      selectors:
+        - kind: ConfigMap

tests/set-labels/legacy-config/Kptfile

@@ -6,3 +6,6 @@ pipeline:
   mutators:
     - image: gcr.io/kpt-fn/set-labels:unstable
       configPath: fn-config.yaml
+      selectors:
+        - kind: ConfigMap
+        - kind: MyResource

tests/set-labels/local-config/Kptfile

@@ -6,3 +6,5 @@ pipeline:
   mutators:
     - image: gcr.io/kpt-fn/set-labels:unstable
       configPath: fn-config.yaml
+      selectors:
+        - kind: ConfigMap

tests/starlark/map-key-inline-comment/fn-config.yaml

@@ -7,5 +7,6 @@ source: |
   def setnamespace(resources, namespace):
     for resource in resources:
       # mutate the resource
-      resource["metadata"]["namespace"] = namespace
+      if resource["kind"] not in ["StarlarkRun", "Kptfile"]:
+        resource["metadata"]["namespace"] = namespace
   setnamespace(ctx.resource_list["items"], "prod")

tests/starlark/non-standard-features/fn-config.yaml

@@ -16,4 +16,5 @@ source: |
   print(fib(3))
 
   for resource in ctx.resource_list["items"]:
-    resource["metadata"]["namespace"] = "test"
+    if resource["kind"] not in ["StarlarkRun", "Kptfile"]:
+      resource["metadata"]["namespace"] = "test"