Add Gotify priority environment variable (#159)

Adds environment variable `VIGILANT_NOTIFICATION_GOTIFY_PRIORITY` to control Gotify message priority.
VerifiedJoseph · Apr 19, 2024 · 4f86a67 · 4f86a67
1 parent a6900fe
commit 4f86a67
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 9 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -32,10 +32,11 @@ To send push notifications, a notification service is required. Vigilant support
 
 To use Gotify, a URL and application token must be given.
 
-| Name                                 | Description                |
-| ------------------------------------ | -------------------------- |
-| `VIGILANT_NOTIFICATION_GOTIFY_URL`   | URL used to access Gotify. |
-| `VIGILANT_NOTIFICATION_GOTIFY_TOKEN` | Gotify application token.  |
+| Name                                    | Description                             |
+| --------------------------------------- | --------------------------------------- |
+| `VIGILANT_NOTIFICATION_GOTIFY_URL`      | URL used to access Gotify.              |
+| `VIGILANT_NOTIFICATION_GOTIFY_TOKEN`    | Gotify application token.               |
+| `VIGILANT_NOTIFICATION_GOTIFY_PRIORITY` | Gotify message priority. Defaults to 4. |
 
 ### Ntfy
 

diff --git a/docs/feeds.md b/docs/feeds.md
@@ -26,7 +26,7 @@ feeds:
 | `url`             | **Yes**  | Feed URL                                                                      |
 | `interval`        | **Yes**  | Interval between feed checks in seconds. Minimum value is `300` (5 minutes).  |
 | `gotify_token`    | No       | Gotify application token. Overrides token set with an environment variable.   |
-| `gotify_priority` | No       | Gotify message priority.                                                      |
+| `gotify_priority` | No       | Gotify message priority. Overrides default value and/or environment variable. |
 | `ntfy_topic`      | No       | Ntfy topic. Overrides topic set with an environment variable.                 |
 | `ntfy_token`      | No       | Ntfy access token. Overrides token set with an environment variable.          |
 | `ntfy_priority`   | No       | Ntfy message priority. Overrides default value and/or environment variable.   |
diff --git a/src/Config/Validate/Gotify.php b/src/Config/Validate/Gotify.php
@@ -21,6 +21,24 @@ public function url(): void
         $this->config['notification_gotify_url'] = $this->getEnv('NOTIFICATION_GOTIFY_URL');
     }
 
+    /**
+     * Validate `VIGILANT_NOTIFICATION_GOTIFY_PRIORITY`
+     *
+     * @throws ConfigException if priority is not a number
+     */
+    public function priority(): void
+    {
+        if ($this->hasEnv('NOTIFICATION_GOTIFY_PRIORITY') === true) {
+            if (is_numeric($this->getEnv('NOTIFICATION_GOTIFY_PRIORITY')) === false) {
+                throw new ConfigException(
+                    'Gotify priority value is not a number [VIGILANT_NOTIFICATION_GOTIFY_PRIORITY]'
+                );
+            }
+
+            $this->config['notification_gotify_priority'] = (int) $this->getEnv('NOTIFICATION_GOTIFY_PRIORITY');
+        }
+    }
+
     /**
      * Validate `VIGILANT_NOTIFICATION_GOTIFY_TOKEN`
      *

diff --git a/src/Config/Validator.php b/src/Config/Validator.php
@@ -117,10 +117,11 @@ public function notificationService(array $supportedServices): void
         $this->config['notification_service'] = $service;
 
         if ($service === 'gotify') {
-            $ntfy = new Validate\Gotify($this->config);
-            $ntfy->url();
-            $ntfy->token();
-            $this->config = $ntfy->getConfig();
+            $gotify = new Validate\Gotify($this->config);
+            $gotify->url();
+            $gotify->priority();
+            $gotify->token();
+            $this->config = $gotify->getConfig();
         }
 
         if ($service === 'ntfy') {

diff --git a/tests/Config/Validate/GotifyTest.php b/tests/Config/Validate/GotifyTest.php
@@ -49,6 +49,34 @@ public function testNoUrl(): void
         $validate->url();
     }
 
+    /**
+     * Test priority
+     */
+    public function testPriority(): void
+    {
+        putenv('VIGILANT_NOTIFICATION_GOTIFY_PRIORITY=1');
+
+        $validate = new Validate(self::$defaults);
+        $validate->priority();
+        $config = $validate->getConfig();
+
+        $this->assertEquals(1, $config['notification_gotify_priority']);
+    }
+
+    /**
+     * Test priority is not a number
+     */
+    public function testPriorityNotNumber(): void
+    {
+        $this->expectException(ConfigException::class);
+        $this->expectExceptionMessage('Gotify priority value is not a number');
+
+        putenv('VIGILANT_NOTIFICATION_GOTIFY_PRIORITY=hello');
+
+        $validate = new Validate(self::$defaults);
+        $validate->priority();
+    }
+
     /**
      * Test token
      */

diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -43,6 +43,7 @@ protected function resetEnvs(): void
         // Gotify
         putenv('VIGILANT_NOTIFICATION_GOTIFY_URL');
         putenv('VIGILANT_NOTIFICATION_GOTIFY_TOKEN');
+        putenv('VIGILANT_NOTIFICATION_GOTIFY_PRIORITY');
 
         // Ntfy
         putenv('VIGILANT_NOTIFICATION_NTFY_URL');