Add set-labels e2e tests and readme

examples/set-labels-full-coverage/.expected/diff.patch

@@ -0,0 +1,256 @@
+diff --git a/resources.yaml b/resources.yaml
+index 6a06662..62df835 100644
+--- a/resources.yaml
++++ b/resources.yaml
+@@ -2,56 +2,84 @@ apiVersion: v1
+ kind: Service
+ metadata:
+   name: my-service
++  labels:
++    app: new
++    color: orange
++    fruit: apple
+ spec:
+   selector:
+-    app: MyApp
++    app: new
++    color: orange
++    fruit: apple
+ ---
+ apiVersion: v1
+ kind: ReplicationController
+ metadata:
+   name: nginx
++  labels:
++    app: new
++    color: orange
++    fruit: apple
+ spec:
+   replicas: 3
+   selector:
+-    app: nginx
++    app: new
++    color: orange
++    fruit: apple
+   template:
+     metadata:
+       name: nginx
+       labels:
+-        app: nginx
++        app: new
++        color: orange
++        fruit: apple
+ ---
+ apiVersion: apps/v1
+ kind: Deployment
+ metadata:
+   name: nginx-deployment
+   labels:
+-    app: nginx
++    app: new
++    color: orange
++    fruit: apple
+ spec:
+   replicas: 3
+   selector:
+     matchLabels:
+-      app: nginx
++      app: new
++      color: orange
++      fruit: apple
+   template:
+     metadata:
+       labels:
+-        app: nginx
++        app: new
++        color: orange
++        fruit: apple
+ ---
+ apiVersion: apps/v1
+ kind: ReplicaSet
+ metadata:
+   name: frontend
+   labels:
+-    app: guestbook
++    app: new
+     tier: frontend
++    color: orange
++    fruit: apple
+ spec:
+   replicas: 3
+   selector:
+     matchLabels:
+       tier: frontend
++      app: new
++      color: orange
++      fruit: apple
+   template:
+     metadata:
+       labels:
+         tier: frontend
++        app: new
++        color: orange
++        fruit: apple
+ ---
+ apiVersion: apps/v1
+ kind: DaemonSet
+@@ -60,23 +88,38 @@ metadata:
+   namespace: kube-system
+   labels:
+     k8s-app: fluentd-logging
++    app: new
++    color: orange
++    fruit: apple
+ spec:
+   selector:
+     matchLabels:
+       name: fluentd-elasticsearch
++      app: new
++      color: orange
++      fruit: apple
+   template:
+     metadata:
+       labels:
+         name: fluentd-elasticsearch
++        app: new
++        color: orange
++        fruit: apple
+ ---
+ apiVersion: apps/v1
+ kind: StatefulSet
+ metadata:
+   name: web
++  labels:
++    app: new
++    color: orange
++    fruit: apple
+ spec:
+   selector:
+     matchLabels:
+-      app: nginx
++      app: new
++      color: orange
++      fruit: apple
+   serviceName: "nginx"
+   replicas: 3
+   minReadySeconds: 10
+@@ -85,6 +128,9 @@ spec:
+         name: www
+         labels:
+           key: www
++          app: new
++          color: orange
++          fruit: apple
+       spec:
+         accessModes: ["ReadWriteOnce"]
+         storageClassName: "my-storage-class"
+@@ -95,6 +141,9 @@ spec:
+         name: xxx
+         labels:
+           key: xxx
++          app: new
++          color: orange
++          fruit: apple
+         spec:
+           accessModes: ["ReadWrite"]
+           storageClassName: "my-storage-class"
+@@ -104,12 +153,18 @@ spec:
+   template:
+     metadata:
+       labels:
+-        app: nginx
++        app: new
++        color: orange
++        fruit: apple
+ ---
+ apiVersion: batch/v1
+ kind: Job
+ metadata:
+   name: pi
++  labels:
++    app: new
++    color: orange
++    fruit: apple
+ spec:
+   selector:
+     matchLabels:
+@@ -117,12 +172,14 @@ spec:
+   template:
+     metadata:
+       labels:
+-        color: pi
++        color: orange
++        app: new
++        fruit: apple
+     spec:
+       containers:
+         - name: pi
+           image: perl:5.34
+-          command: ["perl",  "-Mbignum=bpi", "-wle", "'print bpi(2000)'"]
++          command: ["perl", "-Mbignum=bpi", "-wle", "'print bpi(2000)'"]
+       restartPolicy: Never
+   backoffLimit: 4
+ ---
+@@ -130,12 +187,19 @@ apiVersion: batch/v1
+ kind: CronJob
+ metadata:
+   name: hello
++  labels:
++    app: new
++    color: orange
++    fruit: apple
+ spec:
+   schedule: "* * * * *"
+   jobTemplate:
+     metadata:
+       labels:
+         env: dev
++        app: new
++        color: orange
++        fruit: apple
+     spec:
+       selector:
+         matchLabels:
+@@ -144,6 +208,9 @@ spec:
+         metadata:
+           labels:
+             testkey: testvalue
++            app: new
++            color: orange
++            fruit: apple
+         spec:
+           containers:
+             - name: hello
+@@ -159,6 +226,10 @@ apiVersion: policy/v1
+ kind: PodDisruptionBudget
+ metadata:
+   name: hello
++  labels:
++    app: new
++    color: orange
++    fruit: apple
+ spec:
+   selector:
+     matchLabels:
+@@ -169,6 +240,10 @@ kind: NetworkPolicy
+ metadata:
+   name: test-network-policy
+   namespace: default
++  labels:
++    app: new
++    color: orange
++    fruit: apple
+ spec:
+   podSelector:
+     matchLabels:
+@@ -179,6 +254,10 @@ kind: MyResource
+ metadata:
+   name: the-service
+   namespace: the-namespace
++  labels:
++    app: new
++    color: orange
++    fruit: apple
+ spec:
+   selector:
+     labels:

