実践！ユニットテスト入門

Slide 1

Slide 1 text

Slide 2

Slide 2 text

2 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing 自己紹介 ● 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、Mashu Kushibiki）

Slide 3

Slide 3 text

3 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing 自己紹介個人開発が好きプログラミングをするパンダ（@Panda_Program、Mashu Kushibiki）ブログ書いてます https://panda-program.com/ ビールの画像投稿サイト作りました https://beerbreak.info/ Next.js + Vercel + Supabase

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Slide 7

Slide 7 text

7 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing 本発表の裏目標テストの入門者を初心者にする１テストの初心者を中級者にすることを目的とした「『質』のいいユニットテストを書くためのプラクティス」という良いスライドに進むための知識を得る https://speakerdeck.com/hgsgtk/practices-to-write-better-unit- test ２３

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

19 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing とある会社のお話　　「エースのキツネくんが担当したところだね」　　「キツネくんはお客さんの欲しい機能をすぐに作れる天才なんだ　　　けど、結構バグが出ちゃうんだ」　　「（それってほんとの天才か...？）」　　「お気をつけて！」　　「ソフトウェアにバグはつきものだよね。オンボーディングは　　　他の人に頼むから、僕はもう行くね」

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

33 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing 夢の中で「会社がなくなれば職を失う。失業を避けるためには、　バグを出さないようにするのだ」　　「私は仙人だから神田明神は関係ないがな」「バグを出せば社内では上司や同僚からの信頼を失い、社外では　ユーザーからの信頼を失う」　　「どうも君はバグが怖いと見える。確かに怖い」「信頼を失ったユーザーは離脱し、サービスの売上は落ち、　ひいては会社が倒産するかもしれない」

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

Slide 42

Slide 42 text

Slide 43

Slide 43 text

Slide 44

Slide 44 text

Slide 45

Slide 45 text

Slide 46

Slide 46 text

Slide 47

Slide 47 text

Slide 48

Slide 48 text

Slide 49

Slide 49 text

Slide 50

Slide 50 text

Slide 51

Slide 51 text

Slide 52

Slide 52 text

Slide 53

Slide 53 text

Slide 54

Slide 54 text

Slide 55

Slide 55 text

Slide 56

Slide 56 text

Slide 57

Slide 57 text

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

62 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing 1. テストケースは日本語で書こうユニットテストの実践知識 3. いろんな assertion を知ろう 5. dataProvider でテストケースをまとめよう 2. arrange / act / assert パターンで書こう 4. setUp / tearDown で前後の処理をしよう

Slide 63

Slide 63 text

Slide 64

Slide 64 text

Slide 65

Slide 65 text

Slide 66

Slide 66 text

Slide 67

Slide 67 text

67 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing テストケースは日本語で書こうテストケース名のテクニック - 前提条件がある場合は、「method_Xのとき、Yを返す」と書く - 処理内容を一言で書きにくいときは、責務が多すぎる可能性あり - 処理を private メソッドに切り出す / 処理をクラスに切り出す - モデリングを見直してみる

Slide 68

Slide 68 text

Slide 69

Slide 69 text

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

Slide 70

Slide 70 text

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

Slide 71

Slide 71 text

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

Slide 72

Slide 72 text

Slide 73

Slide 73 text

Slide 74

Slide 74 text

Slide 75

Slide 75 text

Slide 76

Slide 76 text

76 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing いろんな assertion を知ろう assertion（アサーション）は、値が真であることをプログラマが表明するためのもの $this->assertSame は最も基本となるアサーション「期待する値」と「実際の値」を比較した結果、同じならテストは success（成功）、違うなら fail

Slide 77

Slide 77 text

77 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing 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 78

Slide 78 text

Slide 79

Slide 79 text

79 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing 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 80

Slide 80 text

80 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing 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 81

Slide 81 text

Slide 82

Slide 82 text

Slide 83

Slide 83 text

Slide 84

Slide 84 text

Slide 85

Slide 85 text

Slide 86

Slide 86 text

Slide 87

Slide 87 text

Slide 88

Slide 88 text

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

Slide 89

Slide 89 text

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

Slide 90

Slide 90 text

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

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

95 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing setUp / tearDown で前後の処理をしよう setUp にまとめるのではなく、前処理用の private メソッドを作ってもいい - 今回の例ならこちらの方が適している - タイトルと本文が、テストケースごとに異なるため - テスト対象ではない値は空文字にするなど柔軟な対応ができる

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

Slide 102

Slide 102 text

Slide 103

Slide 103 text

Slide 104

Slide 104 text

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

Slide 105

Slide 105 text

Slide 106

Slide 106 text

Slide 107

Slide 107 text

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

Slide 108

Slide 108 text

108 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing 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 109

Slide 109 text

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

Slide 110

Slide 110 text

Slide 111

Slide 111 text

Slide 112

Slide 112 text

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

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

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

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

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

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

Slide 143

Slide 143 text

Slide 144

Slide 144 text

Slide 145

Slide 145 text

Slide 146

Slide 146 text

Slide 147

Slide 147 text

Slide 148

Slide 148 text

Slide 149

Slide 149 text

Slide 150

Slide 150 text

Slide 151

Slide 151 text

Slide 152

Slide 152 text

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

Slide 153

Slide 153 text

Slide 154

Slide 154 text

154 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing アジャイルテストの四象限 Using Models to Help Plan Tests in Agile Projects https://www.informit.com/articles/article.aspx?p=2253544&ranMID=24808 開発を支援する製品を評価（批評）する技術面ビジネス面

Slide 155

Slide 155 text

155 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing アジャイルテストの四象限 Using Models to Help Plan Tests in Agile Projects https://www.informit.com/articles/article.aspx?p=2253544&ranMID=24808 開発を支援する製品を評価（批評）する技術面ビジネス面

Slide 156

Slide 156 text

156 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing DevOps バグフィルター A Practical Guide to Testing in DevOps Japanese Edition https://leanpub.com/testingindevops-japanese-edition 網目をすり抜けて本番でバグが出る可能性もある

Slide 157

Slide 157 text

Slide 158

Slide 158 text

158 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing 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 159

Slide 159 text

Slide 160

Slide 160 text

Slide 161

Slide 161 text

Slide 162

Slide 162 text

Slide 163

Slide 163 text

Slide 164

Slide 164 text

164 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing さらなる学習のための資料 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 165

Slide 165 text

165 © 2012-2022 BASE, Inc. #phpcon_okinawa #unit_testing さらなる学習のための資料 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 166

Slide 166 text