fix: update exception for config files

cslant · Nov 7, 2023 · f507dce · f507dce
1 parent 1e073b8
commit f507dce
Show file tree

Hide file tree

Showing 7 changed files with 96 additions and 7 deletions.
diff --git a/src/Bot.php b/src/Bot.php
@@ -3,6 +3,7 @@
 namespace CSlant\TelegramGitNotifier;
 
 use CSlant\TelegramGitNotifier\Constants\EventConstant;
+use CSlant\TelegramGitNotifier\Exceptions\ConfigFileException;
 use CSlant\TelegramGitNotifier\Interfaces\BotInterface;
 use CSlant\TelegramGitNotifier\Interfaces\EventInterface;
 use CSlant\TelegramGitNotifier\Interfaces\SettingInterface;
@@ -29,6 +30,17 @@ class Bot implements AppInterface, BotInterface, EventInterface, SettingInterfac
 
     public Setting $setting;
 
+    /**
+     * @param Telegram|null $telegram
+     * @param string|null $chatBotId
+     * @param Event|null $event
+     * @param string|null $platform
+     * @param string|null $platformFile
+     * @param Setting|null $setting
+     * @param string|null $settingFile
+     *
+     * @throws ConfigFileException
+     */
     public function __construct(
         Telegram $telegram = null,
         ?string $chatBotId = null,
@@ -38,12 +50,22 @@ public function __construct(
         Setting $setting = null,
         ?string $settingFile = null,
     ) {
-        $this->telegram = $telegram ?? new Telegram(config('telegram-git-notifier.bot.token'));
-        $this->setCurrentChatBotId($chatBotId);
         $this->event = $event ?? new Event();
         $this->setPlatFormForEvent($platform, $platformFile);
+        $this->validatePlatformFile();
 
         $this->setting = $setting ?? new Setting();
         $this->updateSetting($settingFile);
+        $this->validateSettingFile();
+
+        $this->telegram = $telegram ?? new Telegram(config('telegram-git-notifier.bot.token'));
+        $this->setCurrentChatBotId($chatBotId);
+    }
+
+    public function validateSettingFile(): void
+    {
+        if (empty($this->setting->getSettingFile())) {
+            throw ConfigFileException::settingFile($this->setting->getSettingFile());
+        }
     }
 }
diff --git a/src/Exceptions/ConfigFileException.php b/src/Exceptions/ConfigFileException.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace CSlant\TelegramGitNotifier\Exceptions;
+
+final class ConfigFileException extends TelegramGitNotifierException
+{
+    public static function settingFile(?string $settingFile = null): self
+    {
+        return new self('Something went wrong while reading settings file. Check your settings file path: ' . ($settingFile ?? 'null'));
+    }
+
+    public static function platformFile(?string $platform = null, ?string $platformFile = null): self
+    {
+        return new self('Something went wrong while reading platform file. Check your platform file path: ' . ($platformFile ?? 'null') . ' for platform: ' . ($platform ?? 'null'));
+    }
+}
diff --git a/src/Interfaces/BotInterface.php b/src/Interfaces/BotInterface.php
@@ -2,6 +2,7 @@
 
 namespace CSlant\TelegramGitNotifier\Interfaces;
 
+use CSlant\TelegramGitNotifier\Exceptions\ConfigFileException;
 use CSlant\TelegramGitNotifier\Exceptions\MessageIsEmptyException;
 
 interface BotInterface
@@ -46,4 +47,10 @@ public function isOwner(): bool;
      * @return bool
      */
     public function isNotifyChat(): bool;
+
+    /**
+     * @return void
+     * @throws ConfigFileException
+     */
+    public function validateSettingFile(): void;
 }
diff --git a/src/Interfaces/EventInterface.php b/src/Interfaces/EventInterface.php
@@ -3,6 +3,7 @@
 namespace CSlant\TelegramGitNotifier\Interfaces;
 
 use CSlant\TelegramGitNotifier\Constants\EventConstant;
+use CSlant\TelegramGitNotifier\Exceptions\ConfigFileException;
 use CSlant\TelegramGitNotifier\Trait\ActionEventTrait;
 use Symfony\Component\HttpFoundation\Request;
 
@@ -27,7 +28,7 @@ public function getActionOfEvent(object $payload): string;
      * @return void
      * @see EventTrait::setPlatFormForEvent()
      */
