Migration on ララジャパン

データベースのテスト

Sat, 01 Feb 2020 02:18:37 +0900

既存のDBのそれぞれのテーブルにおいて、migrationファイルやfactoryファイルが揃ったところで、phpunitのテストを作成して実行してみましょう。

テストDBの作成

テストDBは、phpunitのためだけのDBとなるゆえに、ブラウザでアクセスする本DBとは違うDBを作成します。つまり、開発サイトでは、プロジェクト１つに対して２つのDBを持つことになります。

本DBは、mysqlで、テストのDBには、sqliteという設定がドキュメントでも一般のLaravelの記事でも書かれていますが、私はテストといえども、本DBもテストDBも同じmysqlを使用することを勧めます。条件をまったく同じとしたいからです。

まず、mysqlのコマンドで、テストDB（demo_test）を作成します。

$ echo "create database demo_test" | mysql -u root -p
Query OK, 1 row affected (0.00 sec)

次に、config/database.phpをエディターで開いて、mysqlのコネクションをコピーして、mysql_testのコネクションを作成します。

config/databse.php

use Illuminate\Support\Str;

return [
....
    'connections' => [
...
        'mysql' => [
            'driver' => 'mysql',
            'url' => env('DATABASE_URL'),
            'host' => env('DB_HOST', '127.0.0.1'),
            'port' => env('DB_PORT', '3306'),
            'database' => env('DB_DATABASE', 'forge'),
            'username' => env('DB_USERNAME', 'forge'),
            'password' => env('DB_PASSWORD', ''),
            'unix_socket' => env('DB_SOCKET', ''),
            'charset' => 'utf8mb4',
            'collation' => 'utf8mb4_unicode_ci',
            'prefix' => '',
            'prefix_indexes' => true,
            'strict' => true,
            'engine' => null,
            'options' => extension_loaded('pdo_mysql') ? array_filter([
                PDO::MYSQL_ATTR_SSL_CA => env('MYSQL_ATTR_SSL_CA'),
            ]) : [],
        ],

        'mysql_test' => [
            'driver' => 'mysql',
            'url' => env('DATABASE_URL'),
            'host' => env('DB_HOST', '127.0.0.1'),
            'port' => env('DB_PORT', '3306'),
            'database' => 'demo_test',
            'username' => 'root',
            'password' => 'secret',
            'unix_socket' => env('DB_SOCKET', ''),
            'charset' => 'utf8mb4',
            'collation' => 'utf8mb4_unicode_ci',
            'prefix' => '',
            'prefix_indexes' => true,
            'strict' => true,
            'engine' => null,
            'options' => extension_loaded('pdo_mysql') ? array_filter([
                PDO::MYSQL_ATTR_SSL_CA => env('MYSQL_ATTR_SSL_CA'),
            ]) : [],
        ],
...

mysql_testにおいて編集した項目は、database、username、passwordです。env()を使用せずに、固定としています。必要なら他の項目も同様に編集してください。それから、usernameに指定するmysqlのユーザーは必ず、drop table, create table, truncateのsql文と実行できる権限を持つユーザーである必要があります。それゆえに、ここではrootのmysqlユーザーを使用しています。

次に、テーブル作成のartisanコマンドを実行して、テストDBにテーブルを作成します。前回で作成したmigrationファイルがここで役立ちます。

$ php artisan migrate:fresh --database=mysql_test
Dropped all tables successfully.
Migration table created successfully.
Migrating: 2014_10_12_000000_create_users_table
Migrated:  2014_10_12_000000_create_users_table (0.03 seconds)
Migrating: 2014_10_12_100000_create_password_resets_table
Migrated:  2014_10_12_100000_create_password_resets_table (0.02 seconds)
Migrating: 2019_08_19_000000_create_failed_jobs_table
Migrated:  2019_08_19_000000_create_failed_jobs_table (0.01 seconds)

必ず、–databaseでmysql_testのコネクションを指定ください。指定しないと、本DBの方が空となってしまうので注意を！

phpunitの設定

テストDBをテストの実行で使用するには、phpunit.xmlの編集が必要です。

phpunit.xml

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
         backupGlobals="false"
         backupStaticAttributes="false"
         bootstrap="vendor/autoload.php"
         colors="true"
         convertErrorsToExceptions="true"
         convertNoticesToExceptions="true"
         convertWarningsToExceptions="true"
         processIsolation="false"
         stopOnFailure="false">
    <testsuites>
        <testsuite name="Unit">
            <directory suffix="Test.php">./tests/Unit</directory>
        </testsuite>

        <testsuite name="Feature">
            <directory suffix="Test.php">./tests/Feature</directory>
        </testsuite>
    </testsuites>
    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">./app</directory>
        </whitelist>
    </filter>
    <php>
        <server name="APP_ENV" value="testing"/>
        <server name="BCRYPT_ROUNDS" value="4"/>
        <server name="CACHE_DRIVER" value="array"/>
        <server name="DB_CONNECTION" value="mysql_test"/>
        <server name="MAIL_DRIVER" value="array"/>
        <server name="QUEUE_CONNECTION" value="sync"/>
        <server name="SESSION_DRIVER" value="array"/>
    </php>
</phpunit>

DB_CONNECTIONをmysql_testと指定しています。

さて、これでphpunitを実行できます。vendor/bin/phpunitは、このプロジェクトでインストールされたバージョンのphpunitなので、必ずそのパスを使用してください。

$ vendor/bin/phpunit
PHPUnit 8.5.2 by Sebastian Bergmann and contributors.

..                                                                  2 / 2 (100%)

Time: 335 ms, Memory: 16.00 MB

OK (2 tests, 2 assertions)

OKがテスト成功、という意味です。

RefreshDatabaseトレイト

先のphpunitの実行では、データベースのテストは含まれていません。作成してみましょう。

$php artisan make:test --unit UserTest
Test created successfully.

この実行で、tests/Unit/UserTest.phpのファイルが作成されますが、それを以下のように編集します。

UserTest.php

namespace Tests\Unit;

// use PHPUnit\Framework\TestCase // Laravel 6.xで生成されるが、コメントして以下を追加
use Tests\TestCase;

use Illuminate\Foundation\Testing\RefreshDatabase; // 追加

use App\User;

class UserTest extends TestCase
{
    use RefreshDatabase;

    public function test_create_a_user()
    {
        factory(User::class)->create(); // usersのDBテーブルにレコードを１つ作成

        $this->assertCount(1, User::all()); // すべてのレコードを取得してレコード数が１であることを確認
    }
}

実行してみましょう。

$ vendor/bin/phpunit --filter UserTest
PHPUnit 8.5.2 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 511 ms, Memory: 22.00 MB

OK (1 test, 1 assertion)

成功ですね。

このテストは何回実行しても成功となります。

$ vendor/bin/phpunit --filter UserTest
PHPUnit 8.5.2 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 511 ms, Memory: 22.00 MB

OK (1 test, 1 assertion)
$ vendor/bin/phpunit --filter UserTest
PHPUnit 8.5.2 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 511 ms, Memory: 22.00 MB

OK (1 test, 1 assertion)

試しに、use RefershDatabaseをコメントして実行してみてください。

$ vendor/bin/phpunit --filter UserTest
PHPUnit 8.5.2 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 511 ms, Memory: 22.00 MB

OK (1 test, 1 assertion)

$ vendor/bin/phpunit --filter UserTest
PHPUnit 8.5.2 by Sebastian Bergmann and contributors.

F                                                                   1 / 1 (100%)

Time: 324 ms, Memory: 18.00 MB

There was 1 failure:

1) Tests\Unit\UserTest::testExample
Failed asserting that actual size 2 matches expected size 1.

/vol1/usr/www/repos/repos/l6x/tests/Unit/UserTest.php:23

FAILURES!
Tests: 1, Assertions: 1, Failures: 1.

１回名は成功ですが、２回目は失敗です．なぜなら、RefereshDatabaseなしではレコードは追加されていくばかりだからです。RefereshDatabaseのトレイトを使用することによりDBテーブルが空となり、毎回同じ条件でテストを実行できます。

Larave 6.xへ更新

Sat, 18 Jan 2020 01:14:39 +0900

またまたLaravelの更新の時期がやってきました。と言っても、またしても遅れての私のキャッチアップです。Laravel 6.xのバージョンは、Laravel 5.5と同様にLTSの長期サポートまでなので、バグの修正は、9/3/2021まで、セキュリティの修正は、9/3/2022までとあるので、できるならアップグレードしたいです。また、6.xのバージョンは、新サービスのサーバーレス対応のVaporでは必須ゆえに、Laravelを実行するサーバーのスケールアップに興味があるなら、なおさら頑張ってアップグレードする必要あります。

何が変わった？

さて、バージョン6.xともなると、大きな変更は少なくなってきています。私のプロジェクトでのアップグレードで気づいたことの報告をします。

まず忘れる前に、Laravel 6.xの更新には、最低php 7.2のバージョンが必要となります。と言っても、最新のphpは、バージョン7.4です。phpもLaravelもバージョンアップのペースが速い。もう少し遅くても、とも思います。

ヘルパーの変更

Laravel 5.8に更新で登場したのですが、配列や文字列のヘルパー関数が、クラスのstaticのメソッドに代わる、という話。例えば、array_only()は、Arr::only()に代わる。その時点では、両方使用できましたが、Laravel 6.xでは、もうグローバル関数の方はデフォルトでは使用できません。

それらを使用するには、以下を実行してパッケージを追加する必要あります。

$ composer require laravel/helpers

使用していたパッケージへの影響

phpunitのバージョンは、Laravel 5.8のバージョン7からバージョン8になりました。そして悲しいことに私が愛好していたデータベースのテストのphpunit/dbunitの開発・管理が止まりました。

ここでいつか紹介しようと思っていたのですが、紹介する前に作者の意向で開発ストップです。dbunitは、xmlファイルで用意したデータをユニットテストのためにデータベースにインポートしてくれる便利な機能があります。毎回のテストの前には、データをtruncateしてくれるのでいつでも空の状態から始めることができ、でテストの再現性を実現してくれます。

しかし、そこはオープンソースの強みというか、githubなどのサービスの便利さというか、他の開発者（以下のリンク）が早速にもレポをフォークしてphpunitバージョン8に対応してくれています。残念ながら、このパッケージのメインテナーとはならないようですが。

https://github.com/kornrunner/dbunit

これで暫くは凌げそうですが、この際に、Laravelのmigrationやfactoryを使用した、RefershDatabaseのトレイトを使ったデータベースのテストに書き換えていこうとも思います。

そして、そのステップ１として、前回の既存のＤＢからmigrationファイルを自動作成のパッケージの紹介でした。

しかし、このパッケージ、残念ながらLaravel6.xでは互換性で使えない、と思ったら対応しているこれまたレポをフォークしたパッケージがありました。

https://github.com/oscarafdev/migrations-generator

捨てる神があれば、拾う神ありです。助けられます。

ユーザー認証

Laravel 5.xでは、php artisan make:authの実行でユーザー認証の機能が追加できました。

Laravel 6.xでは、以下の実行が必要となります。

$ composer require laravel/ui
$ php artisan ui bootstrap --auth

uiのタイプとしては、bootstrap, vue, reactの選択があります。これらの実行で、ユーザー認証に必要なrouteの追加や、コントローラーやブレードのファイルが作成されます。

既存のＤＢからmigrationファイルを自動作成

Fri, 10 Jan 2020 03:33:08 +0900

私が現在管理するプロジェクトのほとんどは、Laravelのフレームワーク採用以前から存在したphpのプロジェクトです。嬉しいことにお客様から移行の機会を与えられて、ほとんどLaravelに書き換えることができました。しかし、それらのプロジェクトのDBの管理には、Laravelのmigrationを使用していません。私が開発したオンラインのツールが生成するSQLファイルでDBの変更を行っています。最近になって、プロジェクトのデータベーステストを行う必要が出て、migrationのファイルを用意しなければなくなりました。

どうして、migrationのファイルが必要？

今までは、dbunitなるものを使用してデータベーステストを行っていましたが、これが去年に作者（phpunitの作者でもある）の意向で開発が停止となりました。それゆえに、テストにおいてLaravelのRefreshDatabaseトレイトの使用に変えていくことが突然に必要になったわけです。

RefreshDatabaseは、毎回のテストの実行において、

$ php artisan migrate:fresh

の実行と同様に、migrationファイルで定義されたDBのテーブルをすべて削除し、再度一からそれらを作成します。つまり、データベースのテーブルをすべてゼロレコードの状態としてくれます。それゆえに、既存のDBのすべてのテーブルのmigrationを作成する必要があるのです。

migrationファイル自動生成ツール

既存のDBからmigrationファイルを作成するツールはないかと、探した結果、以下のツールが出てきました。

https://github.com/Xethron/migrations-generator

ツールのインストールには、

$ composer require --dev "xethron/migrations-generator"

をコマンドラインで実行します。

migrationファイルを作成するには、artisanの実行となります。laravel 5.8で新規のプロジェクトを作成して実行してみました。

$ php artisan migrate:generate
Using connection: mysql

Generating migrations for: password_resets, users

 Do you want to log these migrations in the migrations table? [Y/n] :
 > y

 Next Batch Number is: 2. We recommend using Batch Number 0 so that it becomes the "first" migration [Default: 0] :
 > 2

Setting up Tables and Index Migrations
Created: /vol1/usr/www/repos/repos/l58-new/database/migrations/2020_01_08_191742_create_password_resets_table.php
Created: /vol1/usr/www/repos/repos/l58-new/database/migrations/2020_01_08_191742_create_users_table.php

Setting up Foreign Key Migrations


Finished!

上の実行においては、２つ質問が尋ねられます。

最初は、migrationsのDBテーブルにログを作成するか？ 2番目は、そのログにおいてのバッチ番号をなんとするか？

上では、yと2と答えたところ、migrationsのデータは以下のようになりました。

mysql> select * from migrations;
+----+------------------------------------------------+-------+
| id | migration                                      | batch |
+----+------------------------------------------------+-------+
|  1 | 2014_10_12_000000_create_users_table           |     1 |
|  2 | 2014_10_12_100000_create_password_resets_table |     1 |
|  3 | 2020_01_08_191742_create_password_resets_table |     2 |
|  4 | 2020_01_08_191742_create_users_table           |     2 |
+----+------------------------------------------------+-------+
4 rows in set (0.00 sec)

すでに、php artisan migrateが実行されていたので、最初の２つのレコードはそのときに生成されていたものです。これらはLaraelのデフォルトのmigrationファイルです。

一方、generateで生成されたのは次の２つのレコードですが、見ての通り既存のものと重複となってしまいました。既存のDBをもとに１からDBテーブルを作成するという目的では、generate実行の前にmigrationsテーブルを空としたほうが良さそうですね。

さて、生成されたものと、デフォルトのmigrationファイルを比べてみましょう。

デフォルト：2014_10_12_000000_create_users_table.php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('name');
            $table->string('email')->unique();
            $table->timestamp('email_verified_at')->nullable();
            $table->string('password');
            $table->rememberToken();
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('users');
    }
}

