LaravelとPHPUnit-データアクセスをモック化してHTTPテスト＆ユニットテストを効率化する-

Factory定義

まずはFactoryを編集して、モック化に使用する疑似データを定義しておきます。

Factoryは以下artisanコマンドで生成できます。

# プロジェクトルートへ移動
cd /path/to/laravel

# Factory生成
php artisan make:factory BookFactory

生成したBookFactoryに以下を追加します。

laravel/database/factories/BookFactory.php

$factory->define(Book::class, function () {
    return [
        'id'     => 1,
        'name'  => '車輪の下で',
        'author_id' => 1,
        'author' => [
            'id'     => 1,
            'name' => 'ヘルマン・ヘッセ'
        ]
    ];
}, 'test_book_mock_data_1');

コントローラのテスト

ここからHTTPテストを定義していきます。以下のartisanコマンドを叩いてテストクラスを生成します。

# コントローラのテストクラス生成
php artisan make:test BookListControllerTest

laravel/tests/Feature/BookListControllerTest.php

<?php

namespace Tests\Feature;

use Mockery;
use App\Services\BookDataAccess;
use Tests\TestCase;

class BookListControllerTest extends TestCase
{
    /** @var Mockery */
    protected $repositoryMock;

    public function setUp(): void
    {
        parent::setUp();

        // BookListの疑似データを作成
        $books = [];
        $books[] = factory(\App\Book::class, 'test_book_mock_data_1')->make()->toArray();

        // リポジトリのデータアクセスをモック
        $this->repositoryMock = Mockery::mock(BookDataAccess::class);
        $this->repositoryMock->shouldReceive('getList')->andReturn($books);
        $this->app->instance(BookDataAccess::class, $this->repositoryMock);
    }

    public function tearDown(): void
    {
        parent::tearDown();
        Mockery::close();
    }

    /**
     * @test
     * @group http
     * @group booklist
     * @group getlist
     */
    public function getList_データ取得が正常に行えビューが表示されること()
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }

    /**
     * @test
     * @group http
     * @group booklist
     * @group getlist
     */
    public function getList_ビューへ渡すデータが意図した構造であること()
    {
        $response = $this->get('/');

        $response->assertViewHas('list');
    }
}

コンストラクタであるsetUpメソッドで、データアクセス部分のモック化を行っています。

$books[] = factory(\App\Book::class, 'test_book_mock_data_1')->make()->toArray();

先にFactoryで定義した疑似データを取得し、BookListの疑似データを作成しています。

// リポジトリのデータアクセスをモック
$this->repositoryMock = Mockery::mock(BookDataAccess::class);
$this->repositoryMock->shouldReceive('getList')->andReturn($books);
$this->app->instance(BookDataAccess::class, $this->repositoryMock);

リポジトリへのデータアクセスをモック化しています。

1. データアクセスに対するモックを作成
2. リポジトリのgetList()メソッド要求に対して、BookListの疑似データを返す様に指定
3. データアクセスに対してモック化を実行

これでデータアクセス部分のモック化が実行されます。

次に各テストケースですが、HTTPテストなので、リクエストを発生するところからがスタートになります。 今回定義したテストケースではそれぞれ、ドメインルートへのリクエストに対して以下のテストケースを定義しています。

• HTTPステータスコード200のレスポンスを以て正常にビューの表示までが行えた事
• リクエストの処理後、ビューに渡されるデータにlistプロパティが存在している事

つまり今回の例で言えば、HTTPテストを行う事によって、
「ドメインルートへのリクエストをBookListコントローラが受け取り、Bookサービスクラスがリポジトリよりデータを取得しそれをビューへ渡す」
という一連の処理の流れをテストする事ができるわけです。

今回定義した２つのテストケースによって、きちんと意図した処理の道筋を通る事を確認する。 これがHTTPテストを行う意味です。なので、ストレージ部分はモック化し、そこの部分はリポジトリのユニットテスト（DBテスト）で行う事で、自動テストを効率化（時間短縮）する事ができます。

