Testing improvements (make more robust) (#71)

* Update AccountControllerTest.php

* Update LoginControllerTest.php

* Update EmailVerificationControllerTest.php

* Update LogoutControllerTest.php

* Update OrganisationControllerTest.php

* Update RegisterControllerTest.php

* Update ResetPasswordControllerTest.php

Author: SebKay

.env.example

@@ -9,6 +9,7 @@ BCRYPT_ROUNDS=12
 
 SEED_SUPER_ADMIN_EMAIL=super@laravel-inertia-template.test
 SEED_ADMIN_EMAIL=admin@laravel-inertia-template.test
+SEED_USER_EMAIL=user@laravel-inertia-template.test
 
 LOG_CHANNEL=stack
 LOG_STACK=single

.env.testing

@@ -9,6 +9,7 @@ BCRYPT_ROUNDS=4
 
 SEED_SUPER_ADMIN_EMAIL=super@laravel-inertia-template.test
 SEED_ADMIN_EMAIL=admin@laravel-inertia-template.test
+SEED_USER_EMAIL=user@laravel-inertia-template.test
 
 LOG_CHANNEL=stack
 LOG_STACK=single

database/factories/UserFactory.php

@@ -52,4 +52,15 @@ public function admin(?string $email = null)
                 $user->assignRole(Role::ADMIN->value);
             });
     }
+
+    public function user(?string $email = null)
+    {
+        return $this
+            ->state(fn (array $attributes) => [
+                'email' => $email ?: \env('SEED_USER_EMAIL'),
+            ])
+            ->afterCreating(function (User $user) {
+                $user->assignRole(Role::USER->value);
+            });
+    }
 }

tests/Feature/Controllers/AccountControllerTest.php

@@ -4,8 +4,8 @@
 use Illuminate\Support\Facades\Hash;
 use Inertia\Testing\AssertableInertia as Assert;
 
+use function Pest\Faker\fake;
 use function Pest\Laravel\actingAs;
-use function Pest\Laravel\from;
 use function Pest\Laravel\get;
 use function Pest\Laravel\patch;
 
