Testing refactor (#43)

* Update UserTest.php

* User `describe` blocks for tests

* Update AccountControllerTest.php

* Change `inertia()->render()` to `inertia()`

* Create separate `LogoutController`

* Update RegisterController.php

* Seed an organisation for each admin user

* Use enum for roles

* Update 2023_11_21_161739_create_permission_tables.php

Author: SebKay

app/Http/Controllers/AccountController.php

@@ -10,7 +10,7 @@ class AccountController extends Controller
 {
     public function edit(Request $request)
     {
-        return \inertia()->render('Account/Edit', [
+        return \inertia('Account/Edit', [
             'user' => UserResource::make($request->user()),
         ]);
     }

app/Http/Controllers/HomeController.php

@@ -6,6 +6,6 @@ class HomeController extends Controller
 {
     public function index()
     {
-        return \inertia()->render('Home/Index');
+        return \inertia('Home/Index');
     }
 }

app/Http/Controllers/LoginController.php

@@ -12,7 +12,7 @@ public function show(Request $request)
     {
         $isProd = \app()->environment('production');
 
-        return \inertia()->render('Login/Show', [
+        return \inertia('Login/Show', [
             'email' => ! $isProd ? \env('SEED_ADMIN_EMAIL') : '',
             'password' => ! $isProd ? '12345' : '',
             'remember' => ! $isProd ? true : false,
@@ -23,7 +23,7 @@ public function show(Request $request)
     public function store(LoginStore $request)
     {
         \throw_if(
-            ! \auth()->attempt($request->only('email', 'password'), $request->validated('remember')),
+            ! \auth()->attempt($request->only('email', 'password'), $request->only('remember')),
             ValidationException::withMessages([
                 'email' => \__('auth.failed'),
             ])
@@ -37,14 +37,4 @@ public function store(LoginStore $request)
 
         return \redirect()->route('home');
     }
-
-    public function destroy(Request $request)
-    {
-        \auth()->logout();
-
-        $request->session()->invalidate();
-        $request->session()->regenerateToken();
-
-        return \redirect()->route('login');
-    }
 }

app/Http/Controllers/LogoutController.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use Illuminate\Http\Request;
+
+class LogoutController extends Controller
+{
+    public function __invoke(Request $request)
+    {
+        \auth()->logout();
+
+        $request->session()->invalidate();
+        $request->session()->regenerateToken();
+
+        return \redirect()->route('login');
+    }
+}

app/Http/Controllers/RegisterController.php

@@ -2,22 +2,21 @@
 
 namespace App\Http\Controllers;
 
+use App\Enums\Role;
 use App\Http\Requests\Register\RegisterStore;
 use App\Models\User;
 
 class RegisterController extends Controller
 {
     public function show()
     {
-        $isProd = \app()->environment('production');
-
-        return \inertia()->render('Register/Show', [
-            'first_name' => ! $isProd ? 'Jim' : '',
-            'last_name' => ! $isProd ? 'Gordon' : '',
-            'email' => ! $isProd ? 'test@test.com' : '',
-            'password' => ! $isProd ? '123456Ab#' : '',
-            'organisation_name' => ! $isProd ? 'GCPD' : '',
-        ]);
+        return \inertia('Register/Show', \app()->environment('local') ? [
+            'first_name' => 'Jim',
+            'last_name' => 'Gordon',
+            'email' => 'test@test.com',
+            'password' => '123456Ab#',
+            'organisation_name' => 'GCPD',
+        ] : []);
     }
 
     public function store(RegisterStore $request)
@@ -32,7 +31,7 @@ public function store(RegisterStore $request)
         ]);
         $user->currentOrganisation()->associate($user->organisations->first())->save();
 
-        $user->assignRole('user');
+        $user->assignRole(Role::USER->value);
 
         \auth()->loginUsingId($user->id);
 

app/Http/Middleware/HandleInertiaRequests.php

@@ -10,7 +10,7 @@ class HandleInertiaRequests extends Middleware
 {
     public function share(Request $request): array
     {
-        return array_merge(parent::share($request), [
+        return \array_merge(parent::share($request), [
             'auth' => [
                 'user' => $request->user() ? UserResource::make($request->user()) : [],
             ],

app/Models/User.php

@@ -4,6 +4,7 @@
 
 // use Illuminate\Contracts\Auth\MustVerifyEmail;
 
+use App\Enums\Role;
 use Filament\Models\Contracts\FilamentUser;
 use Filament\Models\Contracts\HasName;
 use Filament\Panel;
@@ -79,7 +80,7 @@ public function updatePassword(?string $new_password = '')
 
     public function canAccessPanel(Panel $panel): bool
     {
-        return $this->hasRole('admin');
+        return $this->hasRole(Role::ADMIN->value);
     }
 
     public function getFilamentName(): string

database/factories/UserFactory.php

@@ -2,6 +2,7 @@
 
 namespace Database\Factories;
 
+use App\Enums\Role;
 use App\Models\User;
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Illuminate\Support\Str;
@@ -33,7 +34,14 @@ public function unverified()
     public function admin()
     {
         return $this->afterCreating(function (User $user) {
-            $user->assignRole('admin');
+            $user->assignRole(Role::ADMIN->value);
+        });
+    }
+
+    public function user()
+    {
+        return $this->afterCreating(function (User $user) {
+            $user->assignRole(Role::USER->value);
         });
     }
 }

database/migrations/2023_11_21_161739_create_permission_tables.php

@@ -1,5 +1,7 @@
 <?php
 
+use App\Enums\Permission;
+use App\Enums\Role;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
@@ -26,7 +28,7 @@ public function up(): void
 
         Schema::create($tableNames['permissions'], function (Blueprint $table) {
             $table->bigIncrements('id'); // permission id
-            $table->string('name');       // For MySQL 8.0 use string('name', 125);
+            $table->enum('name', Permission::values());
             $table->string('guard_name'); // For MySQL 8.0 use string('guard_name', 125);
             $table->timestamps();
 
@@ -39,7 +41,7 @@ public function up(): void
                 $table->unsignedBigInteger($columnNames['team_foreign_key'])->nullable();
                 $table->index($columnNames['team_foreign_key'], 'roles_team_foreign_key_index');
             }
-            $table->string('name');       // For MySQL 8.0 use string('name', 125);
+            $table->enum('name', Role::values());
             $table->string('guard_name'); // For MySQL 8.0 use string('guard_name', 125);
             $table->timestamps();
             if ($teams || config('permission.testing')) {

database/seeders/OrganisationsSeeder.php

@@ -2,6 +2,7 @@
 
 namespace Database\Seeders;
 
+use App\Enums\Role;
 use App\Models\Organisation;
 use App\Models\User;
 use Illuminate\Database\Console\Seeds\WithoutModelEvents;
@@ -13,17 +14,19 @@ class OrganisationsSeeder extends Seeder
 
     public function run()
     {
-        $adminUser = User::whereEmail(\env('SEED_ADMIN_EMAIL'))->firstOrFail();
-
-        $orgs = Organisation::factory(5)
-            ->for($adminUser)
-            ->afterCreating(function (Organisation $org) use ($adminUser) {
-                $org->users()->attach($adminUser);
-            })
-            ->create();
-
-        $adminUser->currentOrganisation()
-            ->associate($orgs->first())
-            ->save();
+        User::whereHas('roles', fn ($q) => $q->where('name', Role::ADMIN->value))
+            ->get()
+            ->each(function (User $user) {
+                $user->currentOrganisation()
+                    ->associate(
+                        Organisation::factory()
+                            ->for($user)
+                            ->afterCreating(function (Organisation $org) use ($user) {
+                                $org->users()->attach($user);
+                            })
+                            ->create()
+                    )
+                    ->save();
+            });
     }
 }