PHPUnit 10 概論 / Introduction of PHPUnit 10

by 02

Slide 1

Slide 1 text

2023/03/23 PHPerKaigi 2023 @02 PHPUnit 10 概論

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Slide 7

Slide 7 text

Slide 8

Slide 8 text

Slide 9

Slide 9 text

#phperkaigi #a © 2012-2023 BASE, Inc. 今日話す内容 9 ● PHP8.1以上が必須に ● 新しいテストイベントシステムの追加 ● 各テストの結果やテスト自体の問題を区別する ● PHP8.0のAttributeを用いたメタデータの仕様変更 ● 色覚多様性を考慮したコードカバレッジレポートの仕様変更 ● DataProviderの仕様変更 ● 文法の誤りや差別的な用語を消す ● 削除されたが代替手段の提供がないメソッド

Slide 10

Slide 10 text

PHP8.1以上が必須に

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Slide 13

Slide 13 text

新しいテストイベントシステムの追加

Slide 14

Slide 14 text

Slide 15

Slide 15 text

Slide 16

Slide 16 text

Slide 17

Slide 17 text

#phperkaigi #a © 2012-2023 BASE, Inc. 17 1. 関連するイベントのSubscriberを作成する https://docs.phpunit.de/en/10.0/extending-phpunit.html#extending-phpunit-event-system-extending-the-test-runner-examples-executionﬁnishedsubscriber-php 新しいテストイベントシステムの追加

Slide 18

Slide 18 text

#phperkaigi #a © 2012-2023 BASE, Inc. 18 1. 関連するイベントのSubscriberを作成する https://docs.phpunit.de/en/10.0/extending-phpunit.html#extending-phpunit-event-system-extending-the-test-runner-examples-executionﬁnishedsubscriber-php 新しいテストイベントシステムの追加

Slide 19

Slide 19 text

#phperkaigi #a © 2012-2023 BASE, Inc. 19 2. Subscriberを設定するExtensionを作成する https://docs.phpunit.de/en/10.0/extending-phpunit.html#event-system-subscribing-to-events-examples-extension-php 新しいテストイベントシステムの追加

Slide 20

Slide 20 text

#phperkaigi #a © 2012-2023 BASE, Inc. 20 2. Subscriberを設定するExtensionを作成する https://docs.phpunit.de/en/10.0/extending-phpunit.html#event-system-subscribing-to-events-examples-extension-php 新しいテストイベントシステムの追加

Slide 21

Slide 21 text

#phperkaigi #a © 2012-2023 BASE, Inc. 21 3. Extensionをphpunit.xml等に設定する https://docs.phpunit.de/en/10.0/extending-phpunit.html#extending-phpunit-event-system-extending-the-test-runner-examples-phpunit-xml 新しいテストイベントシステムの追加

Slide 22

Slide 22 text

各テストの結果やテスト自体の問題を区別する

Slide 23

Slide 23 text

#phperkaigi #a © 2012-2023 BASE, Inc. 各テストの結果やテスト自体の問題を区別する 23 各テストの結果(Errored, Failed, Incomplete, Skipped, Passed, etc) やテスト自体の問題(Considered risky, Warning, etc) のそれぞれを明確に区別する方針になりました。この方針に基づいた変更がいくつかあります。

Slide 24

Slide 24 text

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

Slide 29

Slide 29 text

Slide 30

Slide 30 text

Slide 31

Slide 31 text

#phperkaigi #a © 2012-2023 BASE, Inc. 31 デフォルトでは、deprecations, notices, warningsなどを出力しない特定のテストの結果やテスト自体の問題については、デフォルトでは出力しない仕様へと変わりました。 ● Incomplete ● Skipped ● Deprecated ● Error ● Notice ● Warning 各テストの結果やテスト自体の問題を区別する

Slide 32

Slide 32 text

#phperkaigi #a © 2012-2023 BASE, Inc. 32 デフォルトでは、deprecations, notices, warningsなどを出力しないオプションを使用、もしくはphpunit.xmlの設定を変更すれば表示されます。 ● --display-incomplete、displayDetailsOnIncompleteTests ● --display-skipped、displayDetailsOnSkippedTests ● --display-deprecations、displayDetailsOnTestsThatTriggerDeprecations ● --display-errors、displayDetailsOnTestsThatTriggerErrors ● --display-notices、displayDetailsOnTestsThatTriggerNotices ● --display-warnings、displayDetailsOnTestsThatTriggerWarnings 各テストの結果やテスト自体の問題を区別する

Slide 33

Slide 33 text

Slide 34

Slide 34 text

