Added test for HttpClientLogger::addRequestMiddleware()

pascalbaljet · pascalbaljet · commit 27b535c84fc8 · 2023-11-08T20:55:24.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,10 @@
-/vendor/
+.phpunit.cache
+.phpunit.result.cache
+.pint.cache.json
 /.idea
 /composer.lock
 /tests/_coverage
-.phpunit.result.cache
-.pint.cache.json
+/vendor/
+build
+coverage
+phpunit.xml
diff --git a/composer.json b/composer.json
@@ -34,15 +34,32 @@
     },
     "require-dev": {
         "laravel/framework": "^10.0",
-        "laravel/pint": "^1.10"
+        "laravel/pint": "^1.10",
+        "orchestra/testbench": "^8.8",
+        "pestphp/pest": "^2.20",
+        "pestphp/pest-plugin-arch": "^2.0",
+        "pestphp/pest-plugin-laravel": "^2.0"
     },
     "autoload": {
         "psr-4": {
             "Onlime\\LaravelHttpClientGlobalLogger\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Onlime\\LaravelHttpClientGlobalLogger\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/pest",
+        "test-coverage": "vendor/bin/pest --coverage",
+        "format": "vendor/bin/pint"
+    },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     },
     "extra": {
         "laravel": {
@@ -53,4 +70,4 @@
     },
     "minimum-stability": "stable",
     "prefer-stable": true
-}
+}
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd"
+    backupGlobals="false"
+    bootstrap="vendor/autoload.php"
+    colors="true"
+    processIsolation="false"
+    stopOnFailure="false"
+    executionOrder="random"
+    failOnWarning="true"
+    failOnRisky="true"
+    failOnEmptyTestSuite="true"
+    beStrictAboutOutputDuringTests="true"
+    cacheDirectory=".phpunit.cache"
+    backupStaticProperties="false"
+>
+    <testsuites>
+        <testsuite name="VendorName Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage>
+        <report>
+            <html outputDirectory="build/coverage"/>
+            <text outputFile="build/coverage.txt"/>
+            <clover outputFile="build/logs/clover.xml"/>
+        </report>
+    </coverage>
+    <logging>
+        <junit outputFile="build/report.junit.xml"/>
+    </logging>
+    <source>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
+</phpunit>
diff --git a/tests/ExampleTest.php b/tests/ExampleTest.php
@@ -0,0 +1,37 @@
+<?php
+
+use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Log;
+use Onlime\LaravelHttpClientGlobalLogger\HttpClientLogger;
+use Psr\Http\Message\RequestInterface;
+use Psr\Log\LoggerInterface;
+
+it('can add a global request middleware to log the requests', function () {
+    Http::globalRequestMiddleware(
+        fn (RequestInterface $psrRequest) => $psrRequest->withHeader('X-Test', 'test')
+    );
+
+    HttpClientLogger::addRequestMiddleware();
+
+    $logger = Mockery::mock(LoggerInterface::class);
+
+    Log::shouldReceive('channel')->with('http-client')->andReturn($logger);
+
+    $logger->shouldReceive('info')->withArgs(function ($message) {
+        expect($message)
+            ->toContain('REQUEST: GET https://example.com')
+            ->and($message)
+            ->toContain('X-Test: test');
+
+        return true;
+    })->once()->andReturnSelf();
+
+    $logger->shouldReceive('info')->withArgs(function ($message) {
+        expect($message)
+            ->toContain('RESPONSE: HTTP/1.1 200 OK');
+
+        return true;
+    })->once()->andReturnSelf();
+
+    Http::fake()->get('https://example.com');
+});
diff --git a/tests/Pest.php b/tests/Pest.php
@@ -0,0 +1,5 @@
+<?php
+
+use Onlime\LaravelHttpClientGlobalLogger\Tests\TestCase;
+
+uses(TestCase::class)->in(__DIR__);
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Onlime\LaravelHttpClientGlobalLogger\Tests;
+
+use Onlime\LaravelHttpClientGlobalLogger\Providers\ServiceProvider;
+use Orchestra\Testbench\TestCase as Orchestra;
+
+class TestCase extends Orchestra
+{
+    protected function getPackageProviders($app)
+    {
+        return [
+            ServiceProvider::class,
+        ];
+    }
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +<?php
++
 +use Onlime\LaravelHttpClientGlobalLogger\Tests\TestCase;
++
 +uses(TestCase::class)->in(__DIR__);