Merge pull request #38 from RonasIT/37-php-unit-9-support

#feat: implement compatibility with PHPUnit 9

Author: astorozhevsky

readme.md

@@ -26,14 +26,26 @@ to display the generated documentation for a config.
 ### Plugin
  1. Add middleware **\RonasIT\Support\AutoDoc\Http\Middleware\AutoDocMiddleware::class** to *Http/Kernel.php*.
  1. Use **\RonasIT\Support\AutoDoc\Tests\AutoDocTestCaseTrait** in your TestCase in *tests/TestCase.php*
- 1. Call `saveDocumentation` method in the `TearDown` method of your base TestCase class
  1. In *config/auto-doc.php* you can specify enabling of plugin, info of your project, 
  some defaults descriptions and route for rendering of documentation. 
  1. In *.env* file you should add following lines
     `
     LOCAL_DATA_COLLECTOR_PROD_PATH=/example-folder/documentation.json  
     LOCAL_DATA_COLLECTOR_TEMP_PATH=/tmp/documentation.json
     `
+ 1. Configure documentation saving, using one of the next way:
+  - Add `SwaggerExtension` to the `<extensions>` block of your `phpunit.xml`. Please note that this way will be removed after updating PHPUnit up to 10 version (https://github.com/sebastianbergmann/phpunit/issues/4676)
+  ```
+  <extensions>
+      <extension class="RonasIT\Support\AutoDoc\Tests\PhpUnitExtensions\SwaggerExtension"/>
+  </extensions>
+  <testsuites>
+      <testsuite name="Feature">
+          <directory suffix="Test.php">./tests/Feature</directory>
+      </testsuite>
+  </testsuites>
+  ```
+  - Call `php artisan swagger:push-documentation` console command after the `tests` stage in your CI/CD configuration
 
 ## Usages
  For correct working of plugin you have to dispose all the validation rules in the rules() method of class YourRequest, 

src/AutoDocServiceProvider.php

@@ -3,6 +3,7 @@
 namespace RonasIT\Support\AutoDoc;
 
 use Illuminate\Support\ServiceProvider;
+use RonasIT\Support\AutoDoc\Commands\PushDocumentationCommand;
 
 class AutoDocServiceProvider extends ServiceProvider
 {
@@ -24,6 +25,10 @@ public function boot()
             require __DIR__ . '/Http/routes.php';
         }
 
+        $this->commands([
+            PushDocumentationCommand::class
+        ]);
+
         $this->loadViewsFrom(__DIR__ . '/Views', 'auto-doc');
     }
 

src/Commands/PushDocumentationCommand.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace RonasIT\Support\AutoDoc\Commands;
+
+use Illuminate\Console\Command;
+use RonasIT\Support\AutoDoc\Services\SwaggerService;
+
+class PushDocumentationCommand extends Command
+{
+    protected $signature = 'swagger:push-documentation';
+    protected $description = 'Push swagger collected documentation';
+
+    public function handle(): int
+    {
+        app(SwaggerService::class)->saveProductionData();
+
+        return 0;
+    }
+}

src/Services/SwaggerService.php

@@ -543,24 +543,23 @@ protected function parseRequestName($request)
 
     protected function getResponseDescription($code)
     {
+        $defaultDescription = Response::$statusTexts[$code];
+
         $request = $this->getConcreteRequest();
 
-        return elseChain(
-            function () use ($request, $code) {
-                return empty($request) ? Response::$statusTexts[$code] : null;
-            },
-            function () use ($request, $code) {
-                $annotations = $this->getClassAnnotations($request);
-
-                return Arr::get($annotations, "_{$code}");
-            },
-            function () use ($code) {
-                return config("auto-doc.defaults.code-descriptions.{$code}");
-            },
-            function () use ($code) {
-                return Response::$statusTexts[$code];
-            }
-        );
+        if (empty($request)) {
+            return $defaultDescription;
+        }
+
+        $annotations = $this->getClassAnnotations($request);
+
+        $localDescription = Arr::get($annotations, "_{$code}");
+
+        if (!empty($localDescription)) {
+            return $localDescription;
+        }
+
+        return config("auto-doc.defaults.code-descriptions.{$code}", $defaultDescription);
     }
 
     protected function getActionName($uri)

src/Tests/AutoDocTestCaseTrait.php

@@ -2,36 +2,10 @@
 
 namespace RonasIT\Support\AutoDoc\Tests;
 
-use RonasIT\Support\AutoDoc\Services\SwaggerService;
 use RonasIT\Support\AutoDoc\Http\Middleware\AutoDocMiddleware;
 
 trait AutoDocTestCaseTrait
 {
-    public $docService;
-
-    public function createApplication()
-    {
-        parent::createApplication();
-    }
-
-    public function tearDown(): void
-    {
-        $this->saveDocumentation();
-
-        parent::tearDown();
-    }
-
-    public function saveDocumentation()
-    {
-        $currentTestCount = $this->getTestResultObject()->count();
-        $allTestCount = $this->getTestResultObject()->topTestSuite()->count();
-
-        if (($currentTestCount == $allTestCount) && (!$this->hasFailed())) {
-            $docService = $this->docService ?? app(SwaggerService::class);
-            $docService->saveProductionData();
-        }
-    }
-
     /**
      * Disabling documentation collecting on current test
      */

src/Tests/PhpUnitExtensions/SwaggerExtension.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace RonasIT\Support\AutoDoc\Tests\PhpUnitExtensions;
+
+use PHPUnit\Runner\AfterLastTestHook;
+use Illuminate\Foundation\Application;
+use Illuminate\Contracts\Console\Kernel;
+use RonasIT\Support\AutoDoc\Services\SwaggerService;
+
+/**
+ * This interface, as well as the associated mechanism for extending PHPUnit,
+ * will be removed in PHPUnit 10. There is no alternative available in this
+ * version of PHPUnit.
+ *
+ * @see https://github.com/sebastianbergmann/phpunit/issues/4676
+ */
+class SwaggerExtension implements AfterLastTestHook
+{
+    public function executeAfterLastTest(): void
+    {
+        $this->createApplication();
+
+        app(SwaggerService::class)->saveProductionData();
+    }
+
+    protected function createApplication(): Application
+    {
+        $app = require __DIR__ . '/../../../../../../bootstrap/app.php';
+
+        $app->loadEnvironmentFrom('.env.testing');
+        $app->make(Kernel::class)->bootstrap();
+
+        return $app;
+    }
+}