Add extensive unit test suite and configure PCOV coverage

.github/workflows/run-tests.yml

@@ -32,7 +32,7 @@ jobs:
         with:
           php-version: ${{ matrix.php }}
           tools: composer:v2
-          coverage: none
+          coverage: pcov
         env:
           update: true
 

.gitignore

@@ -3,6 +3,8 @@
 phpunit.xml
 .phpunit.cache
 .phpunit.result.cache
+clover.xml
+coverage-report
 composer.lock
 composer.phar
 vendor

.php-cs-fixer.dist.php

@@ -4,7 +4,11 @@
     ->in(__DIR__)
     ->exclude([
         "local-test",
+        "docker",
         ".github",
+        ".vscode",
+        ".phpunit.cache",
+        "docs",
         "vendor",
         "node_modules"
     ]);

README.md

@@ -71,7 +71,7 @@ This package requires **PHP >= 8.2** and supports **Laravel 12 and 13** (via `il
 
 | PHP | Laravel 12 | Laravel 13 |
 | --- | :---: | :---: |
-| 8.2 | ✅ | — (Laravel 13 requires PHP >= 8.3) |
+| 8.2 | ✅ | ❌ |
 | 8.3 | ✅ | ✅ |
 | 8.4 | ✅ | ✅ |
 | 8.5 | ✅ | ✅ |

docker/php/Dockerfile

@@ -6,7 +6,10 @@ RUN apt-get update \
         git \
         unzip \
         libzip-dev \
+        $PHPIZE_DEPS \
     && docker-php-ext-install zip \
+    && pecl install pcov \
+    && docker-php-ext-enable pcov \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 

src/CloudflareServiceProvider.php

@@ -30,9 +30,15 @@ private function setupConfig(): void
 
         if ($this->app instanceof LaravelApplication && $this->app->runningInConsole()) {
             $this->publishes([$source => $this->app->configPath('cloudflare.php')]);
-        } elseif ($this->app instanceof LumenApplication) {
+        }
+        // @codeCoverageIgnoreStart
+        // Lumen is discontinued and not an installed dependency here (only
+        // referenced for interface compatibility); this branch cannot be
+        // exercised without adding a dependency on an abandoned framework.
+        elseif ($this->app instanceof LumenApplication) {
             $this->app->configure('cloudflare');
         }
+        // @codeCoverageIgnoreEnd
 
         $this->mergeConfigFrom($source, 'cloudflare');
     }

src/Configurations/Rules/CacheSettingsRule.php

@@ -12,6 +12,6 @@ class CacheSettingsRule extends Rule
 
     protected function getActionParameters(): ?array
     {
-
+        return null;
     }
 }

src/Configurations/Rules/ExecuteRule.php

@@ -12,6 +12,6 @@ class ExecuteRule extends Rule
 
     protected function getActionParameters(): ?array
     {
-
+        return null;
     }
 }

src/Configurations/Rules/LogCustomFieldRule.php

@@ -12,6 +12,6 @@ class LogCustomFieldRule extends Rule
 
     protected function getActionParameters(): ?array
     {
-
+        return null;
     }
 }

src/Configurations/Rules/OriginRule.php

@@ -12,6 +12,6 @@ class OriginRule extends Rule
 
     protected function getActionParameters(): ?array
     {
-
+        return null;
     }
 }

src/Configurations/Rules/RedirectRule.php

@@ -12,6 +12,6 @@ class RedirectRule extends Rule
 
     protected function getActionParameters(): ?array
     {
-
+        return null;
     }
 }

src/Configurations/Rules/RewriteRule.php

@@ -12,6 +12,6 @@ class RewriteRule extends Rule
 
     protected function getActionParameters(): ?array
     {
-
+        return null;
     }
 }

src/Configurations/Rules/ScoreRule.php

@@ -12,6 +12,6 @@ class ScoreRule extends Rule
 
     protected function getActionParameters(): ?array
     {
-
+        return null;
     }
 }

src/Configurations/Rules/ServeErrorRule.php

@@ -12,6 +12,6 @@ class ServeErrorRule extends Rule
 
     protected function getActionParameters(): ?array
     {
-
+        return null;
     }
 }

src/Configurations/Rules/SkipRule.php

@@ -40,6 +40,6 @@ public function disableLogging(): self
 
     protected function getActionParameters(): ?array
     {
-
+        return null;
     }
 }

src/Endpoints/Workers/Routes.php

@@ -35,7 +35,7 @@ public function create(string $zoneId, array $values): ResponseInterface
     {
         $this->requiredParams(['pattern'], $values);
 
-        return $this->$this->getHttpClient()->post("/zones/{$zoneId}/workers/routes", $values);
+        return $this->getHttpClient()->post("/zones/{$zoneId}/workers/routes", $values);
     }
 
     /**

src/Endpoints/Zones/PageRules.php

@@ -55,7 +55,7 @@ public function create(string $zoneId, array|PageRule $values): ResponseInterfac
             $values = $values->toArray();
         }
 
-        return $this->$this->getHttpClient()->post("/zones/{$zoneId}/pagerules", $values);
+        return $this->getHttpClient()->post("/zones/{$zoneId}/pagerules", $values);
     }
 
     /**

src/Exceptions/MissingArgumentException.php

@@ -9,7 +9,7 @@ class MissingArgumentException extends \ErrorException
      * @param int            $code
      * @param \Throwable|null $previous
      */
-    public function __construct($required, int $code = 0, \Throwable $previous = null)
+    public function __construct($required, int $code = 0, ?\Throwable $previous = null)
     {
         if (is_string($required)) {
             $required = [$required];

src/HttpClient/Response.php

@@ -114,13 +114,17 @@ public function get($target, $key, $default = null)
         foreach ($key as $i => $segment) {
             unset($key[$i]);
 
+            // @codeCoverageIgnoreStart
+            // $key is always exploded into string segments above, so $segment
+            // can never actually be null or a float; kept as defensive guards.
             if (is_null($segment)) {
                 return $target;
             }
 
             if (is_float($segment)) {
                 $segment = (string) $segment;
             }
+            // @codeCoverageIgnoreEnd
 
             if (is_array($target) && array_key_exists($segment, $target)) {
                 $target = $target[$segment];

test/Tests/Configurations/Rules/BlockRuleTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Cloudflare\Tests\Configurations\Rules;
+
+use Cloudflare\Configurations\Rules\BlockRule;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class BlockRuleTest extends TestCase
+{
+    #[Test]
+    public function shouldBuildArray()
+    {
+        $rule = new BlockRule(['error' => 'blocked'], 'application/json', 403);
+
+        $array = $rule->toArray();
+
+        $this->assertSame('block', $array['action']);
+        $this->assertSame([
+            'response' => [
+                'content' => ['error' => 'blocked'],
+                'content_type' => 'application/json',
+                'status_code' => 403,
+            ],
+        ], $array['action_parameters']);
+    }
+}

test/Tests/Configurations/Rules/CacheSettingsRuleTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Cloudflare\Tests\Configurations\Rules;
+
+use Cloudflare\Configurations\Rules\CacheSettingsRule;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class CacheSettingsRuleTest extends TestCase
+{
+    #[Test]
+    public function shouldBuildArray()
+    {
+        $rule = new CacheSettingsRule();
+
+        $array = $rule->toArray();
+
+        $this->assertSame('set_cache_settings', $array['action']);
+        $this->assertArrayNotHasKey('action_parameters', $array);
+    }
+}

test/Tests/Configurations/Rules/ChallengeRuleTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Cloudflare\Tests\Configurations\Rules;
+
+use Cloudflare\Configurations\Rules\ChallengeRule;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class ChallengeRuleTest extends TestCase
+{
+    #[Test]
+    public function shouldBuildArray()
+    {
+        $rule = new ChallengeRule();
+
+        $array = $rule->toArray();
+
+        $this->assertSame('challenge', $array['action']);
+        $this->assertArrayNotHasKey('action_parameters', $array);
+    }
+}

test/Tests/Configurations/Rules/CompressionRuleTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Cloudflare\Tests\Configurations\Rules;
+
+use Cloudflare\Configurations\Rules\CompressionRule;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class CompressionRuleTest extends TestCase
+{
+    #[Test]
+    public function shouldBuildArray()
+    {
+        $rule = new CompressionRule('gzip');
+
+        $array = $rule->toArray();
+
+        $this->assertSame('compress_response', $array['action']);
+        $this->assertSame(['algorithms' => ['name' => 'gzip']], $array['action_parameters']);
+    }
+}

test/Tests/Configurations/Rules/ConfigRuleTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Cloudflare\Tests\Configurations\Rules;
+
+use Cloudflare\Configurations\Rules\ConfigRule;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class ConfigRuleTest extends TestCase
+{
+    #[Test]
+    public function shouldBuildArray()
+    {
+        $rule = new ConfigRule();
+
+        $array = $rule->toArray();
+
+        $this->assertSame('set_config', $array['action']);
+        $this->assertSame(['ssl' => 'flexible'], $array['action_parameters']);
+    }
+}

test/Tests/Configurations/Rules/DDoSDynamicRuleTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Cloudflare\Tests\Configurations\Rules;
+
+use Cloudflare\Configurations\Rules\DDoSDynamicRule;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class DDoSDynamicRuleTest extends TestCase
+{
+    #[Test]
+    public function shouldBuildArray()
+    {
+        $rule = new DDoSDynamicRule();
+
+        $array = $rule->toArray();
+
+        $this->assertSame('ddos_dynamic', $array['action']);
+        $this->assertArrayNotHasKey('action_parameters', $array);
+    }
+}

test/Tests/Configurations/Rules/ExecuteRuleTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Cloudflare\Tests\Configurations\Rules;
+
+use Cloudflare\Configurations\Rules\ExecuteRule;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class ExecuteRuleTest extends TestCase
+{
+    #[Test]
+    public function shouldBuildArray()
+    {
+        $rule = new ExecuteRule();
+
+        $array = $rule->toArray();
+
+        $this->assertSame('execute', $array['action']);
+        $this->assertArrayNotHasKey('action_parameters', $array);
+    }
+}

test/Tests/Configurations/Rules/ForceConnectionCloseRuleTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Cloudflare\Tests\Configurations\Rules;
+
+use Cloudflare\Configurations\Rules\ForceConnectionCloseRule;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class ForceConnectionCloseRuleTest extends TestCase
+{
+    #[Test]
+    public function shouldBuildArray()
+    {
+        $rule = new ForceConnectionCloseRule();
+
+        $array = $rule->toArray();
+
+        $this->assertSame('force_connection_close', $array['action']);
+        $this->assertArrayNotHasKey('action_parameters', $array);
+    }
+}

test/Tests/Configurations/Rules/JSChallengeRuleTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Cloudflare\Tests\Configurations\Rules;
+
+use Cloudflare\Configurations\Rules\JSChallengeRule;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class JSChallengeRuleTest extends TestCase
+{
+    #[Test]
+    public function shouldBuildArray()
+    {
+        $rule = new JSChallengeRule();
+
+        $array = $rule->toArray();
+
+        $this->assertSame('js_challenge', $array['action']);
+        $this->assertArrayNotHasKey('action_parameters', $array);
+    }
+}