feat: catch and report exception during Open-Api file validation (#45)

RonasIT · Oct 26, 2023 · 654e3f3 · 654e3f3
1 parent e53c27c
commit 654e3f3
Show file tree

Hide file tree

Showing 4 changed files with 244 additions and 21 deletions.
diff --git a/composer.json b/composer.json
@@ -23,7 +23,8 @@
   },
   "require-dev": {
     "orchestra/testbench": "^6.25",
-    "php-coveralls/php-coveralls": "^2.5"
+    "php-coveralls/php-coveralls": "^2.5",
+    "php-mock/php-mock-phpunit": "^2.7"
   },
   "autoload": {
     "psr-4": {

diff --git a/composer.lock b/composer.lock
diff --git a/src/Services/SwaggerService.php b/src/Services/SwaggerService.php
@@ -697,19 +697,19 @@ public function getDocFileContent()
         foreach ($additionalDocs as $filePath) {
             $fullFilePath = base_path($filePath);
 
-            if (!file_exists($fullFilePath)) {
-                throw new DocFileNotExistsException($fullFilePath);
-            }
+            try {
+                if (!file_exists($fullFilePath)) {
+                    throw new DocFileNotExistsException($fullFilePath);
+                }
 
-            $fileContent = json_decode(file_get_contents($fullFilePath), true);
+                $fileContent = json_decode(file_get_contents($fullFilePath), true);
 
-            if (empty($fileContent)) {
-                throw new EmptyDocFileException($fullFilePath);
-            }
+                if (empty($fileContent)) {
+                    throw new EmptyDocFileException($fullFilePath);
+                }
 
-            try {
                 $this->validateSpec($fileContent);
-            } catch (InvalidSwaggerSpecException $exception) {
+            } catch (DocFileNotExistsException|EmptyDocFileException|InvalidSwaggerSpecException $exception) {
                 report($exception);
 
                 continue;

diff --git a/tests/AutoDocControllerTest.php b/tests/AutoDocControllerTest.php
@@ -3,11 +3,13 @@
 namespace RonasIT\Support\Tests;
 
 use Illuminate\Http\Response;
-use RonasIT\Support\AutoDoc\Exceptions\DocFileNotExistsException;
-use RonasIT\Support\AutoDoc\Exceptions\EmptyDocFileException;
+use phpmock\phpunit\PHPMock;
+use RonasIT\Support\Tests\Support\Traits\MockTrait;
 
 class AutoDocControllerTest extends TestCase
 {
+    use MockTrait, PHPMock;
+
     protected $documentation;
     protected $localDriverFilePath;
 
@@ -52,32 +54,44 @@ public function testGetJSONDocumentationWithAdditionalPaths()
         $this->assertEqualsJsonFixture('tmp_data_with_additional_paths', $response->json());
     }
 
-    public function getJSONDocumentationDoesntExist()
+    public function testGetJSONDocumentationDoesntExist()
     {
+        $mock = $this->getFunctionMock('RonasIT\Support\AutoDoc\Services', 'report');
+        $mock->expects($this->once());
+
         config([
             'auto-doc.additional_paths' => ['invalid_path/non_existent_file.json']
         ]);
 
-        $this->expectException(DocFileNotExistsException::class);
+        $response = $this->json('get', '/auto-doc/documentation');
+
+        $response->assertStatus(Response::HTTP_OK);
 
-        $this->json('get', '/auto-doc/documentation');
+        $response->assertJson($this->documentation);
     }
 
-    public function getJSONDocumentationIsEmpty()
+    public function testGetJSONDocumentationIsEmpty()
     {
+        $mock = $this->getFunctionMock('RonasIT\Support\AutoDoc\Services', 'report');
+        $mock->expects($this->once());
+
         config([
             'auto-doc.additional_paths' => ['tests/fixtures/AutoDocControllerTest/documentation__non_json.txt']
         ]);
 
-        $this->expectException(EmptyDocFileException::class);
+        $response = $this->json('get', '/auto-doc/documentation');
 
-        $this->json('get', '/auto-doc/documentation');
+        $response->assertStatus(Response::HTTP_OK);
+
+        $response->assertJson($this->documentation);
     }
 
     public function testGetJSONDocumentationInvalidAdditionalDoc()
     {
         config([
-            'auto-doc.additional_paths' => ['tests/fixtures/AutoDocControllerTest/documentation__invalid_format__missing_field__paths.json']
+            'auto-doc.additional_paths' => [
+                'tests/fixtures/AutoDocControllerTest/documentation__invalid_format__missing_field__paths.json'
+            ]
         ]);
 
         $response = $this->json('get', '/auto-doc/documentation');