laravelのテストコードをデバッグした際にDBデータが反映されない【RefreshDatabase】

Question

前提

laravelでテストコード(PHPUnit)を書いていますが、
処理の中でDBのテーブルにレコードをINSERTした後に、
デバッグで一時停止した状態でコマンドラインからテーブルをSELECTすると、
結果が反映されていない状態(レコード0件)で結果が返ってきます。（想定としてはSELECTの結果レコードが返ってくるはず）

use RefreshDatabase;をコメントアウトすると、想定通りレコードが返ってくるので、
RefreshDatabaseが関係していると思ったのですが、どうしても想定通りになりませんでした。

実現したいこと

デバッグで一時停止した状態でSELECTしたら、想定通りレコードが返ってくるようにしたいです。
または仕様として、レコードが返ってこない仕様なのであればそれを知りたいです。

意図

テストコード書くのは初心者です。
テストコードの中で、seeder等でテストデータを入れたりしたいので、
デバッグで一時停止して、DBの値を見ながらテストコードを書きたいと思った次第です。
（そもそもテストコードをデバッグするということ自体が間違っているのでしょうか・・？）

環境

MacBookAir macOS Monterey 12.4 Intel
Docker Desktop(ローカル開発・検証)
PHP 8.1.12
Laravel Framework 8.75
PHPUnit 9.5.10
Xdebug 3.2.0

検証用のプロジェクトリポジトリ(GitHub)

https://github.com/corock510/Experiment

該当のソースコード

<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\Log;
use Tests\TestCase;

use Illuminate\Support\Facades\DB;

class UserTest extends TestCase
{
    use RefreshDatabase;

    /**
     * A basic feature test example.
     *
     * @return void
     */
    public function test_create_user()
    {
        //クエリビルダを用いて、usersテーブルに2件レコード追加（本来ここはテストコードではなくテスト対象のクラスのメソッドに書きますが、便宜的にここにINSERT処理を書いています。）
        DB::table('users')->insert([
            ['name' => 'A', 'email' => '[e-mail]', 'password' => 'aaa'],
            ['name' => 'B', 'email' => '[e-mail]', 'password' => 'aaa']
        ]);

        //検証用 ブレークポイント usersテーブルにselect文流して$getValに代入
        $getVal = DB::table('users')->select('name')->get();

        //検証用 ログ(src/storage/logs/laravel.log)に$getValの値を書き込み
        Log::info($getVal);

        //usersテーブルの件数が2件であればテストOK
        $this->assertDatabaseCount(table: 'users', count: 2);
    }
}

詳細

上記のUserTest.phpでは、usersテーブルにレコードを2件INSERTし、その件数が2件であることをテストしています。
INSERT処理の直後(29行目)にブレークポイントを張ってデバッグで一時停止した状態で、コマンドライン上からMySQLに接続し、
usersテーブルにSELECT文を流すと、結果は2件のはずが、0件(Empty set)で返ってきます。
その後、UserTest.phpをステップ実行すると、想定通り2件取得できています。

冒頭でも書きましたが、13行目のuse RefreshDatabase;をコメントアウトすると、④で想定通り2件返ってきます。

検証手順

①拡張機能のxDebugをインストール済の状態で【cmd + shift + D】【F5】でxDebugを実行
②UserTest.phpの29行目selectの処理にブレークポイントを設定（Error Exception Uncaught Exceptionのチェックを外す）
③下記記載(1)の方法で、UserTest実行（②のブレークポイントで一時停止する）
④下記記載(2)の方法で、コマンドライン上でMySQLに接続して、usersテーブルにSELECT文を流す（結果は2件のはずが、0件(Empty set)で返ってくる）
⑤UserTest.phpの処理をステップ実行する（想定通り2件取得できている）

(1)UserTest実行
$ docker compose exec php bash
# ./vendor/bin/phpunit tests/Feature/UserTest.php

(2)DB接続、usersテーブルSELECT文発行
$ docker compose exec db mysql -u root -p
password
> use database;
> select name from users;

---

何卒、よろしくお願いいたしますm(_ _)m

Comments

[yuma.inaura]

自分のMac環境でも試しましたが普通に成功しますね

むしろ use RefreshDatabase を外すと二回目以降の実行で 重複レコード登録で失敗しました

[yuma.inaura]

https://github.com/corock510/Experiment のコードで docker から実行しましたがこちらもテストが成功しました

root@bedaeb24c0f5:/var/www/html# ./vendor/bin/phpunit tests/Feature/UserTest.php

Deprecated: PHP Startup: Use of mbstring.internal_encoding is deprecated in Unknown on line 0
PHPUnit 9.5.27 by Sebastian Bergmann and contributors.

. 1 / 1 (100%)

Time: 00:02.053, Memory: 24.00 MB

OK (1 test, 1 assertion)

[koiking510]

検証ありがとうございます。
はい、テストは私の方でも成功します。

「DBにレコードが2件存在することのテスト」は成功するのに、
デバッグで一時停止して、コマンドラインでSELECTした時に0件で返ってくるのは何故か？
という質問でした。

Answer 1

テストでのDBの扱い方はいくつか方法がある。

1. トランザクション内で実行。RefreshDatabaseはこれ。
2. 別データベースで実行。sailはこれ。
3. インメモリSQLiteを使用。

前提として必須な常識は「テストで既存のデータベースを変更されたら困る」
これが分かってないと何も理解できない。

1 RefreshDatabase

トランザクション内なので既存のデータベースには影響を与えない。つまりテストの途中で中を見ても何もない。質問への回答はここだけで終わり。「DBのテストにはRefreshDatabaseを使う。テスト中に中を見るような意味のないことをしない」

RefreshDatabaseなしで他の方法も使ってないなら既存のデータベースを変更している。テストの途中でも変更が反映されるけどそれはつまり既存のデータベースが壊れてるのでやってはいけないこと。

2 別データベース

sailではphpunit.xmlが書き換えられて
DB_DATABASE=testingという別のデータベースが使われるので既存のデータベースへの影響はない。

3 インメモリSQLite

コメントアウトされてるけどLaravelのデフォルトのphpunit.xmlはインメモリSQLiteをすぐ使えるように用意されている。

        <!-- <env name="DB_CONNECTION" value="sqlite"/> -->
        <!-- <env name="DB_DATABASE" value=":memory:"/> -->

全部既存のデータベースを壊さないための方法。

Comments

[koiking510]

ご回答ありがとうございます。

＞前提「テストで既存のデータベースを変更されたら困る」
→こちらは理解しました。

＞トランザクション内なので既存のデータベースには影響を与えない。つまりテストの途中で中を見ても何もない。質問への回答はここだけで終わり。
→なるほど、おそらく理解できました。
　RefreshDatabaseを使用したテストは、トランザクションが開始された状態でテスト実行され、テスト中は未コミットの状態になっているため、コマンドライン上からDBを見ても反映されていない というイメージでしょうか。

＞テスト中に中を見るような意味のないことをしない
→やはりそういうことなのですね。これが聞けて良かったです。

他の方法もご提示いただきありがとうございます。参考にさせていただきます。