Chore: refactor filter and action with cuex

Signed-off-by: FogDong <dongtianxin.tx@alibaba-inc.com>

.github/workflows/release-binary.yaml

@@ -10,7 +10,7 @@ permissions:
   contents: write
 
 env:
-  GO_VERSION: '1.17'
+  GO_VERSION: '1.19'
 
 jobs:
   kube-trigger:

.github/workflows/unit-test.yaml

@@ -14,7 +14,7 @@ on:
   workflow_dispatch: { }
 
 env:
-  GO_VERSION: '1.17'
+  GO_VERSION: '1.19'
   GOLANGCI_VERSION: 'v1.47.2'
 
 jobs:

.github/workflows/upload-test-binary.yaml

@@ -15,7 +15,7 @@ on:
 
 env:
   GOLANGCI_VERSION: 'v1.47.2'
-  GO_VERSION: '1.17'
+  GO_VERSION: '1.19'
 
 jobs:
   detect-noop:

.gitignore

@@ -63,3 +63,5 @@ default.etcd
 # Generated Dockerfile
 # This is automatically generated by Make depending on which image you want to build.
 Dockerfile
+
+vendor/

Dockerfile.in

@@ -20,7 +20,7 @@
 # You need to enable Docker BuildKit for this to work.
 # Also refer to Makefile for how it can be done.
 
-ARG BUILD_IMAGE=golang:1.17
+ARG BUILD_IMAGE=golang:1.19
 ARG BASE_IMAGE=gcr.io/distroless/static:nonroot
 
 # Force native build platform, and cross-build to target platform later.

README.md

@@ -17,7 +17,7 @@ extensions.
 
 ### Sources
 
