add exceptions and tests mockup notifications mails

Author: JAVI-CC

app/Exceptions/RecoveryPasswordException.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace App\Exceptions;
+
+use Exception;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Throwable;
+
+class RecoveryPasswordException extends Exception
+{
+  public function __construct(
+    string $message = "The password could not be reset at this time, please try again later",
+    int $code = Response::HTTP_INTERNAL_SERVER_ERROR,
+    ?Throwable $previous = null
+  ) {
+    parent::__construct($message, $code, $previous);
+  }
+
+  public function render(Request $request)
+  {
+    if ($request->isJson())
+      return response()->json(['message' => __($this->message)], $this->code);
+  }
+}

app/Exceptions/RegisteredException.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace App\Exceptions;
+
+use Exception;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Throwable;
+
+class RegisteredException extends Exception
+{
+  public function __construct(
+    string $message,
+    int $code = Response::HTTP_INTERNAL_SERVER_ERROR,
+    ?Throwable $previous = null
+  ) {
+    parent::__construct($message, $code, $previous);
+  }
+
+  public function render(Request $request)
+  {
+    if ($request->isJson())
+      return response()->json(['message' => __($this->message)], $this->code);
+  }
+}

app/Http/Controllers/AuthController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use App\Exceptions\RecoveryPasswordException;
 use App\Http\Requests\User\ChangePasswordRequest;
 use App\Http\Requests\User\LoginRequest;
 use App\Http\Requests\User\RecoveryPasswordRequest;
@@ -50,7 +51,7 @@ public function recoveryPassword(RecoveryPasswordRequest $request): JsonResponse
     try {
       $user->notify(new RecoveryPasswordNotification());
     } catch (\Exception $e) {
-      return response()->json(['message' => __('The password could not be reset at this time, please try again later')], 500);
+      throw new RecoveryPasswordException();
     }
 
     return response()->json(['message' => __('In a few moments you will receive an email to reset your password. Check your mailbox')], 200);

app/Http/Controllers/UserController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use App\Exceptions\RegisteredException;
 use App\Exports\UsersExport;
 use App\Http\Requests\User\UserAddRequest;
 use App\Http\Requests\User\UserUpdateRequest;
@@ -49,7 +50,7 @@ public function store(UserAddRequest $request): JsonResponse
         $mediaService->deleteFile();
 
       DB::rollBack();
-      return response()->json(['message' => $e->getMessage()], 500);
+      throw new RegisteredException($e->getMessage());
     }
 
     DB::commit();

app/Models/User.php

