From 2e48eb886e0b67fc460d203d8bd1abeb7faa1bc6 Mon Sep 17 00:00:00 2001
From: Matthias von Bargen <matt@mavon.ie>
Date: Mon, 17 Jun 2024 18:54:22 +0200
Subject: [PATCH] add event handler configuration (#20)

---
 docker/caddy/Dockerfile                       |  3 +-
 src/Config/Apps/Events.php                    | 33 ++++++++++
 src/Config/Apps/Events/Handlers/Exec.php      | 65 +++++++++++++++++++
 src/Config/Apps/Events/Subscription.php       | 46 +++++++++++++
 .../Apps/Events/HandlerInterface.php          | 12 ++++
 tests/Integration/CaddyTest.php               | 29 +++++++++
 tests/Unit/Apps/EventTest.php                 | 60 +++++++++++++++++
 7 files changed, 247 insertions(+), 1 deletion(-)
 create mode 100644 src/Config/Apps/Events.php
 create mode 100644 src/Config/Apps/Events/Handlers/Exec.php
 create mode 100644 src/Config/Apps/Events/Subscription.php
 create mode 100644 src/Interfaces/Apps/Events/HandlerInterface.php
 create mode 100644 tests/Unit/Apps/EventTest.php

diff --git a/docker/caddy/Dockerfile b/docker/caddy/Dockerfile
index d1b2f86..2718bf7 100644
--- a/docker/caddy/Dockerfile
+++ b/docker/caddy/Dockerfile
@@ -1,7 +1,8 @@
 FROM caddy:2.8.4-builder-alpine
 
 RUN xcaddy build --with github.com/darkweak/souin/plugins/caddy@a2e88383a2bced983914cc12bde413ad8887b56d \
-    --with github.com/darkweak/souin@a2e88383a2bced983914cc12bde413ad8887b56d
+    --with github.com/darkweak/souin@a2e88383a2bced983914cc12bde413ad8887b56d \
+    --with github.com/mholt/caddy-events-exec
 
 # See https://caddyserver.com/docs/conventions#file-locations for details
 ENV XDG_CONFIG_HOME /config
diff --git a/src/Config/Apps/Events.php b/src/Config/Apps/Events.php
new file mode 100644
index 0000000..438da3c
--- /dev/null
+++ b/src/Config/Apps/Events.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mattvb91\CaddyPhp\Config\Apps;
+
+use mattvb91\CaddyPhp\Config\Apps\Events\Subscription;
+use mattvb91\CaddyPhp\Interfaces\App;
+
+class Events implements App
+{
+    /** @var Subscription[] */
+    private array $subscriptions;
+
+    /**
+     * @param Subscription[] $subscriptions
+     */
+    public function __construct(array $subscriptions = [])
+    {
+        $this->subscriptions = $subscriptions;
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'subscriptions' => [
+                ...array_map(function (Subscription $subscription): array {
+                    return $subscription->toArray();
+                }, $this->subscriptions),
+            ],
+        ];
+    }
+}
diff --git a/src/Config/Apps/Events/Handlers/Exec.php b/src/Config/Apps/Events/Handlers/Exec.php
new file mode 100644
index 0000000..1d3e356
--- /dev/null
+++ b/src/Config/Apps/Events/Handlers/Exec.php
@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mattvb91\CaddyPhp\Config\Apps\Events\Handlers;
+
+use mattvb91\CaddyPhp\Interfaces\Apps\Events\HandlerInterface;
+
+/**
+ * https://caddyserver.com/docs/json/apps/events/subscriptions/handlers/exec/
+ */
+class Exec implements HandlerInterface
+{
+    private string $command;
+
+    /** @var string[]  */
+    private array $args;
+
+    private string $dir;
+
+    private int $timeout;
+
+    private bool $foreground;
+
+    /** @var int[] */
+    private array $abort_codes;
+
+    /**
+     * @param string[] $args
+     * @param int[] $abort_codes
+     */
+    public function __construct(
+        string $command,
+        array $args,
+        string $dir,
+        int $timeout = 0,
+        bool $foreground = false,
+        array $abort_codes = [0]
+    ) {
+        $this->command = $command;
+        $this->args = $args;
+        $this->dir = $dir;
+        $this->timeout = $timeout;
+        $this->foreground = $foreground;
+        $this->abort_codes = $abort_codes;
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'handler'     => $this->getHandler(),
+            "command"     => $this->command,
+            "args"        => $this->args,
+            "dir"         => $this->dir,
+            "timeout"     => $this->timeout,
+            "foreground"  => $this->foreground,
+            "abort_codes" => $this->abort_codes,
+        ];
+    }
+
+    public function getHandler(): string
+    {
+        return 'exec';
+    }
+}
diff --git a/src/Config/Apps/Events/Subscription.php b/src/Config/Apps/Events/Subscription.php
new file mode 100644
index 0000000..cb480c7
--- /dev/null
+++ b/src/Config/Apps/Events/Subscription.php
@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mattvb91\CaddyPhp\Config\Apps\Events;
+
+use mattvb91\CaddyPhp\Interfaces\Apps\Events\HandlerInterface;
+use mattvb91\CaddyPhp\Interfaces\Arrayable;
+
+class Subscription implements Arrayable
+{
+    /** @var string[] */
+    private array $events;
+
+    /** @var string [] */
+    private array $modules;
+
+    /** @var HandlerInterface[] */
+    private array $handlers;
+
+    /**
+     * @param string[] $events
+     * @param string[] $modules
+     * @param HandlerInterface[] $handlers
+     */
+    public function __construct(
+        array $events = [],
+        array $modules = [],
+        array $handlers = []
+    ) {
+        $this->events = $events;
+        $this->modules = $modules;
+        $this->handlers = $handlers;
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'events'   => $this->events,
+            'modules'  => $this->modules,
+            'handlers' => array_map(function (HandlerInterface $handler): array {
+                return $handler->toArray();
+            }, $this->handlers),
+        ];
+    }
+}
diff --git a/src/Interfaces/Apps/Events/HandlerInterface.php b/src/Interfaces/Apps/Events/HandlerInterface.php
new file mode 100644
index 0000000..3391281
--- /dev/null
+++ b/src/Interfaces/Apps/Events/HandlerInterface.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mattvb91\CaddyPhp\Interfaces\Apps\Events;
+
+use mattvb91\CaddyPhp\Interfaces\Arrayable;
+
+interface HandlerInterface extends Arrayable
+{
+    public function getHandler(): string;
+}
diff --git a/tests/Integration/CaddyTest.php b/tests/Integration/CaddyTest.php
index 14016f2..20635b2 100644
--- a/tests/Integration/CaddyTest.php
+++ b/tests/Integration/CaddyTest.php
@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Client;
 use mattvb91\CaddyPhp\Caddy;
