Add Support for Embedding TriggerBindingSpec in EL

TriggerBindingSpec can be added to EventListener Trigger
tektoncd · Apr 30, 2020 · e0a4232 · e0a4232
1 parent 4060450
commit e0a4232
Show file tree

Hide file tree

Showing 25 changed files with 255 additions and 64 deletions.
diff --git a/docs/clustertriggerbindings.md b/docs/clustertriggerbindings.md
@@ -48,8 +48,10 @@ spec:
       bindings:
         - name: pipeline-clusterbinding
           kind: ClusterTriggerBinding
+          ref: pipeline-clusterbinding
         - name: message-clusterbinding
           kind: ClusterTriggerBinding
+          ref: message-clusterbinding
       template:
         name: pipeline-template
 ```

diff --git a/docs/eventlisteners.md b/docs/eventlisteners.md
@@ -149,7 +149,7 @@ The `triggers` field is required. Each EventListener can consist of one or more
 - `name` - (Optional) a valid
   [Kubernetes name](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)
 - [`interceptors`](#interceptors) - (Optional) list of interceptors to use
-- `bindings` - A list of names of `TriggerBindings` to use
+- `bindings` - A list of names of `TriggerBindings` to use or embedded TriggerBindingsSpecs to use.
 - `template` - The name of `TriggerTemplate` to use
 
 ```yaml
@@ -160,7 +160,12 @@ triggers:
           eventTypes: ["pull_request"]
     bindings:
       - name: pipeline-binding
+        ref:  pipeline-binding
       - name: message-binding
+        spec:
+            params:
+              - name: message
+                value: Hello from the Triggers EventListener!
     template:
       name: pipeline-template
 ```
@@ -180,7 +185,9 @@ triggers:
           eventTypes: ["pull_request"]
     bindings:
       - name: pipeline-binding
+        ref:  pipeline-binding
       - name: message-binding
+        ref:  message-binding
     template:
       name: pipeline-template
 ``` 
@@ -316,6 +323,7 @@ spec:
               namespace: default
       bindings:
         - name: pipeline-binding
+          ref: pipeline-binding
       template:
         name: pipeline-template
 ```
@@ -361,6 +369,7 @@ spec:
               - pull_request
       bindings:
         - name: pipeline-binding
+          ref: pipeline-binding
       template:
         name: pipeline-template
 ```
@@ -405,6 +414,7 @@ spec:
               - Push Hook
       bindings:
         - name: pipeline-binding
+          ref:  pipeline-binding
       template:
         name: pipeline-template
 ```
@@ -450,6 +460,7 @@ spec:
             filter: "header.canonical('X-GitHub-Event') == 'push'"
       bindings:
       - name: pipeline-binding
+        ref: pipeline-binding
       template:
         name: pipeline-template
 ```
@@ -488,6 +499,7 @@ spec:
             filter: "header.canonical('X-GitHub-Event') == 'push'"
       bindings:
       - name: pipeline-binding
+        ref: pipeline-binding
       template:
         name: pipeline-template
 ```
@@ -515,6 +527,7 @@ spec:
               expression: "truncate(body.pull_request.head.sha, 7)"
       bindings:
       - name: pipeline-binding
+        ref: pipeline-binding
       template:
         name: pipeline-template
 ```
@@ -544,6 +557,7 @@ spec:
               expression: "split(body.ref, '/')[2]"
       bindings:
       - name: pipeline-binding
