LaravelのテストでbelongsToManyのデータをFactoryに作らせる

LaravelのFactoryはテストデータ作成がすごく楽で便利。Factoryの定義でリレーションデータも作成するようにしておけば各テストでは一つデータ作成を呼び出すだけでテストができてしまう。

hasOneとかのような1:1のリレーション定義の場合はマニュアルに書かれているような方法で自動生成できる。hasManyやbelongsToManyもテスト実行時にはeachとかでデータを追加することはできるが、できれば定義しておいて省略したい。その場合はちょっと処理の追加が必要。

具体的にはdefineとは別に、afterCreatingとかで追加データを入れてあげれば良い。たとえばpostsにtagsを割り当てる場合はこんな感じ。

$factory->afterCreating(App\Models\Post::class, function ($post, $faker) {
    $random = rand(1, 3);
    $tagIds = [];
    for ($i = 0; $i < $random; $i++) {
        $tagIds[] = factory(Tag::class)->create()->id;
    }
    $post->tags()->sync($tagIds);
});

上記は適当に書いたので、動作確認してないけど下記でも良いと思う。

$factory->afterCreating(App\Models\Post::class, function ($post, $faker) {
    $tagIds = factory(Tag::class, rand(1, 3))
        ->create()
        ->map(function ($tag) {
            return $tag->id;
        });
    $post->tags()->sync($tagIds);
});