7
2

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

【日本語】What is Pest 3.0(PHP Testing Framework)

7
Last updated at Posted at 2024-09-04

Laravel11からデフォルトのテストフレームワークとなったPestですが、近日バージョンアップが行われます。
まだまだPHPUnitの歴史が深く、浸透していないですが、日本最速(?)キャッチアップを目指して紐解いていきます。

速報としてサクッと紹介しつつ、各機能に「で、自分のプロジェクトに入れるか?」の判断観点を一言ずつ添えています。

Pest 2.0との互換性

完全下位互換性があるため、簡単にバージョンアップ可能です。
この辺は昨今当たり前になってきていますね。

ただし「互換だから上げられる」と「新機能を使うか」は別の話です。バージョンアップ自体のコストはほぼゼロでも、今回の新機能はどれもチームの運用に手を入れる話なので、1つずつ吟味していきます。

主要なアップデート

タスク管理、アーキテクチャプリセット、ミューテーションテストの3点です。
以下にまとめます。

タスク管理

タスク管理を使用すると、担当者(assignee)、課題番号(issue)、プルリクエスト番号、メモなどをテスト上で直接追跡できます。タスクを追跡すると、テストで常に利用できる作業履歴を保持できます。
TDDが捗りそうです。

test('some test 1', function () {
    // ...
})->todo(assignee: 'paulredmond', issue: 13);
 
it('returns a successful response', function () {
    $response = $this->get('/');
 
    $response->assertStatus(200);
})->todo(
    assignee:'nunomaduro',
    issue:11,
    pr:1,
    note:'Need to assert the response body.'
);
 
// Eric is a closer ☕️
test('drives always go in the fairway', function () {
    // ...
})->done(assignee: 'nunomaduro', issue: 11);

#11や@nunomaduroをクリックすればGithubにアクセスできます。
image.png

コマンドラインから、担当者または問題別にテストをフィルタリングできます。

$ pest --issue=11
$ pest --assignee=paulredmond --pr=1
$ pest --assignee=ericlbarnes
$ pest --issue=13
$ pest --notes # returns tests with notes

入れるか?の判断観点

便利そうですが、最初に浮かんだ疑問は「GitHub IssuesやPRコメントと二重管理にならないか?」です。タスクの置き場所が増えると、どちらかが必ず腐ります。

使い分けるなら、

  • 仕様の議論やバグ報告など、会話が必要なタスク → 今まで通りGitHub Issues
  • 「このテストはアサーションが足りない」のようなテストコードに紐づくTODOだけ → Pestのtodo()に寄せる

という線引きが現実的だと考えています。todo()はテストと同じファイルに残るのでコードレビューの射程に入り、Issueと違って放置されにくい。ここが採用する一番の理由になりそうです。

アーキテクチャプリセット

アーキテクチャプリセットは、複数のプロジェクトで同じアーキテクチャルールをすばやく適用し、Laravel、PHP、Strict/Relaxed PHPなどの一般的なプリセットを活用する仕組みです。これにより、デバッグ関数を残したままにするといった操作が防止されるため、コードの一貫性が向上します。
社内の開発環境の均一化の手段の1つとして有効です。またLaravel初心者がいるPJで、PRで指摘しあう必要もなくなるので、より高度なコミュニケーションに集中できます。

これらのプリセットは次の方法で使用できます
arch()->preset()

arch()->expect('dd')->not->toBeUsed();

ddを使っていないことだけをテストすると下記のように検知されます。
image.png

上記のようなテストを1つずつ書くこともできます。(既存PJや大規模PJ向け)
新規PJや中規模、小規模なPJ向けには、下記のように呼び出すだけで一括でテストできます。

// die(), phpinfo()といった不要な関数の呼び出しがないことをテストします。
arch()->preset()->php();
 
// eval(), md5()といったセキュリティに問題ある関数の呼び出しがないことをテストします。
arch()->preset()->security();
 
// コントローラのメソッドを検証するためのプリセットです、
// コントローラファイルの接尾辞が `Controller` である、など。
arch()->preset()->laravel();
 
// クラスがfinalなものであることを保証するプリセットです。
arch()->preset()->strict();
 
// 厳密な型が使用されないようにプリセットされ、finalもprivateメソッドもないことをテストします。
arch()->preset()->relaxed();

入れるか?の判断観点

この機能の本質は、「規約をレビューで指摘する」から「規約をテストで強制する」への転換だと思っています。人間が目視で指摘していたことをCIが落としてくれるので、レビュワーの脳を規約チェックから解放できます。

導入のしやすさはPJの段階で大きく変わります。

  • 新規PJ: 最初からプリセットを有効にしておけばコストほぼゼロ。迷わず入れたい
  • 既存PJ: プリセットを一括で有効にすると違反が大量に検出される前提で構える。まずは上のdd禁止のような1行ルールから始めて、違反をゼロにできたルールから順に足していく段階適用が現実的

「全部直してから入れる」ではなく「入れてから違反を減らしていく」順番にできるのが、テストで強制する方式の良いところです。

ミューテーションテスト

使い方は、--mutateオプションを付けるだけです。
コードをわずかに自動改変(ミューテーション)し、テストを実施します。
この時テストが失敗すれば、テストは正しく書かれています。
もし、テストが成功してしまうと、改変した箇所がテストで検証されていないことがわかります。

入れるか?の判断観点

3つの中で一番「前提を疑ってくる」機能です。
カバレッジ100%が保証するのは「コードが実行された」ことだけで、アサーションが甘ければバグを入れてもテストは通ってしまいます。ミューテーションテストはコードをわざと壊して「テストがちゃんと落ちるか」を見ることで、テストの量ではなく質を検証してくれます。

一方で、改変パターンごとにテストを回し直す仕組み上、実行時間は通常のテストの比ではありません。CIに常時組み込むのは重いので、

  • 普段のCIでは回さず、nightlyや週次など別ジョブで回す
  • まずは決済・認証のような「テストの質が命」のモジュールに絞って回す

あたりから始めるのが現実的だと考えています。

参考

動画を見てわかるように、ここまでサクサクと試せるのはPestだけなのではないでしょうか?
まさにPestの素晴らしさを体現している動画だと思い、私は非常に感動しました。

感動したまま終わらせないために、自分はまず既存PJにdd禁止の1行アーキテクチャテストを入れて、「規約をテストで強制する」ところから試してみます。

7
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
7
2

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?