生成：2020_01_08_191742_create_users_table

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;

class CreateUsersTable extends Migration {

	/**
	 * Run the migrations.
	 *
	 * @return void
	 */
	public function up()
	{
		Schema::create('users', function(Blueprint $table)
		{
			$table->bigInteger('id', true)->unsigned();
			$table->string('name');
			$table->string('email')->unique();
			$table->dateTime('email_verified_at')->nullable();
			$table->string('password');
			$table->string('remember_token', 100)->nullable();
			$table->timestamps();
		});
	}


	/**
	 * Reverse the migrations.
	 *
	 * @return void
	 */
	public function down()
	{
		Schema::drop('users');
	}

}

やや違いがありますね。例えば、email_verified_atの定義、なぜかtimestampからdateTimeとなっています。また、bigIncrementやrememberTokenに対応するフィールドも生成では変わっています。しかし、これらは、実行されるDBテーブルでは同じとなります。

ということで、mysqldumpの結果と見比べて、手動での調整が必要となりそうです。しかし、かなりの部分を作成してくれるので十分使えそうです。

DBにインデックスを追加

Sun, 20 Jan 2019 03:17:58 +0900

正直言って、Laravelのmigration機能は私のLaravelのプロジェクトでは使用したことありません。よく理解していないこともあり、失敗してクライアントのデータベースを空にしてしまうことを考えると悪夢です。とか言ってコマンドラインでSQL文を実行する現状もリスクはそう変わりません。ということで、前回においてmigrationを使用する機会があったので、この際にmigrationの理解を深めたいです。

