WIP

Signed-off-by: jolheiser <john.olheiser@gmail.com>

Author: jolheiser

modules/webhook/webhook.go

@@ -0,0 +1,69 @@
+// Copyright 2022 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package webhook
+
+import (
+	"errors"
+	"io"
+
+	"gopkg.in/yaml.v2"
+)
+
+// Webhook is a custom webhook
+type Webhook struct {
+	ID   string   `yaml:"id"`
+	HTTP string   `yaml:"http"`
+	Exec []string `yaml:"exec"`
+	Form []Form   `yaml:"form"`
+}
+
+// Form is a webhook form
+type Form struct {
+	ID       string `yaml:"id"`
+	Label    string `yaml:"label"`
+	Type     string `yaml:"type"`
+	Required bool   `yaml:"required"`
+	Default  string `yaml:"default"`
+}
+
+func (w *Webhook) validate() error {
+	if w.ID == "" {
+		return errors.New("webhook id is required")
+	}
+	if (w.HTTP == "" && len(w.Exec) == 0) || (w.HTTP != "" && len(w.Exec) > 0) {
+		return errors.New("webhook requires one of exec or http")
+	}
+	for _, form := range w.Form {
+		if form.ID == "" {
+			return errors.New("form id is required")
+		}
+		if form.Label == "" {
+			return errors.New("form label is required")
+		}
+		if form.Type == "" {
+			return errors.New("form type is required")
+		}
+	}
+	return nil
+}
+
+// Parse parses a Webhooks from an io.Reader
+func Parse(r io.Reader) (*Webhook, error) {
+	b, err := io.ReadAll(r)
+	if err != nil {
+		return nil, err
+	}
+
+	var w Webhook
+	if err := yaml.Unmarshal(b, &w); err != nil {
+		return nil, err
+	}
+
+	if err := w.validate(); err != nil {
+		return nil, err
+	}
+
+	return &w, nil
+}

modules/webhook/webhook_test.go

@@ -0,0 +1,44 @@
+package webhook
+
+import (
+	"bytes"
+	"code.gitea.io/gitea/testdata"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestWebhook(t *testing.T) {
+	tt := []struct {
+		Name string
+		File string
+		Err  bool
+	}{
+		{
+			Name: "Executable",
+			File: "executable.yml",
+		},
+		{
+			Name: "HTTP",
+			File: "http.yml",
+		},
+		{
+			Name: "Bad",
+			File: "bad.yml",
+			Err:  true,
+		},
+	}
+
+	for _, tc := range tt {
+		t.Run(tc.Name, func(t *testing.T) {
+			contents, err := testdata.Webhook.ReadFile("webhook/" + tc.File)
+			assert.NoError(t, err, "expected to read file")
+
+			_, err = Parse(bytes.NewReader(contents))
+			if tc.Err {
+				assert.Error(t, err, "expected to get an error")
+			} else {
+				assert.NoError(t, err, "expected to not get an error")
+			}
+		})
+	}
+}

testdata/testdata.go

@@ -0,0 +1,8 @@
+package testdata
+
+import "embed"
+
+var (
+	//go:embed webhook
+	Webhook embed.FS
+)

testdata/webhook/bad.yml

@@ -0,0 +1 @@
+# Malformed or no data

testdata/webhook/executable.go

@@ -0,0 +1,87 @@
+package webhook
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+	"os"
+)
+
+type Payload struct {
+	Form map[string]struct {
+		Label    string      `json:"label"`
+		Type     string      `json:"type"`
+		Required bool        `json:"required"`
+		Default  interface{} `json:"default"`
+		Value    interface{} `json:"value"`
+	} `json:"form"`
+}
+
+func main() {
+	data, err := io.ReadAll(os.Stdin)
+	if err != nil {
+		panic(err)
+	}
+
+	var p Payload
+	if err := json.Unmarshal(data, &p); err != nil {
+		panic(err)
+	}
+
+	username, ok := p.Form["username"]
+	if !ok {
+		panic("username not found in form data")
+	}
+	checkType(username.Type, username.Value)
+	if username.Value.(string) != "jolheiser" {
+		panic("username should be jolheiser")
+	}
+
+	favNum, ok := p.Form["favorite-number"]
+	if !ok {
+		panic("favorite-number not found in form data")
+	}
+	checkType(favNum.Type, favNum.Value)
+	if username.Value.(float64) != 12 {
+		panic("favNum should be 12")
+	}
+
+	pineapple, ok := p.Form["pineapple"]
+	if !ok {
+		panic("pineapple not found in form data")
+	}
+	checkType(pineapple.Type, pineapple.Value)
+	if pineapple.Value.(bool) {
+		panic("pineapple should be false")
+	}
+
+	secret, ok := p.Form["secret"]
+	if !ok {
+		panic("secret not found in form data")
+	}
+	checkType(secret.Type, secret.Value)
+	if secret.Value.(string) != "sn34ky" {
+		panic("secret should be sn34ky")
+	}
+}
+
+func checkType(typ string, val interface{}) {
+	var ok bool
+	switch typ {
+	case "text", "secret":
+		_, ok = val.(string)
+	case "bool":
+		_, ok = val.(bool)
+	case "number":
+		_, ok = val.(float64)
+	}
+	if !ok {
+		panic(fmt.Sprintf("unexpected type %q for %v", typ, val))
+	}
+}
+
+// override panic
+func panic(v interface{}) {
+	fmt.Println(v)
+	os.Exit(1)
+}

testdata/webhook/executable.yml

@@ -0,0 +1,17 @@
+id: executable
+exec: ["go", "run", "executable.go"]
+form:
+  - id: username        # Required
+    label: Username     # Required, the label for the input
+    type: text          # Required, the type of input (text, number, bool, secret)
+    required: true      # Optional, defaults to false
+  - id: favorite-number
+    label: Favorite Number
+    type: number
+    default: 12        # Optional, a default value
+  - id: pineapple
+    label: Pineapple on Pizza
+    type: bool
+  - id: secret
+    label: Passphrase
+    type: secret

testdata/webhook/http.yml

@@ -0,0 +1,17 @@
+id: http
+http: "http://localhost:4665"
+form:
+  - id: username        # Required
+    label: Username     # Required, the label for the input
+    type: text          # Required, the type of input (text, number, bool, secret)
+    required: true      # Optional, defaults to false
+  - id: favorite-number
+    label: Favorite Number
+    type: number
+    default: 12        # Optional, a default value
+  - id: pineapple
+    label: Pineapple on Pizza
+    type: bool
+  - id: secret
+    label: Passphrase
+    type: secret