example tests

Signed-off-by: eternal-flame-AD <yume@yumechi.jp>

Author: eternal-flame-AD

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.24.6
+      - name: Install dependencies
+        run: go mod download
+      - name: Test
+        run: cd v2 && go test -v ./...
+
+  test-windows:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.24.6
+      - name: Install dependencies
+        run: go mod download
+      - name: Test
+        run: cd v2 && go test -v ./...

v2/anon_unix.go

@@ -0,0 +1,21 @@
+//go:build unix
+
+package plugin
+
+import (
+	"golang.org/x/sys/unix"
+)
+
+func NewAnonPipe(rx *uintptr, tx *uintptr, cloexec bool) error {
+	var tmp [2]int
+	var flags int
+	if cloexec {
+		flags = unix.O_CLOEXEC
+	}
+	if err := unix.Pipe2(tmp[:], flags); err != nil {
+		return err
+	}
+	*rx = uintptr(tmp[0])
+	*tx = uintptr(tmp[1])
+	return nil
+}

v2/anon_windows.go

@@ -0,0 +1,25 @@
+//go:build windows
+
+package plugin
+
+import (
+	"unsafe"
+
+	"golang.org/x/sys/windows"
+)
+
+func NewAnonPipe(rx *uintptr, tx *uintptr, cloexec bool) error {
+	var tmp [2]windows.Handle
+	var sa windows.SecurityAttributes
+	sa.Length = uint32(unsafe.Sizeof(sa))
+	if !cloexec {
+		sa.InheritHandle = 1
+	}
+	err := windows.CreatePipe(&tmp[0], &tmp[1], &sa, 0)
+	if err != nil {
+		return err
+	}
+	*rx = uintptr(tmp[0])
+	*tx = uintptr(tmp[1])
+	return nil
+}

v2/cli_flags.go

@@ -6,37 +6,44 @@ import (
 )
 
 type PluginCliFlags struct {
-	flagSet  *flag.FlagSet
-	CAData   []byte
-	CertData []byte
-	KeyData  []byte
+	flagSet     *flag.FlagSet
+	KexReqFile  *os.File
+	KexRespFile *os.File
+	Debug       bool
 }
 
 func ParsePluginCLIFlags(args []string) (*PluginCliFlags, error) {
 	flagSet := flag.NewFlagSet(os.Args[0], flag.ContinueOnError)
-	var caFile string
-	var certFile string
-	var keyFile string
-	flagSet.StringVar(&certFile, "cert-file", "", "Path to the certificate file for Transport Auth.")
-	flagSet.StringVar(&keyFile, "key-file", "", "Path to the key file for Transport Auth.")
-	flagSet.StringVar(&caFile, "ca-file", "", "Path to the CA file for Transport Auth.")
+	var kexReqFileName string
+	var kexRespFileName string
+	var debug bool
+	flagSet.StringVar(&kexReqFileName, "kex-req-file", "", "File name for the key exchange for Transport Auth.")
+	flagSet.StringVar(&kexRespFileName, "kex-resp-file", "", "File name for the key exchange for Transport Auth.")
+	flagSet.BoolVar(&debug, "debug", false, "Enable debug mode.")
 	flagSet.Parse(args)
-	certData, err := os.ReadFile(certFile)
-	if err != nil {
-		return nil, err
-	}
-	keyData, err := os.ReadFile(keyFile)
+
+	kexReqFile, err := os.OpenFile(kexReqFileName, os.O_WRONLY, 0)
 	if err != nil {
 		return nil, err
 	}
-	caData, err := os.ReadFile(caFile)
+	kexRespFile, err := os.OpenFile(kexRespFileName, os.O_RDONLY, 0)
 	if err != nil {
 		return nil, err
 	}
 	return &PluginCliFlags{
-		flagSet:  flagSet,
-		CAData:   caData,
-		CertData: certData,
-		KeyData:  keyData,
+		flagSet:     flagSet,
+		KexReqFile:  kexReqFile,
+		KexRespFile: kexRespFile,
+		Debug:       debug,
 	}, nil
 }
