実践！ユニットテスト入門（PHPカンファレンス2022）

by panda_program

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Slide 3

Slide 3 text

3 © 2012-2022 BASE, Inc. #phpcon2022 自己紹介 ● BASE株式会社 ● 所属：BASE / Product Dev / CRM3 ● 現在のお仕事：シニアエンジニア ○ フロントエンドで React（Next.js）を書いたり Vue.js を書いたり ○ バックエンドでは PHP を書いてます ○ 最近は顧客管理機能（CRM）を開発してます ● 好きなことと活動 ○ DevOps とアジャイルの開発プロセス（特にXP）が好き ○ Software Design 2022年3月号で TDD 特集の2,3部を執筆しました ○ twitter: @Panda_Program プログラミングをするパンダ（@Panda_Program）

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

Slide 10

Slide 10 text

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

Slide 18

Slide 18 text

Slide 19

Slide 19 text

Slide 20

Slide 20 text

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

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

Slide 32

Slide 32 text

Slide 33

Slide 33 text

Slide 34

Slide 34 text

Slide 35

Slide 35 text

Slide 36

Slide 36 text

Slide 37

Slide 37 text

明日からテストを実践するための知識を得る

Slide 38

Slide 38 text

Slide 39

Slide 39 text

テストケースは日本語で書こう

Slide 40

Slide 40 text

Slide 41

Slide 41 text

41 © 2012-2022 BASE, Inc. #phpcon2022 テストケースは日本語で書こう 1テストケースにつき、1メソッドテストケース名 = メソッド名なので、直感的に理解できる「日本語」がベスト格言「コードは書く時間より、読まれる時間の方が長い」格言「テストコードがドキュメントになるように書こう」テストコードを読む人のことを考えて、テストケース名でこのメソッドは何をしているのか（= what）を説明する

Slide 42

Slide 42 text

Slide 43

Slide 43 text

Slide 44

Slide 44 text

Slide 45

Slide 45 text

arrange / act / assert パターンで書こう

Slide 46

Slide 46 text

46 © 2012-2022 BASE, Inc. #phpcon2022 arrange / act / assert パターンで書こう・constructor で投稿のタイトルを設定　する・getTitle で投稿のタイトルを取得する (PHP 8 だともっとシンプルに書けるが、あえて省略していない）「Arrange Act Assert」 http://wiki.c2.com/?ArrangeActAssert Post クラスを作ってみる

Slide 47

Slide 47 text

47 © 2012-2022 BASE, Inc. #phpcon2022 arrange / act / assert パターンで書こう「Arrange Act Assert」 http://wiki.c2.com/?ArrangeActAssert ・arrange で、前提条件と入力値を配置する・act で、テスト対象（メソッド）を実行する・assert で、期待した結果を得られることをチェックする arrange / act / assert はテストの実装パターンの一つ

Slide 48

Slide 48 text

48 © 2012-2022 BASE, Inc. #phpcon2022 arrange / act / assert パターンで書こう「Arrange Act Assert」 http://wiki.c2.com/?ArrangeActAssert arrange / act / assert パターンのメリット・1テストケース 1act を意識できる　・左画像で getEditors は不要だとわかる　・複数の act があればテストケースを分ける・自分が今どこを書いているのか自覚できる　・次に何を書くのか迷わなくなるなお、arrange は不要な時もある

Slide 49

Slide 49 text

Slide 50

Slide 50 text

Slide 51

Slide 51 text

Slide 52

Slide 52 text

いろんな assertion を知ろう

Slide 53

Slide 53 text

Slide 54

Slide 54 text

54 © 2012-2022 BASE, Inc. #phpcon2022 assertSame（$val1, $val2） assertTrue（$value） assertNull（$value） assertEquals（$val1,$val2） assertFalse（$value）値の厳密な比較（===相当） $value が true である $value が null である値の緩い比較（==相当） $value が false であるいろんな assertion を知ろう「PHPUnit Docs » 1. アサーション」 https://phpunit.readthedocs.io/ja/latest/assertions.html

Slide 55

Slide 55 text

Slide 56

Slide 56 text

56 © 2012-2022 BASE, Inc. #phpcon2022 assertCount（$num, $arr） assertContains（$val, $arr） assertRegExp（$ptn, $str） assertEmpty（$arr） assertArrayHasKey($key, $arr) 配列 $arr の要素が $num 個である配列 $arr が $val を含んでいる文字列 $str がパターン $ptn にマッチする配列 $arr が空配列である配列 $arr にキー $key が含まれているいろんな assertion を知ろう「PHPUnit Docs » 1. アサーション」 https://phpunit.readthedocs.io/ja/latest/assertions.html

Slide 57

Slide 57 text

57 © 2012-2022 BASE, Inc. #phpcon2022 assertGreaterThan （$num1, $num2） assertFileExists（$path） expectException($className) assertGreaterThanOrEqual （$num1, $num2） assertInstanceOf （$className, $instance） $num1 が $num2 より小さい（$num1 < $num2）ファイルパス $path にファイルがある $className の例外を throw する $num1 が $num2 以下である（$num1 <= $num2） $instance がクラス $className のインスタンスであるいろんな assertion を知ろう「PHPUnit Docs » 1. アサーション」 https://phpunit.readthedocs.io/ja/latest/assertions.html