今回の例でもしデータアクセス部分をモック化しない場合はリポジトリからのデータアクセスが発生するので、テスト用のDBやデータを用意する必要があります。 どのみち前処理が必要になるので、それならばモック化した方が良い事しかありません。

サービスクラスのテスト

テスト対象であるBookServiceクラスは以下のようなソースになっています。

laravel/app/services/BookService.php

<?php
declare(strict_types=1);

namespace App\Services;

use App\Entities\BookList;

class BookService implements BookDataAccess
{
    /** @var BookDataAccess */
    private $BookDataAccess;

    /** @var BookList */
    private $BookList;

    public function __construct(BookDataAccess $BookDataAccess, BookList $BookList)
    {
        $this->BookDataAccess = $BookDataAccess;
        $this->BookList       = $BookList;
    }

    public function getList(): BookList
    {
        $data = $this->BookDataAccess->getList();

        $this->BookList->set($data);

        return $this->BookList;
    }
}

定義されているgetList()メソッドは、リポジトリから取得したデータをエンティティに渡しBookListオブジェクトを作成して返す処理になっています。 このメソッドに対するユニットテストを定義します。

以下のartisanコマンドを叩いてテストクラスを生成します。

# サービスクラスのテストクラス生成
php artisan make:test BookServiceTest --unit

laravel/tests/Unit/BookServiceTest.php

<?php
declare(strict_types=1);

namespace Tests\Unit;

use Mockery;
use Tests\TestCase;
use App\Services\BookDataAccess;
use App\services\BookService;

class BookServiceTest extends TestCase
{
    /** @var Mockery */
    protected $repositoryMock;

    /** @var BookService */
    protected $BookService;

    public function setUp(): void
    {
        parent::setUp();

        // BookListの疑似データを作成
        $books = [];
        $books[] = factory(\App\Book::class, 'test_book_mock_data_1')->make()->toArray();

        // リポジトリのデータアクセスをモック
        $this->repositoryMock = Mockery::mock(BookDataAccess::class);
        $this->repositoryMock->shouldReceive('getList')->andReturn($books);
        $this->app->instance(BookDataAccess::class, $this->repositoryMock);

        // BookServiceインスタンス生成
        $this->BookService = app(BookService::class);
    }

    public function tearDown(): void
    {
        parent::tearDown();
        Mockery::close();
    }

    /**
     * @test
     * @group unit
     * @group service
     * @group BookService
     * @group getList
     */
    public function getList_返り値がBookListオブジェクトであること(): void
    {
        $data = $this->BookService->getList();

        $this->assertInstanceOf(\App\Entities\BookList::class, $data);
    }

    /**
     * @test
     * @group unit
     * @group service
     * @group BookService
     * @group getList
     */
    public function getList_必要なプロパティを保持していること(): void
    {
        $data = $this->BookService->getList();

        $this->assertObjectHasAttribute('id', $data->getIterator()[0]);
        $this->assertObjectHasAttribute('name', $data->getIterator()[0]);
        $this->assertObjectHasAttribute('author', $data->getIterator()[0]);
    }
}

モック化の手順は先程と同じなので、バリエーションとしての紹介です。 このメソッドでは受け取ったデータでBookListオブジェクトを作成するという仕事があるので、その部分が意図通りに行えている事が最も テストしたい部分になります。なのでデータアクセス部分はモック化し、その処理が正しく行えているかだけをテストしている。という事になります。

リポジトリのテスト

リポジトリでは実際にデータの操作を行う部分なのでモック化はせず、実際にDBを操作してテストを行います。 今回はMySQLとSQLiteでのデータソースを用意していたので、この２つのリポジトリに対するテストを定義します。

まずはテスト対象となるインターフェースと各リポジトリのソースです。

laravel/app/Services/BookDataAccess.php

<?php
declare(strict_types=1);

namespace App\Services;

interface BookDataAccess
{
    public function getList();
}

laravel/app/Repositories/BookMysqlRepository.php

<?php
declare(strict_types=1);

namespace App\Repositories;

use App\Services\BookDataAccess;
use App\Book;

class BookMysqlRepository implements BookDataAccess
{
    protected $Book;

    private $connection = 'mysql';

