Tweet
Tweet

Slide 1

Slide 1 text

© - BASE, Inc. X ⾃作して理解する xUnit - 改訂版 & 最終版 - . . PHPerKaigi - @hgsgtk

Slide 2

Slide 2 text

© - BASE, Inc. エピローグ • 我々は⽇々PHPUnitにお世話になる PHPerである • しかし、PHPUnitのユーザーとしての 関わりばかりで、PHPUnit⾃⾝が何を しているのかに⽬を向ける機会は少ない

Slide 3

Slide 3 text

© - BASE, Inc. エピローグ • PHPUnitはxUnitというテスティングフ レームワークファミリーの⼀⼈ • そもそもxUnitという単語は知っていて も、それらがどのような役割‧機能を 持っているものなのか知っているだろう か

Slide 4

Slide 4 text

© - BASE, Inc. xUnitの “輪郭” を、 かんたんな⾃作を通じて 理解する 本⽇のゴール設定

Slide 5

Slide 5 text

© - BASE, Inc. About me BASE BANK, Inc. / Dev Division / Tech Lead これまでの PHPerKaigi • . New!!! • 2019. 「質」のいいユニットテストを書くためのプラクティス • 2018. レビューをもらいやすい細かい プルリクの切り分け⽅ @hgsgtk Kazuki Higashiguchi

Slide 6

Slide 6 text

© - BASE, Inc. hgsgtk/mpunit - Mini PHP xUnit Testing Framework https://github.com/hgsgtk/mpunit

Slide 7

Slide 7 text

© - BASE, Inc. Agenda xUnit Test Automation Framework Summary

Slide 8

Slide 8 text

© - BASE, Inc. xUnitとは “Test Automation Framework” の総称 Kent Beck⽒が作成したSmalltalk製の SUnit が起源となり、Javaの JUnit で広 まり、PHPでは、PHPUnit が2020年にお けるデファクトスタンダードに https://en.wikipedia.org/wiki/XUnit https://martinfowler.com/bliki/Xunit.html

Slide 9

Slide 9 text

© - BASE, Inc. “Test Automation Framework” “We use a framework that provides all the mechanisms needed to run the test logic so the test writer needs to provide only the test-specific logic.” Meszaros, Gerard. xUnit Test Patterns: Refactoring Test Code Chapter 18. Test Strategy Patterns

Slide 10

Slide 10 text

© - BASE, Inc. Ref: “xUnit Test Patterns: Refactoring Test Code” https://www.amazon.co.jp/xUnit-Test-Patterns-Refactoring-Addison-Wesley/dp/

Slide 11

Slide 11 text

© - BASE, Inc. テストスイートを実⾏し結果を記録する ために必要なメカニズムを持つ • テストを⾒つける • テストスイートに組み⽴てる • 順番に実⾏する • 期待値を検証する • テストの失敗‧エラーをレポートする • 失敗‧エラー発⽣時にクリーンアップする “Test Automation Framework” Meszaros, Gerard. xUnit Test Patterns: Refactoring Test Code Chapter 18. Test Strategy Patterns

Slide 12

Slide 12 text

© - BASE, Inc. 様々な “Test Automation Frameworks” • Robot User Test Frameworks (Recorded Test) • The xUnit of Test Automation Frameworks (Scripted Test) • Data-Driven Test Frameworks (Data-Driven Test) Meszaros, Gerard. xUnit Test Patterns: Refactoring Test Code Chapter 18. Test Strategy Patterns

Slide 13

Slide 13 text

© - BASE, Inc. ※補⾜ Recorded Test • アプリケーションとのやり取りを記録 し、テストツールとして使⽤する戦略 • 現代のもので例えれば、Seleninum な どのUIを通じて SUT を操作してその画 ⾯を記録する、といったものが該当する といってよい。

Slide 14

Slide 14 text

© - BASE, Inc. ※補⾜ Data-Driven Test • Data-Driven Test は、テストに必要な データを、ファイルとして保存し、テス ト実⾏時に利⽤する • “business people” を⾃動化テストの 作成に関与してもらうのに良い戦略とさ れる

Slide 15

Slide 15 text

© - BASE, Inc. ※ 補⾜ Fit: Framework for Data-Driven Test http://fit.c .com/wiki.cgi?IntroductionToFit

Slide 16

Slide 16 text

© - BASE, Inc. 様々な “Test Automation Frameworks” • Robot User Test Frameworks (Recorded Test) • The xUnit of Test Automation Frameworks (Scripted Test) • Data-Driven Test Frameworks (Data-Driven Test) Meszaros, Gerard. xUnit Test Patterns: Refactoring Test Code Chapter 18. Test Strategy Patterns

Slide 17

Slide 17 text

