Merge pull request #91 from jmgoncalves97/add-continue-on-errors-option

added continue-on-errors option for use in specific cases such as end…

Author: andreaselia

README.md

@@ -54,6 +54,12 @@ The following usage will generate routes with the basic auth specified.
 php artisan export:postman --basic="username:password123"
 ```
 
+The following usage will continue until the end, even if it has error or incompatible endpoints.
+
+```bash
+php artisan export:postman --continue-on-errors
+```
+
 If both auths are specified, bearer will be favored.
 
 ## Examples

phpunit.xml

@@ -1,5 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+<phpunit
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  bootstrap="vendor/autoload.php"
+  backupGlobals="false"
+  colors="true"
+  processIsolation="false"
+  stopOnFailure="false"
+  xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd"
+  cacheDirectory=".phpunit.cache"
+  backupStaticProperties="false"
+>
   <coverage/>
   <testsuites>
     <testsuite name="Unit">

src/Commands/ExportPostmanCommand.php

@@ -9,6 +9,7 @@
 use Illuminate\Contracts\Validation\ValidationRule;
 use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Routing\Router;
+use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Storage;
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\Str;
@@ -27,7 +28,8 @@ class ExportPostmanCommand extends Command
     /** @var string */
     protected $signature = 'export:postman
                             {--bearer= : The bearer token to use on your endpoints}
-                            {--basic= : The basic auth to use on your endpoints}';
+                            {--basic= : The basic auth to use on your endpoints}
+                            {--continue-on-errors : Continues even if an error occurs in any route, middleware or method (boolean)}';
 
     /** @var string */
     protected $description = 'Automatically generate a Postman collection for your API routes';
@@ -62,6 +64,9 @@ class ExportPostmanCommand extends Command
         'basic',
     ];
 
+    /** @var bool */
+    private $stopOnErrors = true;
+
     /** @var \Illuminate\Validation\Validator */
     private $validator;
 
@@ -77,12 +82,14 @@ public function handle(): void
     {
         $this->setFilename();
         $this->setAuthToken();
+        $this->setOptions();
         $this->initializeStructure();
         $this->initializePhpDocParser();
 
         foreach ($this->router->getRoutes() as $route) {
             $methods = array_filter($route->methods(), fn ($value) => $value !== 'HEAD');
-            $middlewares = $route->gatherMiddleware();
+
+            $middlewares = $this->handleCallable(fn () => $route->gatherMiddleware());
 
             foreach ($methods as $method) {
                 $includedMiddleware = false;
@@ -103,7 +110,7 @@ public function handle(): void
 
                 $routeAction = $route->getAction();
 
-                $reflectionMethod = $this->getReflectionMethod($routeAction);
+                $reflectionMethod = $this->handleCallable(fn () => $this->getReflectionMethod($routeAction));
 
                 if (! $reflectionMethod) {
                     continue;
@@ -223,6 +230,18 @@ public function handle(): void
         $this->info('Postman Collection Exported: '.storage_path('app/'.$exportName));
     }
 
+    protected function handleCallable($callable)
+    {
+        try {
+            return $callable();
+        } catch (\Throwable $th) {
+            if ($this->stopOnErrors) {
+                throw $th;
+            }
+            Log::error($th->getMessage()."\n[stacktrace]\n".$th->getTraceAsString()."\n");
+        }
+    }
+
     protected function getReflectionMethod(array $routeAction): ?object
     {
         // Hydrates the closure if it is an instance of Opis\Closure\SerializableClosure
@@ -489,6 +508,13 @@ protected function setAuthToken()
         }
     }
 
+    protected function setOptions()
+    {
+        if ($this->option('continue-on-errors') === true) {
+            $this->stopOnErrors = false;
+        }
+    }
+
     protected function isStructured()
     {
         return $this->config['structured'];

tests/Feature/ExportPostmanTest.php

@@ -119,6 +119,32 @@ public function test_basic_export_works(bool $formDataEnabled)
         }
     }
 
+    public function test_continue_on_errors_works()
+    {
+        $router = $this->app['router'];
+
+        $router->middleware('api')->group(function ($router) {
+            $router->get('endpoint/with/error', [NonExistentController::class, 'index']);
+            $router->get('endpoint/without/error', function () {
+                return 'index';
+            });
+        });
+
+        $this->artisan('export:postman --continue-on-errors')->assertExitCode(0);
+
+        $collection = json_decode(Storage::get('postman/'.config('api-postman.filename')), true);
+
+        $collectionRoute = Arr::first($collection['item'], function ($item) {
+            return $item['name'] == 'endpoint/without/error';
+        });
+        $this->assertNotNull($collectionRoute);
+
+        $collectionRoute = Arr::first($collection['item'], function ($item) {
+            return $item['name'] == 'endpoint/with/error';
+        });
+        $this->assertNull($collectionRoute);
+    }
+
     /**
      * @dataProvider providerFormDataEnabled
      */