    public function __construct(Book $Book)
    {
        $this->Book = $Book;
    }

    public function getList(): array
    {
        return $this->Book::on($this->connection)->with('author:id,name')->get()->toArray();
    }
}

laravel/app/Repositories/BookSqliteRepository.php

<?php
declare(strict_types=1);

namespace App\Repositories;

use App\Services\BookDataAccess;
use App\Book;

class BookSqliteRepository implements BookDataAccess
{
    protected $Book;

    private $connection = 'sqlite';

    public function __construct(Book $Book)
    {
        $this->Book = $Book;
    }

    public function getList(): array
    {
        return $this->Book::on($this->connection)->with('author:id,name')->get()->toArray();
    }
}

これらに対してテストを定義します。 以下のartisanコマンドを叩いてテストクラスを生成します。

php artisan make:test BookDataAccessTest --unit
php artisan make:test BookMysqlRepositoryTest --unit
php artisan make:test BookSqliteRepositoryTest --unit

それぞれ、テストを定義していきます。

laravel/tests/Unit/BookDataAccessTest.php

<?php

namespace Tests\Unit;

use Tests\TestCase;

abstract class BookDataAccessTest extends TestCase
{
    /**
     * @test
     * @group unit
     * @group DataAccess
     * @group Book
     * @group getList
     */
    public function getList_データ取得が正常に行われること()
    {
        factory(\App\Author::class, 'test_author_data_1')->create();
        factory(\App\Book::class, 'test_book_data_1')->create();

        $list = $this->Book->getList();

        $this->assertCount(1, $list);
    }

    /**
     * @test
     * @group unit
     * @group DataAccess
     * @group Book
     * @group getList
     */
    public function getList_必要なプロパティがセットされていること()
    {
        factory(\App\Author::class, 'test_author_data_1')->create();
        factory(\App\Book::class, 'test_book_data_1')->create();

        $list = $this->Book->getList();

        $expected = [
            'id', 'name', 'author_id', 'author'
        ];
        $this->assertSame($expected, array_keys($list[0]));

        $expected = [
            'id', 'name'
        ];
        $this->assertSame($expected, array_keys($list[0]['author']));
    }

}

laravel/tests/Unit/BookMysqlRepositoryTest.php

<?php

namespace Tests\Unit;

use App\Book;
use App\Entities\BookList;
use App\Services\BookDataAccess;
use App\Repositories\BookMysqlRepository;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\Artisan;

class BookMysqlRepositoryTest extends BookDataAccessTest
{
    use RefreshDatabase;

    protected $Book;

    public function setUp(): void
    {
        parent::setUp();

        $this->app->bind(BookDataAccess::class, function($app) {
            return new BookMysqlRepository(new Book, new BookList);
        });

        $this->Book = app(BookMysqlRepository::class);
    }

    public function tearDown(): void
    {
        Artisan::call('migrate:refresh');
        parent::tearDown();
    }
}

laravel/tests/Unit/BookSqliteRepositoryTest.php

<?php

namespace Tests\Unit;

use App\Book;
use App\Entities\BookList;
use App\Services\BookDataAccess;
use App\Repositories\BookSqliteRepository;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\Artisan;

class BookSqliteRepositoryTest extends BookDataAccessTest
{
    use RefreshDatabase;

    protected $Book;

    public function setUp(): void
    {
        parent::setUp();

        // データベースをSQLiteへ変更
        config(['database.default' => 'sqlite']);

        // マイグレーション実行
        Artisan::call('migrate:refresh');

        $this->app->bind(BookDataAccess::class, function($app) {
            return new BookSqliteRepository(new Book, new BookList);
        });

        $this->Book = app(BookSqliteRepository::class);
    }

    public function tearDown(): void
    {
        parent::tearDown();
    }
}

ちなみにデータソースが２つありますが、それぞれのテストDBを用意しています。

# .env
DB_DATABASE=laravel_db
DB_DATABASE_SQLITE=/vpath/to/laravel/database/database.sqlite

# .env.testing
DB_DATABASE=test_laravel_db
DB_DATABASE_SQLITE=/path/to/laravel/database/test_database.sqlite