© - BASE, Inc. Agenda xUnit Test Automation Framework Summary

Slide 18

Slide 18 text

© - BASE, Inc. 様々な “Test Automation Frameworks” • Robot User Test Frameworks (Recorded Test) • The xUnit of Test Automation Frameworks (Scripted Test) • Data-Driven Test Frameworks (Data-Driven Test) Meszaros, Gerard. xUnit Test Patterns: Refactoring Test Code Chapter 18. Test Strategy Patterns

Slide 19

Slide 19 text

© - BASE, Inc. “Scripted Test” 機能を実⾏する⽬的で SUT（System Under Test: テスト対象システム）と対話 するテストプログラムを書くことで、テ ストを⾃動化する 我々PHPerが息を吸うように書いている “あんな感じ” テストコード

Slide 20

Slide 20 text

© - BASE, Inc. “あんな感じ” のテストコード

Slide 21

Slide 21 text

© - BASE, Inc. ここまでの xUnit の “輪郭” Scripted Testによるテスト⾃動化のため に必要なメカニズムを提供する

Slide 22

Slide 22 text

© - BASE, Inc. . テストを⾒つける . テストスイートに組み⽴てる . 順番に実⾏する . 期待値を検証する . テストの失敗‧エラーをレポートする . 失敗‧エラー発⽣時にクリーンアップする 必要なメカニズム

Slide 23

Slide 23 text

© - BASE, Inc. Component Design Test Runner Test Suite Test Case Test Case Test Case Test Case SUT Meszaros, Gerard. xUnit Test Patterns: Refactoring Test Code Chapter 7. xUnit Basic ※ ؆ུԽ͍ͯࣔͯ͠͠·͢ɻ

Slide 24

Slide 24 text

© - BASE, Inc. Component Design Test Runner Test Suite Test Case Test Case Test Case Test Case SUT Meszaros, Gerard. xUnit Test Patterns: Refactoring Test Code Chapter 7. xUnit Basic .テストを⾒つける .テストスイートに組み⽴てる .順番に実⾏する .期待値を検証する .テストの失敗‧エラーをレポートする .失敗‧エラー発⽣時にクリーンアップする ※ ؆ུԽ͍ͯࣔͯ͠͠·͢ɻ

Slide 25

Slide 25 text

© - BASE, Inc. Test Runner • 開発者が実⾏するインターフェース （GUI, CUI etc） • 役割 • TestSuiteの初期化 • TestCaseの実⾏ • トラッキングとレポート

Slide 26

Slide 26 text

© - BASE, Inc. 開発者が実⾏するインターフェース: CUIでの実⾏

Slide 27

Slide 27 text

© - BASE, Inc. CUIでの実⾏インターフェースとなる実⾏ファイル https://github.com/hgsgtk/mpunit/blob/ c e a d f f c b bfe ffff c/bin/mpunit#L

Slide 28

Slide 28 text

© - BASE, Inc. Test Suiteの初期化 • テストスイート、つまり対象のテストメ ソッド郡を⾒つけてまとめる作業といえ る • テストメソッドの⾒つけ⽅にテスティン グフレームワークの戦略が⾒られる

Slide 29

Slide 29 text

© - BASE, Inc. テストメソッドの⾒つけ⽅ • Test Enumeration • ⼿動でテストスイートに属するすべてのテストを 列挙する • Test Discovery • テストスイートに属するすべてのテストを⾃動で ⾒つける • Test Selection • 付与された attribute をもとに実⾏するテストを ⾒つける

Slide 30

Slide 30 text

© - BASE, Inc. Test Discoveryの狙い “Lost TestによるProduction Bug”を回 避するため Lost Test: テストメソッド‧テストケース が無効またはテストスイートに追加され ていない状態 Meszaros, Gerard. xUnit Test Patterns: Refactoring Test Code Chapter 17.Project Smells

Slide 31

Slide 31 text

© - BASE, Inc. Test Discoveryを実現してみる https://github.com/hgsgtk/mpunit/blob/ f e be a df aaf a a fd b /src/Command.php#L *Test.php のファイルを集める

Slide 32

Slide 32 text

© - BASE, Inc. Test Discoveryを実現してみる https://github.com/hgsgtk/mpunit/blob/ c f b f ac b dcfc b f /src/TestRunner.php#L TestSuiteを初期化 TestClassを⾒つけ出し ->addTest()

Slide 33

Slide 33 text

© - BASE, Inc. Test Discoveryを実現してみる https://github.com/hgsgtk/mpunit/blob/ c f b f ac b dcfc b f /src/TestRunner.php#L 役割 • TestSuiteの初期化 • TestCaseの実⾏ • トラッキングとレポート

Slide 34

Slide 34 text

