feat: Added unit tests for webhook-service and improved error messages (

#6064) * Added unit tests for webhook-config and added checks for required parameters Signed-off-by: odubajDT <[email protected]> * Added unit tests for template_engine Signed-off-by: odubajDT <[email protected]> * Improved error message of webhook-service Signed-off-by: odubajDT <[email protected]>
keptn · Dec 1, 2021 · 5b4516e · 5b4516e
1 parent adebbbb
commit 5b4516e
Show file tree

Hide file tree

Showing 4 changed files with 126 additions and 6 deletions.
diff --git a/webhook-service/handler/handler.go b/webhook-service/handler/handler.go
@@ -3,12 +3,13 @@ package handler
 import (
 	"errors"
 	"fmt"
+	"strings"
+
 	"github.com/keptn/go-utils/pkg/api/models"
 	keptnv2 "github.com/keptn/go-utils/pkg/lib/v0_2_0"
 	"github.com/keptn/keptn/go-sdk/pkg/sdk"
 	"github.com/keptn/keptn/webhook-service/lib"
 	logger "github.com/sirupsen/logrus"
-	"strings"
 )
 
 const webhookConfigFileName = "webhook/webhook.yaml"
@@ -174,9 +175,9 @@ func (th *TaskHandler) onStartedWebhookExecution(keptnHandler sdk.IKeptn, event
 		}
 	} else {
 		// if sendFinished is set to false, we need to send a .started event for each webhook request to be executed
-		for range webhook.Requests {
+		for _, req := range webhook.Requests {
 			if err := keptnHandler.SendStartedEvent(event); err != nil {
-				return sdkError(fmt.Sprintf("could not send .started event: %s", err.Error()), err)
+				return sdkError(fmt.Sprintf("could not send .started event: request '%s': %s", req, err.Error()), err)
 			}
 		}
 	}

diff --git a/webhook-service/lib/template_engine_test.go b/webhook-service/lib/template_engine_test.go
@@ -1,8 +1,10 @@
 package lib_test
 
 import (
-	"github.com/keptn/keptn/webhook-service/lib"
+	"strings"
 	"testing"
+
+	"github.com/keptn/keptn/webhook-service/lib"
 )
 
 func TestTemplateEngine_ParseTemplate(t1 *testing.T) {
@@ -15,6 +17,7 @@ func TestTemplateEngine_ParseTemplate(t1 *testing.T) {
 		args    args
 		want    string
 		wantErr bool
+		errMsg  string
 	}{
 		{
 			name: "parse template",
@@ -28,6 +31,7 @@ func TestTemplateEngine_ParseTemplate(t1 *testing.T) {
 			},
 			want:    "foo bar",
 			wantErr: false,
+			errMsg:  "",
 		},
 		{
 			name: "wrong template syntax",
@@ -41,6 +45,35 @@ func TestTemplateEngine_ParseTemplate(t1 *testing.T) {
 			},
 			want:    "",
 			wantErr: true,
+			errMsg:  "unexpected",
+		},
+		{
+			name: "non-existing key",
+			args: args{
+				data: map[string]interface{}{
+					"env": map[string]interface{}{
+						"bar": "foo",
+					},
+				},
+				templateStr: "foo {{.env.foo}}",
+			},
+			want:    "",
+			wantErr: true,
+			errMsg:  ".env.foo",
+		},
+		{
+			name: "empty value",
+			args: args{
+				data: map[string]interface{}{
+					"env": map[string]interface{}{
+						"bar": "",
+					},
+				},
+				templateStr: "foo {{.env.barz}}",
+			},
+			want:    "",
+			wantErr: true,
+			errMsg:  ".env.barz",
 		},
 	}
 	for _, tt := range tests {
@@ -54,6 +87,9 @@ func TestTemplateEngine_ParseTemplate(t1 *testing.T) {
 			if got != tt.want {
 				t1.Errorf("ParseTemplate() got = %v, want %v", got, tt.want)
 			}
+			if err != nil && !strings.Contains(err.Error(), tt.errMsg) {
+				t1.Errorf("ParseTemplate() errMsg = %v, want %v", err.Error(), tt.errMsg)
+			}
 		})
 	}
 }