#phperkaigi #a © 2012-2023 BASE, Inc. 34 特定のテストの結果やテスト自体の問題が発生しても、例外を投げない以下のテストの結果やテスト自体の問題が発生しても、例外を投げないようになりました。 ● Deprecated ● Error ● Notice ● Warning expectException()を使っても、上記のテストイベントは検知しないということです。各テストの結果やテスト自体の問題を区別する

Slide 35

Slide 35 text

#phperkaigi #a © 2012-2023 BASE, Inc. 35 特定のテストの結果やテスト自体の問題が発生しても、例外を投げないまた、例外として検知しなくなった以下のメソッドも削除になりました。 ● expectDeprecation()、expectDeprecationMessage() 、 expectDeprecationMessageMatches() ● expectError()、expectErrorMessage()、expectErrorMessageMatches() ● expectNotice()、expectNoticeMessage()、 expectNoticeMessageMatches() ● expectWarning()、expectWarningMessage()、 expectWarningMessageMatches() 各テストの結果やテスト自体の問題を区別する

Slide 36

Slide 36 text

Slide 37

Slide 37 text

PHP8.0のAttributeを用いたメタデータの仕様変更

Slide 38

Slide 38 text

#phperkaigi #a © 2012-2023 BASE, Inc. PHP8.0のAttributeを用いたメタデータの仕様変更 38 PHP8.0 でAttributesが実装されたので、PHPUnitでもAttributesを使ってメタデータを指定できるようになりました。優先度が Attributesのメタデータ > コメントのメタデータになる他、コメントのメタデータはPHPUnit11で非推奨、PHPUnit12では削除になるようです。

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Slide 41

Slide 41 text

#phperkaigi #a © 2012-2023 BASE, Inc. 41 また、PHPUnit内ではプロパティをAttributeと読んでいましたが、 Attribute → Propertyへと名前を変える方針になりました。そのため、Attributeと名のつくassertメソッドが全て削除されます（代替手段がないメソッドもあり） PHP8.0のAttributeを用いたメタデータの仕様変更

Slide 42

Slide 42 text

#phperkaigi #a © 2012-2023 BASE, Inc. 42 削除予定のAttributeと名のつくassertメソッド ● assertClassHasAttribute() ● assertClassNotHasAttribute() ● assertClassHasStaticAttribute() ● assertClassNotHasStaticAttribute() ● assertObjectHasAttribute() ● assertObjectNotHasAttribute() ● classHasAttribute() ● classHasStaticAttribute() ● objectHasAttribute() PHP8.0のAttributeを用いたメタデータの仕様変更

Slide 43

Slide 43 text

#phperkaigi #a © 2012-2023 BASE, Inc. 43 削除予定のAttributeと名のつくassertメソッド ● assertClassHasAttribute() ● assertClassNotHasAttribute() ● assertClassHasStaticAttribute() ● assertClassNotHasStaticAttribute() ● assertObjectHasAttribute() ● assertObjectNotHasAttribute() ● classHasAttribute() ● classHasStaticAttribute() ● objectHasAttribute() 以下はPHPUnit10.1にて実装予定 → assertObjectHasProperty() → assertObjectNotHasProperty() PHP8.0のAttributeを用いたメタデータの仕様変更

Slide 44

Slide 44 text

#phperkaigi #a © 2012-2023 BASE, Inc. 44 削除予定のAttributeと名のつくassertメソッド ● assertClassHasAttribute() ● assertClassNotHasAttribute() ● assertClassHasStaticAttribute() ● assertClassNotHasStaticAttribute() ● assertObjectHasAttribute() ● assertObjectNotHasAttribute() ● classHasAttribute() ● classHasStaticAttribute() ● objectHasAttribute() → ? → ? → ? → ? → assertObjectHasProperty() → assertObjectNotHasProperty() → ? → ? → ? PHP8.0のAttributeを用いたメタデータの仕様変更

Slide 45

Slide 45 text

色覚多様性を考慮したコードカバレッジレポートの仕様変更

Slide 46

Slide 46 text

Slide 47

Slide 47 text

Slide 48

Slide 48 text

DataProviderの仕様変更

Slide 49

Slide 49 text

Slide 50

Slide 50 text

文法の誤りや差別的な用語を消す

Slide 51

Slide 51 text

#phperkaigi #a © 2012-2023 BASE, Inc. 文法の誤りや差別的な用語を消す 51 文法の誤りや判断しづらいメソッドが削除されました。 ● assertNotIsReadable ● assertNotIsWritable ● assertDirectoryNotExists ● assertDirectoryNotIsReadable ● assertDirectoryNotIsWritable ● assertFileNotExists ● assertFileNotIsReadable ● assertRegExp ● assertNotRegExp

Slide 52

Slide 52 text

