BackEnd

Laravelでテストコードを書くには? Featureテスト/Unitテスト

投稿日:

はじめに

Laravelでは、PHPUnitが標準で組み込まれているので、プロジェクトのセットアップ完了後、すぐにテストコードを書き始めることができます。この記事では、Featureテストを使用したWeb APIのテストコードの実装と、Unitテストを使用したデータベースのテストコードの実装について紹介します。

FeatureとUnitの使い分け

testsディレクトリの配下に、Featureディレクトリと、Unitディレクトリがあり、ここにテストコードを配置していきます。
FeatureにはControllerやRouting、Middlewareの機能テストを実装し、それ以外の単体テストをUnitに実装します。
phpunit.xmlにこの2つのテストスイートが定義済みのため、テストを実行すると、両方のテストコードが実装されます。さらにテストスイートを分解したい場合は、phpunit.xmlを編集することで、テストスイートを増やすことができます。

今回は、図書貸し出し機能を例に、テストコードについて説明していきます。

テスト用データベースの準備

自動テストでは、テスト中に何度かデータベースをリフレッシュするため、テスト専用のデータベースを用意しておきましょう。
phpunit.xmlで、<php>タグの中に、<server>タグを使用すると、テスト時にenvファイルの設定を上書きすることができます。
今回は、同ホスト内に別のデータベースを用意したため、 DB_DATABASEのvalueを、テスト用のデータベースに変更します。

これで、テストを実行したときは、テスト用のデータベースが使用されるようになります。

Featureテスト

Featureテストを使用して、Web APIのテストコードを実装したいと思います。

テスト対象のコード

まずは、対象となるマイグレーション、コントローラ、ルーティングを実装します。

マイグレーション

ルーティング(api.php)

コントローラ(BookController.php)

モデル(Book.php)

テストコードの実装

まず、テストコードのファイルを生成します。

tests/Featureディレクトリに、テストコードの雛形が作成されます。ここにテストコードを実装していきます。
/api/booksへのリクエストのテストコードです。

$this->get()メソッドを使用することで、第一引数のパスにリクエストすることができます。
その他にも、$this->post()でPOSTリクエストも可能です。その場合は、第二引数で、配列でパラメータを付与します。

テスト結果の検証

アサーションで検証することができます。

ステータスコードの検証

assertStatus()メソッドを使用します。

JSONのパラメータ判定

assertJsonFragment()メソッドを使用すると、引数に渡したJSONが、レスポンスに含まれているか検証します。

JSONの完全一致を検証する場合は、assertJson()メソッドを使用します。

テストの実行

次のコマンドでテストを実行できます。

テストに成功すると、次のように出力されます。

テストに失敗すると、失敗箇所が表示されるため、実装を修正して、再度テストを行いましょう。

Unitテスト

Unitテストを使用して、モデルの単体テストを実装したいと思います。

テスト対象の実装

先ほどのBookモデルに、本の貸し出し・返却用のメソッドを追加します。

Factory

Factoryは、ダミーレコードを作成できる機能です。引数にFakerが入るため、ダミーデータをランダムに生成することも可能です。
今回は、あらかじめ貸し出す本を登録しておくため、Factoryを使用して、booksテーブルにインサートしていきます。
まず、Factoryファイルを作成します。

--modelオプションで、ファクトリで生成するモデルを指定します。ここで指定したモデルが、ファクトリ内で定義されます。
このモデルクラスを指定しないと、ファクトリでデータを生成しようとしても、エラーとなるため、必ず指定しましょう。

カラム名をキーとして、値を設定していきます。 $fakerを使用している箇所は、それぞれランダムな値が入ります。
Fakerの主なメソッドを紹介します。

  • randomNumber()
    ランダムな正数値を生成します。
  • numberBetween(min, max)
    min〜maxの間のランダムな正数値を生成します。
  • email
    ランダムなメールアドレスを生成します。
  • phoneNumber
    ランダムな電話番号を生成します。
  • name
    ランダムな人物名を生成します。
  • sentence()
    ランダムな1文を生成します。
  • paragraph()
    ランダムな1段落分の文章を生成します。

そのほかにも、様々なフォーマットがあります。
参考: Faker (Github)

単体テストの実装

単体テストのファイルを作成します。 --unitオプションを付けると、 tests/Unitディレクトリに作成されます。単体テストの場合は、Featureと区別を付けるために、このオプションを使用した方が良いでしょう。

テストコードを実装します。

setUp()メソッドは、各テストが始まる前に毎回呼ばれます。 RefreshDatabaseトレイトを使用しているため、テスト実施ごとにデータベースの全レコードが削除されるため、ここでFactoryを使用してデータを投入します。
ここでは使用していませんが、tearDown()メソッドは、テスト終了時に毎度呼ばれるメソッドで、各テスト後の後処理に使用します。
testCheckOut()メソッドとtestReturnBook()メソッドが、今回実装したテストです。assertEquals()メソッドを使用して、実行結果を検証します。

テストの実行

Featureテストと同じく、次のコマンドでテストを実行できます。

さいごに

いかがでしたか。Laravelでは初めからPHPUnitを使用することができるので、手軽にテストコードを書き始めることができました。適切なテストコードを書いて、システムの品質・保守性向上に繋げたいと思います。

おすすめ書籍

PHPフレームワークLaravel入門 第2版 PHPフレームワーク Laravel実践開発 PHPフレームワーク Laravel Webアプリケーション開発 バージョン5.5 LTS対応 よくわかるPHPの教科書 【PHP7対応版】

blog-page_footer_336




blog-page_footer_336




-BackEnd
-,

執筆者:


comment

メールアドレスが公開されることはありません。

CAPTCHA


関連記事

laravel logo

LaravelのArtisanコマンドを自作する

1 はじめに2 コマンドの作成方法3 コマンドの実装3.1 文字列出力3.2 引数3.3 オプション3.4 入力を使用した対話型3.4.1 ask()メソッド3.4.2 secret()メソッド3.4 ...

js

Moment Timezoneを使ってJavaScriptで日付を変換する

1 はじめに2 Moment Timezone2.1 セットアップ2.2 使用例3 Moment Timezoneの機能3.1 タイムゾーンの一覧を表示する3.2 現在のタイムゾーンを表示する3.3 ...

rails

Railsでの非同期処理とDelayed Job

1 はじめに2 Active Job2.1 Active Jobの役割2.2 ジョブを作成する2.3 ジョブをキューに登録する2.4 コールバック2.5 例外3 Delayed Job3.1 設定3. ...

laravel logo

LaravelのFacade(ファサード)とは? 何気なく使用していた裏側の仕組みを解説!

1 はじめに1.1 Facadeを使用しているクラス2 Facadeの仕組み3 Facadeの作成3.1 サンプルコードに必要な実装3.2 Serviceの作成3.3 Facadeクラスの作成3.4 ...

PHPerだけどKotlinを勉強したって良いよね その1〜クラス編〜

1 はじめに2 インターフェース2.1 基本2.2 デフォルト実装付メソッド2.3 同じメソッド名を持つ複数のインターフェース3 修飾子3.1 open3.2 abstract4 可視性修飾子5 さい ...

フォロー

follow us in feedly

blog-page_side_responsive

2020年4月
 1234
567891011
12131415161718
19202122232425
2627282930 

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。