© - BASE, Inc. テストの失敗‧エラーをレポートする

Slide 35

Slide 35 text

© - BASE, Inc. テストの失敗‧エラーを TestResult として貯める https://github.com/hgsgtk/mpunit/blob/ e ffa c e f c d d fb d d ef b /src/TestResult.php#L

Slide 36

Slide 36 text

© - BASE, Inc. Component Design Test Runner Test Suite Test Case Test Case Test Case Test Case SUT Meszaros, Gerard. xUnit Test Patterns: Refactoring Test Code Chapter 7. xUnit Basic .テストを⾒つける .テストスイートに組み⽴てる .順番に実⾏する .期待値を検証する .テストの失敗‧エラーをレポートする .失敗‧エラー発⽣時にクリーンアップする ※ ؆ུԽ͍ͯࣔͯ͠͠·͢ɻ

Slide 37

Slide 37 text

© - BASE, Inc. TestSuite / TestCase の実装パターン シンプルなインターフェース “Standard Test Interface” を実装している事が多い .Count Test - テストの個数をカウント .Run Test - テストを実⾏する 単⼀‧複数とテストの個数やそれに応じた実⾏⽅法 などの詳細について気にしなくていい、という狙い がある

Slide 38

Slide 38 text

© - BASE, Inc. PHPUnitのTest Interface https://github.com/sebastianbergmann/phpunit/blob/ddd c dc b e ae b ff a /src/Framework/ Test.php#L

Slide 39

Slide 39 text

© - BASE, Inc. 実⾏するインターフェースをもつTestCase https://github.com/hgsgtk/mpunit/blob/ fc a a d af b c ef ee ea b /src/TestCase.php#L

Slide 40

Slide 40 text

© - BASE, Inc. 実⾏するインターフェースをもつTestCase https://github.com/hgsgtk/mpunit/blob/ fc a a d af b c ef ee ea b /src/TestCase.php#L テストクラスのPUBLICメソッドから、先頭が test で始まる メソッドを探す

Slide 41

Slide 41 text

© - BASE, Inc. 実⾏するインターフェースをもつTestCase https://github.com/hgsgtk/mpunit/blob/ fc a a d af b c ef ee ea b /src/TestCase.php#L テストメソッドを実⾏ @dataProvider があれば、テストメソッドに引数を付与

Slide 42

Slide 42 text

© - BASE, Inc. 期待値を検証する • 期待値の検証（Verify）に⾄るまでに は、以下の4つの要素が存在する。 • SUTを実⾏するための準備‧SUTの実 ⾏‧実⾏後の検証‧実⾏後の後⽚付け • これらは、 “Four-Phase Test” という 概念整理がされている

Slide 43

Slide 43 text

© - BASE, Inc. Four-Phase Test • “We structure each test with four distinct parts executed in sequence.” • Four-Phase • Fixture Setup • Exercise • Verify • Fixture TearDown Meszaros, Gerard. xUnit Test Patterns: Refactoring Test Code Chapter 19.xUnit Basics Patterns

Slide 44

Slide 44 text

setUp() tearDown

Slide 45

Slide 45 text

© - BASE, Inc. Verify: built-in assertion method xUnitファミリーの多くは、テスト作成の 省⼒化という⽬的感のもと、built-inのア サーションメソッドを⽤意している

Slide 46

Slide 46 text

© - BASE, Inc. Verify: アサーションを実現するとしたら？ • assert function(PHP) <- MPUnit • beberlei/assert • webmozart/assert • hamcrest/hamcrest-php etc

Slide 47

Slide 47 text

© - BASE, Inc. $this->assertSame()などを実現してみる https://github.com/hgsgtk/mpunit/blob/f c da df ee b e d c/src/Assert.php#L

Slide 48

Slide 48 text

© - BASE, Inc. ここまでの xUnit の “輪郭” • Scripted Testによるテスト⾃動化のた めに必要なメカニズムを提供する • 必要なメカニズム • テストを⾒つける • テストスイートに組み⽴てる • 順番に実⾏する • 期待値を検証する • テストの失敗‧エラーをレポートする • 失敗‧エラー発⽣時にクリーンアップする • メカニズムを構成するコンポーネント郡

Slide 49

Slide 49 text

© - BASE, Inc. Agenda xUnit Test Automation Framework Summary

Slide 50

Slide 50 text

© - BASE, Inc. ⾃作してみることで輪郭を捉える • 実際に実装してみることで、xUnitがど ういうメカニズムを我々に提供している のかがわかる • その背景の理由‧根拠を知ることで、メ カニズムの意図に沿った使い⽅をできる のではないか • xUnitの背景をもとにPHPUnitを読むと 理解しやすくなる

Slide 51

Slide 51 text

© - BASE, Inc. X exit();