#phperkaigi #a © 2012-2023 BASE, Inc. 文法の誤りや差別的な用語を消す 52 文法の誤りや判断しづらいメソッドが削除されました。 ● assertNotIsReadable ● assertNotIsWritable ● assertDirectoryNotExists ● assertDirectoryNotIsReadable ● assertDirectoryNotIsWritable ● assertFileNotExists ● assertFileNotIsReadable ● assertRegExp ● assertNotRegExp → assertIsNotReadable → assertIsNotWritable → assertDirectoryDoesNotExist → assertDirectoryIsNotReadable → assertDirectoryIsNotWritable → assertFileDoesNotExist → assertFileIsNotReadable → assertMatchesRegularExpression → assertDoesNotMatchRegularExpression

Slide 53

Slide 53 text

#phperkaigi #a © 2012-2023 BASE, Inc. 文法の誤りや差別的な用語を消す 53 差別的な用語を用いているクラスやプロパティ、オプションも削除されました。 ● PHPUnit\Util\Blacklist ● PHPUnit\Framework\TestCase::$backupGlobalsBlacklist ● PHPUnit\Framework\TestCase::$backupStaticAttributesBlacklist ● --whitelist オプション

Slide 54

Slide 54 text

#phperkaigi #a © 2012-2023 BASE, Inc. 文法の誤りや差別的な用語を消す 54 差別的な用語を用いているクラスやプロパティ、オプションも削除されました。 ● PHPUnit\Util\Blacklist → PHPUnit\Util\Excludelist ● PHPUnit\Framework\TestCase::$backupGlobalsBlacklist → PHPUnit\Framework\TestCase::$backupGlobalsExcludeList ● PHPUnit\Framework\TestCase::$backupStaticAttributesBlacklist → PHPUnit\Framework\TestCase::$backupStaticAttributesExcludeList ● --whitelist オプション → --coverage-ﬁlter オプション

Slide 55

Slide 55 text

削除されたが代替手段の提供がないメソッド

Slide 56

Slide 56 text

Slide 57

Slide 57 text

#phperkaigi #a © 2012-2023 BASE, Inc. 57 PHPUnit\Framework\MockObject\Matcher\InvokedAtIndex at(int $index) 評価対象のメソッドが $index 回目に実行された際にマッチするオブジェクトを返します。 https://docs.phpunit.de/en/9.6/test-doubles.html 削除されたが代替手段の提供がないメソッド

Slide 58

Slide 58 text

#phperkaigi #a © 2012-2023 BASE, Inc. 58 PHPUnit\Framework\MockObject\Matcher\InvokedAtIndex at(int $index) issueに書いてあったコメントでは、withConsecutiveメソッドへの置き換えを提案、もしくは置き換えの実施をしていたケースが多かったです。 https://github.com/sebastianbergmann/phpunit/issues/4297 削除されたが代替手段の提供がないメソッド

Slide 59

Slide 59 text

#phperkaigi #a © 2012-2023 BASE, Inc. 59 PHPUnit\Framework\MockObject\Matcher\InvokedAtIndex at(int $index) issueに書いてあったコメントでは、withConsecutiveメソッドへの置き換えを提案、もしくは置き換えの実施をしていたケースが多かったです。 https://github.com/sebastianbergmann/phpunit/issues/4297 削除されたが代替手段の提供がないメソッド

Slide 60

Slide 60 text

#phperkaigi #a © 2012-2023 BASE, Inc. 60 PHPUnit\Framework\MockObject\Builder\InvocationMocker withConsecutive(array ...$arguments) withConsecutive() メソッドには、テスト対象の呼び出しにあわせて、引数の配列を好きなだけ渡せます。個々の配列は制約のリストです。 with() と同様に、これがモック対象メソッドのそれぞれの引数に対応します。 https://docs.phpunit.de/en/9.6/test-doubles.html 削除されたが代替手段の提供がないメソッド

Slide 61

Slide 61 text

#phperkaigi #a © 2012-2023 BASE, Inc. 61 PHPUnit\Framework\MockObject\Builder\InvocationMocker withConsecutive(array ...$arguments) https://github.com/sebastianbergmann/phpunit/issues/4564 削除されたが代替手段の提供がないメソッド

Slide 62

Slide 62 text

#phperkaigi #a © 2012-2023 BASE, Inc. 62 PHPUnit\Framework\MockObject\Builder\InvocationMocker withConsecutive(array ...$arguments) 残念ながら代替手段がないままPHPUnit 10で削除されてしまい、現在も代替手段として何が良いのか議論している最中です。 https://github.com/sebastianbergmann/phpunit/issues/4026 良いアイディアがあれば、issueにコメントしたりPRを出したりする方が早く事が運ぶかもしれませんね。削除されたが代替手段の提供がないメソッド

