偉人を数える
Seeding Factory の基礎
問題
Laravel デフォルトの users テーブルに、偉人名を初期登録してください。
そして、 users テーブルにデータがその人数分登録されていることを確認してください。
問題は、以下の手順で解いてください。
- Red:小さいテストを作成し、失敗を確認してください
- Green:テストを成功させてください
- Refactor:整理・整頓してください
- 必要に応じて、1から3を繰り返してください
ヒント
背景知識
- 偉人たちの取得方法： Inspiring php クラス
- users テーブル： おそらく、 Laravel にデフォルトで入っているはずです
便利なアサーションの例
アサーションの調べ方 も合わせてご覧ください。
今回は、以下を使うのではないかと思います。
-
assertDatabaseCount($table_name, $int)（Database テスト : $table_name テーブルに $int 個のデータが入っているか）
解答例
続きを読む
実行環境：
- Laravel v13.7.0
- PHP 8.4
- PHPUnit
Red
CountLegendsTest を作ります。
bash:
php artisan make:test CountLegendsTest
tests/Feature/CountLegendsTest.php:
<?php
namespace Tests\Feature;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;
use Illuminate\Foundation\Inspiring;
class CountLegendsTest extends TestCase
{
use RefreshDatabase;
public function test_偉人を数える(): void
{
$this->seed();
$authors = Inspiring::quotes()->map(function (string $quote_author):string
{
[$quote, $author] = explode('-', $quote_author);
$author = trim($author);
return $author;
});
$unique = $authors->unique(); // もし重複があれば消す
$this->assertDatabaseCount('users', $unique->count());
}
}
bash:
php artisan test ./tests/Feature/CountLegendsTest.php
Green
Seeder を作成します。
bash:
php artisan make:seeder UserSeeder
database/seeders/UserSeeder.php:
<?php
namespace Database\Seeders;
use Illuminate\Database\Console\Seeds\WithoutModelEvents;
use Illuminate\Database\Seeder;
use Illuminate\Foundation\Inspiring;
use Illuminate\Support\Str;
use App\Models\User;
class UserSeeder extends Seeder
{
public function run(): void
{
$authors_data = Inspiring::quotes()
->map(function (string $quote_author): string {
[$quote, $author] = explode('-', $quote_author);
$author = trim($author);
return $author;
})
->unique()
->map(function (string $name):array {
$now = now();
$email = strtolower(str_replace(' ', '-', $name));
$password = Str::random(60);
return [
'name' => $name,
'email' => $email . '@example.com',
'password' => $password,
'created_at' => $now,
'updated_at' => $now,
];
});
User::insert($authors_data->toArray());
}
}
ちょっと長くなってしまいましたが、やっていることは複数のデータを配列にして insert しているだけです。
もう少し可読性の良い、 Factory という仕組みをこのあと紹介します。
users テーブルのスキーマについては、 Users のマイグレーションファイルをご覧ください。
今回は、初期設定なので、 database/seeders/DatabaseSeeder.php に登録します。
<?php
namespace Database\Seeders;
use Illuminate\Database\Console\Seeds\WithoutModelEvents;
use Illuminate\Database\Seeder;
class DatabaseSeeder extends Seeder
{
use WithoutModelEvents;
public function run(): void
{
$this->call([
UserSeeder::class,
]);
}
}
テストを実行し、成功を確認してください。
Refactor
Factory を使って、可読性をよくします。
User に対するファクトリーとして、 database/factories/UserFactory.php がすでに用意されています。
パスワードなどは、これを利用することで、シーダーファイルへの記載が減ります。
シーダーファイルを、ファクトリーを使う方法で書き換えます。
database/seeders/UserSeeder.php:
use Illuminate\Database\Eloquent\Factories\Sequence;
...
public function run(): void
{
$authors_data = Inspiring::quotes()
->map(fn($s)=>trim(explode('-', $s)[1]))
->unique()
->map(function (string $name):array {
$email = strtolower(str_replace(' ', '-', $name));
return [
'name' => $name,
'email' => $email . '@example.com',
];
});
User::factory()
->count($authors_data->count())
->state(new Sequence(...$authors_data))
->create();
}
テストを実行して、 Green のままであることを確認します。
解説
続きを読む
データベース操作の種類 - DDL と DML
データベースには、テーブルを作ったり壊したりする処理と、そのテーブルにデータを出し入れ（CRUD）する処理があります。
前者を DDL といい、後者を DML といいます。
以前書いたように、 DDL 操作の全履歴を残せるのが、 Laravel のマイグレーションの強みです。
一方、 DML （データの CRUD 操作）は、 web アプリサービスの中で処理されるものであり、それらをいちいち残しておくことにメリットは、あまり無さそうです。
とはいえ、初期データや、マスタデータ、テストでのダミーデータなど、いくつかの場面で、 DML を使いまわしたいこともあります。
これを PHP ファイルとして残す仕組みが、 Seeding です。
と、思っていたのですが、実務では、マイグレーションファイルに、直接初期データを書く（DML操作をする）ことも、よくあることなのだそうです。
Seeding について
シーダーファイルは、 database/seeders/ ディレクトリ下に作られます。
その中で、 database/seeders/DatabaseSeeder.php だけは特別なものです。
php artisan migrate:fresh --seed
上記コマンドを実行した時、 --seed オプションで、初期データ用のシーダーを一斉に実行したい場合があります。
このような場合に、 DatabaseSeeder.php ファイルに登録しておけば、それらが一斉に実行される仕組みです。
一方、個別に実行したい場合もあるかもしれません。
そのような場合は、以下のようにコマンドを実行します。
php artisan db:seed UserSeeder
テストでの初期設定の実行
TestCase クラスの中で、以下のようにプロパティを設定することで、テスト時のセットアップ時に、初期設定（DatabaseSeeder）のシーディングを実行してくれます。
class CountLegendsTest extends TestCase
{
use RefreshDatabase;
protected $seed = true;
...
}
また、テストの中で初期設定（DatabaseSeeder）に設定していない Seeder ファイルを実行したい場合もあるかもしれません。（ダミーデータを入れたい場合など）
その際は、テストメソッドの中で、以下のように書きます。
$this->seed(UserSeeder::class);
$this->assert...
ファクトリーについて
ファクトリーという言葉を検索するときには、注意してください。
一般的なプログラミングの用語としての「ファクトリー」は、ファクトリーパターンという、インスタンス生成の仕組みを指す場合もあります。
検索するときは、「Laravel Factory 使い方」など、 Laravel のファクトリーを調べてください。
さて、 Laravel のファクトリーは、モデルのインスタンスを作成したい場合に使えるものです。
あくまでも「モデル」作成に使えるというところがポイントです。
必ずしもデータベースに保存（永続化）する必要のないデータのモデル（たとえば、テスト中のダミーデータなど）にも利用できます。
データベースに永続化させたい場合は、 create() メソッドを使います。
一方、ダミーデータの場合は、 make() メソッドを使ってください。
今回の問題では、初期データとして保存する必要があるため、 create() メソッドを使っています。