Add test for console command and requests not covered before, rename test methods according to convention

Author: patrickrobrecht

app/Exports/BookingsExportSpreadsheet.php

@@ -17,9 +17,9 @@ class BookingsExportSpreadsheet extends Spreadsheet
      * @param Collection<Booking> $bookings
      */
     public function __construct(
-        private Event $event,
-        private BookingOption $bookingOption,
-        private Collection $bookings
+        private readonly Event $event,
+        private readonly BookingOption $bookingOption,
+        private readonly Collection $bookings
     ) {
         parent::__construct();
 

app/Exports/Traits/ExportsToExcel.php

@@ -11,17 +11,6 @@
  */
 trait ExportsToExcel
 {
-    public function createSheetFromCollection(
-        string $title,
-        Collection $collection,
-        array $headerColumns,
-        \Closure $rowProvider
-    ): Worksheet {
-        $sheet = $this->createSheet();
-        self::fillSheetFromCollection($sheet, $title, $collection, $headerColumns, $rowProvider);
-        return $sheet;
-    }
-
     public function setMetaData(string $title): void
     {
         $this->getProperties()
@@ -35,7 +24,7 @@ public static function fillSheetFromCollection(
         Collection $collection,
         array $headerColumns,
         \Closure $rowProvider
-    ): void {
+    ): Worksheet {
         $worksheet->setTitle(substr(str_replace(['*', ':', '/', '\\', '?', '[', ']'], '', $title), 0, 31));
         $worksheet->fromArray([
             [$title],
@@ -48,6 +37,8 @@ public static function fillSheetFromCollection(
         self::formatHeadline($worksheet, $columnCount);
         $worksheet->setAutoFilter([1, 3, $columnCount, 3]);
         self::setAutoSizeForColumns($worksheet, $columnCount);
+
+        return $worksheet;
     }
 
     public static function formatHeadline(Worksheet $worksheet, int $columnCount): void

app/Http/Controllers/LocationController.php

@@ -6,7 +6,6 @@
 use App\Http\Requests\LocationRequest;
 use App\Models\Location;
 use App\Models\Organization;
-use App\Models\User;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Support\Facades\Session;
 use Illuminate\View\View;
@@ -41,7 +40,7 @@ public function create(): View
 
     public function store(LocationRequest $request): RedirectResponse
     {
-        $this->authorize('create', User::class);
+        $this->authorize('create', Location::class);
 
         $location = new Location();
         if ($location->fillAndSave($request->validated())) {

app/Models/Booking.php

@@ -94,7 +94,7 @@ public function age(): Attribute
         return Attribute::get(fn () => Carbon::now()->floatDiffInYears($this->date_of_birth));
     }
 
-    public function bookedByUser()
+    public function bookedByUser(): BelongsTo
     {
         return $this->belongsTo(User::class, 'booked_by_user_id');
     }
@@ -126,7 +126,7 @@ public function scopeGroup(Builder $query, Group|int $group): Builder
         );
     }
 
-    public function scopePaymentStatus(Builder $query, int|PaymentStatus $paymentStatus)
+    public function scopePaymentStatus(Builder $query, int|PaymentStatus $paymentStatus): Builder
     {
         $payment = is_int($paymentStatus)
             ? $paymentStatus

database/factories/BookingOptionFactory.php

@@ -22,8 +22,8 @@ public function definition(): array
         return [
             'name' => __('Booking option') . ' #' . $this->faker->unique()->randomNumber(),
             'description' => $this->faker->sentences(2, true),
-            'available_from' => Carbon::yesterday()->startOfDay(),
-            'available_until' => Carbon::tomorrow()->endOfDay(),
+            'available_from' => $this->faker->dateTimeBetween('-30 years', '-1 day'),
+            'available_until' => $this->faker->dateTimeBetween('+1 day', '+30 days'),
             'price' => $this->faker->randomFloat(2, 5, 100),
         ];
     }

database/factories/EventFactory.php

@@ -35,8 +35,12 @@ public function definition(): array
         ];
     }
 
-    public function visibility(Visibility $visibility): static
+    public function visibility(?Visibility $visibility): static
     {
+        if ($visibility === null) {
+            return $this;
+        }
+
         return $this->state(fn (array $attributes) => [
             'visibility' => $visibility,
         ]);

tests/Feature/Console/Commands/CheckDocumentsCommandTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Tests\Feature\Console\Commands;
+
+use App\Console\Commands\CheckDocumentsCommand;
+use App\Models\Document;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Storage;
+use PHPUnit\Framework\Attributes\CoversClass;
+use Symfony\Component\Console\Command\Command;
+use Tests\TestCase;
+use Tests\Traits\GeneratesTestData;
+
+#[CoversClass(CheckDocumentsCommand::class)]
+#[CoversClass(Document::class)]
+class CheckDocumentsCommandTest extends TestCase
+{
+    use GeneratesTestData;
+    use RefreshDatabase;
+
+    public function testAllDocumentsOk(): void
+    {
+        self::createDocuments();
+
+        Storage::shouldReceive('exists')
+            ->andReturn(true);
+
+        $this->artisan('app:check-documents')
+            ->expectsOutput('All documents ok.')
+            ->assertSuccessful();
+    }
+
+    public function testCommandDetectsMissingDocuments(): void
+    {
+        $existingDocuments = self::createDocuments();
+        foreach ($existingDocuments as $document) {
+            Storage::shouldReceive('exists')
+                ->with($document->path)
+                ->andReturn(true);
+        }
+
+        $missingDocuments = self::createDocuments();
+        foreach ($missingDocuments as $document) {
+            Storage::shouldReceive('exists')
+                ->with($document->path)
+                ->andReturn(false);
+        }
+
+        $command = $this->artisan('app:check-documents')
+            ->expectsOutput(sprintf('%d documents are missing.', count($missingDocuments)));
+        foreach ($missingDocuments as $document) {
+            $command->expectsOutputToContain($document->path . ' missing');
+        }
+        $command->assertExitCode(Command::FAILURE);
+    }
+}

tests/Feature/Http/AccountControllerTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Http;
+namespace Tests\Feature\Http;
 
 use App\Http\Controllers\AccountController;
 use App\Http\Requests\UserRequest;
@@ -18,24 +18,17 @@ class AccountControllerTest extends TestCase
 {
     use RefreshDatabase;
 
-    public function testAccountIsAccessibleWithCorrectAbility(): void
+    public function testUserCanViewAccountOnlyWithCorrectAbility(): void
     {
         $this->assertUserCanGetOnlyWithAbility('/account', Ability::ViewAccount);
     }
 
-    public function testEditAccountIsAccessibleWithCorrectAbility(): void
+    public function testUserCanOpenEditAccountFormOnlyWithCorrectAbility(): void
     {
         $this->assertUserCanGetOnlyWithAbility('/account/edit', Ability::EditAccount);
     }
 
-    public function testAccountCannotBeEditedWithoutAbility(): void
-    {
-        $this->actingAsUserWithAbility(Ability::ViewAccount);
-
-        $this->put('/account', $this->getRandomUserData())->assertForbidden();
-    }
-
-    public function testAccountCanBeEditedWithAbility(): void
+    public function testUserCanUpdateAccountWithCorrectAbility(): void
     {
         $this->actingAsUserWithAbility(Ability::EditAccount);
 
@@ -44,7 +37,14 @@ public function testAccountCanBeEditedWithAbility(): void
             ->assertRedirect('/account/edit');
     }
 
-    public function testAccountEditThrowsErrorsForInvalidData(): void
+    public function testUserCannotUpdateAccountWithoutAbility(): void
+    {
+        $this->actingAsUserWithAbility(Ability::ViewAccount);
+
+        $this->put('/account', $this->getRandomUserData())->assertForbidden();
+    }
+
+    public function testUserReceivesErrorMessagesForInvalidAccountData(): void
     {
         $this->actingAsUserWithAbility(Ability::EditAccount);
 
@@ -63,7 +63,7 @@ private function getRandomUserData(): array
         );
     }
 
-    public function testListOfOwnAbilitiesIsAccessibleWithCorrectAbility(): void
+    public function testUserCanViewAbilitiesOnlyWithCorrectAbility(): void
     {
         $this->assertUserCanGetOnlyWithAbility('/account/abilities', Ability::ViewAbilities);
     }

tests/Feature/Http/Auth/AuthenticationTest.php

@@ -22,12 +22,12 @@ class AuthenticationTest extends TestCase
 {
     use RefreshDatabase;
 
-    public function testLoginScreenCanBeRendered(): void
+    public function testGuestCanViewLoginForm(): void
     {
         $this->assertGuestCanGet('/login');
     }
 
-    public function testUsersCanAuthenticateUsingTheLoginScreen(): void
+    public function testActiveUserCanLogin(): void
     {
         $user = User::factory()->create();
 
@@ -41,7 +41,7 @@ public function testUsersCanAuthenticateUsingTheLoginScreen(): void
     }
 
     #[DataProvider('notActiveStatuses')]
-    public function testUsersCannotAuthenticateIfNotActive(ActiveStatus $activeStatus): void
+    public function testInactiveUserCannotLogin(ActiveStatus $activeStatus): void
     {
         $user = User::factory()
             ->status($activeStatus)
@@ -63,7 +63,7 @@ public static function notActiveStatuses(): array
         ];
     }
 
-    public function testUsersCannotAuthenticateWithInvalidPassword(): void
+    public function testUserCannotLoginWithWrongPassword(): void
     {
         $user = User::factory()->create();
 
@@ -74,4 +74,13 @@ public function testUsersCannotAuthenticateWithInvalidPassword(): void
 
         $this->assertGuest();
     }
+
+    public function testUserCanLogout(): void
+    {
+        $this->actingAsAnyUser();
+
+        $this->post(route('logout'))
+            ->assertRedirect('/');
+        $this->assertGuest();
+    }
 }

tests/Feature/Http/Auth/EmailVerificationTest.php

@@ -27,14 +27,14 @@ class EmailVerificationTest extends TestCase
 {
     use RefreshDatabase;
 
-    public function testEmailVerificationPromptCanBeRendered(): void
+    public function testUserCanOpenEmailVerificationPrompt(): void
     {
         $this->actingAs($this->createUnverifiedUser())
-            ->get('/')
+            ->get('/verify-email')
             ->assertOk();
     }
 
-    public function testEmailVerificationLinkCanBeRequested(): void
+    public function testUserCanRequestEmailVerificationLink(): void
     {
         Notification::fake();
 
@@ -51,7 +51,7 @@ public function testEmailVerificationLinkCanBeRequested(): void
         });
     }
 
-    public function testEmailCanBeVerified(): void
+    public function testUserCanVerifyEmail(): void
     {
         $user = $this->createUnverifiedUser();
 
@@ -70,7 +70,7 @@ public function testEmailCanBeVerified(): void
         $this->assertTrue($user->fresh()->hasVerifiedEmail());
     }
 
-    public function testEmailIsNotVerifiedWithInvalidHash(): void
+    public function testUserCannotVerifyEmailWithInvalidHash(): void
     {
         $user = $this->createUnverifiedUser();
 

tests/Feature/Http/Auth/PasswordConfirmationTest.php

@@ -13,7 +13,7 @@ class PasswordConfirmationTest extends TestCase
 {
     use RefreshDatabase;
 
-    public function testConfirmPasswordScreenCanBeRendered(): void
+    public function testUserCanViewConfirmPasswordForm(): void
     {
         $user = User::factory()->create();
 
@@ -22,10 +22,11 @@ public function testConfirmPasswordScreenCanBeRendered(): void
         $response->assertStatus(200);
     }
 
-    public function testPasswordCanBeConfirmed(): void
+    public function testUserCanConfirmPassword(): void
     {
         $user = User::factory()->create();
 
+        /** @noinspection PhpUnhandledExceptionInspection */
         $this->actingAs($user)
             ->post('/confirm-password', [
                 'password' => 'password',
@@ -34,7 +35,7 @@ public function testPasswordCanBeConfirmed(): void
             ->assertSessionHasNoErrors();
     }
 
-    public function testPasswordIsNotConfirmedWithInvalidPassword(): void
+    public function testUserCannotConfirmWithInvalidPassword(): void
     {
         $user = User::factory()->create();