Slide 63

Slide 63 text

#phperkaigi #a © 2012-2023 BASE, Inc. 最後に 63 今回どのChangeLogに触れたかは、スライドの最後に載せています。時間の都合で一部のみの解説になりましたが、まだまだ解説していない機能がたくさんあります！ ● 新規追加、仕様変更のあった、削除されたassertメソッドやオプション ● TestCaseクラスの（スーパー）グローバル変数の仕様変更 ● キャッシュ先のディレクトリ変更 ● XML周りの変更今回の発表で話せなかった部分は、後日テックブログに載せようと思います！ BASEプロダクトチームブログをよろしくお願いします！

Slide 64

Slide 64 text

Slide 65

Slide 65 text

Slide 66

Slide 66 text

#phperkaigi #a © 2012-2023 BASE, Inc. 今回触れたChangeLog 66 新しいテストイベントシステムの追加 ● #4676: Event System for extending PHPUnit's test runner ● #3389: Remove PHPUnit\Framework\TestListener and PHPUnit\Framework\TestListenerDefaultImplementation ● #4596: Remove Test Hooks

Slide 67

Slide 67 text

#phperkaigi #a © 2012-2023 BASE, Inc. 今回触れたChangeLog 67 各テストの結果やテスト自体の問題を区別する ● A test method now continues execution after test(ed) code triggered E_(USER_)DEPRECATED, E_(USER_)NOTICE, E_STRICT, or E_(USER_)WARNING ● The CLI test runner now only stops after a test errored when --stop-on-error or --stop-on-defect is used ● The CLI test runner now only stops after a test failed when --stop-on-failure or --stop-on-defect is used ● The CLI test runner now only stops after a test triggered a warning when --stop-on-warning or --stop-on-defect is used ● The CLI test runner now only stops after a test was marked as risky when --stop-on-risky or --stop-on-defect is used ● The CLI test runner now only stops after a test was skipped when --stop-on-skipped is used

Slide 68

Slide 68 text

#phperkaigi #a © 2012-2023 BASE, Inc. 今回触れたChangeLog 68 各テストの結果やテスト自体の問題を区別する ● The CLI test runner now only stops after a test was marked as incomplete when --stop-on-incomplete is used ● #3777: Remove PHPUnit\Framework\Error* classes ● Removed the expectDeprecation(), expectDeprecationMessage(), and expectDeprecationMessageMatches() methods ● Removed the expectError(), expectErrorMessage(), and expectErrorMessageMatches() methods ● Removed the expectNotice(), expectNoticeMessage(), and expectNoticeMessageMatches() methods ● Removed the expectWarning(), expectWarningMessage(), and expectWarningMessageMatches() methods

Slide 69

Slide 69 text

#phperkaigi #a © 2012-2023 BASE, Inc. 今回触れたChangeLog 69 PHP8.0のAttributeを用いたメタデータの仕様変更 ● #4502: Support PHP 8 attributes for adding metadata to test classes and test methods as well as tested code units ● #4603: Use "property" instead of "attribute" for conﬁguring the backup of static ﬁelds ● #4601: Remove assertions that operate on class/object properties

Slide 70

Slide 70 text

#phperkaigi #a © 2012-2023 BASE, Inc. 今回触れたChangeLog 70 色覚多様性に関するアクセシビリティを考慮したコードカバレッジレポートの仕様変更 ● #4893: Make path to custom.css for HTML code coverage report conﬁgurable DataProviderの仕様変更 ● Using a non-static method as a data provider is now deprecated ● Using a non-public method as a data provider is now deprecated ● Declaring a data provider method to require an argument is now deprecated

Slide 71

Slide 71 text

#phperkaigi #a © 2012-2023 BASE, Inc. 今回触れたChangeLog 71 文法の誤りや差別的な用語を消す ● #4063: Remove assertNotIsReadable() ● #4066: Remove assertNotIsWritable() ● #4069: Remove assertDirectoryNotExists() ● #4072: Remove assertDirectoryNotIsReadable() ● #4075: Remove assertDirectoryNotIsWritable() ● #4078: Remove assertFileNotExists() ● #4081: Remove assertFileNotIsReadable() ● #4087: Remove assertRegExp() ● #4090: Remove assertNotRegExp() ● #4272: Remove PHPUnit\Util\Blacklist ● #4273: Remove PHPUnit\Framework\TestCase::$backupGlobalsBlacklist ● #4274: Remove PHPUnit\Framework\TestCase::$backupStaticAttributesBlacklist ● #4278: Remove --whitelist option ● #4536: Remove assertFileNotIsWritable()