laravelとテストについて

Copyright © Xchange Solutions All right reserved.

Fukuoka.php Vol.17 ～Rebooted～

Laravelとテストについて

株式会社エクスチェンジソリューションズ

野田健夫

2016.06.22

2


こんにちは！

野田健夫（のだたけお）https://twitter.com/nodatakeo

https://www.facebook.com/nodatakeo

株式会社エクスチェンジソリューションズ

http://twitter.com/nodatakeo

https://www.facebook.com/nodatakeo

3


今日の内容

1. 開発者に立ちはだかるテストの壁

2. なぜテストをやるのか？

3. テストの種類

4. テストへのジレンマ

5. Laravelテスト

環境構築

API編

ウェブページ編

その他

6. まとめ

4


開発者に立ちはだかるテストの壁

環境作るのが面倒くさい。

実装に比べて生産的でない感じがする。

単体テストはともかくとして、シナリオ

テストが作りにくい。

時間がない。

5


なぜテストをやるのか？

利用可能な状態を担保するため。

要件を満たしているか確認するため。

品質を高め、信頼性を上げるため。

システムが動かなかったり、品質が低いと

利用者・顧客の不利益になる。その

リカバリーにかかる作業コストも大きい。

6


テストの種類

単体テスト

結合テスト

システムテスト

メソッド・関数の期待値検査

APIスキーマ・HTMLコンテンツチェック

シナリオテスト・脆弱性テスト

パフォーマンス、ログ、サーバー周りなど

これまでテスト自動化に悩んでいた領域

→xUnitテスト

→debugbar、slowログ、jmeter、zabbixなど

※ウェブアプリケーションでの例

7


テストへのジレンマ

テストの必要性は理解しているけど、コスト高い

のでは？

自動テストでできる検査って、ロジック以下の

assertHoge系の値検査ぐらいしかなかったっけ？

調べてみたらLaravelでいろいろテストを

支援する仕組みが用意されていた。

8


Laravelのテスト: phpunit

よく使われているphpunitでのテストを

ベースとしている。

composer dump-autoload

./vendor/phpunit/phpunit/phpunit tests

composer dump-autoload

./vendor/phpunit/phpunit/phpunit --filter 'testContent' tests/api/ApiContentControllerTest.php

./tests 以下のテストケースをすべて実行する。

./tests 以下のテストケースのうち特定のテストクラスでfilterして実行する。

9


Laravelのテスト: 環境構築(Fixture)

テストのフィクスチャ(Fixture:ベースとなるデー

タ設定)に Seederを使う。

過去の案件では、.envのAPP_ENVをみて、環境ごとに切り替えれるSeederを用意。

abstract class BaseSeeder extends Seeder

{

/*** Get default seeds by table name* @param $target table name* @return void*/

public function getConfig($target)

{

$config = require(base_path('database/seeds/default_'. config('app.env') . '.php'));

return array_get($config, $target);

}

}

class ContentSeeder extends BaseSeeder

{

/*** Run the database seeds.** @return void*/

public function run()

{

//削除Content::truncate();

// コンテンツのデータ追加foreach ($this->getConfig('contents') as $record) {

$dao = new Content ();

$dao->setUpRecord($record);

$dao->save();

}

}

}

テストの初期状態を共有

10


Laravelのテスト: APIスキーマチェック

seeJsonStructureメソッド

キー名の配列を渡して構造をチェック

assertResponseStatus/assertResponseOkメソッド

HTTPステータスコードをチェック

// JSONパラメータ$content = [];

// メソッド$method = 'GET';

// URL

$url = route("contents.get");

// サーバー環境変数$server = $this->getServerParameter($method, $url);

// JSONでAPIを呼び出し$this->withServerVariables($server)

->json($method, $url, $content, $server);

// JSON構造のチェック$this->seeJsonStructure([

'error',

‘content_list' => [

'*' => [

'id',

'title',

],

],

]);

// ステータスコードのチェック$this->assertResponseStatus(200);

