PHPUnit11の新しい仲間たち

PHPUnitの10.0以降から現時点での最新版である11.1系を比較し、新しく定義されたアサーションメソッドを調べてみました。
本資料は、 第164回 PHP勉強会＠東京(https://phpstudy.connpass.com/event/318430/) でのLTに利用したものです

Transcript

1. PHPUnit11の新しい仲間たち 第164回 PHP勉強会＠東京 / 2024-05-29 Hideki Kinjyo GitHub: o0h / X: @o0h_
2. 自己紹介 • 金城秀樹 / きんじょうひでき • GitHub:@o0h / Twitter:@o0h_ • 好きなFWはCakePHP • アイコンは 美味しい鮭親子丼の写真です • 最近の悩み: 「よく使う操作でKeynoteがクラッシュする」
3. ちわ、どうも・・本日のお話・・・ • PHPUnitの最新版は11.xです • どんな事が変わってるんだ？？？の一部を復習していきます • 一部 = アサーションメソッドの差分
4. 詳しく丁寧な話は、コチラに期待！！ ＼02さん@phpconfuk／ 
5. 今日は アサーションメソッドに 注目していきます
6. なんでアサーションメソッドが好きなの？ • テストコードは、欠陥を発見されるために作成される • => 読まれるのは欠陥が発見された時 • 存在意義を果たすには、「なぜ欠陥なのか」を伝える事が重要 • => コードやメッセージが 「概念レベル(機械寄りではなく、人の認知に近いレベル)」で まとまっていて欲しい
7. なんでアサーションメソッドが好きなの？ • 表現力豊かなテスト(Expressive Tests)は、 xUnit Test Patterns「自動化テストのゴール」群の1つ • 関連パターンに「Custom Assertion」など • "Create a purpose-built Assertion Method that compares only those attributes of the object that define test-specific equality." • アサーションメソッド ≒ 語彙力となる、と思う 参考: http://xunitpatterns.com/Goals%20of%20Test%20Automation.html http://xunitpatterns.com/Custom%20Assertion.html
8. 参考、どぞ・・ 一緒に働いていた人が最近の考えを晒していたのでご紹介 (身内のメガネ抜きにして、個人的にも好物な話だったので是非) https://asumikam.com/entry/2024/05/18/002702 https://speakerdeck.com/asumikam/good-assertion
9. あわせて読みたい • https://github.com/rectorphp/rector-phpunit ※ rulesetはphpunit100まで。phpunit-code-quality等を併用で対応 • https://github.com/phpstan/phpstan-phpunit • https://github.com/Yoast/PHPUnit-Polyfills ※ 対応しているのは10.xまで
10. 比較してみよう • 10.x => 11.xには、どんなアサーションが入ったんだい？？が関心事 • PHPUnitの特徴 • ChangeLogが充実している(ソースと一緒にコミットされている) • => ただしマイナーバージョンごと(ex: ChangeLog-11.1.md) • 新しいメソッドはマイナーバージョンで(も)追加される
11. 私「0.2ver.以上ジャンプすると追うのが面倒そう…」
12. 「11までに入ったアサーションメソッド」を 知りたい・・・知りたくない？
13. 仕事なら / 真面目にちまちま (changelogを)読むけれど…
14. 今の私は、 「新しいものを見せびらかしてドヤ顔したい」 だけなのに！！
15. よし、じゃあ雑にやろう
16. コード本体に吐かせてみるか
17. やったこと 1. PHPUnitのソースコードを持ってきて 2. (ほとんどの)アサーションメソッドが入っている`Assert`クラスを 3. ReflectionClassにくわせて 4. メソッド一覧を、2つのバージョンで比較して 5. 新しく定義されたものを抜いてくる 結果は https://gist.github.com/o0h/fe9bf8d952362bf7332d41462335bc73 に
18. Packagistから 各バージョン情報セットを 持ってきて
19. 比較したいバージョンの ソース(zip)を取得
20. 解凍＆配置をして
21. 落ちてきた `PHPUnit\Framework\Assert` クラスを
22. FQCNが衝突しないように小細工しつつ 読み込んで
23. evalで無理やりクラス定義して
24. ReflectionClassを作って
25. assertで始まるメソッドを抽出
26. 存在する/しないを比較して なんかゴニョる
27. • 結果こんな感じ • removedなものはなかった (本当か？)
28. 10.0 -> 11.1の間に生えたメソッド • assertArrayIsEqualToArrayOnlyConsideringListOfKeys • assertArrayIsEqualToArrayIgnoringListOfKeys • assertArrayIsIdenticalToArrayOnlyConsideringListOfKeys • assertArrayIsIdenticalToArrayIgnoringListOfKeys • assertObjectHasProperty • assertObjectNotHasProperty • assertFileMatchesFormat
29. assertArrayIsEqualToArrayOnlyConsideringListOfKeys 関心のあるキーに限定してequalsになってるかを検査
30. assertArrayIsEqualToArrayIgnoringListOfKeys 指定したキーを除外してequalsになってるかを検査
31. assertObjectHasProperty • これは名前の通り • 「むしろ今まで無かったですっけ？？」って気持ちになる・・・ • 10.1で追加 • https://github.com/sebastianbergmann/phpunit/commit/ bf3c8defbb6bbb59c549ff3186d52275371f30ee • https://github.com/sebastianbergmann/phpunit/blob/10.1.0/ ChangeLog-10.1.md
32. assertFileMatchesFormat 指定したファイルの中身が期待するフォーマットに沿っているかを検査
33. assertFileMatchesFormat • 使える指定子はこんな感 じ。内部的には正規表現の マッチ • src: https://github.com/ sebastianbergmann/phpunit/blob/11.1.3/ src/Framework/Constraint/String/ StringMatchesFormatDescription.php#L87- L100 • この「フォーマットでの マッチ」は昔からあるもの
34. まとめ • 「細かいアサーションメソッドを使いこなしまくる」の pros/consもありますよね • アンテナを張っておく => ドンピシャのものが来たら突っこむ！！ が良いのかな〜という気がする • 無理に突っ込むのはちょっと待ちたい • 使いたいのが生えたら、 Rectorのカスタムルールでｺﾞﾘｺﾞﾘすると良いかも
35. おしまい！ お付き合いいただき ありがとうございました!!