LaravelでPHPUnitを使ってCRUD処理のテストを自動化③【投稿の削除】

LaravelでPHPUnitを使って、CRUD処理のテストを自動化させる方法を解説しています。

今回は、投稿の削除の処理のテストを書いていきます。投稿の削除は、投稿者本人と管理者のみが行えるようにします。

実際の開発の現場でも使えるよう、実践的なテストの作り方をご紹介していきますね。

本記事は、CRUD処理を使ってWebアプリ開発ができる方向けのものとなります。テストの前提となるWebアプリは既に開発済みのものとして、本記事では詳しく解説しません。

Webアプリの前提条件
事前準備：Gate（ゲート）の設定
CRUD処理のテスト：投稿の削除
さいごに

Webアプリの前提条件

Webアプリの前提条件や事前準備については、前回までの記事にて解説しています。

新規作成画面の表示と保存、編集、更新のテスト方法も解説しています。

LaravelでPHPUnitを使ってCRUD処理のテストを自動化①【投稿の作成と保存テスト】

LaravelでPHPUnitを使って、CRUD処理のテストを実施する方法を解説します。今回は投稿の新規作成ページの表示と、保存のためのテストコードを書いていきます。面倒なテストを自動化して、開発作業を効率化していきましょう♪PHPUnit...

LaravelでPHPUnitを使ってCRUD処理のテストを自動化②【投稿の編集と更新】

LaravelでPHPUnitを使って、CRUD処理のテストを自動化させる方法を解説します。今回は投稿の編集画面の表示・投稿の更新のためのテストを書いていきます。編集と更新は、投稿者本人のみが行えるようにします。権限がない人が処理を行うと、...

PHPUnitの基本的な使い方を知りたい場合は、まずは下記記事をご覧ください。

LaravelでPHPUnitを使ってテストを自動化してみよう

Laravelではテスト用のフレームワークとして、PHPUnitやPestが使えます。本記事では、LaravelでのPHPUnitの基本の使い方を説明します。Webアプリ開発にテストは必須です。手動テストで十分なこともありますが、Webアプ...

事前準備：Gate（ゲート）の設定

今回は、投稿の削除は、投稿者本人と管理者のみが行えるものとします。

管理者かどうかは、usersテーブルのroleカラムに”admin”と入っているかどうかで判断するようにします。

この前提で、app/Providers/AuthServiceProvidersに、次のようにadminゲートを作っておきましょう。

【app/Providers/AuthServiceProviders】

use Illuminate\Support\Facades\Gate;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

（省略）

    public function boot(): void
    {
        Gate::define('admin', function ($user, $post) {
            if(($user->id==$post->user_id) || ($user->role=='admin')) {
                return true;
            }
            return false;
        });
    }

このゲートを使うと、投稿者本人（$user->id==$post->user_id)）またはユーザーの役割がadmin（$user->role==’admin’）であれば、return true として、処理を実行します。

コントローラの投稿の編集画面表示と更新のメソッドには、下記のように作成したadminゲートを設定しておきます。

【PostController】

    public function destroy(Request $request,Post $post)
    {
        $this->authorize('admin', $post);
       
        （省略）
    }

CRUD処理のテスト：投稿の削除

投稿の削除のテストを作っていきましょう。

tests/Feature/PostTest.phpを開き、下記のようにコードを加えます。

【tests/Feature/PostTest.php】

    // 投稿の削除テスト（投稿者本人または管理人のみ削除できる）
    public function test_can_delete_post()
    {
        $user = User::factory()->create();
        $post = Post::factory()->create(['user_id' => $user->id]);

        $response = $this->actingAs($user)->delete('/post/' . $post->id);

        $response->assertStatus(302);
        $this->assertDatabaseMissing('posts', ['id' => $post->id]);

        // 別のユーザーが投稿を削除しようとした場合に403エラーになることを確認
        $anotherUser = User::factory()->create();
        $post2 = Post::factory()->create(['user_id' => $anotherUser->id]);
        $post2->save();
        $response = $this->actingAs($user)->delete('/post/' . $post2->id);
        $response->assertStatus(403);

        // 管理者が投稿を削除できることを確認
        $adminUser = User::factory()->create(['role' => 'admin']);
        $post3 = Post::factory()->create(['user_id' => $user->id]);
        $response = $this->actingAs($adminUser)->delete('/post/' . $post3->id);
        $response->assertStatus(302);
        $this->assertDatabaseMissing('posts', ['id' => $post3->id]);
    }

コードの意味を解説します。

factoryを使って新規ユーザー($user)と新規投稿($post)を作成します。$postのuser_idは、$userのidとします。
このユーザーとして、投稿を削除します。その後、HTTPステータスが302であるかどうかを確認します。HTTPステータスが302であれば、リクエストが指定したURLにリダイレクトされた状態ということになります。また、$this->assertDatabaseMissingによって、
$postのデータがデータベースから削除されていることも確認します。
次に、もう一人ダミーユーザー($anotherUser)を作成します。新たに投稿（$post2）を作成します。$post2のuser_idは、$anotherUserのidとします。
この状態で、最初のuserが投稿（$post2) を削除しようとします。ですが、$post2のuser_idは、anotherUserのidであるため、削除できません。この時、HTTPステータスが403であるかどうかを確認します。HTTPステータスが403は、権限がないということになります。
次に、管理者権限を持つダミーユーザー($adminUser)を作成します。新規投稿（$post3）も作成します。$post3のuser_idは、$userのidとします。
この状態で、$adminUserが投稿（$post3) を削除します。その後、HTTPステータスが302であるかどうかを確認します。HTTPステータスが302であれば、リクエストが指定したURLにリダイレクトされた状態ということになります。また、$this->assertDatabaseMissingによって、$post2のデータがデータベースから削除されていることも確認します。

これによって、自分が作った投稿を削除できるかテストしています。また、自分以外の人が作成した投稿を削除しようとすると、403エラーになるかどうかをテストしています。さらに、管理者であれば自分以外の人が作成した投稿を削除できるかテストしています。

コードを保存したら、下記コマンドを実行します。