// レスポンス状態のチェック$this->assertResponseOk();

11


Laravelのテスト: API値チェック

seeメソッドレスポンス中に値が含まれるか検査が可能。

responseプロパティレスポンス自体も取得できるので、値を抜き出せば、従来のassert

チェックも可能。

$this->see('Laravel 5');

$response = json_decode($this->response->content(), true);

$this->assertEquals('Laravel 5', $response['title']);

12


Laravelのテスト: WEBコンテンツチェック

visitメソッド

URLにアクセス。

typeメソッド

指定IDフォームに入力。

pressメソッド

指定IDボタンを押下。

seePageIsメソッド

現在URL値をチェック。

$this->visit(route('admin.logout'));

$this->visit(route('admin.login'));

$this->type('[email protected]', 'login_id');

$this->type('testpw123', 'login_pw');

$this->press('action');

$this->seePageIs(route('admin.top'));

$this->see('TOPページ');

シナリオテストの動作チェックが可能。

13


Chrome Extension: Laravel TestTools

14


Chrome Extension: Laravel TestTools

開発ツール(ctrl+shift+i)のタブに「Laravel TestTools」が追加。

Selenium IDEの記録のような形で[Record]ボタンを押下すると

テストコードが生成されます。

15


DB値のチェック

seeInDatabaseメソッド

テーブル内に指定したキーのレコードがあるかチェック。

$this->seeInDatabase('users', ['email' => '[email protected]']);

16


Test用Trait

Illuminate/Foundation/Testing/DatabaseMigrations.php (Trait)

テスト開始時にマイグレーションを実行し、終了後にマイグレーションロールバックする。

Illuminate/Foundation/Testing/DatabaseTransactions.php (Trait)

テスト開始時にトランザクションを開始し、終了後にロールバックする。

Illuminate/Foundation/Testing/WithoutEvents.php (Trait)

すべてのイベントを抑止して余計な処理を発生させない。

Illuminate/Foundation/Testing/WithoutMiddleware.php (Trait)

すべてのミドルウェアを抑止して余計な処理を発生させない。

Illuminate/Foundation/Testing/Conserns/* (Trait)

テスト向けの各種実装。see*系(seeJsonStructureなど)は、ほかのフレームワークでも参考になると

思います。

17


まとめ

テスト自動化は、テストの壁を低くする。

開発してリリースしておしまいでなく、開発が継続する案件

が増えている。デグレを避けるためにも必須になりつつある

ように感じている。

フレームワークが持っているテストの仕組みを使うことでAPI

スキーマテストやシナリオテストといったより複雑なテスト

自動化をシンプルに行うことができる。

テストは放っておくと腐る。テストが適切に行われるよう仕

様変更や動作が変わった場合は、メンテナンスを必ず行う。

18


番外編：GuzzleでAPI/シナリオテスト

GuzzleもAPIクライアントとしてだけでなく

テストにもシンプルで使い易いと思います。

public function __construct()

{

$this->endPoint = "https://hoge.jp";

$this->client = new HttpClient($this->endPoint);

}

/*** OAuth 認証ページテスト* @Test*/

public function testAuthorization() {

$this->endPoint = “https://hogehoge.jp”;$this->client = new HttpClient($this->endPoint);

// rfc6570

$uri = array(‘/auth/authorize?response_type={response_type}&client_id={client_id}&state={state}’,array(‘response_type’ => ‘code’, ‘client_id’ => ‘demoapp’, ‘state’ => session_id()));

// リクエストを作成$request = $this->client->get($uri);

// レスポンスを取得$response = $request->send();

// 値検査$this->assertEquals(200, $response->getStatusCode());

}

19


番外編：テストを取り巻く技術要素

Behat/Mink/PHPSpec

PHPUnit

Framework Unit Testing

Library Unit Testing

単体テスト

結合テスト

Selenium

BDD

※どこまでテストケースに書くかは案件内容と設計内容による。

laravelとテストについて

Engineering