fix: [TKC-3468] print webhook payload yaml text (#6321)

* fix: print xml text

Signed-off-by: Vladislav Sukhin <[email protected]>

* fix: unit test

Signed-off-by: Vladislav Sukhin <[email protected]>

* fix: remove type

Signed-off-by: Vladislav Sukhin <[email protected]>

* fix: fmt template

Signed-off-by: Vladislav Sukhin <[email protected]>

---------

Signed-off-by: Vladislav Sukhin <[email protected]>

Author: vsukhin

pkg/api/v1/testkube/model_webhook_create_request_extended.go

@@ -4,7 +4,7 @@ import "fmt"
 
 func (w *WebhookCreateRequest) QuoteTextFields() {
 	if w.PayloadTemplate != "" {
-		w.PayloadTemplate = fmt.Sprintf("%q", w.PayloadTemplate)
+		w.PayloadTemplate, _ = printPayloadTemplate(w.PayloadTemplate)
 	}
 
 	for key, val := range w.Config {

pkg/api/v1/testkube/model_webhook_extended.go

@@ -9,7 +9,11 @@
  */
 package testkube
 
-import "fmt"
+import (
+	"fmt"
+
+	"gopkg.in/yaml.v3"
+)
 
 type Webhooks []Webhook
 
@@ -48,7 +52,7 @@ func (w Webhook) GetAnnotations() map[string]string {
 
 func (w *Webhook) QuoteTextFields() {
 	if w.PayloadTemplate != "" {
-		w.PayloadTemplate = fmt.Sprintf("%q", w.PayloadTemplate)
+		w.PayloadTemplate, _ = printPayloadTemplate(w.PayloadTemplate)
 	}
 
 	for key, val := range w.Config {
@@ -78,3 +82,15 @@ func (w *Webhook) QuoteTextFields() {
 		w.Parameters[key] = value
 	}
 }
+
+func printPayloadTemplate(text string) (string, error) {
+	data := struct {
+		PayloadTemplate string `yaml:"payloadTemplate"`
+	}{PayloadTemplate: text}
+	yamlData, err := yaml.Marshal(&data)
+	if err != nil {
+		return "", err
+	}
+
+	return string(yamlData), nil
+}

pkg/api/v1/testkube/model_webhook_template_create_request_extended.go

@@ -4,7 +4,7 @@ import "fmt"
 
 func (w *WebhookTemplateCreateRequest) QuoteTextFields() {
 	if w.PayloadTemplate != "" {
-		w.PayloadTemplate = fmt.Sprintf("%q", w.PayloadTemplate)
+		w.PayloadTemplate, _ = printPayloadTemplate(w.PayloadTemplate)
 	}
 
 	for key, val := range w.Config {

pkg/api/v1/testkube/model_webhook_template_extended.go

@@ -48,7 +48,7 @@ func (w WebhookTemplate) GetAnnotations() map[string]string {
 
 func (w *WebhookTemplate) QuoteTextFields() {
 	if w.PayloadTemplate != "" {
-		w.PayloadTemplate = fmt.Sprintf("%q", w.PayloadTemplate)
+		w.PayloadTemplate, _ = printPayloadTemplate(w.PayloadTemplate)
 	}
 
 	for key, val := range w.Config {

pkg/crd/crd_test.go

@@ -12,7 +12,7 @@ func TestGenerateYAML(t *testing.T) {
 
 	t.Run("generate single CRD yaml", func(t *testing.T) {
 		// given
-		expected := "apiVersion: executor.testkube.io/v1\nkind: Webhook\nmetadata:\n  name: name1\n  namespace: namespace1\n  labels:\n    key1: value1\n  annotations:\n    key2: value2  \nspec:\n  events:\n  - start-test\n  uri: http://localhost\n  selector: app=backend\n  payloadObjectField: text\n  payloadTemplate: {{ .Id }}\n  payloadTemplateReference: ref\n  headers:\n    Content-Type: appication/xml\n  disabled: true\n  config:\n    var1:\n      value: pb\n    var2:\n      secret:\n        namespace: ns\n        name: secret\n        key: pr\n  parameters:\n    - name: var3\n      description: descr\n      required: true\n      example: 12345\n      default: 0\n      pattern: [0-9]*\n  webhookTemplateRef:\n    name: tmpl\n"
+		expected := "apiVersion: executor.testkube.io/v1\nkind: Webhook\nmetadata:\n  name: name1\n  namespace: namespace1\n  labels:\n    key1: value1\n  annotations:\n    key2: value2  \nspec:\n  events:\n  - start-test\n  uri: http://localhost\n  selector: app=backend\n  payloadObjectField: text\n  payloadTemplateReference: ref\n  headers:\n    Content-Type: appication/xml\n  disabled: true\n  config:\n    var1:\n      value: pb\n    var2:\n      secret:\n        namespace: ns\n        name: secret\n        key: pr\n  parameters:\n    - name: var3\n      description: descr\n      required: true\n      example: 12345\n      default: 0\n      pattern: [0-9]*\n  webhookTemplateRef:\n    name: tmpl\n  {{ .Id }}\n"
 		webhooks := []testkube.Webhook{
 			{
 				Name:                     "name1",
@@ -58,7 +58,7 @@ func TestGenerateYAML(t *testing.T) {
 
 	t.Run("generate multiple CRDs yaml", func(t *testing.T) {
 		// given
-		expected := "apiVersion: executor.testkube.io/v1\nkind: Webhook\nmetadata:\n  name: name1\n  namespace: namespace1\n  labels:\n    key1: value1\n  annotations:\n    key3: value3  \nspec:\n  events:\n  - start-test\n  uri: http://localhost\n  selector: app=backend\n  payloadObjectField: text\n  payloadTemplate: {{ .Id }}\n  payloadTemplateReference: ref\n  headers:\n    Content-Type: appication/xml\n  disabled: true\n  config:\n    var1:\n      value: pb\n    var2:\n      secret:\n        namespace: ns\n        name: secret\n        key: pr\n  parameters:\n    - name: var3\n      description: descr\n      required: true\n      example: 12345\n      default: 0\n      pattern: [0-9]*\n  webhookTemplateRef:\n    name: tmpl\n\n---\napiVersion: executor.testkube.io/v1\nkind: Webhook\nmetadata:\n  name: name2\n  namespace: namespace2\n  labels:\n    key2: value2\n  annotations:\n    key4: value4  \nspec:\n  events:\n  - end-test-success\n  uri: http://localhost\n  selector: app=backend\n  payloadObjectField: text\n  payloadTemplate: {{ .Id }}\n  payloadTemplateReference: ref\n  headers:\n    Content-Type: appication/xml\n  disabled: true\n  config:\n    var1:\n      value: pb\n    var2:\n      secret:\n        namespace: ns\n        name: secret\n        key: pr\n  parameters:\n    - name: var3\n      description: descr\n      required: true\n      example: 12345\n      default: 0\n      pattern: [0-9]*\n  webhookTemplateRef:\n    name: tmpl\n"
+		expected := "apiVersion: executor.testkube.io/v1\nkind: Webhook\nmetadata:\n  name: name1\n  namespace: namespace1\n  labels:\n    key1: value1\n  annotations:\n    key3: value3  \nspec:\n  events:\n  - start-test\n  uri: http://localhost\n  selector: app=backend\n  payloadObjectField: text\n  payloadTemplateReference: ref\n  headers:\n    Content-Type: appication/xml\n  disabled: true\n  config:\n    var1:\n      value: pb\n    var2:\n      secret:\n        namespace: ns\n        name: secret\n        key: pr\n  parameters:\n    - name: var3\n      description: descr\n      required: true\n      example: 12345\n      default: 0\n      pattern: [0-9]*\n  webhookTemplateRef:\n    name: tmpl\n  {{ .Id }}\n\n---\napiVersion: executor.testkube.io/v1\nkind: Webhook\nmetadata:\n  name: name2\n  namespace: namespace2\n  labels:\n    key2: value2\n  annotations:\n    key4: value4  \nspec:\n  events:\n  - end-test-success\n  uri: http://localhost\n  selector: app=backend\n  payloadObjectField: text\n  payloadTemplateReference: ref\n  headers:\n    Content-Type: appication/xml\n  disabled: true\n  config:\n    var1:\n      value: pb\n    var2:\n      secret:\n        namespace: ns\n        name: secret\n        key: pr\n  parameters:\n    - name: var3\n      description: descr\n      required: true\n      example: 12345\n      default: 0\n      pattern: [0-9]*\n  webhookTemplateRef:\n    name: tmpl\n  {{ .Id }}\n"
 		webhooks := []testkube.Webhook{
 			{
 				Name:                     "name1",

pkg/crd/templates/webhook.tmpl

@@ -31,9 +31,6 @@ spec:
   {{- if .PayloadObjectField }}
   payloadObjectField: {{ .PayloadObjectField }}
   {{- end }}
-  {{- if .PayloadTemplate }}
-  payloadTemplate: {{ .PayloadTemplate }}
-  {{- end }}
   {{- if .PayloadTemplateReference }}
   payloadTemplateReference: {{ .PayloadTemplateReference }}
   {{- end }}  
@@ -86,3 +83,6 @@ spec:
   webhookTemplateRef:
     name: {{ .WebhookTemplateRef.Name }}
   {{- end }}
+  {{- if .PayloadTemplate }}
+  {{ .PayloadTemplate }}
+  {{- end }}