DBにインデックスを追加

まず、前回においては以下のようなmigrationを作成することで新規のテーブルaddressesを作成しました。

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
 
class CreateAddressesTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('addresses', function (Blueprint $table) {
            $table->increments('id');
            $table->integer('user_id')->unsigned();
            $table->string('address');
            $table->timestamps();
        });
    }
 
    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('addresses');
    }
}

そして、以下を実行することで、addressesのテーブルを作成できます。

$ php artisan migrate
Migrating: 2019_01_10_140631_create_addresses_table
Migrated:  2019_01_10_140631_create_addresses_table

しかし、これではusersのテーブルとのjoinにおいてパフォーマンスが良くありません。例えば、以下のようなクエリを実行するときです。

Psy Shell v0.9.3 (PHP 7.1.14 — cli) by Justin Hileman
>>> User::join('addresses', 'users.id', '=', 'addresses.user_id')->get();

SQL文では以下となります。

mysql> select * from `users` inner join `addresses` on `users`.`id` = `addresses`.`user_id`

しかし、このjoinでは、データベースはマッチするuser_idを探すために毎回addressesのレコードをすべてチェックしなければなりません。レコード数が多くなれば、クエリの実行時間はとても長くなります。

しかし、これは、addresses.user_idにインデックスを追加するだけで簡単に解決できます。

