Merge pull request #1 from niladam/feature/add_tests

Add tests and run tests workflow

Author: niladam

.gitattributes

@@ -26,3 +26,4 @@
 /tailwind.config.js     export-ignore
 /testbench.yaml         export-ignore
 /UPGRADING.md           export-ignore
+/.phpunit.cache		export-ignore

.github/run-tests.yml

@@ -0,0 +1,28 @@
+name: Run PHP Tests
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version: [ '7.4', '8.2' ]
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          # Add any required extensions here, for example:
+          extensions: mbstring, intl, pcntl, xml, json
+
+      - name: Install dependencies
+        run: composer install --no-interaction --prefer-dist --optimize-autoloader
+
+      - name: Run tests
+        run: vendor/bin/phpunit

.gitignore

@@ -2,6 +2,7 @@
 .idea
 .phpunit.result.cache
 .php-cs-fixer.cache
+.phpunit.cache
 .vscode
 build
 composer.lock

composer.json

@@ -16,7 +16,8 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.65",
-        "phpunit/phpunit": "^9.6"
+        "phpunit/phpunit": "^9.6",
+        "orchestra/testbench": "^6.47"
     },
     "extra": {
         "laravel": {
@@ -32,5 +33,10 @@
         "psr-4": {
             "Niladam\\LaravelZabbix\\": "src/"
         }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Niladam\\LaravelZabbix\\Tests\\": "tests/"
+        }
     }
 }

phpunit.xml.dist

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheResultFile=".phpunit.cache/test-results"
+         colors="true"
+         executionOrder="depends,defects"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="Laravel Zabbix Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage cacheDirectory=".phpunit.cache/code-coverage"
+              processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+    <php>
+        <env name="APP_ENV" value="testing"/>
+        <env name="CACHE_DRIVER" value="array"/>
+        <env name="SESSION_DRIVER" value="array"/>
+        <env name="QUEUE_DRIVER" value="sync"/>
+    </php>
+</phpunit>

src/Communication/Batch.php

@@ -18,7 +18,7 @@ public function __construct(string $request = 'sender data')
 
     public function add(Message $message): void
     {
-        $this->batch['data'][] = $message->serialized();
+        $this->batch['data'][] = $message;
     }
 
     public function getBatch(): array

src/Communication/Message.php

@@ -144,7 +144,7 @@ protected function validate(): void
         Assert::notNull($this->value, 'You have not set the "value" value on your message. Use usingValue() to do that.');
     }
 
-    public function serialized(): mixed
+    public function serialized(): array
     {
         return $this->jsonSerialize();
     }
@@ -156,7 +156,7 @@ public function send()
         return $this->manager->send();
     }
 
-    public function jsonSerialize(): mixed
+    public function jsonSerialize(): array
     {
         $this->validate();
 

src/Communication/Response.php

@@ -33,8 +33,6 @@ class Response
      */
     private ?float $duration;
 
-    private ?string  $humanDuration;
-
     public function __construct(array $response)
     {
         $this->parseZabbixResponse($response);
@@ -95,15 +93,15 @@ private function parseZabbixResponse(array $response): void
     {
         if (!isset($response['response'])) {
             throw new ResponseException(
-                'invalid zabbix server response, missing `response` field'
+                'Invalid zabbix server response, missing `response` field'
             );
         }
 
         $this->responseStatus = $response['response'];
 
         if (!isset($response['info'])) {
             throw new ResponseException(
-                'invalid zabbix server response, missing `info` field'
+                'Invalid zabbix server response, missing `info` field'
             );
         }
 
@@ -153,7 +151,6 @@ private function parseZabbixResponse(array $response): void
         $this->failedItems = (int) $matches[2];
         $this->totalItems = (int) $matches[3];
         $this->duration = (float) $matches[4];
-        $this->humanDuration = $this->convertToHumanReadableTime($matches[4]);
     }
 
     public function convertToHumanReadableTime(float $seconds): string

src/Notifications/Contracts/SentViaZabbix.php

@@ -26,7 +26,7 @@ public function getHostConfiguration();
     /**
      * @return bool|Response
      */
-    public function send(): mixed;
+    public function send();
 
     public function toZabbix($notifiable);
 }

src/Notifications/ZabbixAlert.php

@@ -14,6 +14,8 @@ abstract class ZabbixAlert extends ZabbixNotification implements SentViaZabbix
 {
     protected ?ZabbixManager $manager = null;
 
+    public ?string $message = null;
+
     public function __construct(
         ?string $message = null
     ) {
@@ -27,12 +29,14 @@ public function __construct(
             $message = $this->getMessage();
         }
 
+        $this->message = $message;
+
         $this->manager->add(
-            $this->toMessage($message)
+            $this->asZabbixMessage($message)
         );
     }
 
-    protected function toMessage(string $message): Message
+    protected function asZabbixMessage(string $message): Message
     {
         $hostConfiguration = $this->getValidConfiguration();
 
@@ -74,7 +78,7 @@ public function usingServer(array $configuration): ZabbixAlert
      *
      * @return bool|Response
      */
-    public function send(): mixed
+    public function send()
     {
         return $this->manager->send();
     }
@@ -90,4 +94,9 @@ public function toZabbix($notifiable): ZabbixAlert
     {
         return $this;
     }
+
+    public function getAlertMessage(): string
+    {
+        return $this->message;
+    }
 }