@@ -129,7 +129,7 @@ public static function countAdmins(): int
 
   public static function getAllUsers(): Collection
   {
-    return Cache::remember(User::CACHE_KEY, now()->addDay(), function () {
+    return Cache::remember(User::CACHE_KEY, (int)now()->addDay()->diffInSeconds(), function () {
       return User::With(['rol'])->orderBy('nombre')->get();
     });
   }

app/Notifications/VerifiedNotification.php

@@ -15,7 +15,7 @@ class VerifiedNotification extends Notification implements ShouldQueue
   /**
    * Create a new notification instance.
    */
-  public function __construct(private bool $isVerified)
+  public function __construct(public bool $isVerified)
   {
   }
 

tests/Feature/AuthTest.php

@@ -5,7 +5,13 @@
 use App\Mail\RecoveryPasswordMail;
 use App\Mail\VerifiedMail;
 use App\Models\User;
+use App\Notifications\RecoveryPasswordNotification;
+use App\Notifications\VerifiedNotification;
+use Illuminate\Auth\Events\Verified;
 use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\Mail;
+use Illuminate\Support\Facades\Notification;
 use Illuminate\Support\Str;
 use Laravel\Sanctum\Sanctum;
 use Tests\TestCase;
@@ -76,17 +82,21 @@ public function test_cambiar_el_password_del_user(): void
 
   public function test_llamar_al_endpoint_restablecer_password(): void
   {
+    Notification::fake();
     $data = ['email' => 'user@email.com'];
-    Sanctum::actingAs($this->createNewUser());
+    $user = $this->createNewUser();
+    Sanctum::actingAs($user);
 
     $res = $this->postJson(self::PATH . 'recovery/password', $data);
 
+    Notification::assertSentTo([$user], RecoveryPasswordNotification::class, fn ($notification, $channels, $notifiable) => (in_array('mail', $channels)));
     $res->assertStatus(200);
     $res->assertExactJson(['message' => __('In a few moments you will receive an email to reset your password. Check your mailbox')]);
   }
 
   public function test_email_restablecer_password(): void
   {
+    Mail::fake();
     $data = ['email' => 'user@email.com'];
     $user = $this->createNewUser();
 
@@ -99,26 +109,33 @@ public function test_email_restablecer_password(): void
 
   public function test_llamar_al_endpoint_verificacion_usuario_ya_verificado(): void
   {
-    Sanctum::actingAs($this->createNewUser());
+    Notification::fake();
+    $user = $this->createNewUser();
+    Sanctum::actingAs($user);
 
     $res = $this->postJson(self::PATH_USER . 'verification/email/notification');
 
+    Notification::assertSentTo([$user], VerifiedNotification::class, fn ($notification, $channels, $notifiable) => (in_array('broadcast', $channels) && $notification->isVerified));
     $res->assertStatus(200);
     $res->assertExactJson(['message' => __('Email already verified')]);
   }
 
   public function test_llamar_al_endpoint_verificacion_usuario_no_verificado(): void
   {
-    Sanctum::actingAs($this->createNewUser(false, false));
+    Notification::fake();
+    $user = $this->createNewUser(false, false);
+    Sanctum::actingAs($user);
 
     $res = $this->postJson(self::PATH_USER . 'verification/email/notification');
 
+    Notification::assertNotSentTo([$user], VerifiedNotification::class);
     $res->assertStatus(200);
     $res->assertExactJson(['message' => __('Email forwarded successfully')]);
   }
 
   public function test_email_verificar_usuario(): void
   {
+    Mail::fake();
     $data = ['email' => 'user@email.com'];
     $url = config('app.DOMAIN_FRONTEND') . "/auth/verification/email" . Str::random(10) . "&token=" . Str::random(10);
     $user = $this->createNewUser(false, false);
@@ -133,26 +150,34 @@ public function test_email_verificar_usuario(): void
 
   public function test_verificar_usuario(): void
   {
+    Notification::fake();
+    Event::fake();
     $data = ['email' => 'user@email.com'];
     $user = $this->createNewUser(false, false);
     Sanctum::actingAs($user);
 
     $res = $this->getJson(self::PATH_USER . 'verification/email/' . $user->id . '/' . sha1($data['email']));
 
+    Notification::assertSentTo([$user], VerifiedNotification::class, fn ($notification, $channels, $notifiable) => (in_array('broadcast', $channels) && $notification->isVerified));
+    Event::assertDispatched(Verified::class);
     $this->assertNotNull($user->email_verified_at);
     $res->assertStatus(200);
     $res->assertExactJson(['message' => __('Email has been verified')]);
   }
 
   public function test_verificar_usuario_ya_verificado(): void
   {
+    Notification::fake();
+    Event::fake();
     $data = ['email' => 'user@email.com'];
     $user = $this->createNewUser(false);
     $emailVerifiedAt = $user->email_verified_at;
     Sanctum::actingAs($user);
 
     $res = $this->getJson(self::PATH_USER . 'verification/email/' . $user->id . '/' . sha1($data['email']));
 
+    Notification::assertSentTo([$user], VerifiedNotification::class, fn ($notification, $channels, $notifiable) => (in_array('broadcast', $channels) && $notification->isVerified));
+    Event::assertNotDispatched(Verified::class);
     $this->assertEquals($emailVerifiedAt, $user->email_verified_at);
     $res->assertStatus(200);
     $res->assertExactJson(['message' => __('Email already verified')]);

tests/Feature/UserTest.php

@@ -4,11 +4,15 @@
 
 use App\Exports\UsersExport;
 use App\Models\User;
+use Closure;
+use Illuminate\Auth\Events\Registered;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Foundation\Testing\DatabaseMigrations;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Foundation\Testing\WithFaker;
 use Illuminate\Http\UploadedFile;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Storage;
 use Laravel\Sanctum\Sanctum;
 use Maatwebsite\Excel\Facades\Excel;
@@ -28,10 +32,11 @@ public function test_obtener_todos_los_users(): void
     $userAuth = $this->createNewUser(true);
     $this->createMutipleUser(5);
     $users = User::With(['rol'])->orderBy('nombre')->get();
+    Cache::shouldReceive('remember')->once()->with('users', (int)now()->addDay()->diffInSeconds(), Closure::class)->andReturn($users);
     Sanctum::actingAs($userAuth);
-
+    
     $res = $this->getJson(self::PATH);
-
+    
     $res->assertStatus(200);
     $res->assertExactJson($this->getResourceCollectionUsers($users));
   }
@@ -51,6 +56,7 @@ public function test_obtener_user_mediante_id(): void
 
   public function test_crear_user(): void
   {
+    Event::fake();
     Storage::fake(self::FAKE_STORAGE);
     Sanctum::actingAs($this->createNewUser(true));
     $data = [
@@ -66,6 +72,7 @@ public function test_crear_user(): void
     $res = $this->postJson(self::PATH, $data);
     $user = User::Where('email', 'test@laravel.com')->first();
 
+    Event::assertDispatched(Registered::class);
     $this->assertEquals($data['nombre'], $user->nombre);
     $this->assertEquals($data['apellidos'], $user->apellidos);
     $this->assertEquals($data['email'], $user->email);