Added Controller Unit tests

Author: le0daniel

src/Http/Controllers/ImageController.php

@@ -8,15 +8,15 @@
 
 namespace le0daniel\Laravel\ImageEngine\Http\Controllers;
 
+use Illuminate\Http\JsonResponse;
 use Illuminate\Routing\Controller as BaseController;
-use Illuminate\Support\Facades\Log;
 use le0daniel\Laravel\ImageEngine\Image\ImageException;
 use le0daniel\Laravel\ImageEngine\Image\ImageEngine;
 use le0daniel\Laravel\ImageEngine\Utility\SignatureException;
 use le0daniel\Laravel\ImageEngine\Utility\Signatures;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 
-class ImageController extends BaseController
+final class ImageController extends BaseController
 {
     private ImageEngine $imageEngine;
 
@@ -25,20 +25,22 @@ public function __construct(ImageEngine $imageEngine)
         $this->imageEngine = $imageEngine;
     }
 
-    private function expired()
+    private function jsonResponse(array $data, int $statusCode = 200): JsonResponse
     {
-        return response()->json(
-            [
-                'error' => 'Expired'
-            ],
-            410
-        );
+        return new JsonResponse($data, $statusCode);
+    }
+
+    private function expired(): JsonResponse
+    {
+        return $this->jsonResponse(['error' => 'Expired',], 410);
     }
 
     public function image(string $folder, string $path, string $extension)
     {
         try {
-            $imageRepresentation = $this->imageEngine->getImageFromSignedString($folder . Signatures::SIGNATURE_STRING_SEPARATOR . $path);
+            $imageRepresentation = $this->imageEngine->getImageFromSignedString(
+                $folder . Signatures::SIGNATURE_STRING_SEPARATOR . $path
+            );
             if ($imageRepresentation->isExpired) {
                 return $this->expired();
             }
@@ -55,21 +57,9 @@ public function image(string $folder, string $path, string $extension)
                 $imageRepresentation->cacheControlHeaders()
             );
         } catch (SignatureException $signatureException) {
-            Log::error('Image Rendering: ' . $signatureException->getMessage());
-            return response()->json(
-                [
-                    'Error' => 'Invalid signature provided',
-                ],
-                422
-            );
+            return $this->jsonResponse(['error' => 'Invalid signature provided'], 422);
         } catch (ImageException $error) {
-            Log::error('Image Rendering: ' . $error->getMessage() . ' => ' . $error->getHint());
-            return response()->json(
-                [
-                    'Error' => 'Internal rendering error',
-                ],
-                500
-            );
+            return $this->jsonResponse(['error' => 'Internal rendering error'], 500);
         }
     }
 

tests/Http/Controllers/ImageControllerTest.php

@@ -2,10 +2,14 @@
 
 namespace le0daniel\Tests\Laravel\ImageEngine\Http\Controllers;
 
+use Carbon\Carbon;
+use Illuminate\Http\JsonResponse;
 use Intervention\Image\ImageManager;
 use le0daniel\Laravel\ImageEngine\Http\Controllers\ImageController;
 use le0daniel\Laravel\ImageEngine\Image\ImageEngine;
+use le0daniel\Laravel\ImageEngine\Image\ImageException;
 use le0daniel\Laravel\ImageEngine\Image\ImageRepresentation;
+use le0daniel\Laravel\ImageEngine\Utility\SignatureException;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
@@ -25,6 +29,12 @@ protected function setUp(): void
         $this->imageController = new ImageController(
             $this->imageEngine->reveal()
         );
+
+        $this
+            ->imageEngine
+            ->render(Argument::type(ImageRepresentation::class), 'jpg', false)
+            ->willReturn(test_files('image.jpg'))
+        ;
     }
 
     public function testImage()
@@ -33,17 +43,53 @@ public function testImage()
             ImageRepresentation::from('path', 'medium')
         );
 
-        $this
-            ->imageEngine
-            ->render(Argument::type(ImageRepresentation::class), 'jpg', false)
-            ->willReturn(test_files('image.jpg'))
-        ;
-
         /** @var BinaryFileResponse $binaryFileResponse */
         $binaryFileResponse = $this->imageController->image('folder', 'string', 'jpg');
         $this->assertSame(
             test_files('image.jpg'),
             $binaryFileResponse->getFile()->getRealPath()
         );
     }
+
+    public function testExpired()
+    {
+        $this->imageEngine->getImageFromSignedString('folder::string')->willReturn(
+            ImageRepresentation::from('path', 'medium', Carbon::now()->subHour())
+        );
+
+        /** @var JsonResponse $jsonResponse */
+        $jsonResponse = $this->imageController->image('folder', 'string', 'jpg');
+        $this->assertSame(
+            410,
+            $jsonResponse->getStatusCode()
+        );
+    }
+
+    public function testInvalidSignature()
+    {
+        $this->imageEngine->getImageFromSignedString('folder::string')->willThrow(
+            new SignatureException('invalid sig')
+        );
+
+        /** @var JsonResponse $jsonResponse */
+        $jsonResponse = $this->imageController->image('folder', 'string', 'jpg');
+        $this->assertSame(
+            422,
+            $jsonResponse->getStatusCode()
+        );
+    }
+
+    public function testImageExceptionHandling()
+    {
+        $this->imageEngine->getImageFromSignedString('folder::string')->willThrow(
+            ImageException::withHint('test', 'value')
+        );
+
+        /** @var JsonResponse $jsonResponse */
+        $jsonResponse = $this->imageController->image('folder', 'string', 'jpg');
+        $this->assertSame(
+            500,
+            $jsonResponse->getStatusCode()
+        );
+    }
 }