migrationを作成してインデックスを追加してみましょう。

まず、migrationを作成します。

$ php artisan make:migration change_addresses --table=addresses

作成されたファイルを編集します。

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class ChangeAddressesTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('addresses', function (Blueprint $table) {
            $table->index('user_id');
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('addresses', function (Blueprint $table) {
            $table->dropIndex('addresses_user_id_index');
        });
    }
}

これだけです。rollbackのためにdown()も定義することを忘れないように。dropIndex()の引数は、DBの項目名ではなく、間に下線文字を入れて、テーブル名と項目名とindexの文字列をコンバインします（例：addresses_user_id_index）。

次は、このmigrationの反映ですが、その前に–pretendのオプションでどんなSQL文が実行されるかチェックしてみます。

$ php artisan migrate --pretend
ChangeAddressesTable: alter table `addresses` add index `addresses_user_id_index`(`user_id`)

いいですね。思い通りです。

実際にmigrateします。

$ php artisan migrate
Migrating: 2019_01_15_132109_change_addresses_table
Migrated:  2019_01_15_132109_change_addresses_table

住所タイプの導入とユニークインデックスの追加

次は、もう少し複雑なケースを見てみましょう。

現在は、1ユーザー(usersの1レコード）において、複数の住所（addressesのレコード）を紐づけることができますが、住所が会社のものか自宅なのか別荘（夢）なのかわかりません。そこで、その情報を保存するために住所タイプなるtypeという項目を追加します。

migrationを作成します。

$ php artisan make:migration change_addresses2 --table=addresses

作成されたファイルを編集します。

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class ChangeAddresses2Table extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('addresses', function (Blueprint $table) {
            // 項目の追加
            $table->string('type')->after('user_id');

            // インデックスを付け直す
            $table->dropIndex('addresses_user_id_index');
            $table->unique(['user_id','type']);
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('addresses', function (Blueprint $table) {
            $table->string('type')->after('user_id');                                                                                                                                                              
                                                                                                                                                                                                                   
            $table->dropIndex('addresses_user_id_index');                                                                                                                                                          
            $table->unique(['user_id','type']);  
        });
    }
}

typeの項目の追加の後には、現在のインデックスを削除して新規にuser_idとtypeをコンバインしたインデックスを追加しなおします。そして、1ユーザーに対して住所タイプは同じものを使用できない制限のために、unique()の関数を使用します。

またもや、–pretendでSQL文をチェックします。

$ php artisan migrate --pretend
ChangeAddresses2Table: alter table `addresses` add `type` varchar(191) not null after `user_id`
ChangeAddresses2Table: alter table `addresses` drop index `addresses_user_id_index`
ChangeAddresses2Table: alter table `addresses` add unique `addresses_user_id_type_unique`(`user_id`, `type`)

次は、migrateの実行なのですが、すでにデータがある状態で実行するとレコード重複のエラーが出る可能性あります。とくにすでに１ユーザーに対して複数の住所のレコードがある場合は、それらの項目に新規の項目typeに空が入ってくるからです。

今回は、このエラーを避けるために、migrate:freshを実行します。すべてのテーブルをdropしてから作成したmigrationをすべて実行してくれます。

$ php artisan migrate:fresh
Dropped all tables successfully.
Migration table created successfully.
Migrating: 2014_10_12_000000_create_users_table
Migrated:  2014_10_12_000000_create_users_table
Migrating: 2014_10_12_100000_create_password_resets_table
Migrated:  2014_10_12_100000_create_password_resets_table
Migrating: 2019_01_10_140631_create_addresses_table
Migrated:  2019_01_10_140631_create_addresses_table
Migrating: 2019_01_15_132109_change_addresses_table
Migrated:  2019_01_15_132109_change_addresses_table
Migrating: 2019_01_18_131940_change_addresses2_table
Migrated:  2019_01_18_131940_change_addresses2_table

しかし、実際のプロダクションではできないことですね。データ皆空になってしまうし。その対応は課題としましょう。

フェイクデータの作成

さて、DBテーブルができたところで、前回のようにフェイクデータの作成をしてみたいです。

今回追加したtypeの項目のために、database/factories/AddressFactory.phpを編集します。

use Faker\Generator as Faker;

$factory->define(App\Address::class, function (Faker $faker) {
    return [
       'type'    => $faker->randomElement(['自宅', '会社']),
       'address' => $faker->address
    ];
});

tinkerで実行してみます。

>>> factory(App\User::class,3)->create()->each(function ($user) { $user->addresses()->save(factory(App\Address::class)->make()); });
...
User::join('addresses', 'users.id', '=', 'addresses.user_id')->get();
=> Illuminate\Database\Eloquent\Collection {#2346
     all: [
       App\User {#2307
         id: 1,
         name: "山本 七夏",
         email: "hirokawa.osamu@example.org",
         created_at: "2019-01-19 02:33:51",
         updated_at: "2019-01-19 02:33:51",
         user_id: 1,
         type: "自宅",
         address: "5212837  京都府佐々木市西区近藤町加納9-4-4 コーポ宮沢110号",
       },
       App\User {#2353
         id: 2,
         name: "若松 裕樹",
         email: "tsuda.rika@example.com",
         created_at: "2019-01-19 02:33:51",
         updated_at: "2019-01-19 02:33:51",
         user_id: 2,
         type: "自宅",
         address: "4853444  奈良県佐々木市南区鈴木町廣川8-3-9",
       },
       App\User {#2355
         id: 3,
         name: "江古田 裕太",
         email: "ksato@example.org",
         created_at: "2019-01-19 02:33:51",
         updated_at: "2019-01-19 02:33:51",
         user_id: 3,
         type: "会社",
         address: "8386040  愛知県宮沢市中央区井高町加納4-2-10",
       },
     ],
   }

うまくフェイクデータが作成されましたね。

最後に１つ有用なコマンドとして、migrate:status。現在のmigrationのステータスを一覧できます。左の1列目がすべてＹとなっているのは現在あるmigrationがすべて実行された状態です。

$ php artisan migrate:status
+------+------------------------------------------------+
| Ran? | Migration                                      |
+------+------------------------------------------------+
| Y    | 2014_10_12_000000_create_users_table           |
| Y    | 2014_10_12_100000_create_password_resets_table |
| Y    | 2019_01_10_140631_create_addresses_table       |
| Y    | 2019_01_15_132109_change_addresses_table       |
| Y    | 2019_01_18_131940_change_addresses2_table      |
+------+------------------------------------------------+

migrate:rollbackしたなら、すべてNoのＮとなります。

+------+------------------------------------------------+
| Ran? | Migration                                      |
+------+------------------------------------------------+
| N    | 2014_10_12_000000_create_users_table           |
| N    | 2014_10_12_100000_create_password_resets_table |
| N    | 2019_01_10_140631_create_addresses_table       |
| N    | 2019_01_15_132109_change_addresses_table       |
| N    | 2019_01_18_131940_change_addresses2_table      |
+------+------------------------------------------------+

hasManyのフェイクデータの作成

Sun, 13 Jan 2019 02:19:08 +0900

hasManyリレーションは、Eloquentのモデル間（つまり、DBのテーブル間）に1対多の関係を持たせるリレーションです。今回は、factory()を使って、このhasManyのリレーションを持つDBテーブルにフェイクデータを作成してみます。

hasMany

DBにおける1対多の関係では、2つのDBテーブルを親子とみなすと、親の１レコードに対してそれに紐づく子のレコードが１あるいは複数存在します。

例えば、親をusers（ユーザー）、子をaddresses（住所）とし、それぞれのEloquentのモデル、User、Addressを定義し、User::addresses()のリレーションを定義すれば、以下のようなデータとなります。

>>> User::find(1)->load('addresses');
=> App\User {#2312
     id: 1,
     name: "原田 涼平",
     email: "esasada@example.com",
     created_at: "2019-01-12 01:53:58",
     updated_at: "2019-01-12 01:53:58",
     addresses: Illuminate\Database\Eloquent\Collection {#2340
       all: [
         App\Address {#2349
           id: 1,
           user_id: 1,
           address: "8731301  山口県石田市中央区田中町高橋1-5-6 コーポ高橋110号",
           created_at: "2019-01-12 01:53:58",
           updated_at: "2019-01-12 01:53:58",
         },
         App\Address {#2348
           id: 2,
           user_id: 1,
           address: "7159410  京都府坂本市北区加納町加藤9-7-8",
           created_at: "2019-01-12 01:53:58",
           updated_at: "2019-01-12 01:53:58",
         },
       ],
     },
   }

ここでは、原田さんは２つの住所を持つことが表示されています。もちろん、これらはフェイクデータですが、次の準備をすればこれがtinkerの１行の実行で親子のレコードを作成できます。

準備

Laravelの新規のプロジェクトを作成すると、usersのmigration、model、factoryがすでに定義されています。ここで必要なのは、addressesにおいて同様な定義です。

まず、migrationから

$ php artisan make:migration create_addresses_table --create=addresses

上のコマンドラインでの実行で、

$ ls -1 database/migrations 
2014_10_12_000000_create_users_table.php
2014_10_12_100000_create_password_resets_table.php
2019_01_10_140631_create_addresses_table.php

2019_01_10_140631_create_addresses_table.phpのファイルが作成されます。これを以下のように編集。

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateAddressesTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('addresses', function (Blueprint $table) {
            $table->increments('id');
            $table->integer('user_id')->unsigned();
            $table->string('address');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('addresses');
    }
}

users.idと紐づけるために、addresses.user_idの項目が追加されていることに注意してください。

そして、次を実行して、addressesのDBテーブルを作成します。

$ php artisan migrate
Migrating: 2019_01_10_140631_create_addresses_table
Migrated:  2019_01_10_140631_create_addresses_table

次に、モデルを作成。これもコマンドラインで実行。

$ php artian make:model Address

以下のファイルが作成されます。

app/Address.php

そしてこれを以下のように編集。

namespace App;

use Illuminate\Database\Eloquent\Model;

class Address extends Model
{
    protected $fillable = [
        'address'
    ];
}

Addressのモデルができたところで、UserのモデルにhasManyのリレーション、addresses()を定義します。

app/User.php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use App\Auth\Passwords\CanResetPassword;

class User extends Authenticatable
{
    use Notifiable;
	use CanResetPassword;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];

    public function addresses()
    {
        return $this->hasMany('App\Address');
    }
}

