fix: [TKC-2209] add webhooks events

api/v1/testkube.yaml

@@ -7096,13 +7096,6 @@ components:
           example:
             - true
             - false
-        onStateChange:
-          type: boolean
-          description: whether webhook is triggered on state change only
-          default: false
-          example:
-            - true
-            - false
 
     Event:
       description: Event data
@@ -7165,16 +7158,30 @@ components:
         - end-test-failed
         - end-test-aborted
         - end-test-timeout
+        - become-test-up
+        - become-test-down
+        - become-test-failed
+        - become-test-aborted
+        - become-test-timeout
         - start-testsuite
         - end-testsuite-success
         - end-testsuite-failed
         - end-testsuite-aborted
         - end-testsuite-timeout
+        - become-testsuite-up
+        - become-testsuite-down
+        - become-testsuite-failed
+        - become-testsuite-aborted
+        - become-testsuite-timeout
         - queue-testworkflow
         - start-testworkflow
         - end-testworkflow-success
         - end-testworkflow-failed
         - end-testworkflow-aborted
+        - become-testworkflow-up
+        - become-testworkflow-down
+        - become-testworkflow-failed
+        - become-testworkflow-aborted        
         - created
         - updated
         - deleted

cmd/kubectl-testkube/commands/webhooks/common.go

@@ -42,11 +42,6 @@ func NewCreateWebhookOptionsFromFlags(cmd *cobra.Command) (options apiv1.CreateW
 		return options, err
 	}
 
-	onStateChange, err := cmd.Flags().GetBool("on-state-change")
-	if err != nil {
-		return options, err
-	}
-
 	disabled, err := cmd.Flags().GetBool("disable")
 	if err != nil {
 		return options, err
@@ -64,7 +59,6 @@ func NewCreateWebhookOptionsFromFlags(cmd *cobra.Command) (options apiv1.CreateW
 		PayloadTemplate:          payloadTemplateContent,
 		Headers:                  headers,
 		PayloadTemplateReference: payloadTemplateReference,
-		OnStateChange:            onStateChange,
 		Disabled:                 disabled,
 	}
 
@@ -157,13 +151,5 @@ func NewUpdateWebhookOptionsFromFlags(cmd *cobra.Command) (options apiv1.UpdateW
 		options.Disabled = &disabled
 	}
 
-	if cmd.Flag("on-state-change").Changed {
-		onStateChange, err := cmd.Flags().GetBool("on-state-change")
-		if err != nil {
-			return options, err
-		}
-		options.OnStateChange = &onStateChange
-	}
-
 	return options, nil
 }

cmd/kubectl-testkube/commands/webhooks/create.go