+
+func (f *PluginCliFlags) Close() error {
+	if err := f.KexReqFile.Close(); err != nil {
+		return err
+	}
+	if err := f.KexRespFile.Close(); err != nil {
+		return err
+	}
+	return nil
+}

v2/examples_v1/echo/echo.go

@@ -0,0 +1,120 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"log"
+	"net/url"
+
+	"github.com/gin-gonic/gin"
+	"github.com/gotify/plugin-api"
+)
+
+// GetGotifyPluginInfo returns gotify plugin info.
+func GetGotifyPluginInfo() plugin.Info {
+	return plugin.Info{
+		ModulePath: "github.com/gotify/server/v2/plugin/example/echo",
+		Name:       "test plugin",
+	}
+}
+
+// EchoPlugin is the gotify plugin instance.
+type EchoPlugin struct {
+	msgHandler     plugin.MessageHandler
+	storageHandler plugin.StorageHandler
+	config         *Config
+	basePath       string
+}
+
+// SetStorageHandler implements plugin.Storager
+func (c *EchoPlugin) SetStorageHandler(h plugin.StorageHandler) {
+	c.storageHandler = h
+}
+
+// SetMessageHandler implements plugin.Messenger.
+func (c *EchoPlugin) SetMessageHandler(h plugin.MessageHandler) {
+	c.msgHandler = h
+}
+
+// Storage defines the plugin storage scheme
+type Storage struct {
+	CalledTimes int `json:"called_times"`
+}
+
+// Config defines the plugin config scheme
+type Config struct {
+	MagicString string `yaml:"magic_string"`
+}
+
+// DefaultConfig implements plugin.Configurer
+func (c *EchoPlugin) DefaultConfig() interface{} {
+	return &Config{
+		MagicString: "hello world",
+	}
+}
+
+// ValidateAndSetConfig implements plugin.Configurer
+func (c *EchoPlugin) ValidateAndSetConfig(config interface{}) error {
+	c.config = config.(*Config)
+	return nil
+}
+
+// Enable enables the plugin.
+func (c *EchoPlugin) Enable() error {
+	log.Println("echo plugin enabled")
+	return nil
+}
+
+// Disable disables the plugin.
+func (c *EchoPlugin) Disable() error {
+	log.Println("echo plugin disbled")
+	return nil
+}
+
+// RegisterWebhook implements plugin.Webhooker.
+func (c *EchoPlugin) RegisterWebhook(baseURL string, g *gin.RouterGroup) {
+	c.basePath = baseURL
+	g.GET("/echo", func(ctx *gin.Context) {
+
+		storage, _ := c.storageHandler.Load()
+		conf := new(Storage)
+		json.Unmarshal(storage, conf)
+		conf.CalledTimes++
+		newStorage, _ := json.Marshal(conf)
+		c.storageHandler.Save(newStorage)
+
+		c.msgHandler.SendMessage(plugin.Message{
+			Title:    "Hello received",
+			Message:  fmt.Sprintf("echo server received a hello message %d times", conf.CalledTimes),
+			Priority: 2,
+			Extras: map[string]any{
+				"plugin::name": "echo",
+			},
+		})
+		ctx.Writer.WriteString(fmt.Sprintf("Magic string is: %s\r\nEcho server running at %secho", c.config.MagicString, c.basePath))
+	})
+}
+
+// GetDisplay implements plugin.Displayer.
+func (c *EchoPlugin) GetDisplay(location *url.URL) string {
+	loc := &url.URL{
+		Path: c.basePath,
+	}
+	if location != nil {
+		loc.Scheme = location.Scheme
+		loc.Host = location.Host
+	}
+	loc = loc.ResolveReference(&url.URL{
+		Path: "echo",
+	})
+	return "Echo plugin running at: " + loc.String()
+}
+
+// NewGotifyPluginInstance creates a plugin instance for a user context.
+func NewGotifyPluginInstance(ctx plugin.UserContext) plugin.Plugin {
+	return &EchoPlugin{}
+}
+
+func main() {
+	panic("this should be built as go plugin")
+}