そして、Addressのフェイクデータを作成するためにfactoryを作成します。

$ php artisan make:factory AddressFactory

この実行でAddressFactory.phpのファイルが作成されます。

$ ls -1 database/factories 
AddressFactory.php
UserFactory.php

これを以下のように編集。

use Faker\Generator as Faker;                                                                                                                                                                                      
                                                                                                                                                                                                                   
$factory->define(App\Address::class, function (Faker $faker) {                                                                                                                                                     
    return [                                                                                                                                                                                                       
       'address' => $faker->address                                                                                                                                                                                
    ];                                                                                                                                                                                                             
});

最後に、フェイクデータを日本語で作成するために、config/app.phpに以下を追加します。

..
    'faker_locale' => 'ja_JP', 
..

これで準備終わり。

フェイクデータの作成

さて、tinkerの出番です。

$ php artisan tinker

>>> factory(App\User::class)->create()->each(function ($user) { $user->addresses()->save(factory(App\Address::class)->make()); });
=> true
>>> User::find(1)->load('addresses');
=> App\User {#2310
     id: 1,
     name: "近藤 亮介",
     email: "mikako.koizumi@example.net",
     created_at: "2019-01-12 02:56:16",
     updated_at: "2019-01-12 02:56:16",
     addresses: Illuminate\Database\Eloquent\Collection {#2347
       all: [
         App\Address {#2349
           id: 1,
           user_id: 1,
           address: "8657778  滋賀県松本市南区中島町笹田9-6-2",
           created_at: "2019-01-12 02:56:16",
           updated_at: "2019-01-12 02:56:16",
         },
       ],
     },
   }