@@ -24,7 +24,6 @@ func NewCreateWebhookCmd() *cobra.Command {
 		payloadTemplateReference string
 		update                   bool
 		disable                  bool
-		onStateChange            bool
 	)
 
 	cmd := &cobra.Command{
@@ -103,7 +102,6 @@ func NewCreateWebhookCmd() *cobra.Command {
 	cmd.Flags().BoolVar(&update, "update", false, "update, if webhook already exists")
 	cmd.Flags().BoolVar(&disable, "disable", false, "disable webhook")
 	cmd.Flags().MarkDeprecated("enable", "enable webhook is deprecated")
-	cmd.Flags().BoolVar(&onStateChange, "on-state-change", false, "specify whether webhook should be triggered only on a state change")
 
 	return cmd
 }

cmd/kubectl-testkube/commands/webhooks/update.go

@@ -18,7 +18,6 @@ func UpdateWebhookCmd() *cobra.Command {
 		headers                  map[string]string
 		payloadTemplateReference string
 		disable                  bool
-		onStateChange            bool
 	)
 
 	cmd := &cobra.Command{
@@ -60,7 +59,6 @@ func UpdateWebhookCmd() *cobra.Command {
 	cmd.Flags().StringVar(&payloadTemplateReference, "payload-template-reference", "", "reference to payload template to use for the webhook")
 	cmd.Flags().BoolVar(&disable, "disable", false, "disable webhook")
 	cmd.Flags().MarkDeprecated("enable", "enable webhook is depecated")
-	cmd.Flags().BoolVar(&onStateChange, "on-state-change", false, "specify whether webhook should be triggered only on a state change")
 
 	return cmd
 }

docs/docs/articles/webhooks.mdx

@@ -80,7 +80,7 @@ spec:
   selector: ""
 ```
 
-Where <YOUR_ENDPOINT_URL> should be replaced with the HTTPS endpoint URL where you want to receive the webhook events.
+Where `<YOUR_ENDPOINT_URL>` should be replaced with the HTTPS endpoint URL where you want to receive the webhook events.
 
 And then apply with:
 
@@ -170,7 +170,7 @@ And set it with `--payload-template template.json`.
 testkube create webhook --name example-webhook --events start-test --events end-test-passed --events end-test-failed --payload-template template.json --uri <YOUR_ENDPOINT_URL>
 ```
 
-Where <YOUR_ENDPOINT_URL> should be replaced with the HTTPS endpoint URL where you want to receive the webhook events.
+Where `<YOUR_ENDPOINT_URL>` should be replaced with the HTTPS endpoint URL where you want to receive the webhook events.
 
 ```sh title="Expected output:"
 Webhook created example-webhook 🥇
@@ -310,16 +310,30 @@ Webhooks can be triggered on any of the following events:
 - end-test-failed
 - end-test-aborted
 - end-test-timeout
+- become-test-up
+- become-test-down
+- become-test-failed
+- become-test-aborted
+- become-test-timeout
 - start-testsuite
 - end-testsuite-success
 - end-testsuite-failed
 - end-testsuite-aborted
 - end-testsuite-timeout
-- start-testworkflow
+- become-testsuite-up
+- become-testsuite-down
+- become-testsuite-failed
+- become-testsuite-aborted
+- become-testsuite-timeout
+- queue-testworkflow
 - start-testworkflow
 - end-testworkflow-success
 - end-testworkflow-failed
 - end-testworkflow-aborted
+- become-testworkflow-up
+- become-testworkflow-down
+- become-testworkflow-failed
+- become-testworkflow-aborted 
 - created
 - updated
 - deleted
@@ -353,6 +367,10 @@ The full Event Data Model can be found [here](https://github.com/kubeshop/testku
 
 ### TestExecution (Execution):
 
+:::warning
+Test and Test Suite webhooks are being deprecated from Testkube.
+:::
+
 - `Id` - Execution ID (for example, `64f8cf3c712890925aea51ce`)
 - `TestName` - Test Name (for example, `postman-executor-smoke`)
 - `TestSuiteName` - Test Suite name (if run as a part of a Test Suite)
@@ -377,6 +395,10 @@ The full Execution data model can be found [here](https://github.com/kubeshop/te
 
 ### TestSuiteExecution:
 
+:::warning
+Test and Test Suite webhooks are being deprecated from Testkube.
+:::
+
 - `Id` - TestSuiteExecution ID (for example, `64f8d5b2712890925aea51dc`)
 - `Name` - TestSuite execution name (for example, `ts-executor-postman-smoke-tests-472`)
 - `Status` - TestSuite execution status (for example, `running` or `passed`)
@@ -646,14 +668,34 @@ The examples show only the `create` operations, however, these instructions work
 
 ## Enable Webhooks on State Changes
 
-It is possible to get notified by webhooks only when the latest execution's outcome differs from the previous one. This way you can see instantly when one of your scheduled tests was healed or when they got broken. It could also help prevent alert fatigue by deduplicating the alerts and therefore decreasing the load on your monitoring systems. Enable this by setting `onStateChange` to true directly on the webhook.
+It is possible to get notified by webhooks only when the latest execution's outcome differs from the previous one. This way you can see instantly when one of your scheduled tests was healed or when they got broken. It could also help prevent alert fatigue by deduplicating the alerts and therefore decreasing the load on your monitoring systems.
+Testkube suppots special webhook event types to track changes between current and previous execution states.
+For Tests:
+- become-test-up (from any error state to succeed one)
+- become-test-down (from succeed state to any error one)
+- become-test-failed (from any state to failed one)
+- become-test-aborted (from any state to aborted one)
+- become-test-timeout (from any state to timeout one)
+
+For Test Suites:
+- become-testsuite-up (from any error state to succeed one)
+- become-testsuite-down (from succeed state to any error one)
+- become-testsuite-failed (from any state to failed one)
+- become-testsuite-aborted (from any state to aborted one)
+- become-testsuite-timeout (from any state to timeout one)
+
+For Test Workflowss:
+- become-testworkflow-up (from any error state to succeed one)
+- become-testworkflow-down (from succeed state to any error one)
+- become-testworkflow-failed (from any state to failed one)
+- become-testworkflow-aborted (from any state to aborted one)
 
 <Tabs>
 
 <TabItem value="cli" label="CLI">
 
 ```bash
-testkube update webhook --name example-webhook --on-state-change
+testkube update webhook --name example-webhook
 ```
 
 </TabItem>
@@ -671,7 +713,6 @@ testkube update webhook --name example-webhook --on-state-change
         "end-test-failed"
     ],
     "disabled": false,
-    "onStateChange": true,
 }
 ```
 
@@ -690,7 +731,6 @@ spec:
   - start-test
   - end-test-success
   - end-test-failed
-  onStateChange: true
   uri: https://webhook.url/
 ```
 

docs/docs/cli/testkube_create_webhook.md

@@ -19,7 +19,6 @@ testkube create webhook [flags]
   -h, --help                                help for webhook
   -l, --label stringToString                label key value pair: --label key1=value1 (default [])
   -n, --name string                         unique webhook name - mandatory
-      --on-state-change                     specify whether webhook should be triggered only on a state change
       --payload-field string                field to use for notification object payload
       --payload-template string             if webhook needs to send a custom notification, then a path to template file should be provided
       --payload-template-reference string   reference to payload template to use for the webhook

docs/docs/cli/testkube_update_webhook.md

@@ -19,7 +19,6 @@ testkube update webhook [flags]
   -h, --help                                help for webhook
   -l, --label stringToString                label key value pair: --label key1=value1 (default [])
   -n, --name string                         unique webhook name - mandatory
-      --on-state-change                     specify whether webhook should be triggered only on a state change
       --payload-field string                field to use for notification object payload
       --payload-template string             if webhook needs to send a custom notification, then a path to template file should be provided
       --payload-template-reference string   reference to payload template to use for the webhook

pkg/api/v1/testkube/model_event_extended.go

@@ -215,7 +215,7 @@ func (e Event) Log() []any {
 	}
 }
 
-func (e Event) Valid(selector string, types []EventType) (valid bool) {
+func (e Event) Valid(selector string, types []EventType) (matchedTypes []EventType, valid bool) {
 	var executionLabels map[string]string
 
 	// load labels from event test execution or test-suite execution or test workflow execution
@@ -231,21 +231,29 @@ func (e Event) Valid(selector string, types []EventType) (valid bool) {
 
 	typesMatch := false
 	for _, t := range types {
-		if t == e.Type() {
-			typesMatch = true
-			break
+		ts := []EventType{t}
+		if t.IsBecome() {
+			ts = t.MapBecomeToRegular()
+		}
+
+		for _, et := range ts {
+			if et == e.Type() {
+				typesMatch = true
+				matchedTypes = append(matchedTypes, t)
+				break
+			}
 		}
 	}
 
 	if !typesMatch {
-		return false
+		return nil, false
 	}
 
 	valid = selector == ""
 	if !valid {
 		selector, err := labels.Parse(selector)
 		if err != nil {
-			return false
+			return nil, false
 		}
 
 		valid = selector.Matches(labels.Set(executionLabels))