From 44f00c9a52d6999d6b1908969063824e370b5ae4 Mon Sep 17 00:00:00 2001
From: Thomas Arrow <thomas.arrow@wikimedia.de>
Date: Tue, 31 Oct 2023 12:36:17 +0000
Subject: [PATCH] minimal example of testing simple job that emails a simple
 notification

---
 app/Jobs/SendSimpleNotificationJob.php       | 37 ++++++++++++
 app/Notifications/SimpleNotification.php     | 61 ++++++++++++++++++++
 tests/Unit/SendSimpleNotificationJobTest.php | 30 ++++++++++
 tests/Unit/SimpleNotificationTest.php        | 28 +++++++++
 4 files changed, 156 insertions(+)
 create mode 100644 app/Jobs/SendSimpleNotificationJob.php
 create mode 100644 app/Notifications/SimpleNotification.php
 create mode 100644 tests/Unit/SendSimpleNotificationJobTest.php
 create mode 100644 tests/Unit/SimpleNotificationTest.php

diff --git a/app/Jobs/SendSimpleNotificationJob.php b/app/Jobs/SendSimpleNotificationJob.php
new file mode 100644
index 000000000..78bc88baf
--- /dev/null
+++ b/app/Jobs/SendSimpleNotificationJob.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Jobs;
+
+use App\Notifications\SimpleNotification;
+use App\User;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldBeUnique;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+class SendSimpleNotificationJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /**
+     * Create a new job instance.
+     *
+     * @return void
+     */
+    public function __construct(User $user)
+    {
+        $this->user = $user;
+    }
+
+    /**
+     * Execute the job.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        $this->user->notify(new SimpleNotification());
+    }
+}
diff --git a/app/Notifications/SimpleNotification.php b/app/Notifications/SimpleNotification.php
new file mode 100644
index 000000000..548182738
--- /dev/null
+++ b/app/Notifications/SimpleNotification.php
@@ -0,0 +1,61 @@
+<?php
+
+namespace App\Notifications;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+
+class SimpleNotification extends Notification
+{
+    use Queueable;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        return ['mail'];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return \Illuminate\Notifications\Messages\MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        return (new MailMessage)
+                    ->line('The introduction to the notification.')
+                    ->action('Notification Action', url('/'))
+                    ->line('Thank you for using our application!');
+    }
+
+    /**
+     * Get the array representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function toArray($notifiable)
+    {
+        return [
+            //
+        ];
+    }
+}
diff --git a/tests/Unit/SendSimpleNotificationJobTest.php b/tests/Unit/SendSimpleNotificationJobTest.php
new file mode 100644
index 000000000..866c8ddd6
--- /dev/null
+++ b/tests/Unit/SendSimpleNotificationJobTest.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Tests\Unit;
+
+use App\Jobs\SendSimpleNotificationJob;
+use App\Notifications\SimpleNotification;
+use App\User;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Illuminate\Support\Facades\Notification;
+use Tests\TestCase;
+
+class SendSimpleNotificationJobTest extends TestCase
+{
+
+    use DatabaseTransactions;
+
+    /**
+     * A basic unit test example.
+     *
+     * @return void
+     */
+    public function test_example()
+    {
+        Notification::fake();
+        $user = User::create(['email' => 'foobar@example.com', 'password' => 'asdf']);
+        $job = new SendSimpleNotificationJob($user);
+        $job->handle();
+        Notification::assertSentTo($user, SimpleNotification::class);
+    }
+}
diff --git a/tests/Unit/SimpleNotificationTest.php b/tests/Unit/SimpleNotificationTest.php
new file mode 100644
index 000000000..4c386f0a6
--- /dev/null
+++ b/tests/Unit/SimpleNotificationTest.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Tests\Unit;
+
+use App\Notifications\SimpleNotification;
+use App\User;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Illuminate\Support\Facades\Notification;
+use Tests\TestCase;
+
+class SimpleNotificationTest extends TestCase
+{
+    use DatabaseTransactions;
+
+    /**
+     * A basic unit test example.
+     *
+     * @return void
+     */
+    public function test_example()
+    {
+        Notification::fake();
+        $notification = new SimpleNotification();
+        $user = User::create(['email' => 'foobar@example.com', 'password' => 'asdf']);
+        $user->notify($notification);
+        Notification::assertSentTo($user, SimpleNotification::class);
+    }
+}