examples/set-labels-advanced/Kptfile → examples/set-labels-full-coverage/Kptfile

@@ -2,10 +2,9 @@ apiVersion: kpt.dev/v1
 kind: Kptfile
 metadata:
   name: example
+  annotations:
+    config.kubernetes.io/local-config: "true"
 pipeline:
   mutators:
     - image: gcr.io/kpt-fn/set-labels:unstable
       configPath: fn-config.yaml
-      selectors:
-        - kind: ConfigMap
-        - kind: MyResource

examples/set-labels-advanced/README.md → examples/set-labels-full-coverage/README.md

@@ -1,16 +1,16 @@
-# set-labels: Advanced Example
+# set-labels: Full Coverage Example
 
 ### Overview
 
 This example demonstrates how to declaratively run [`set-labels`] function
-to upsert labels to the `.metadata.labels` field on all resources.
+to upsert all common labels to different built-in resources and CustomResourceDefinition (CRD) resources.
 
 ### Fetch the example package
 
 Get the example package by running the following commands:
 
 ```shell
-$ kpt pkg get https://github.com/GoogleContainerTools/kpt-functions-catalog.git/examples/set-labels-advanced
+$ kpt pkg get https://github.com/GoogleContainerTools/kpt-functions-catalog.git/examples/set-labels-full-coverage
 ```
 
 We use the following `Kptfile` and `fn-config.yaml` to configure the function.
@@ -20,6 +20,8 @@ apiVersion: kpt.dev/v1
 kind: Kptfile
 metadata:
   name: example
+  annotations:
+    config.kubernetes.io/local-config: "true"
 pipeline:
   mutators:
     - image: gcr.io/kpt-fn/set-labels:unstable
@@ -32,33 +34,28 @@ apiVersion: fn.kpt.dev/v1alpha1
 kind: SetLabels
 metadata:
   name: my-config
+  annotations:
+    config.kubernetes.io/local-config: "true"
 labels:
   color: orange
   fruit: apple
-additionalLabelFields:
-  - kind: MyResource
-    group: dev.example.com
-    version: v1
-    create: true
-    path: spec/selector/labels
+  app: new
 ```
 
 The desired labels is provided using `labels` field. We have a CRD with group
-`dev.example.com`, version `v1` and kind `MyResource`. We want the labels to be
-added to field `.spec.selector.labels` as well. We specify it in field
-`additionalLabelFields`.
+`dev.example.com`, version `v1` and kind `MyResource`. 
 
 ### Function invocation
 
 Invoke the function by running the following commands:
 
 ```shell
-$ kpt fn render set-labels-advanced
+$ kpt fn render set-labels-full-coverage
 ```
 
 ### Expected result
 
-Check all resources have 2 labels: `color: orange` and `fruit: apple`. And the
-resource of kind `MyResource` also has these 2 labels in `spec.selector.labels`.
+Check all resources, the following labels should be upserted to the `labels`, `matchingLabels` or `seletors(labelSelector)` fields: 
+`color: orange`, `fruit: apple` and `app: new`.
 
 [`set-labels`]: https://catalog.kpt.dev/set-labels/v0.1/

examples/set-labels-full-coverage/fn-config.yaml

@@ -0,0 +1,10 @@
+apiVersion: fn.kpt.dev/v1alpha1
+kind: SetLabels
+metadata:
+  name: my-config
+  annotations:
+    config.kubernetes.io/local-config: "true"
+labels:
+  color: orange
+  fruit: apple
+  app: new