-A Source is what listens to events (event source). For example, a `k8s-resource-watcher` source can watch Kubernetes
+A Source is what listens to events (event source). For example, a `resource-watcher` source can watch Kubernetes
 resources. Once a Kubernetes resource (e.g. ConfigMap) is changed, it will raise an event that will be passed
 to [Filters](#Filters) for further processing.
 
@@ -40,7 +40,7 @@ updated whenever the ConfigMaps that are referenced by `ref-objects` are updated
 
 To accomplish this, we will:
 
-- use a `k8s-resource-watcher` Source to listen to update events of ConfigMaps
+- use a `resource-watcher` Source to listen to update events of ConfigMaps
 - use a `cue-validator` Filter to only keep the ConfigMaps that we are interested in
 - trigger an `bump-application-revision` Action to update Application.
 
@@ -85,7 +85,7 @@ An example config file looks like this:
 # You can add multiple triggers.
 triggers:
   - source:
-      type: k8s-resource-watcher
+      type: resource-watcher
       properties:
         # We are interested in ConfigMap events.
         apiVersion: "v1"
@@ -94,23 +94,17 @@ triggers:
         # Only watch update event.
         events:
           - update
-    filters:
-      - type: cue-validator
-        # Filter the events above.
-        properties:
-            # Filter by validating the object data using CUE.
-            # For example, we are filtering by ConfigMap names (metadata.name) from above.
-            # Only ConfigMaps with names that satisfy this regexp "this-will-trigger-update-.*" will be kept.
-            template: |
-              metadata: name: =~"this-will-trigger-update-.*"
-    actions:
+    # Filter the events above.
+    filter: |
+      context: data: metadata: name: =~"this-will-trigger-update-.*"
+    action:
       # Bump Application Revision to update Application.
-      - type: bump-application-revision
-        properties:
-          namespace: default
-          # Select Applications to bump using labels.
-          labelSelectors:
-            my-label: my-value
+      type: bump-application-revision
+      properties:
+        namespace: default
+        # Select Applications to bump using labels.
+        matchingLabels:
+          my-label: my-value
 ```
 
 Let's assume your config file is `config.yaml`, to run kube-trigger:
@@ -141,26 +135,21 @@ spec:
     instance: kubetrigger-sample
   triggers:
     - source:
-        type: k8s-resource-watcher
+        type: resource-watcher
         properties:
           apiVersion: "v1"
           kind: ConfigMap
           namespace: default
           events:
             - update
-      filters:
-        - type: cue-validator
-          properties:
-            template: |
-              // Filter by object name.
-              // I used regular expressions here.
-              metadata: name: =~"this-will-trigger-update-.*"
-      actions:
-        - type: bump-application-revision
-          properties:
-            namespace: default
-            labelSelectors:
-              my-label: my-value
+      filter: |
+        context: data: metadata: name: =~"this-will-trigger-update-.*"
+      action:
+        type: bump-application-revision
+        properties:
+          namespace: default
+          matchingLabels:
+            my-label: my-value
 ```
 
 ## Advanced kube-trigger Instance Configuration

api/v1alpha1/triggerservice_types.go

@@ -52,9 +52,9 @@ type TriggerServiceList struct {
 
 // TriggerMeta is the meta data of a trigger.
 type TriggerMeta struct {
-	Source  Source       `json:"source"`
-	Filters []FilterMeta `json:"filters"`
-	Actions []ActionMeta `json:"actions"`
+	Source Source     `json:"source"`
+	Filter string     `json:"filter"`
+	Action ActionMeta `json:"action"`
 }
 
 // ActionMeta is what users type in their configurations, specifying what action
@@ -66,21 +66,6 @@ type ActionMeta struct {
 	// Properties are user-provided parameters. You should parse it yourself.
 	// +kubebuilder:pruning:PreserveUnknownFields
 	Properties *runtime.RawExtension `json:"properties,omitempty"`
-
-	// Raw is the raw string representation of this action. Typically, you will
-	// not use it. This is for identifying action instances.
-	Raw string `json:"raw,omitempty"`
-}
-
-// FilterMeta is what users type in their configurations, specifying what filter
-// they want to use and what properties they provided.
-type FilterMeta struct {
-	// Type is the type (identifier) of this filter.
-	Type string `json:"type"`
-
-	// Properties are user-provided parameters. You should parse it yourself.
-	// +kubebuilder:pruning:PreserveUnknownFields
-	Properties *runtime.RawExtension `json:"properties,omitempty"`
 }
 
 // Source defines the Source of trigger.
@@ -92,18 +77,11 @@ type Source struct {
 
 const (
 	// SourceTypeResourceWatcher is the source type for K8sResourceWatcher.
-	SourceTypeResourceWatcher string = "k8s-resource-watcher"
+	SourceTypeResourceWatcher string = "resource-watcher"
 	// SourceTypeWebhookTrigger is the source type for WebhookTrigger.
 	SourceTypeWebhookTrigger string = "webhook-trigger"
 )
 
-const (
-	// ActionTypeBumpApplicationRevision is the source type for BumpApplicationRevision.
-	ActionTypeBumpApplicationRevision string = "bump-application-revision"
-	// ActionTypePatchResource is the source type for WebhookTrigger.
-	ActionTypePatchResource string = "patch-resource"
-)
-
 func init() {
 	SchemeBuilder.Register(&TriggerService{}, &TriggerServiceList{})
 }

config/crd/standard.oam.dev_triggerservices.yaml

@@ -42,47 +42,24 @@ spec:
                 items:
                   description: TriggerMeta is the meta data of a trigger.
                   properties:
-                    actions:
-                      items:
-                        description: ActionMeta is what users type in their configurations,
-                          specifying what action they want to use and what properties
-                          they provided.
-                        properties:
-                          properties:
-                            description: Properties are user-provided parameters.
-                              You should parse it yourself.
-                            type: object
-                            x-kubernetes-preserve-unknown-fields: true
-                          raw:
-                            description: Raw is the raw string representation of this
-                              action. Typically, you will not use it. This is for
-                              identifying action instances.
-                            type: string
-                          type:
-                            description: Type is the type (identifier) of this action.
-                            type: string
-                        required:
-                        - type
-                        type: object
-                      type: array
-                    filters:
-                      items:
-                        description: FilterMeta is what users type in their configurations,
-                          specifying what filter they want to use and what properties
-                          they provided.
+                    action:
+                      description: ActionMeta is what users type in their configurations,
+                        specifying what action they want to use and what properties
+                        they provided.
+                      properties:
                         properties:
-                          properties:
-                            description: Properties are user-provided parameters.
-                              You should parse it yourself.
-                            type: object
-                            x-kubernetes-preserve-unknown-fields: true
-                          type:
-                            description: Type is the type (identifier) of this filter.
-                            type: string
-                        required:
-                        - type
-                        type: object
-                      type: array
+                          description: Properties are user-provided parameters. You
+                            should parse it yourself.
+                          type: object
+                          x-kubernetes-preserve-unknown-fields: true
+                        type:
+                          description: Type is the type (identifier) of this action.
+                          type: string
+                      required:
+                      - type
+                      type: object
+                    filter:
+                      type: string
                     source:
                       description: Source defines the Source of trigger.
                       properties:
@@ -96,8 +73,8 @@ spec:
                       - type
                       type: object
                   required:
-                  - actions
-                  - filters
+                  - action
+                  - filter
                   - source
                   type: object
                 type: array

config/samples/standard_v1alpha1_triggerservice.yaml

@@ -12,7 +12,7 @@ spec:
   # You can add multiple triggers.
   triggers:
     - source:
-        type: k8s-resource-watcher
+        type: resource-watcher
         properties:
           # We are interested in ConfigMap events.
           apiVersion: "v1"
@@ -21,20 +21,13 @@ spec:
           # Only watch update event.
           events:
             - update
-      filters:
-        - type: cue-validator
-          # Filter the events above.
-          properties:
-              # Filter by validating the object data using CUE.
-              # For example, we are filtering by ConfigMap names (metadata.name) from above.
-              # Only ConfigMaps with names that satisfy this regexp "this-will-trigger-update-.*" will be kept.
-              template: |
-                metadata: name: =~"this-will-trigger-update-.*"
-      actions:
+      filter: |
+        context: data: metadata: name: =~"this-will-trigger-update-.*"
+      action:
         # Bump Application Revision to update Application.
-        - type: bump-application-revision
-          properties:
-            namespace: default
-            # Select Applications to bump using labels.
-            labelSelectors:
-              my-label: my-value
+        type: bump-application-revision
+        properties:
+          namespace: default
+          # Select Applications to bump using labels.
+          matchingLabels:
+            my-label: my-value

examples/README.md

@@ -10,7 +10,7 @@ updated whenever the ConfigMaps that are referenced by `ref-objects` are updated
 
 ## What we want to achieve?
 
-- use a `k8s-resource-watcher` Source to listen to update events of ConfigMaps
+- use a `resource-watcher` Source to listen to update events of ConfigMaps
 - use a `cue-validator` Filter to only keep the ConfigMaps that we are interested in
 - trigger an `bump-application-revision` Action to update Application.