Refactor existing tests

Author: patrickrobrecht

tests/Feature/Auth/AuthenticationTest.php renamed to tests/Feature/Http/Auth/AuthenticationTest.php

@@ -1,25 +1,23 @@
 <?php
 
-namespace Tests\Feature\Auth;
+namespace Tests\Feature\Http\Auth;
 
+use App\Http\Controllers\Auth\AuthenticatedSessionController;
 use App\Models\User;
 use App\Options\ActiveStatus;
 use App\Providers\RouteServiceProvider;
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use PHPUnit\Framework\Attributes\CoversClass;
 use Tests\TestCase;
 
-/**
- * @covers \App\Http\Controllers\Auth\AuthenticatedSessionController
- */
+#[CoversClass(AuthenticatedSessionController::class)]
 class AuthenticationTest extends TestCase
 {
     use RefreshDatabase;
 
     public function testLoginScreenCanBeRendered(): void
     {
-        $response = $this->get('/login');
-
-        $response->assertStatus(200);
+        $this->assertRouteAccessibleAsGuest('/login');
     }
 
     public function testUsersCanAuthenticateUsingTheLoginScreen(): void

tests/Feature/Auth/EmailVerificationTest.php renamed to tests/Feature/Http/Auth/EmailVerificationTest.php

@@ -1,20 +1,22 @@
 <?php
 
-namespace Tests\Feature\Auth;
+namespace Tests\Feature\Http\Auth;
 
+use App\Http\Controllers\Auth\EmailVerificationNotificationController;
+use App\Http\Controllers\Auth\EmailVerificationPromptController;
+use App\Http\Controllers\Auth\VerifyEmailController;
 use App\Models\User;
 use App\Providers\RouteServiceProvider;
 use Illuminate\Auth\Events\Verified;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\URL;
+use PHPUnit\Framework\Attributes\CoversClass;
 use Tests\TestCase;
 
-/**
- * @covers \App\Http\Controllers\Auth\EmailVerificationNotificationController
- * @covers \App\Http\Controllers\Auth\EmailVerificationPromptController
- * @covers \App\Http\Controllers\Auth\VerifyEmailController
- */
+#[CoversClass(EmailVerificationNotificationController::class)]
+#[CoversClass(EmailVerificationPromptController::class)]
+#[CoversClass(VerifyEmailController::class)]
 class EmailVerificationTest extends TestCase
 {
     use RefreshDatabase;
@@ -25,9 +27,7 @@ public function testEmailVerificationScreenCanBeRendered(): void
             'email_verified_at' => null,
         ]);
 
-        $response = $this->actingAs($user)->get('/verify-email');
-
-        $response->assertStatus(200);
+        $this->actingAs($user)->get('/verify-email')->assertOk();
     }
 
     public function testEmailCanBeVerified(): void

tests/Feature/Auth/PasswordConfirmationTest.php renamed to tests/Feature/Http/Auth/PasswordConfirmationTest.php

@@ -1,14 +1,14 @@
 <?php
 
-namespace Tests\Feature\Auth;
+namespace Tests\Feature\Http\Auth;
 
+use App\Http\Controllers\Auth\ConfirmablePasswordController;
 use App\Models\User;
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use PHPUnit\Framework\Attributes\CoversClass;
 use Tests\TestCase;
 
