【Laravel】 Slack通知の実装・テストコードの書き方を解説

// 取得したWebHookURL
SLACK_WEBHOOK_URL=https://hooks.slack.com/services/xxxxxxxxxx/xxxxxxxxxx/xxxxxxxxxxxxxxxxxxx

// 通知を送信するチャンネル
SLACK_CHANNEL=#general

// 通知の送信者名
SLACK_SENDER_NAME=Slack-Notification-Bot

// 通知の送信者アイコン画像のURL
SLACK_ICON=https://s3-us-west-2.amazonaws.com/xxxxxxx/xxxxxx/xxxxxx/xxxxxxxx.png

> composer require laravel/slack-notification-channel

> php artisan make:notification SlackNotification

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
use Illuminate\Notifications\Messages\SlackMessage;

class SlackNotification extends Notification
{
    use Queueable;

    protected $channel;
    protected $icon;
    protected $name;
    protected $message;

    /**
     * Create a new notification instance.
     * @return void
     */
    public function __construct($message)
    {
        // Slackに関数する情報はconfigに定義しておく
        $this->channel = config('slack.channel');
        $this->icon = config('slack.icon');
        $this->name = config('slack.sender_name');
        $this->message = $message;
    }

    /**
     * Get the notification's delivery channels.
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return ['slack'];
    }

    /**
     * Get the array representation of the notification.
     * @param  mixed  $notifiable
     * @return array
     */
    public function toArray($notifiable)
    {
        return [];
    }

    /**
     * Get the Slack representation of the notification.
     * @param mixed $notifiable
     * @return SlackMessage
     */
    public function toSlack($notifiable)
    {
        return (new SlackMessage)
            ->from($this->name)
            ->image($this->icon)
            ->to($this->channel)
            ->content($this->message);
    }
}

<?php

return [
    'webhook_url' => env('SLACK_WEBHOOK_URL'),
    'channel' => env('SLACK_CHANNEL'),
    'sender_name' => env('SLACK_SENDER_NAME'),
    'icon' => env('SLACK_ICON'),
];

<?php

namespace App\Services;

use Illuminate\Notifications\Notifiable;
use App\Notifications\SlackNotification;

class SlackNotificationService implements SlackNotificationServiceInterface
{
    use Notifiable;

    public function send($message)
    {
        $this->notify(new SlackNotification($message));
    }

    protected function routeNotificationForSlack()
    {
        return config('slack.webhook_url');
    }

    /**
     * Get the value of the notifiable's primary key.
     * ※後述するテストで必要（ないとエラーになる）
     *
     * @return mixed
     */
    public function getKey()
    {
        //
    }
}

<?php

namespace App\Services;

interface SlackNotificationServiceInterface
{
    public function send($message);
}

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use App\Services\SlackNotificationServiceInterface;
use App\Services\SlackNotificationService;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     * @return void
     */
    public function boot()
    {
        //
    }

    /**
     * Register any application services.
     * @return void
     */
    public function register()
    {
        $this->app->singleton(
            SlackNotificationServiceInterface::class,
            SlackNotificationService::class
        );
    }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Services\SlackNotificationServiceInterface;

class SampleController extends Controller
{
    /**
     * @var SlackNotificationServiceInterface
     */
    private $slack_notification_service_interface;

    /**
     * @param SlackNotificationServiceInterface $slack_notification_service_interface
     */
    public function __construct(
        SlackNotificationServiceInterface $slack_notification_service_interface,
    ) {
        $this->slack_notification_service_interface =  $slack_notification_service_interface;
    }

    /**
     * Slack通知を送信する
     */
    public function sendSlackNotification()
    {
        $this->slack_notification_service_interface->send('こんにちは！！');
    }
}

namespace Tests\Controllers;

use Tests\TestCase;
use App\Notifications\SlackNotification;
use App\Services\SlackNotificationService;
use Illuminate\Support\Facades\Notification;

class SampleControllerTest extends TestCase
{
    public function testsendSlackNotification()
    {
        /**
     * sendSlackNotificationのテスト
     *
     * @return void
     */
    public function testSendSlackNotification()
    {
        $expected_message = 'こんにちは！！';

        // Slack通知が実際に送信されないようにする
        Notification::fake();

        // Slack通知の送信回数が1回かのテスト(第３引数の数値が期待する送信回数)
        Notification::assertSentToTimes(new SlackNotificationService, SlackNotification::class, 1);

        // Slack通知に記載されている内容をテスト
        Notification::assertSentTo(
            new SlackNotificationService,
            SlackNotification::class,
            // 第一引数の$notificationはSlackNotification::classのインスタンス
            function ($notification, $channels) use ($expected_message) {
                // ReflectionClassのインスタンスを作成
                $reflected_notification = new \ReflectionClass($notification);
                // $notificationのmessageプロパティを取得
                $message_property = $reflected_notification->getProperty('message');
                // messageプロパティへのアクセスを許可
                $message_property->setAccessible(true);
                // messageプロパティの値(Slack通知に記載されている内容)を取得する
                $message = $message_property->getValue($notification);
                // messageプロパティの値が期待するメッセージと同じかをテストする
                $this->assertEquals($expected_message, $message);
                // 最後にtrueを返さないとエラーになる
                // (return $expected_message === $message; でもOK)
                return true;
            }
        );
    }
    }
}