PHPUnitでテストを行う

Testメソッド作成

makeでTestUnitを作成

$ php artisan make:test [TestUnitName]

🙂💬 作成したTestUnitは[tests/Feature/]配下に配置されるので、機能が分かれている時は[TestUnitName]にディレクトリも追加する.

Testメソッドを実装

以下が初期状態

<?php

namespace Tests\Feature;

use Tests\TestCase;
use Illuminate\Foundation\Testing\RefreshDatabase;

class SampleTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function testExample()
    {
        $this->assertTrue(true);
    }
}

一番重要なのが assertHoge() のようなアサートメソッド. アサーションを行う.
このメソッドがそのテストの成功失敗を判定する. 基本的に１メソッドに対して１アサートメソッドだが、複数指定も可能.
（私は今回１：１でやったので複数指定の場合は他を参照してね.）

アサートメソッド一覧

アサートメソッドに関しては私がまとめるよりも公式が充実しているのでそちらを参照のこと.

DBとのやりとりが発生する場合の約束ごと

🙁💭 ここが一番大変だった、というか知らなかったのではまった.

必ず setUp() すること

<?php
...略...
public function setUp()
{
    parent::setUp(); //おまじない. よくわからんがこれを書くことで環境をリセットしてる.
}

DBとの接続をするときに必ず必要.
各テストメソッドの実行前に呼ばれるメソッドで、テストメソッドごとに同じ環境を用意しテストメソッド内で動的に変化させて追従したい場合に使う.
DBとの接続で必要なのは、メソッドごとにDBの環境をリセットしたいから.
例）テストメソッド１で全データを削除→テストメソッド２で特定のデータを取得できることを確認すると、データが消えているのでNGとなる…ﾅﾄﾞ

tearDown() というのもあって、これは各テストメソッドの実行後に呼ばれる. あと処理が必要な場合はこれも実装が必要.

ざっくり書いてある記事があったので参考に：PHPUNITのテストメソッド実行前後の処理まとめ

DBとの接続（モデルにお任せバージョン）

🙁💭 どのサイトを見てもテスト内部でDBを指定して〜というのばかりで迷ったので書いておく.

<?php
...略...
/**
 * @test
 */
public function 情報を取得できる()
{
	//Nekoモデルインスタンスを作成し、factory1()で作成したデータをDBに登録している.
    $neko = factory(Neko::class)
                ->create($this->factory1()); //factoryについては後述
                
    $nekolist = $neko->selectAll(); //（modelのselectAll()で値を取得している.）
    
    TestCase::assertNotNull($nekolist); //帰ってきた値がNullでなければ"OK"
}

private function factory1()
{
    $data = ([
        'name'			=> 'Tama',
        'kind'			=> 'Abyssinian',
        'birthday'	=> '2022-02-22 22:22:22',
    ]);
        
    return $data;
}

@test アノテーションをつけることでメソッド名に"test"を入れなくてもテストメソッドだと判断をしてくれる
アノテーションもたくさんの種類があるので公式サイトを見てみると良い. わたしは依存を示す @depends をそこそこ使った.

factoryとは？

モデルファクトリー：Laravel 5.1 テスト

テスト実行前に何件かのレコードをデータベースに挿入する必要はよく起きます。こうしたテストデータを手動でそれぞれのカラムへ値を指定する代わりに、Laravelでは「ファクトリー」を使用しEloquentモデルの各属性にデフォルトを設定できます。手始めにアプリケーションのdatabase/factories/ModelFactory.phpファイルを見てください。このファイルには最初からファクトリーの定義が含まれています。

🙂💬 複数のテストにまたがって、共通のいくつかのレコードをデータベースに登録したいときにファクトリーを呼び出すことで簡単にデータを設定することができる. （手動で特定の値を列ごとに設定しなくてよい）

以下ファクトリークラスの例

<?php
...略...
$factory->define(App\Neko::class, function (Faker\Generator $faker) {
    return [
        'name'			=> $faker->name,
        'kind'			=> $faker->kind,
        'birthday'	=> date('Y-m-d H:i:s'),
    ];
});

define()のはじめで対応するモデルを指定する.
$faker は呼び出し時にcreate()に渡される引数.
渡した引数が定義に足りない場合は、定義の値がDBに登録される.

PHPUnitの実行

⚠️プロジェクトのルートにて実施すること

// テストの実行
$ vendor/bin/phpunit

実行結果

成功の場合

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

...............................................................  63 / 108 ( 58%)
.............................................                   108 / 108 (100%)

Time: 3.42 seconds, Memory: 24.00MB

OK (108 tests, 262 assertions)

エラーの場合以下のように出てきます.
. は成功、 F は失敗などいろいろある：PHPUnit マニュアル

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

....F..........................................................  63 / 108 ( 58%)
.............................................                   108 / 108 (100%)

Time: 2.87 seconds, Memory: 24.00MB

There was 1 failure:

1) Tests\Feature\NekoTest::ユーザ一情報覧を取得できる
Failed asserting that [エラー発生個所のフルパス] [エラーの内容]
...略...
~/tests/Feature/NekoTest.php:33

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

気づき

テストの対象にしたい機能をmodelで実装していないとテストにできないので、controllerへ依存しないようなコーディングが命.
このテストだけで全部を網羅しようと分割をやり過ぎても良くないので、必要な場面を判断しつつうまく活用するのが良い.
求める結果がどのようなものかを理解していないと書けない.

わかってないところ

この部分は何？？？カバレッジ？？？ f:id:azix:20180525180747p:plain

信頼サイト

PHPUnit マニュアル