+use mattvb91\CaddyPhp\Config\Apps\Events;
 use mattvb91\CaddyPhp\Config\Apps\Http;
 use mattvb91\CaddyPhp\Config\Apps\Http\Server\Route;
 use mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle\Authentication;
@@ -61,6 +62,34 @@ public function testCanLoadWithHttpApp(): void
         $this->assertTrue($caddy->load());
     }
 
+    /**
+     * @coversNothing
+     */
+    public function testCanLoadWithEventsApp()
+    {
+        $caddy = new Caddy();
+        $caddy->addApp(
+            (new Events([
+                (new Events\Subscription(
+                    handlers: [
+                        new Events\Handlers\Exec(
+                            "datetime",
+                            [],
+                            "/tmp",
+                            0,
+                            false,
+                            []
+                        ),
+                    ]
+                )),
+            ]))
+        );
+
+        $this->assertTrue(
+            $caddy->load()
+        );
+    }
+
     /**
      * @coversNothing
      */
diff --git a/tests/Unit/Apps/EventTest.php b/tests/Unit/Apps/EventTest.php
new file mode 100644
index 0000000..e623aa1
--- /dev/null
+++ b/tests/Unit/Apps/EventTest.php
@@ -0,0 +1,60 @@
+<?php
+
+namespace Tests\Unit\Apps;
+
+use mattvb91\CaddyPhp\Config\Apps\Events;
+use Tests\TestCase;
+
+class EventTest extends TestCase
+{
+
+    /**
+     * @covers \mattvb91\CaddyPhp\Config\Apps\Events::toArray
+     * @covers \mattvb91\CaddyPhp\Config\Apps\Events::__construct
+     * @covers \mattvb91\CaddyPhp\Config\Apps\Events\Subscription::toArray
+     * @covers \mattvb91\CaddyPhp\Config\Apps\Events\Subscription::__construct
+     * @covers \mattvb91\CaddyPhp\Config\Apps\Events\Handlers\Exec::toArray
+     * @covers \mattvb91\CaddyPhp\Config\Apps\Events\Handlers\Exec::__construct
+     */
+    public function testAddingExecEvent()
+    {
+        $events = (new Events([
+            (new Events\Subscription(
+                handlers: [
+                    new Events\Handlers\Exec(
+                        "datetime",
+                        [],
+                        "/tmp",
+                        0,
+                        false,
+                        []
+                    ),
+                ]
+            )),
+        ]));
+
+        $this->assertEquals(
+            [
+                'subscriptions' => [
+                    [
+                        'events'   => [],
+                        'modules'  => [],
+                        'handlers' => [
+                            [
+                                'handler'     => 'exec',
+                                'command'     => 'datetime',
+                                'args'        => [],
+                                'dir'         => '/tmp',
+                                'timeout'     => 0,
+                                'foreground'  => false,
+                                'abort_codes' => [],
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            $events->toArray()
+        );
+    }
+
+}
\ No newline at end of file