自動テストでモックするって、なにそれ？おいしいの？/what_is_mocking

Slide 1

Slide 1 text

自動テストでモックするって、なにそれ？おいしいの？〜依存コンポーネントをコントロールして、上手なテストコードを実装しよう〜

Slide 2

Slide 2 text

自己紹介 - 名前: 阿部真之 - 仕事: 株式会社ゆめみでAndroidエンジニアしてます - 最近はサーバサイド Kotlinの仕事も始めました - 趣味 - コーヒー、ビール、アニメ、ゲーム、読書、 etc… - Twitter: @marchin_1989

Slide 3

Slide 3 text

アジェンダ - ユニットテストの例 - テストダブルとは - テストダブルの分類(サンプルコードで解説) - その他注意点など

Slide 4

Slide 4 text

ユニットテスト書いてますか？

Slide 5

Slide 5 text

ユニットテストコンピュータプログラミングにおいて単体テスト（たんたいテスト）あるいはユニットテスト（英語: Unit test）とは、ソースコードの個々のユニット、すなわち、1つ以上のコンピュータプログラムモジュールが使用に適しているかどうかを決定するために、関連する制御データ、使用手順、操作手順とともにテストする手法である。ユニットとはアプリケーションのテスト可能な最小の部品単位である、と直観的にとらえることができる。 (Wikipedia) ここでは、自動テストの文脈でユニットテストをみていきます。

Slide 6

Slide 6 text

ユニットテストしてみよう

Slide 7

Slide 7 text

- テストダブルってなに？ - モック、スパイ、ダミーとか聞いたことあるけど。。テストダブル？

Slide 8

Slide 8 text

テストダブルとは？ - テストダブルとは、テスト実行時に、テスト対象が依存している外部のコンポーネントと置き換わるもの。 @Test fun `テストコード`() { assertEquals(期待値, テスト対象()) } fun テスト対象(): Int { … 依存コンポーネントのメソッド() … }

Slide 9

Slide 9 text

本番テスト

Slide 10

Slide 10 text

なぜテストダブルに置き換えたいのかテスト対象が外部のコンポーネントに依存しており、テスト環境で利用できなかったり、利用しづらかったりなど、制約（コスト、処理時間）があるとき。 - テストに必要な結果をコントロールできない（実行するたびに値が変わる） - 実行に時間がかかる - 用意するのにお金がかかる

Slide 11

Slide 11 text

テストダブルにはどんなものがあるの？ - xUnit Test Patternsによる定義、分類が有名 - xUnit Test Patternsとは、テスト自動化フレームワークの xUnit（JUnitやNUnitなど）を使用して自動テストを作成するためのパターン (本)。 - 分類 - ダミー(Dummy Object) - スタブ(Test Stub) - スパイ(Test Spy) - モック(Mock Object) - フェイク(Fake Object) 出典: xUnit Test Patterns Test Double http://xunitpatterns.com/Test%20Double.html

Slide 12

Slide 12 text

テストダブルの分類を知っておく利点 - それぞれの役割を理解しておくと、テストダブルに対して何をやらせばいいのか明確になる。適切なテストダブルを選べる。 - モックライブラリのAPIが何を提供しているのか理解しやすくなる。 - ただし、xUnit Test Patternsのテストダブルの分類と言葉が一致しなかったりするので要注意。 - （逆説的だが）自分が作成したいテストケースが明確になる。

Slide 13

Slide 13 text

以降の説明の流れ - テストダブルとその分類 - それぞれ、実際にどうやって置き換えるのか、サンプルコードで紹介(Kotlin)

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

ダミー(Dummy Object) - テストメソッド内で、なにもしない。 - テスト対象に影響を与えないが、コンパイルなどの都合上、用意しないといけないもの。

Slide 21

Slide 21 text

ダミーのサンプルコード

Slide 22

Slide 22 text

スタブ

Slide 23

Slide 23 text

スタブ(Test Stub) - 入力を操作し、任意の値をテスト対象に与える。 - 入力値をテストコード上で、事前設定し、テストを実行。

Slide 24

Slide 24 text

スタブのサンプルコード

Slide 25

Slide 25 text

スパイ

Slide 26

Slide 26 text

スパイ(Test Spy) - テスト対象からの出力を記録。 - テストコード上でその記録した出力を検証する。 - ただし、入力を操作することもある。つまりスタブのように振る舞うこともある。

Slide 27

Slide 27 text

スパイのサンプルコード

Slide 28

Slide 28 text

モック

Slide 29

Slide 29 text

モック(Mock Object) - テスト対象からの出力を記録 - テスト対象内の外部コンポーネントへの出力の期待結果（expected）をセットする - テスト対象を実行しながら、テスト対象から外部コンポーネントへの出力を取得し、モック内部で期待結果と出力結果を比較して、成功か失敗かを判定する - テストコードからは、モックから検証の成功 or 失敗を受け取る - スタブの機能を持つことがある

Slide 30

Slide 30 text

スパイとモックの違い - 両方とも、外部コンポーネントへの出力を検証するためのテストダブル。 - ただし、モックは、テスト対象のメソッドを呼び出す前に、事前に期待結果をセットする。その後、モック内で出力の結果を評価する。 - スパイは、外部コンポーネントへの出力を保持するだけ。外部コンポーネントへの出力結果の評価は後からテストコード上で行う。

Slide 31

Slide 31 text

フェイク

Slide 32

Slide 32 text

フェイク(Fake Object) - テスト実行中、本物ではないが、本物と同じように動作する。 - 本物がテスト環境で使えないとか、返答が遅いなどの理由で利用する。 - テストの実行環境のマシンで起動しておいて、接続先を変更するなどで置き換える - 例 - RDBに対し、同じ機能を持ったオンメモリのデータベース。 - AWSの機能をエミュレートした LocalStack。DynamoDB Local。

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

その他 - ややこしいが、テストダブルの生成を単に「モックする」ということがある。 - 「スタブの入力値自体をテストする」のような意味のないユニットテストを書いてしまうことがあるので注意。 - テストダブルは、まだ実装していないコードの代替となる。 - モックライブラリで実装されている名前と、xUnit Test Patternsのテストダブルの分類は必ずしも一致しない - モックライブラリによっては挙動が異なるので、利用するときはよく挙動を理解しておくこと - rspec-mocks（Ruby）のスパイは、置き換えられた本物の依存コンポーネントの処理は実行されない - MockK（Kotlin）やJest（JavaScript）のスパイは、デフォルトだと、置き換えられた依存コンポーネントの処理も実行される。プロキシのような挙動。