+        ref: pipeline-binding
       template:
         name: pipeline-template
 ```

diff --git a/examples/eventlisteners/cel-eventlistener-interceptor-with-secret.yaml b/examples/eventlisteners/cel-eventlistener-interceptor-with-secret.yaml
@@ -19,5 +19,6 @@ spec:
             filter: "'test-secret'.compareSecret('token', 'mysecret')"
       bindings:
       - name: pipeline-binding
+        ref: pipeline-binding
       template:
         name: pipeline-template
diff --git a/examples/eventlisteners/cel-eventlistener-interceptor.yaml b/examples/eventlisteners/cel-eventlistener-interceptor.yaml
@@ -22,5 +22,6 @@ spec:
             filter: "header.canonical('X-GitHub-Event') == 'push'"
       bindings:
       - name: pipeline-binding
+        ref: pipeline-binding
       template:
         name: pipeline-template
diff --git a/examples/eventlisteners/cel-eventlistener-multiple-overlays.yaml b/examples/eventlisteners/cel-eventlistener-multiple-overlays.yaml
@@ -15,5 +15,6 @@ spec:
               expression: "split(body.ref, '/')[2]"
       bindings:
       - name: pipeline-binding
+        ref: pipeline-binding
       template:
         name: pipeline-template
diff --git a/examples/eventlisteners/cel-eventlistener-no-filter.yaml b/examples/eventlisteners/cel-eventlistener-no-filter.yaml
@@ -13,5 +13,6 @@ spec:
               expression: "truncate(body.pull_request.head.sha, 7)"
       bindings:
       - name: pipeline-binding
+        ref: pipeline-binding
       template:
         name: pipeline-template
diff --git a/examples/eventlisteners/eventlistener-clustertriggerbinding.yaml b/examples/eventlisteners/eventlistener-clustertriggerbinding.yaml
@@ -10,7 +10,9 @@ spec:
       bindings:
         - name: pipeline-clusterbinding
           kind: ClusterTriggerBinding
+          ref: pipeline-clusterbinding
         - name: message-clusterbinding
           kind: ClusterTriggerBinding
+          ref: message-clusterbinding
       template:
         name: pipeline-template
diff --git a/examples/eventlisteners/eventlistener-embedded-bindings.yaml b/examples/eventlisteners/eventlistener-embedded-bindings.yaml
@@ -0,0 +1,19 @@
+---
+apiVersion: triggers.tekton.dev/v1alpha1
+kind: EventListener
+metadata:
+  name: listener-embed-binding
+spec:
+  serviceAccountName: tekton-triggers-example-sa
+  triggers:
+    - name: foo-trig
+      bindings:
+        - name: pipeline-binding
+          ref: pipeline-binding
+        - name: message-binding
+          spec:
+            params:
+              - name: message
+                value: Hello from the Triggers EventListener(listener-embed-binding)!
+      template:
+        name: pipeline-template
diff --git a/examples/eventlisteners/eventlistener-interceptor.yaml b/examples/eventlisteners/eventlistener-interceptor.yaml
@@ -23,5 +23,6 @@ spec:
               namespace: default
       bindings:
         - name: pipeline-binding
+          ref: pipeline-binding
       template:
         name: pipeline-template
diff --git a/examples/eventlisteners/eventlistener-multiinterceptor.yaml b/examples/eventlisteners/eventlistener-multiinterceptor.yaml
@@ -29,5 +29,6 @@ spec:
               namespace: default
       bindings:
         - name: pipeline-binding
+          ref: pipeline-binding
       template:
         name: pipeline-template
diff --git a/examples/eventlisteners/eventlistener.yaml b/examples/eventlisteners/eventlistener.yaml
@@ -9,6 +9,8 @@ spec:
     - name: foo-trig
       bindings:
         - name: pipeline-binding
+          ref: pipeline-binding
         - name: message-binding
+          ref: message-binding
       template:
         name: pipeline-template
diff --git a/examples/eventlisteners/github-eventlistener-interceptor.yaml b/examples/eventlisteners/github-eventlistener-interceptor.yaml
@@ -16,5 +16,6 @@ spec:
               - pull_request
       bindings:
         - name: pipeline-binding
+          ref: pipeline-binding
       template:
         name: pipeline-template
diff --git a/pkg/apis/triggers/v1alpha1/event_listener_defaults.go b/pkg/apis/triggers/v1alpha1/event_listener_defaults.go
@@ -26,6 +26,8 @@ func (el *EventListener) SetDefaults(ctx context.Context) {
 		// set defaults
 		for i := range el.Spec.Triggers {
 			defaultBindings(&el.Spec.Triggers[i])
+			// TODO: Remove this in future release #564.
+			defaultMandatoryRef((&el.Spec.Triggers[i]))
 		}
 	}
 }
@@ -40,3 +42,14 @@ func defaultBindings(t *EventListenerTrigger) {
 		}
 	}
 }
+
+// set default TriggerBinding kind for Bindings
+func defaultMandatoryRef(t *EventListenerTrigger) {
+	if len(t.Bindings) > 0 {
+		for _, b := range t.Bindings {
+			if b.Ref == "" && b.Spec == nil {
+				b.Ref = b.Name
+			}
+		}
+	}
+}
diff --git a/pkg/apis/triggers/v1alpha1/event_listener_defaults_test.go b/pkg/apis/triggers/v1alpha1/event_listener_defaults_test.go
@@ -38,14 +38,17 @@ func TestEventListenerSetDefaults(t *testing.T) {
 					Bindings: []*v1alpha1.EventListenerBinding{
 						{
 							Name: "binding",
+							Ref:  "binding",
 						},
 						{
 							Name: "namespace-binding",
 							Kind: v1alpha1.NamespacedTriggerBindingKind,
+							Ref:  "namespace-binding",
 						},
 						{
 							Name: "cluster-binding",
 							Kind: v1alpha1.ClusterTriggerBindingKind,
+							Ref:  "cluster-binding",
 						},
 					},
 				}},
@@ -59,14 +62,17 @@ func TestEventListenerSetDefaults(t *testing.T) {
 						{
 							Name: "binding",
 							Kind: v1alpha1.NamespacedTriggerBindingKind,
+							Ref:  "binding",
 						},
 						{
 							Name: "namespace-binding",
 							Kind: v1alpha1.NamespacedTriggerBindingKind,
+							Ref:  "namespace-binding",
 						},
 						{
 							Name: "cluster-binding",
 							Kind: v1alpha1.ClusterTriggerBindingKind,
+							Ref:  "cluster-binding",
 						},
 					},
 				}},

diff --git a/pkg/apis/triggers/v1alpha1/event_listener_types.go b/pkg/apis/triggers/v1alpha1/event_listener_types.go
@@ -134,9 +134,12 @@ type SecretRef struct {
 
 // EventListenerBinding refers to a particular TriggerBinding or ClusterTriggerBindingresource.
 type EventListenerBinding struct {
-	Name       string             `json:"name"`
-	Kind       TriggerBindingKind `json:"kind"`
-	APIVersion string             `json:"apiversion,omitempty"`
+	Name string             `json:"name"`
+	Kind TriggerBindingKind `json:"kind"`
+	// +optional
+	Ref        string              `json:"ref,omitempty"`
+	Spec       *TriggerBindingSpec `json:"spec,omitempty"`
+	APIVersion string              `json:"apiversion,omitempty"`
 }
 
 // EventListenerTemplate refers to a particular TriggerTemplate resource.

diff --git a/pkg/apis/triggers/v1alpha1/event_listener_validation.go b/pkg/apis/triggers/v1alpha1/event_listener_validation.go
@@ -50,7 +50,17 @@ func (t *EventListenerTrigger) validate(ctx context.Context) *apis.FieldError {
 			return apis.ErrMissingField(fmt.Sprintf("bindings[%d].name", i))
 		}
 
-		if b.Kind != NamespacedTriggerBindingKind && b.Kind != ClusterTriggerBindingKind {
+		// Either Ref or Spec should be present
+		if b.Ref == "" && b.Spec == nil {
+			return apis.ErrMissingOneOf(fmt.Sprintf("bindings[%d].Ref", i), fmt.Sprintf("bindings[%d].Spec", i))
+		}
+
+		// Both Ref and Spec can't be present at the same time
+		if b.Ref != "" && b.Spec != nil {
+			return apis.ErrMultipleOneOf(fmt.Sprintf("bindings[%d].Ref", i), fmt.Sprintf("bindings[%d].Spec", i))
+		}
+
+		if b.Ref != "" && b.Kind != NamespacedTriggerBindingKind && b.Kind != ClusterTriggerBindingKind {
 			return apis.ErrInvalidValue(fmt.Errorf("invalid kind"), fmt.Sprintf("bindings[%d].kind", i))
 		}
 	}