Slide 58

Slide 58 text

Slide 59

Slide 59 text

Slide 60

Slide 60 text

Slide 61

Slide 61 text

Slide 62

Slide 62 text

setUp / tearDown で前後の処理をしよう

Slide 63

Slide 63 text

Slide 64

Slide 64 text

Slide 65

Slide 65 text

65 © 2012-2022 BASE, Inc. #phpcon2022 setUp / tearDown で前後の処理をしよう前処理を setUp にまとめる・setUp に、そのクラスの全てのテストケース　に共通な前処理（arrange）をまとめる・setUp は、各テストケースの直前に必ず　実行される後処理を tearDown にまとめる・テストの前処理は setUp に、後処理は　tearDown に記述する「PHPUnit Docs » 4. フィクスチャ」 https://phpunit.readthedocs.io/ja/latest/fixtures.html

Slide 66

Slide 66 text

66 © 2012-2022 BASE, Inc. #phpcon2022 setUp / tearDown で前後の処理をしよう「PHPUnit Docs » 4. フィクスチャ」 https://phpunit.readthedocs.io/ja/latest/fixtures.html setUp では、各テストケースに共通な arrange をまとめる・オブジェクトの生成や日付管理ライブラリで時間固定、DBへの接続に使うことが多い　・依存関係の解決（ex. new 　　　　PostPresenter(new Post)）

Slide 67

Slide 67 text

67 © 2012-2022 BASE, Inc. #phpcon2022 setUp / tearDown で前後の処理をしよう tearDown は、あるテストが他のテストに影響を与えないようにするために使う・時間の固定を解除、テーブルのレコードを削除するなど・（本来、プロパティの unset はしなくて良い）「PHPUnit Docs » 4. フィクスチャ」 https://phpunit.readthedocs.io/ja/latest/fixtures.html

Slide 68

Slide 68 text

Slide 69

Slide 69 text

Slide 70

Slide 70 text

Slide 71

Slide 71 text

Slide 72

Slide 72 text

Slide 73

Slide 73 text

dataProvider でテストケースをまとめよう

Slide 74

Slide 74 text

Slide 75

Slide 75 text

Slide 76

Slide 76 text

Slide 77

Slide 77 text

Slide 78

Slide 78 text

Slide 79

Slide 79 text

Slide 80

Slide 80 text

Slide 81

Slide 81 text

81 © 2012-2022 BASE, Inc. #phpcon2022 dataProvider でテストケースをまとめよう「PHPUnit Docs » 2. PHPUnit 用のテストの書き方（データプロバイダ）」 https://phpunit.readthedocs.io/ja/latest/writing-tests-for-phpunit.html#writing-tests-for-phpunit-data-providers 複数のテストケースの構造が同じ 󰢏 データプロバイダーにまとめる処理が同様なら、テストの変数は「入力値」と「期待値」だけ

Slide 82

Slide 82 text

Slide 83

Slide 83 text

Slide 84

Slide 84 text

Slide 85

Slide 85 text

85 © 2012-2022 BASE, Inc. #phpcon2022 dataProvider でテストケースをまとめようロジック側・複数のテストケースで共通の処理を1つにまとめる・テストメソッドに引数を追加　・入力値と期待する値（データ）を受け取る「PHPUnit Docs » 2. PHPUnit 用のテストの書き方（データプロバイダ）」 https://phpunit.readthedocs.io/ja/latest/writing-tests-for-phpunit.html#writing-tests-for-phpunit-data-providers

Slide 86

Slide 86 text

86 © 2012-2022 BASE, Inc. #phpcon2022 dataProvider でテストケースをまとめようデータ側・データプロバイダーは、テストのデータセットを配列で返す・アノテーション @dataProvider は、データを受け取るテストメソッドに書く・データプロバイダー名は「テスト対象のメソッド名 + Provider」がおすすめ　・今回は getBodyProvider 「PHPUnit Docs » 2. PHPUnit 用のテストの書き方（データプロバイダ）」 https://phpunit.readthedocs.io/ja/latest/writing-tests-for-phpunit.html#writing-tests-for-phpunit-data-providers

Slide 87

Slide 87 text

87 © 2012-2022 BASE, Inc. #phpcon2022 dataProvider でテストケースをまとめようデータ側・返り値は配列（厳密には Iterator インターフェースを実装していれば良い）・キーにテストケース名、値に入力値と期待する値を指定する・メリット　・テストケースをまとめられる　・バリエーションの追加が簡単「PHPUnit Docs » 2. PHPUnit 用のテストの書き方（データプロバイダ）」 https://phpunit.readthedocs.io/ja/latest/writing-tests-for-phpunit.html#writing-tests-for-phpunit-data-providers

Slide 88

Slide 88 text

Slide 89

Slide 89 text

Slide 90

Slide 90 text