factoryの実行文が長いので、整形して表示してみましょう。

factory(App\User::class)->create()
    ->each(function ($user) {
        $user->addresses()
            ->save(
               factory(App\Address::class)->make()
　　　　     ); 
    });

1行目で、usersのレコードが作成され、それぞれのusersのレコードにおいて、addresses()のリレーションをもとにaddressesのレコードが作成されます。

１つのusersのレコードに対して、addressesのレコードが複数欲しいなら、save()の部分を

saveMany(factory(App\Address::class, 2)

に置き換えます。以下のように２つaddressesのレコード作成となります。

>>> factory(App\User::class)->create()->each(function ($user) { $user->addresses()->saveMany(factory(App\Address::class, 2)->make()); });
=> true
>>> User::find(2)->load('addresses');
=> App\User {#2368
     id: 2,
     name: "津田 七夏",
     email: "kudo.kaori@example.org",
     created_at: "2019-01-12 02:59:24",
     updated_at: "2019-01-12 02:59:24",
     addresses: Illuminate\Database\Eloquent\Collection {#2369
       all: [
         App\Address {#2354
           id: 4,
           user_id: 2,
           address: "8621292  長崎県石田市中央区大垣町渡辺3-6-8",
           created_at: "2019-01-12 02:59:24",
           updated_at: "2019-01-12 02:59:24",
         },
         App\Address {#2357
           id: 5,
           user_id: 2,
           address: "6857809  沖縄県三宅市南区山本町山岸9-5-9 コーポ山口101号",
           created_at: "2019-01-12 02:59:24",
           updated_at: "2019-01-12 02:59:24",
         },
       ],
     },
   }