diff --git a/webhook-service/lib/webhook_config.go b/webhook-service/lib/webhook_config.go
@@ -1,6 +1,10 @@
 package lib
 
-import "gopkg.in/yaml.v3"
+import (
+	"errors"
+
+	"gopkg.in/yaml.v3"
+)
 
 type WebHookConfig struct {
 	ApiVersion string            `yaml:"apiVersion"`
@@ -44,5 +48,24 @@ func DecodeWebHookConfigYAML(webhookConfigYaml []byte) (*WebHookConfig, error) {
 	if err := yaml.Unmarshal(webhookConfigYaml, webHookConfig); err != nil {
 		return nil, err
 	}
+
+	if len(webHookConfig.Spec.Webhooks) == 0 {
+		return nil, errors.New("Webhook configuration invalid: missing 'webhooks[]' part")
+	}
+
+	for _, webhook := range webHookConfig.Spec.Webhooks {
+		if webhook.Type == "" {
+			return nil, errors.New("Webhook configuration invalid: missing 'webhooks[].Type' part")
+		}
+
+		if webhook.SubscriptionID == "" {
+			return nil, errors.New("Webhook configuration invalid: missing 'webhooks[].SubscriptionID' part")
+		}
+
+		if len(webhook.Requests) == 0 {
+			return nil, errors.New("Webhook configuration invalid: missing 'webhooks[].Requests[]' part")
+		}
+	}
+
 	return webHookConfig, nil
 }
diff --git a/webhook-service/lib/webhook_config_test.go b/webhook-service/lib/webhook_config_test.go
@@ -1,8 +1,9 @@
 package lib
 
 import (
-	"github.com/stretchr/testify/require"
 	"testing"
+
+	"github.com/stretchr/testify/require"
 )
 
 func TestDecodeWebHookConfigYAML(t *testing.T) {
@@ -65,6 +66,65 @@ spec:
 			want:    nil,
 			wantErr: true,
 		},
+		{
+			name: "bad padding invalid input",
+			args: args{
+				webhookConfigYaml: []byte(`apiVersion: webhookconfig.keptn.sh/v1alpha1
+						kind: WebhookConfig
+						metadata:
+						name: webhook-configuration
+						spec:
+						webhooks:
+							- type: "sh.keptn.event.webhook.triggered"
+							subscriptionID: "my-subscription-id"
+							envFrom:
+								- secretRef:
+								name: mysecret
+							requests:
+								- "curl http://localhost:8080 {{.data.project}} {{.env.mysecret}}"`),
+			},
+			want:    nil,
+			wantErr: true,
+		},
+		{
+			name: "misspeling keyworkds invalid input",
+			args: args{
+				webhookConfigYaml: []byte(`apiVersion: webhookconfig.keptn.sh/v1alpha1
+kind: WebhookConfig
+metadata:
+  name: webhook-configuration
+spec:
+  webhooks:
+    - type: "sh.keptn.event.webhook.triggered"
+      subscriptionIDs: "my-subscription-id"
+      envFrom:
+        - secretRef:
+          name: mysecret
+      requests:
+        - "curl http://localhost:8080 {{.data.project}} {{.env.mysecret}}"`),
+			},
+			want:    nil,
+			wantErr: true,
+		},
+		{
+			name: "missing requests invalid input",
+			args: args{
+				webhookConfigYaml: []byte(`apiVersion: webhookconfig.keptn.sh/v1alpha1
+kind: WebhookConfig
+metadata:
+  name: webhook-configuration
+spec:
+  webhooks:
+    - type: "sh.keptn.event.webhook.triggered"
+      subscriptionIDs: "my-subscription-id"
+      envFrom:
+        - secretRef:
+          name: mysecret
+      requests:`),
+			},
+			want:    nil,
+			wantErr: true,
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {