Fix schemas for gh-events and flux, fix render in gh-events

kubeshop · Sep 1, 2023 · 43f59aa · 43f59aa
1 parent 6a97a68
commit 43f59aa
Show file tree

Hide file tree

Showing 5 changed files with 88 additions and 44 deletions.
diff --git a/internal/executor/flux/executor.go b/internal/executor/flux/executor.go
@@ -2,9 +2,9 @@ package flux
 
 import (
 	"context"
+	_ "embed"
 	"fmt"
 
-	"github.com/MakeNowJust/heredoc"
 	"github.com/allegro/bigcache/v3"
 
 	"github.com/kubeshop/botkube/internal/executor/flux/commands"
@@ -17,6 +17,9 @@ import (
 	"github.com/kubeshop/botkube/pkg/pluginx"
 )
 
+//go:embed jsonschema.json
+var jsonschema string
+
 const (
 	PluginName  = "flux"
 	description = "Run the Flux CLI commands directly from your favorite communication platform."
@@ -43,7 +46,9 @@ func (d *Executor) Metadata(context.Context) (api.MetadataOutput, error) {
 		Version:      d.pluginVersion,
 		Description:  description,
 		Dependencies: getPluginDependencies(),
-		JSONSchema:   jsonSchema(),
+		JSONSchema: api.JSONSchema{
+			Value: jsonschema,
+		},
 	}, nil
 }
 
@@ -168,36 +173,3 @@ func (d *Executor) Help(context.Context) (api.Message, error) {
 
 	return out.Message, nil
 }
-
-// jsonSchema returns JSON schema for the executor.
-func jsonSchema() api.JSONSchema {
-	return api.JSONSchema{
-		Value: heredoc.Docf(`{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Flux",
-  "description": "%s",
-  "type": "object",
-  "properties": {
-    "github": {
-      "title": "GitHub",
-      "type": "object",
-      "properties": {
-        "auth": {
-          "title": "Auth",
-          "type": "object",
-          "properties": {
-            "accessToken": {
-              "title": "Access Token",
-              "description": "The GitHub access token. When not provided, some functionality may not work. For example, adding a comment under a pull request.",
-              "type": "string"
-            }
-          }
-        }
-      }
-    }
-  },
-  "required": []
-}
-`, description),
-	}
-}
diff --git a/internal/executor/flux/jsonschema.json b/internal/executor/flux/jsonschema.json
@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Flux",
+  "description": "Run the Flux CLI commands directly from your favorite communication platform.",
+  "type": "object",
+  "uiSchema": {
+    "github": {
+      "auth": {
+        "accessToken": {
+          "ui:widget": "password",
+          "ui:help": "Hint: Make it strong!"
+        }
+      }
+    }
+  },
+  "properties": {
+    "github": {
+      "title": "GitHub",
+      "type": "object",
+      "properties": {
+        "auth": {
+          "title": "Auth",
+          "type": "object",
+          "properties": {
+            "accessToken": {
+              "title": "Access Token",
+              "description": "Instructions for token creation: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token.\n\nLack of token may limit functionality, e.g., adding comments to pull requests or approving them.",
+              "type": "string"
+            }
+          }
+        }
+      }
+    }
+  },
+  "required": []
+}
diff --git a/internal/source/github_events/github_events.go b/internal/source/github_events/github_events.go
@@ -193,7 +193,8 @@ func (w *Watcher) emitMatchingEvent(ctx context.Context, stream *source.StreamOu
 					continue // let's check other events
 				}
 				stream.Event <- source.Event{
-					Message: msg,
+					Message:   msg,
+					RawObject: payload,
 				}
 			}
 		}

diff --git a/internal/source/github_events/jsonschema.json b/internal/source/github_events/jsonschema.json
@@ -4,27 +4,47 @@
   "description": "GitHub Events configuration parameters",
   "type": "object",
   "uiSchema": {
+    "github": {
+      "auth": {
+        "accessToken": {
+          "ui:widget": "password"
+        }
+      }
+    },
     "repositories": {
       "on": {
         "pullRequests": {
+          "notificationTemplate": {
+            "extraButtons": {
+              "displayName": {
+                "ui:widget": "textarea"
+              },
+              "commandTpl": {
+                "ui:widget": "textarea"
+              }
+            }
+          },
           "paths": {
             "include": {
-              "ui:classNames": "non-orderable",
+              "ui:widget": "textarea",
               "ui:options": {
                 "orderable": false
               },
               "items": {
+                "ui:widget": "textarea",
                 "ui:options": {
                   "label": false
                 }
               }
             },
             "exclude": {
+              "ui:widget": "textarea",
               "ui:classNames": "non-orderable",
               "ui:options": {
                 "orderable": false
               },
               "items": {
+                "ui:widget": "textarea",
                 "ui:options": {
                   "label": false
                 }
@@ -146,21 +166,21 @@
                           "type": "array",
                           "items": {
                             "type": "string",
-                            "title": "File path"
+                            "title": "Label"
                           }
                         },
                         "exclude": {
                           "title": "Exclude",
                           "type": "array",
                           "items": {
                             "type": "string",
-                            "title": "File path"
+                            "title": "Label"
                           }
                         }
-                      },
-                      "notificationTemplate": {
-                        "$ref": "#/definitions/notificationTemplate"
                       }
+                    },
+                    "notificationTemplate": {
+                      "$ref": "#/definitions/notificationTemplate"
                     }
                   }
                 }
@@ -242,7 +262,22 @@
               },
               "style": {
                 "title": "Style",
-                "type": "string"
+                "type": "string",
+                "default": "",
+                "oneOf": [
+                  {
+                    "const": "",
+                    "title": "Default"
+                  },
+                  {
+                    "const": "primary",
+                    "title": "Primary"
+                  },
+                  {
+                    "const": "danger",
+                    "title": "Danger"
+                  }
+                ]
               }
             }
           }

diff --git a/internal/source/github_events/render_opts.go b/internal/source/github_events/render_opts.go
@@ -48,7 +48,7 @@ func renderActionButton(tpl ExtraButton, e any) (api.Button, error) {
 		return btns.ForURL(tpl.DisplayName, value, api.ButtonStyle(tpl.Style)), nil
 	}
 
-	value, err := RenderGoTpl(tpl.URL, e)
+	value, err := RenderGoTpl(tpl.CommandTpl, e)
 	if err != nil {
 		return api.Button{}, err
 	}