@@ -28,23 +28,23 @@
 
     test('Can update their details', function () {
         $user = User::factory()->create([
-            'first_name' => 'Jim',
-            'last_name' => 'Gordon',
-            'email' => 'jim@test.com',
-            'password' => 'oldPassword#123',
+            'first_name' => fake()->firstName(),
+            'last_name' => fake()->lastName(),
+            'email' => fake()->safeEmail(),
+            'password' => fake()->password(),
         ]);
 
-        from(route('account.edit'))
-            ->actingAs($user)
+        actingAs($user)
+            ->fromRoute('account.edit')
             ->patch(route('account.update'), $newData = [
-                'first_name' => 'Tim',
-                'last_name' => 'Drake',
-                'email' => 'tim@test.com',
-                'password' => 'newPassword#123',
+                'first_name' => fake()->firstName(),
+                'last_name' => fake()->lastName(),
+                'email' => fake()->safeEmail(),
+                'password' => 'newPassword123#',
             ])
-            ->assertRedirectToRoute('account.edit')
             ->assertSessionDoesntHaveErrors()
-            ->assertSessionHas('success', __('account.updated'));
+            ->assertSessionHas('success', __('account.updated'))
+            ->assertRedirectToRoute('account.edit');
 
         expect($user->refresh())
             ->first_name->toBe($newData['first_name'])
@@ -55,23 +55,27 @@
     });
 
     test("Can't update their email to one that already exists", function () {
-        User::factory()->create([
-            'email' => 'jim@test.com',
+        $user1 = User::factory()->create([
+            'email' => fake()->email(),
         ]);
 
-        $user = User::factory()->create([
-            'email' => 'jeff@test.com',
+        $oldEmail = fake()->email();
+
+        $user2 = User::factory()->create([
+            'email' => $oldEmail,
         ]);
 
-        actingAs($user)
-            ->from(route('account.edit'))
-            ->patch(route('account.update'), $newData = [
-                'email' => 'jim@test.com',
+        actingAs($user2)
+            ->fromRoute('account.edit')
+            ->patch(route('account.update'), [
+                'email' => $user1->email,
+            ])
+            ->assertSessionHasErrors([
+                'email' => __('validation.unique', ['attribute' => 'email']),
             ])
-            ->assertSessionHasErrors('email')
             ->assertRedirectToRoute('account.edit');
 
-        expect($user->refresh()->email)->not()->toBe($newData['email']);
+        expect($user2->refresh()->email)->toBe($oldEmail);
     });
 });
 
@@ -83,6 +87,7 @@
 
     test("Can't update details", function () {
         patch(route('account.update'))
+            ->assertSessionDoesntHaveErrors()
             ->assertRedirectToRoute('login');
     });
 });

tests/Feature/Controllers/EmailVerificationControllerTest.php

@@ -5,9 +5,7 @@
 use Inertia\Testing\AssertableInertia as Assert;
 
 use function Pest\Laravel\actingAs;
-use function Pest\Laravel\from;
 use function Pest\Laravel\get;
-use function Pest\Laravel\withoutExceptionHandling;
 
 describe('Users', function () {
     test('Can access the verification page', function () {
@@ -21,8 +19,6 @@
     });
 
     test('Can verify their email address', function () {
-        withoutExceptionHandling();
-
         $user = User::factory()->unverified()->create();
 
         expect($user->verified_at)->toBeNull();
@@ -44,8 +40,8 @@
 
         $user = User::factory()->unverified()->create();
 
-        from(route('verification.notice'))
-            ->actingAs($user)
+        actingAs($user)
+            ->fromRoute('verification.notice')
             ->post(route('verification.send'))
             ->assertSessionDoesntHaveErrors()
             ->assertRedirectToRoute('verification.notice');

tests/Feature/Controllers/LoginControllerTest.php

@@ -3,6 +3,7 @@
 use App\Models\User;
 use Inertia\Testing\AssertableInertia as Assert;
 
+use function Pest\Faker\fake;
 use function Pest\Laravel\actingAs;
 use function Pest\Laravel\assertAuthenticated;
 use function Pest\Laravel\assertGuest;
@@ -29,13 +30,16 @@
     });
 
     test('Can login', function () {
+        $password = fake()->password();
         $user = User::factory()->create([
-            'password' => '12345',
+            'password' => $password,
         ]);
 
+        assertGuest();
+
         post(route('login'), [
             'email' => $user->email,
-            'password' => '12345',
+            'password' => $password,
         ])
             ->assertSessionDoesntHaveErrors()
             ->assertRedirectToRoute('home');
@@ -44,34 +48,43 @@
     });
 
     test('Can be redirected after login', function () {
+        $password = fake()->password();
         $user = User::factory()->create([
-            'password' => '12345',
+            'password' => $password,
         ]);
 
-        $redirect = 'https://google.com';
+        $redirectUrl = 'https://www.google.com/';
+
+        assertGuest();
 
         from(route('login'))
             ->post(route('login'), [
                 'email' => $user->email,
-                'password' => '12345',
-                'redirect' => $redirect,
+                'password' => $password,
+                'redirect' => $redirectUrl,
             ])
             ->assertSessionDoesntHaveErrors()
-            ->assertRedirect($redirect);
+            ->assertRedirect($redirectUrl);
 
         assertAuthenticated();
     });
 
     test("Can't login with invalid credentials", function () {
         $user = User::factory()->create([
-            'password' => '12345',
+            'password' => fake()->password(),
         ]);
 
-        post(route('login'), [
-            'email' => $user->email,
-            'password' => 'test',
-        ])
-            ->assertSessionHasErrors();
+        assertGuest();
+
+        from(route('login'))
+            ->post(route('login'), [
+                'email' => $user->email,
+                'password' => 'test',
+            ])
+            ->assertSessionHasErrors([
+                'email' => __('auth.failed'),
+            ])
+            ->assertRedirectToRoute('login');
 
         assertGuest();
     });

tests/Feature/Controllers/LogoutControllerTest.php

@@ -3,13 +3,17 @@
 use App\Models\User;
 
 use function Pest\Laravel\actingAs;
+use function Pest\Laravel\assertAuthenticated;
 use function Pest\Laravel\assertGuest;
 use function Pest\Laravel\post;
 
 describe('Users', function () {
     test('Can logout', function () {
-        actingAs(User::factory()->create())
-            ->post(route('logout'))
+        actingAs(User::factory()->create());
+
+        assertAuthenticated();
+
+        post(route('logout'))
             ->assertSessionDoesntHaveErrors()
             ->assertRedirectToRoute('login');
 

tests/Feature/Controllers/OrganisationControllerTest.php

@@ -3,18 +3,20 @@
 use App\Models\User;
 use Inertia\Testing\AssertableInertia as Assert;
 
+use function Pest\Faker\fake;
 use function Pest\Laravel\actingAs;
-use function Pest\Laravel\from;
 use function Pest\Laravel\get;
 use function Pest\Laravel\patch;
 
 beforeEach(function () {
     $this->adminUser = User::factory()
-        ->admin('admin@test.com')
+        ->admin(fake()->email())
         ->create();
 
+    $this->orgName = fake()->company();
+
     $this->adminUser->organisations()->create([
-        'name' => 'GCPD',
+        'name' => $this->orgName,
     ]);
 
     $this->adminUser->organisation()->associate($this->adminUser->organisations->first())->save();
@@ -32,23 +34,27 @@
     });
 
     test("Can update their organisation's name", function () {
-        expect($this->adminUser->organisation->name)->toBe('GCPD');
+        expect($this->adminUser->organisation->name)->toBe($this->orgName);
 
-        from(route('organisation.edit'))
-            ->actingAs($this->adminUser)
-            ->patch(route('organisation.update'), [
-                'name' => 'New Name',
-            ])
+        $data = [
+            'name' => fake()->company(),
+        ];
+
+        actingAs($this->adminUser)
+            ->fromRoute('organisation.edit')
+            ->patch(route('organisation.update'), $data)
             ->assertSessionDoesntHaveErrors()
             ->assertRedirectToRoute('organisation.edit');
 
-        expect($this->adminUser->organisation->refresh()->name)->toBe('New Name');
+        expect($this->adminUser->organisation->refresh()->name)->toBe($data['name']);
     });
 });
 
 describe('Non-Admins', function () {
     test("Can't see the edit page for their organisation", function () {
-        $user = User::factory()->create();
+        $user = User::factory()
+            ->user(fake()->email())
+            ->create();
 
         $user->organisations()->save($this->adminUser->organisation);
         $user->organisation()->associate($user->organisations->first())->save();
@@ -59,20 +65,22 @@
     });
 
     test("Can't update their organisation's name", function () {
-        $user = User::factory()->create();
+        $user = User::factory()
+            ->user(fake()->email())
+            ->create();
 
         $user->organisations()->save($this->adminUser->organisation);
         $user->organisation()->associate($user->organisations->first())->save();
 
-        expect($user->organisation->name)->toBe('GCPD');
+        expect($user->organisation->name)->toBe($this->orgName);
 
         actingAs($user)
             ->patch(route('organisation.update'), [
                 'name' => 'New Name',
             ])
             ->assertForbidden();
 
-        expect($user->organisation->refresh()->name)->toBe('GCPD');
+        expect($user->organisation->refresh()->name)->toBe($this->orgName);
     });
 });
 

tests/Feature/Controllers/RegisterControllerTest.php

@@ -7,6 +7,8 @@
 use function Pest\Laravel\actingAs;
 use function Pest\Laravel\assertAuthenticated;
 use function Pest\Laravel\assertDatabaseHas;
+use function Pest\Laravel\assertGuest;
+use function Pest\Laravel\from;
 use function Pest\Laravel\get;
 use function Pest\Laravel\post;
 
@@ -32,12 +34,14 @@
         $orgName = fake()->company();
         $email = fake()->email();
 
+        assertGuest();
+
         post(route('register.store'), [
             'organisation_name' => $orgName,
             'first_name' => fake()->firstName(),
             'last_name' => fake()->lastName(),
             'email' => $email,
-            'password' => 'P$ssword12345#',
+            'password' => 'Pa$$word12345#',
         ])
             ->assertSessionDoesntHaveErrors()
             ->assertRedirectToRoute('home');
@@ -62,13 +66,17 @@
             'email' => $email,
         ]);
 
-        post(route('register.store'), [
-            'organisation_name' => fake()->company(),
-            'first_name' => fake()->firstName(),
-            'last_name' => fake()->lastName(),
-            'email' => $email,
-            'password' => 'P$ssword12345#',
-        ])
-            ->assertSessionHasErrors('email');
+        from(route('register'))
+            ->post(route('register.store'), [
+                'organisation_name' => fake()->company(),
+                'first_name' => fake()->firstName(),
+                'last_name' => fake()->lastName(),
+                'email' => $email,
+                'password' => 'P$ssword12345#',
+            ])
+            ->assertSessionHasErrors([
+                'email' => __('validation.unique', ['attribute' => 'email']),
+            ])
+            ->assertRedirectToRoute('register');
     });
 });