Merge pull request #8 from mailcarrierapp/feat/tests

danilopolani · web-flow · commit fef5d77a0a22 · 2023-03-30T17:04:29.000+02:00
Add tests
diff --git a/composer.json b/composer.json
@@ -37,6 +37,7 @@
         "nunomaduro/larastan": "^2.0.1",
         "orchestra/testbench": "^7.0",
         "pestphp/pest": "^1.21",
+        "pestphp/pest-plugin-faker": "^1.0",
         "pestphp/pest-plugin-laravel": "^1.1",
         "phpstan/extension-installer": "^1.1",
         "phpstan/phpstan-deprecation-rules": "^1.0",
diff --git a/composer.lock b/composer.lock
diff --git a/database/factories/AttachmentFactory.php b/database/factories/AttachmentFactory.php
@@ -16,6 +16,7 @@ public function definition(): array
         return [
             'log_id' => Log::factory(),
             'strategy' => AttachmentLogStrategy::None,
+            'name' => $this->faker->slug() . '.pdf',
             'size' => $this->faker->numberBetween(1, 10000),
             'path' => $this->faker->filePath(),
             'disk' => null,
diff --git a/database/migrations/1_create_users_table.php b/database/migrations/1_create_users_table.php
@@ -4,8 +4,7 @@
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class extends Migration {
     /**
      * Run the migrations.
      */
diff --git a/database/migrations/2_create_layouts_table.php b/database/migrations/2_create_layouts_table.php
@@ -4,8 +4,7 @@
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class extends Migration {
     /**
      * Run the migrations.
      */
diff --git a/database/migrations/3_create_templates_table.php b/database/migrations/3_create_templates_table.php
@@ -4,8 +4,7 @@
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
-return new class extends Migration
-{
+return new class extends Migration {
     /**
      * Run the migrations.
      */
diff --git a/database/migrations/4_create_logs_table.php b/database/migrations/4_create_logs_table.php
@@ -5,8 +5,7 @@
 use Illuminate\Support\Facades\Schema;
 use MailCarrier\Models\Template;
 
-return new class extends Migration
-{
+return new class extends Migration {
     /**
      * Run the migrations.
      */
diff --git a/database/migrations/5_create_attachments_table.php b/database/migrations/5_create_attachments_table.php
@@ -5,8 +5,7 @@
 use Illuminate\Support\Facades\Schema;
 use MailCarrier\Models\Log;
 
-return new class extends Migration
-{
+return new class extends Migration {
     /**
      * Run the migrations.
      */
diff --git a/pint.json b/pint.json
@@ -7,6 +7,10 @@
             "spacing": "one"
         },
         "method_argument_space": true,
-        "single_trait_insert_per_statement": true
+        "single_trait_insert_per_statement": true,
+        "curly_braces_position": {
+            "anonymous_classes_opening_brace": "same_line"
+        },
+        "fully_qualified_strict_types": false
     }
 }
diff --git a/routes/web.php b/routes/web.php
@@ -8,7 +8,9 @@
 
 Route::middleware(['web', 'auth:' . Config::get('filament.auth.guard')])->group(function () {
     Route::get('preview/logs/{log}', [LogController::class, 'preview'])->name('logs.preview');
-    Route::get('attachment/{attachment}', [MailCarrierController::class, 'downloadAttachment'])->name('download.attachment');
+    Route::get('attachment/{attachment}', [MailCarrierController::class, 'downloadAttachment'])
+        ->whereUuid('attachment')
+        ->name('download.attachment');
 });
 
 Route::prefix('auth')->middleware(['web', 'guest'])->group(function () {
diff --git a/src/Actions/Attachments/Download.php b/src/Actions/Attachments/Download.php
@@ -21,7 +21,7 @@ class Download extends Action
     public function run(Attachment $attachment): ?GenericFile
     {
         if ($attachment->strategy === AttachmentLogStrategy::Upload) {
-            if (!MailCarrier::storage($attachment->disk)->exists($attachment->path)) {
+            if (!MailCarrier::fileExists($attachment->path, $attachment->disk)) {
                 throw new AttachmentNotFoundException($attachment);
             }
         }
diff --git a/src/Actions/Auth/EnsureAuthManagerExists.php b/src/Actions/Auth/EnsureAuthManagerExists.php
@@ -14,7 +14,7 @@ class EnsureAuthManagerExists extends Action
     public function run(): User
     {
         return User::query()->firstOrCreate([
-            'email' => AuthEnum::AuthManagerEmail,
+            'email' => AuthEnum::AuthManagerEmail->value,
         ], [
             'name' => 'Auth Manager',
             'password' => null,
diff --git a/src/Actions/Logs/CreateFromGenericMail.php b/src/Actions/Logs/CreateFromGenericMail.php
@@ -17,7 +17,7 @@
 class CreateFromGenericMail extends Action
 {
     /**
-     * Insert multiple logs at once.
+     * Create a log with attachments.
      */
     public function run(GenericMailDto $genericMailDto): Log
     {
diff --git a/src/Facades/MailCarrier.php b/src/Facades/MailCarrier.php
@@ -13,9 +13,10 @@
  * @method static void validateSocialAuth(\Laravel\Socialite\AbstractUser $user)
  * @method static string|null getSocialAuthDriver()
  * @method static \Illuminate\Contracts\Filesystem\Filesystem storage(?string $disk = null)
+ * @method static bool fileExists(string $resource, ?string $disk = null)
  * @method static string upload(string $content, string $fileName)
  * @method static string|null download(string $resource, ?string $disk = null)
- * @method static int downloadgetFileSize(string $resource, ?string $disk = null)
+ * @method static int getFileSize(string $resource, ?string $disk = null)
  * @method static string humanBytes(int $bytes)
  *
  * @see \MailCarrier\MailCarrierManager
diff --git a/src/Mail/GenericMail.php b/src/Mail/GenericMail.php
@@ -64,4 +64,12 @@ public function build(): self
                 fn (GenericMail $mail) => $mail->bcc($this->params->bcc->email, $this->params->bcc->name)
             );
     }
+
+    /**
+     * Test the mail content against the given value.
+     */
+    public function hasHtml(string $html): bool
+    {
+        return $this->html === $html;
+    }
 }
diff --git a/src/MailCarrierManager.php b/src/MailCarrierManager.php
@@ -95,6 +95,14 @@ public function storage(?string $disk = null): Filesystem
         return Storage::disk($disk ?: Config::get('mailcarrier.attachments.disk'));
     }
 
+    /**
+     * Determine if the a file exists on the disk.
+     */
+    public function fileExists(string $resource, ?string $disk = null): bool
+    {
+        return $this->storage($disk)->exists($resource);
+    }
+
     /**
      * Upload a file to the storage disk.
      *
diff --git a/src/Pages/Dashboard.php b/src/Pages/Dashboard.php
@@ -6,7 +6,7 @@
 
 class Dashboard extends BasePage
 {
-    protected function getColumns(): int | array
+    protected function getColumns(): int|array
     {
         return 3;
     }
diff --git a/src/Widgets/SentFailureChartWidget.php b/src/Widgets/SentFailureChartWidget.php
@@ -11,7 +11,7 @@ class SentFailureChartWidget extends LineChartWidget
 {
     protected static ?string $pollingInterval = null;
 
-    protected int | string | array $columnSpan = 2;
+    protected int|string|array $columnSpan = 2;
 
     public ?string $filter = 'today';
 
diff --git a/tests/Feature/Attachments/DownloadTest.php b/tests/Feature/Attachments/DownloadTest.php
@@ -0,0 +1,79 @@
+<?php
+
+use Illuminate\Http\JsonResponse;
+use MailCarrier\Enums\AttachmentLogStrategy;
+use MailCarrier\Facades\MailCarrier;
+use MailCarrier\Models\Attachment;
+use function Pest\Faker\faker;
+use function Pest\Laravel\getJson;
+
+it('blocks guests', function () {
+    getJson(route('download.attachment', faker()->uuid()))
+        ->assertUnauthorized();
+});
+
+it('throws not found if the attachment does not exist', function () {
+    actingAsUser()
+        ->getJson(route('download.attachment', faker()->uuid()))
+        ->assertNotFound();
+});
+
+it('throws error when strategy is Upload and file does not exist on disk', function () {
+    $attachment = Attachment::factory()->create([
+        'strategy' => AttachmentLogStrategy::Upload,
+    ]);
+
+    MailCarrier::shouldReceive('fileExists')
+        ->andReturn(false);
+
+    actingAsUser()
+        ->getJson(route('download.attachment', $attachment))
+        ->assertStatus(JsonResponse::HTTP_PRECONDITION_FAILED)
+        ->assertJsonPath('key', 'ATTACHMENT_NOT_FOUND_ON_DISK');
+});
+
+it('throws error when strategy is None', function () {
+    $attachment = Attachment::factory()->create([
+        'strategy' => AttachmentLogStrategy::None,
+    ]);
+
+    actingAsUser()
+        ->getJson(route('download.attachment', $attachment))
+        ->assertStatus(JsonResponse::HTTP_PRECONDITION_FAILED)
+        ->assertJsonPath('key', 'ATTACHMENT_NOT_DOWNLOADABLE');
+});
+
+it('downloads file from db when strategy is Inline', function () {
+    $attachment = Attachment::factory()->create([
+        'strategy' => AttachmentLogStrategy::Inline,
+        'name' => 'file.pdf',
+        'content' => base64_encode('foo'),
+    ]);
+
+    actingAsUser()
+        ->getJson(route('download.attachment', $attachment))
+        ->assertOk()
+        ->assertDownload('file.pdf');
+});
+
+it('downloads file from disk when strategy is Upload', function () {
+    $attachment = Attachment::factory()->create([
+        'strategy' => AttachmentLogStrategy::Upload,
+        'name' => 'file.pdf',
+        'path' => 'foo/bar.pdf',
+        'disk' => 'fake-disk',
+        'content' => null,
+    ]);
+
+    MailCarrier::shouldReceive('fileExists')
+        ->andReturn(true);
+
+    MailCarrier::shouldReceive('download')
+        ->with('foo/bar.pdf', 'fake-disk')
+        ->andReturn(base64_encode('foo'));
+
+    actingAsUser()
+        ->getJson(route('download.attachment', $attachment))
+        ->assertOk()
+        ->assertDownload('file.pdf');
+});
diff --git a/tests/Feature/Auth/EnsureAuthManagerExistsTest.php b/tests/Feature/Auth/EnsureAuthManagerExistsTest.php
@@ -0,0 +1,27 @@
+<?php
+
+use MailCarrier\Actions\Auth\EnsureAuthManagerExists;
+use MailCarrier\Models\User;
+use function Pest\Laravel\assertDatabaseCount;
+
+it('creates the auth manager user if does not exist', function () {
+    assertDatabaseCount(User::class, 0);
+
+    $result = EnsureAuthManagerExists::resolve()->run();
+
+    assertDatabaseCount(User::class, 1);
+    expect($result->email)->toBe('auth@mailcarrier.app');
+});
+
+it('returns the auth manager user if already exists', function () {
+    $user = User::factory()->create([
+        'email' => 'auth@mailcarrier.app',
+    ]);
+
+    assertDatabaseCount(User::class, 1);
+
+    $result = EnsureAuthManagerExists::resolve()->run();
+
+    assertDatabaseCount(User::class, 1);
+    expect($result->id)->toBe($user->id);
+});
diff --git a/tests/Feature/Auth/SocialLoginTest.php b/tests/Feature/Auth/SocialLoginTest.php
@@ -0,0 +1,64 @@
+<?php
+
+use Laravel\Socialite\AbstractUser;
+use MailCarrier\Actions\Auth\SocialLogin;
+use MailCarrier\Models\User;
+use function Pest\Faker\faker;
+use function Pest\Laravel\assertDatabaseCount;
+
+it('creates user if does not exist', function () {
+    assertDatabaseCount(User::class, 0);
+
+    $abstractUser = new class extends AbstractUser {};
+    $abstractUser->id = faker()->uuid();
+    $abstractUser->name = faker()->name();
+    $abstractUser->email = faker()->email();
+    $abstractUser->avatar = faker()->imageUrl();
+    $abstractUser->user = ['foo' => 'bar'];
+
+    SocialLogin::resolve()->run($abstractUser);
+
+    assertDatabaseCount(User::class, 1);
+
+    /** @var User */
+    $user = User::first();
+
+    expect($user->oauth_id)->not->toBeNull()->toBe($abstractUser->getId());
+    expect($user->name)->not->toBeNull()->toBe($abstractUser->getName());
+    expect($user->email)->not->toBeNull()->toBe($abstractUser->getEmail());
+    expect($user->picture_url)->not->toBeNull()->toBe($abstractUser->getAvatar());
+    expect($user->oauth_raw)->not->toBeNull()->toBe($abstractUser->getRaw());
+});
+
+it('updates user if already exists by oauth ID', function () {
+    /** @var User */
+    $user = User::factory()->create([
+        'name' => 'foo',
+        'email' => 'foo@example.org',
+        'picture_url' => null,
+        'oauth_id' => $oauthId = faker()->uuid(),
+        'oauth_raw' => ['foo' => 'bar'],
+    ]);
+
+    assertDatabaseCount(User::class, 1);
+
+    $abstractUser = new class extends AbstractUser {};
+    $abstractUser->id = $oauthId;
+    $abstractUser->name = faker()->name();
+    $abstractUser->email = faker()->email();
+    $abstractUser->avatar = faker()->imageUrl();
+    $abstractUser->user = ['foo2' => 'bar2'];
+
+    SocialLogin::resolve()->run($abstractUser);
+
+    assertDatabaseCount(User::class, 1);
+
+    /** @var User */
+    $user = User::first();
+
+    expect($user->oauth_id)->not->toBeNull()->toBe($oauthId);
+    expect($user->name)->not->toBeNull()->toBe($abstractUser->getName());
+    expect($user->email)->not->toBeNull()->toBe($abstractUser->getEmail());
+    expect($user->picture_url)->not->toBeNull()->toBe($abstractUser->getAvatar());
+    expect($user->oauth_raw)->not->toBeNull()->toBe($abstractUser->getRaw());
+});
diff --git a/tests/Feature/DbTest.php b/tests/Feature/DbTest.php
diff --git a/tests/Feature/Logs/CreateFromGenericMailTest.php b/tests/Feature/Logs/CreateFromGenericMailTest.php
diff --git a/tests/Feature/Logs/GetTriggersTest.php b/tests/Feature/Logs/GetTriggersTest.php
diff --git a/tests/Feature/Logs/UpdateTest.php b/tests/Feature/Logs/UpdateTest.php
diff --git a/tests/Feature/SendMailTest.php b/tests/Feature/SendMailTest.php
diff --git a/tests/Feature/Templates/FindBySlugTest.php b/tests/Feature/Templates/FindBySlugTest.php
diff --git a/tests/Feature/Templates/GenerateSlugTest.php b/tests/Feature/Templates/GenerateSlugTest.php
diff --git a/tests/Feature/Templates/RenderTest.php b/tests/Feature/Templates/RenderTest.php
diff --git a/tests/Pest.php b/tests/Pest.php

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,10 @@`
`7`	`7`	`"spacing": "one"`
`8`	`8`	`},`
`9`	`9`	`"method_argument_space": true,`
`10`		`- "single_trait_insert_per_statement": true`
	`10`	`+ "single_trait_insert_per_statement": true,`
	`11`	`+ "curly_braces_position": {`
	`12`	`+ "anonymous_classes_opening_brace": "same_line"`
	`13`	`+ },`
	`14`	`+ "fully_qualified_strict_types": false`
`11`	`15`	`}`
`12`	`16`	`}`