90 © 2012-2022 BASE, Inc. #phpcon2022 dataProvider でテストケースをまとめようテストケースが重複してから初めて、dataProvider を使う。最初から dataProvider を書き始めない。「頭の中で考えて同じだから」ではなく「目で見て」コードが重複していることを確認してから dataProvider を使う。そうしなければ、各テストケースで微妙に arrange が異なったり、assertion を増やしたい場合、 dataProvider を解体する手戻りが発生してしまうため。

Slide 91

Slide 91 text

Slide 92

Slide 92 text

テストを通して、ソフトウェア開発の全体像を学ぶ

Slide 93

Slide 93 text

Slide 94

Slide 94 text

Slide 95

Slide 95 text

Slide 96

Slide 96 text

Slide 97

Slide 97 text

Slide 98

Slide 98 text

Slide 99

Slide 99 text

Slide 100

Slide 100 text

Slide 101

Slide 101 text

101 © 2012-2022 BASE, Inc. #phpcon2022 DevOps バグフィルター A Practical Guide to Testing in DevOps Japanese Edition https://leanpub.com/testingindevops-japanese-edition ユニットテストで小さいバグを捉えるバグが本番にまで行かないようにする = フィルター（網）

Slide 102

Slide 102 text

Slide 103

Slide 103 text

Slide 104

Slide 104 text

Slide 105

Slide 105 text

Slide 106

Slide 106 text

Slide 107

Slide 107 text

Slide 108

Slide 108 text

Slide 109

Slide 109 text

Slide 110

Slide 110 text

付録

Slide 111

Slide 111 text

Slide 112

Slide 112 text

Slide 113

Slide 113 text

Slide 114

Slide 114 text

Slide 115

Slide 115 text

Slide 116

Slide 116 text

Slide 117

Slide 117 text

Slide 118

Slide 118 text

Slide 119

Slide 119 text

Slide 120

Slide 120 text

Slide 121

Slide 121 text

Slide 122

Slide 122 text

Slide 123

Slide 123 text

Slide 124

Slide 124 text

Slide 125

Slide 125 text

Slide 126

Slide 126 text

Slide 127

Slide 127 text

Slide 128

Slide 128 text

Slide 129

Slide 129 text

Slide 130

Slide 130 text

130 © 2012-2022 BASE, Inc. #phpcon2022 ソフトウェアテストの7原則（JSTQB (日本ソフトウェアテスト資格認定委員会)制定） 1. テストは「欠陥があること」しか示せない 2. 全数テストは不可能 … ソフトウェアテストの7原則 https://hkawabata.github.io/technical-note/note/Principle/7-Principl es-of-Software-Test.html

Slide 131

Slide 131 text

Slide 132

Slide 132 text

Slide 133

Slide 133 text

Slide 134

Slide 134 text

Slide 135

Slide 135 text

Slide 136

Slide 136 text

136 © 2012-2022 BASE, Inc. #phpcon2022 Example-guided development （TDD, BDD, ATDD を xDD としてまとめた呼び方）「Example-guided development: A useful abstraction for the xDD family?」 https://cucumber.io/blog/bdd/example-guided-development/

Slide 137

Slide 137 text

Slide 138

Slide 138 text

Slide 139

Slide 139 text

Slide 140

Slide 140 text

Slide 141

Slide 141 text

Slide 142

Slide 142 text

142 © 2012-2022 BASE, Inc. #phpcon2022 さらなる学習のための資料 TDD（テスト駆動開発）「テスト自動化とテスト駆動開発」講演資料（@yattom） https://yattom.hatenablog.com/entry/2021/04/01/102052 「質問5. 実際にTDDで運用したとき、それでも不具合が発生したことがありました。データの量、質が問題視されたことがありました。受け取った情報の信憑性は会話しながら模索しないといけないのでしょうか」（@yattom） https://yattom.hatenablog.com/entry/2021/04/04/171531 「テスト駆動開発の題材を目的別で紹介する」（@nihonbuson） https://nihonbuson.hatenadiary.jp/entry/2021/08/16/090000 「SymfonyとDoctrineで簡単クリーンアーキテクチャ〜プロトタイピングにこそクリーンなTDD が活きた話〜」（ページ下部に動画あり） https://fortee.jp/phpcon-2021/proposal/37d95a00-37bd-41e3-bc4a-7db9414d7597

Slide 143

Slide 143 text

143 © 2012-2022 BASE, Inc. #phpcon2022 さらなる学習のための資料 ATDD 「TDDからATDDへ歩みをすすめる / Step to Acceptance test–driven development from TDD」（@hgsgtk） https://speakerdeck.com/hgsgtk/step-to-acceptance-test-driven-development-from-tdd モックを使った開発「実践テスト駆動開発」 https://www.amazon.co.jp/dp/4798124583 「スタブ・モックは本当に悪者なのか？〜テスト駆動開発をやめて、なお残すべき習慣とは (2)」 https://twop.agile.esm.co.jp/ﬁnding-a-blind-spot-by-agile-test-quadrant-807179783360 DevOps の観点から「A Practical Guide to Testing in DevOps Japanese Edition」（日本語） https://leanpub.com/testingindevops-japanese-edition

Slide 144

Slide 144 text