-    public function setPlatFormForEvent(?string $platform = EventConstant::DEFAULT_PLATFORM, string $platformFile = null): void;
+    public function setPlatFormForEvent(?string $platform = EventConstant::DEFAULT_PLATFORM, ?string $platformFile = null): void;
 
     /**
      * Set event config and get event name
@@ -38,4 +39,10 @@ public function setPlatFormForEvent(?string $platform = EventConstant::DEFAULT_P
      * @see EventTrait::handleEventFromRequest()
      */
     public function handleEventFromRequest(Request $request): ?string;
+
+    /**
+     * @return void
+     * @throws ConfigFileException
+     */
+    public function validatePlatformFile(): void;
 }
diff --git a/src/Notifier.php b/src/Notifier.php
@@ -4,6 +4,7 @@
 
 use CSlant\TelegramGitNotifier\Constants\EventConstant;
 use CSlant\TelegramGitNotifier\Constants\NotificationConstant;
+use CSlant\TelegramGitNotifier\Exceptions\ConfigFileException;
 use CSlant\TelegramGitNotifier\Interfaces\EventInterface;
 use CSlant\TelegramGitNotifier\Interfaces\Structures\AppInterface;
 use CSlant\TelegramGitNotifier\Interfaces\Structures\NotificationInterface;
@@ -25,6 +26,16 @@ class Notifier implements AppInterface, NotificationInterface, EventInterface
 
     public Client $client;
 
+    /**
+     * @param Telegram|null $telegram
+     * @param string|null $chatBotId
+     * @param Event|null $event
+     * @param string|null $platform
+     * @param string|null $platformFile
+     * @param Client|null $client
+     *
+     * @throws ConfigFileException
+     */
     public function __construct(
         Telegram $telegram = null,
         ?string $chatBotId = null,
@@ -33,11 +44,12 @@ public function __construct(
         ?string $platformFile = null,
         Client $client = null,
     ) {
-        $this->telegram = $telegram ?? new Telegram(config('telegram-git-notifier.bot.token'));
-        $this->setCurrentChatBotId($chatBotId);
-
         $this->event = $event ?? new Event();
         $this->setPlatFormForEvent($platform, $platformFile);
+        $this->validatePlatformFile();
+
+        $this->telegram = $telegram ?? new Telegram(config('telegram-git-notifier.bot.token'));
+        $this->setCurrentChatBotId($chatBotId);
 
         $this->client = $client ?? new Client();
     }

diff --git a/src/Trait/EventTrait.php b/src/Trait/EventTrait.php
@@ -3,13 +3,14 @@
 namespace CSlant\TelegramGitNotifier\Trait;
 
 use CSlant\TelegramGitNotifier\Constants\EventConstant;
+use CSlant\TelegramGitNotifier\Exceptions\ConfigFileException;
 use Symfony\Component\HttpFoundation\Request;
 
 trait EventTrait
 {
     use ActionEventTrait;
 
-    public function setPlatFormForEvent(?string $platform = EventConstant::DEFAULT_PLATFORM, string $platformFile = null): void
+    public function setPlatFormForEvent(?string $platform = EventConstant::DEFAULT_PLATFORM, ?string $platformFile = null): void
     {
         /** @var array $platformFileDefaults<platform, platformFile> */
         $platformFileDefaults = config('telegram-git-notifier.data_file.platform');
@@ -31,4 +32,14 @@ public function handleEventFromRequest(Request $request): ?string
 
         return null;
     }
+
+    public function validatePlatformFile(): void
+    {
+        if (empty($this->event->getEventConfig())) {
+            throw ConfigFileException::platformFile(
+                $this->event->platform,
+                $this->event->getPlatformFile()
+            );
+        }
+    }
 }
diff --git a/tests/ConfigTest.php b/tests/ConfigTest.php
@@ -37,3 +37,17 @@
     expect($this->bot->event->getEventConfig())->toBeArray();
     expect($this->bot->event->getEventConfig())->toHaveKey('tag_push');
 });
+
+it('setting file is valid', function () {
+    $this->bot->updateSetting();
+    $this->bot->validateSettingFile();
+
+    expect($this->bot->setting->getSettings())->toBeArray();
+});
+
+it('platform file is valid', function () {
+    $this->bot->setPlatFormForEvent();
+    $this->bot->validatePlatformFile();
+
+    expect($this->bot->event->getEventConfig())->toBeArray();
+});