-/**
- * @covers \App\Http\Controllers\Auth\ConfirmablePasswordController
- */
+#[CoversClass(ConfirmablePasswordController::class)]
 class PasswordConfirmationTest extends TestCase
 {
     use RefreshDatabase;

tests/Feature/Auth/PasswordResetTest.php renamed to tests/Feature/Http/Auth/PasswordResetTest.php

@@ -1,26 +1,25 @@
 <?php
 
-namespace Tests\Feature\Auth;
+namespace Tests\Feature\Http\Auth;
 
+use App\Http\Controllers\Auth\NewPasswordController;
+use App\Http\Controllers\Auth\PasswordResetLinkController;
 use App\Models\User;
 use App\Notifications\ResetPasswordNotification;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Support\Facades\Notification;
+use PHPUnit\Framework\Attributes\CoversClass;
 use Tests\TestCase;
 
-/**
- * @covers \App\Http\Controllers\Auth\NewPasswordController
- * @covers \App\Http\Controllers\Auth\PasswordResetLinkController
- */
+#[CoversClass(NewPasswordController::class)]
+#[CoversClass(PasswordResetLinkController::class)]
 class PasswordResetTest extends TestCase
 {
     use RefreshDatabase;
 
     public function testResetPasswordLinkScreenCanBeRendered(): void
     {
-        $response = $this->get('/forgot-password');
-
-        $response->assertStatus(200);
+        $this->assertRouteAccessibleAsGuest('/forgot-password');
     }
 
     public function testResetPasswordLinkCanBeRequested(): void

tests/Feature/Auth/RegistrationTest.php renamed to tests/Feature/Http/Auth/RegistrationTest.php

@@ -1,33 +1,31 @@
 <?php
 
-namespace Tests\Feature\Auth;
+namespace Tests\Feature\Http\Auth;
 
+use App\Http\Controllers\Auth\RegisteredUserController;
 use App\Providers\RouteServiceProvider;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Support\Facades\Config;
+use PHPUnit\Framework\Attributes\CoversClass;
 use Tests\TestCase;
 
-/**
- * @covers \App\Http\Controllers\Auth\RegisteredUserController
- */
+#[CoversClass(RegisteredUserController::class)]
 class RegistrationTest extends TestCase
 {
     use RefreshDatabase;
 
     public function testRegistrationScreenCannotBeRenderedIfNotEnabled(): void
     {
-        $response = $this->get('/register');
+        Config::set('app.features.registration', false);
 
-        $response->assertStatus(403);
+        $this->get('/register')->assertForbidden();
     }
 
     public function testRegistrationScreenCanBeRenderedIfEnabled(): void
     {
         Config::set('app.features.registration', true);
 
-        $response = $this->get('/register');
-
-        $response->assertStatus(200);
+        $this->assertRouteAccessibleAsGuest('/register');
     }
 
     public function testNewUsersCanRegister(): void

tests/Feature/DashboardTest.php renamed to tests/Feature/Http/DashboardTest.php

@@ -1,21 +1,19 @@
 <?php
 
-namespace Tests\Feature;
+namespace Tests\Feature\Http;
 
+use App\Http\Controllers\DashboardController;
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use PHPUnit\Framework\Attributes\CoversClass;
 use Tests\TestCase;
 
-/**
- * @covers \App\Http\Controllers\DashboardController
- */
+#[CoversClass(DashboardController::class)]
 class DashboardTest extends TestCase
 {
     use RefreshDatabase;
 
     public function testTheApplicationReturnsSuccessfulResponse(): void
     {
-        $response = $this->get('/');
-
-        $response->assertStatus(200);
+        $this->assertRouteAccessibleAsGuest('/');
     }
 }

tests/Feature/UI/UserControllerTest.php renamed to tests/Feature/Http/UserControllerTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Tests\Feature\UI;
+namespace Tests\Feature\Http;
 
 use App\Http\Controllers\UserController;
 use App\Models\User;
@@ -17,14 +17,24 @@ class UserControllerTest extends TestCase
 {
     use RefreshDatabase;
 
-    public function testCanViewUsers(): void
+    public function testUsersCanBeListedWithCorrectAbility(): void
     {
         $this->assertRouteOnlyAccessibleOnlyWithAbility('/users', Ability::ViewUsers);
     }
 
-    public function testUserCanBeCreated(): void
+    public function testUserIsOnlyAccessibleWithCorrectAbility(): void
+    {
+        $this->assertRouteOnlyAccessibleOnlyWithAbility("/users/{$this->createRandomUser()->id}", Ability::ViewUsers);
+    }
+
+    public function testCreateUserFormIsOnlyAccessibleWithCorrectAbility(): void
     {
         $this->assertRouteOnlyAccessibleOnlyWithAbility('/users/create', Ability::CreateUsers);
+    }
+
+    public function testUserIsStored(): void
+    {
+        $this->actingAsUserWithAbility(Ability::CreateUsers);
 
         Notification::fake();
 
@@ -46,9 +56,9 @@ public function testUserCanBeCreated(): void
         Notification::assertNothingSent();
     }
 
-    public function testUserIsNotifiedIfEnabled(): void
+    public function testUserIsStoredAndNotifiedIfEnabled(): void
     {
-        $this->assertRouteOnlyAccessibleOnlyWithAbility('/users/create', Ability::CreateUsers);
+        $this->actingAsUserWithAbility(Ability::CreateUsers);
 
         Notification::fake();
 
@@ -68,4 +78,14 @@ public function testUserIsNotifiedIfEnabled(): void
 
         Notification::assertSentTo($user, AccountCreatedNotification::class);
     }
+
+    public function testEditUserFormIsAccessibleOnlyWithCorrectAbility(): void
+    {
+        $this->assertRouteOnlyAccessibleOnlyWithAbility("/users/{$this->createRandomUser()->id}/edit", Ability::EditUsers);
+    }
+
+    private function createRandomUser(): User
+    {
+        return User::factory()->create();
+    }
 }

tests/Feature/Livewire/Groups/EditGroupTest.php

@@ -8,9 +8,11 @@
 use App\Models\Location;
 use Illuminate\Support\Str;
 use Livewire\Livewire;
+use PHPUnit\Framework\Attributes\CoversClass;
 use Tests\TestCase;
 use Tests\Traits\ActsAsUser;
 
+#[CoversClass(EditGroup::class)]
 class EditGroupTest extends TestCase
 {
     use ActsAsUser;

tests/Feature/Livewire/Groups/ManageGroupsTest.php

@@ -1,16 +1,18 @@
 <?php
 
-namespace Livewire\Groups;
+namespace Tests\Feature\Livewire\Groups;
 
 use App\Livewire\Groups\ManageGroups;
 use App\Models\Event;
 use App\Models\Group;
 use App\Models\Location;
 use Illuminate\Database\Eloquent\Factories\Sequence;
 use Livewire\Livewire;
+use PHPUnit\Framework\Attributes\CoversClass;
 use Tests\TestCase;
 use Tests\Traits\ActsAsUser;
 
+#[CoversClass(ManageGroups::class)]
 class ManageGroupsTest extends TestCase
 {
     use ActsAsUser;

tests/Traits/ActsAsUser.php

@@ -65,6 +65,12 @@ protected function actingAsUserWithRoleName(string $roleName): User
         return $this->actingAsUserWithRole($adminRole);
     }
 
+    protected function assertRouteAccessibleAsGuest(string $route): void
+    {
+        Auth::logout(); // to make sure we act as a guest
+        $this->get($route)->assertOk();
+    }
+
     protected function assertRouteAccessibleWithAbility(string $route, Ability $ability): void
     {
         $this->actingAsUserWithAbility($ability);