スタブ・モック

Mocking

この章のすべてのコードはここにあります

3からカウントダウンするプログラムを作成するように求められました。各数値を新しい行に表示します（1秒の間隔を置いて）、ゼロに達すると「Go！」と表示します。そして終了します。

3
2
1
Go!

これに取り組むには、Countdownという関数を作成します。この関数をmainプログラム内に配置して、次のようにします。

package main

func main() {
    Countdown()
}

これはかなり簡単なプログラムですが、完全にテストするには、いつものように反復的、テストドリブンのアプローチを取る必要があります。

反復とはどういう意味ですか？私たちは、有用なソフトウェアを入手するために、できる限り小さなステップを踏んでいることを確認します。

開発者がうさぎの穴に陥るのはそのためであることが多いため、ハッキングの後に理論的に機能するコードに長い時間を費やしたくありません。 要件をできる限り小さくスライスして、 _ 動作するソフトウェア _ を使用できるようにすることは重要なスキルです。

作業を分割して反復する方法は次のとおりです。

• 表示 3

• 3、2、1 を表示してGo！

• 各行の間で1秒待ちます

最初にテストを書く

私たちのソフトウェアはstdoutに出力する必要があり、DIを使用してこれをテストする方法をDIセクションで確認しました。

func TestCountdown(t *testing.T) {
    buffer := &bytes.Buffer{}

    Countdown(buffer)

    got := buffer.String()
    want := "3"

    if got != want {
        t.Errorf("got %q want %q", got, want)
    }
}

bufferのようなものに不慣れな場合は、前のセクションをもう一度お読みください。

Countdown関数でどこかにデータを書き込む必要があることはわかっています。io.Writerは、Goのインターフェースとしてデータをキャプチャするための事実上の方法です。

• mainでos.Stdoutに送信して、ターミナルに出力されたカウントダウンをユーザーに表示します。

• テストでは、bytes.Bufferに送信して、生成されるデータをテストでキャプチャできるようにします。

テストを試して実行する

./countdown_test.go:11:2: undefined: Countdown

テストを実行するための最小限のコードを記述し、失敗したテスト出力を確認します

Countdownを定義します

func Countdown() {}

再試行

./countdown_test.go:11:11: too many arguments in call to Countdown
    have (*bytes.Buffer)
    want ()

コンパイラーは、関数のシグニチャーが何であるかを通知しているので、更新してください。

func Countdown(out *bytes.Buffer) {}

countdown_test.go:17: got '' want '3'

パーフェクト！

成功させるのに十分なコードを書く

func Countdown(out *bytes.Buffer) {
    fmt.Fprint(out, "3")
}

fm.Fprintを使用しています。これは、io.Writer（* bytes.Bufferなど）を受け取り、それにstringを送信します。テストは成功するはずです。

リファクタリング♪

*bytes.Bufferは機能しますが、代わりに汎用インターフェースを使用する方がよいことはわかっています。

func Countdown(out io.Writer) {
    fmt.Fprint(out, "3")
}

テストを再実行すると、テストに合格するはずです。

問題を完了するために、関数をmainに結び付けましょう。そうすれば、作業を進めていることを確信できる実用的なソフトウェアができます。

package main

import (
    "fmt"
    "io"
    "os"
)

func Countdown(out io.Writer) {
    fmt.Fprint(out, "3")
}

func main() {
    Countdown(os.Stdout)
}

プログラムを試して実行すると、あなたの便利な作業に驚かされます。

はい、これはささいなことのようですが、このアプローチはどのプロジェクトにもお勧めします。 機能のごく一部を取得し、テストに裏打ちされたend-to-endで機能するようにします。

次に、2,1を表示してから、「Go！」を表示します。

最初にテストを書く

配管全体を正しく機能させるために投資することで、ソリューションを安全かつ簡単に反復できます。 すべてのロジックがテストされるので、プログラムが機能していることを確認するために、プログラムを停止して再実行する必要がなくなります。

func TestCountdown(t *testing.T) {
    buffer := &bytes.Buffer{}

    Countdown(buffer)

    got := buffer.String()
    want := `3
2
1
Go!`

    if got != want {
        t.Errorf("got %q want %q", got, want)
    }
}

バックティック構文はstringを作成するもう1つの方法ですが、テストに最適な改行などを配置できます。

テストを試して実行する

countdown_test.go:21: got '3' want '3
        2
        1
        Go!'

成功させるのに十分なコードを書く

func Countdown(out io.Writer) {
    for i := 3; i > 0; i-- {
        fmt.Fprintln(out, i)
    }
    fmt.Fprint(out, "Go!")
}

i--で逆にカウントするforループを使用し、fmt.Fprintlnを使用して、番号と改行文字を続けてoutに出力します。最後にfmt.Fprintを使用して終わった後「Go！」を送信します。

リファクタリング♪

いくつかの魔法の値を名前付き定数にリファクタリングする以外に、リファクタリングすることは多くありません。

const finalWord = "Go!"
const countdownStart = 3

func Countdown(out io.Writer) {
    for i := countdownStart; i > 0; i-- {
        fmt.Fprintln(out, i)
    }
    fmt.Fprint(out, finalWord)
}

ここでプログラムを実行すると、目的の出力が得られるはずですが、1秒の一時停止による劇的なカウントダウンとしてはありません。

Goでは、time.Sleepでこれを実現できます。コードに追加してみてください。

func Countdown(out io.Writer) {
    for i := countdownStart; i > 0; i-- {
        time.Sleep(1 * time.Second)
        fmt.Fprintln(out, i)
    }

    time.Sleep(1 * time.Second)
    fmt.Fprint(out, finalWord)
}

プログラムを実行すると、期待どおりに機能します。

モック

テストは引き続き成功し、ソフトウェアは意図したとおりに機能しますが、いくつかの問題があります。

• テストの実行には4秒かかります。

  • ソフトウェア開発に関する前向きな投稿はすべて、迅速なフィードバックループの重要性を強調しています。

  • 遅いテストは開発者の生産性を台無しにします。

  • 要件がさらに洗練され、より多くのテストが必要になると想像してください。 Countdownのすべての新しいテストのテスト実行に4が追加されたことに満足していますか？

• 関数の重要なプロパティはテストしていません。

テストでそれを制御できるように抽出する必要があるSleepに依存しています。

time.Sleepをモックできる場合は、「実際の」time.Sleepの代わりにDI dependency injection を使用して、呼び出しをスパイしてアサーションを作成できます。

最初にテストを書く

依存関係をインターフェースとして定義しましょう。これにより、mainで「実際の」Sleeperを使用し、テストで spy sleeper を使用できるようになります。インターフェースを使用することにより、Countdown関数はこれを意識せず、呼び出し側に柔軟性を追加します。

type Sleeper interface {
    Sleep()
}

私のCountdown関数はスリープ時間の長さに責任を負わないと設計上の決定をしました。 これにより、少なくとも今のところコードが少し単純化されており、関数のユーザーがその眠気を好きなように設定できることを意味します。

次に、テストで使用するためにモックを作成する必要があります。

type SpySleeper struct {
    Calls int
}

func (s *SpySleeper) Sleep() {
    s.Calls++
}

Spies は、依存関係の使用方法を記録できるモックの一種です。送信された引数、それが呼び出された回数などを記録できます。この例では、Sleep()が呼び出された回数を追跡しているので、テストで確認できます。

テストを更新してSpyへの依存関係を挿入し、スリープが4回呼び出されたことをアサートします。

func TestCountdown(t *testing.T) {
    buffer := &bytes.Buffer{}
    spySleeper := &SpySleeper{}

    Countdown(buffer, spySleeper)

    got := buffer.String()
    want := `3
2
1
Go!`

    if got != want {
        t.Errorf("got %q want %q", got, want)
    }

    if spySleeper.Calls != 4 {
        t.Errorf("not enough calls to sleeper, want 4 got %d", spySleeper.Calls)
    }
}

テストを試して実行する

too many arguments in call to Countdown
    have (*bytes.Buffer, *SpySleeper)
    want (io.Writer)

テストを実行するための最小限のコードを記述し、失敗したテスト出力を確認します

Sleeperを受け入れるにはCountdownを更新する必要があります

func Countdown(out io.Writer, sleeper Sleeper) {
    for i := countdownStart; i > 0; i-- {
        time.Sleep(1 * time.Second)
        fmt.Fprintln(out, i)
    }

    time.Sleep(1 * time.Second)
    fmt.Fprint(out, finalWord)
}

もう一度試すと、同じ理由でmainはコンパイルできなくなります

./main.go:26:11: not enough arguments in call to Countdown
    have (*os.File)
    want (io.Writer, Sleeper)

必要なインターフェースを実装する「実際の」スリーパーを作成しましょう

type DefaultSleeper struct {}

func (d *DefaultSleeper) Sleep() {
    time.Sleep(1 * time.Second)
}

それを実際のアプリケーションで使用することができます

func main() {
    sleeper := &DefaultSleeper{}
    Countdown(os.Stdout, sleeper)
}

成功させるのに十分なコードを書く

テストはコンパイルされていますが、依存関係が挿入されているのではなく、time.Sleepを呼び出しているため、パスしていません。修正しましょう。

func Countdown(out io.Writer, sleeper Sleeper) {
    for i := countdownStart; i > 0; i-- {
        sleeper.Sleep()
        fmt.Fprintln(out, i)
    }

    sleeper.Sleep()
    fmt.Fprint(out, finalWord)
}

テストに合格し、4秒はかかりません。

まだいくつかの問題

テストしていない重要なプロパティがまだあります。

Countdown は各表示の前にスリープする必要があります。

例：

• Sleep

• Print N

• Sleep

• Print N-1

• Sleep

• Print Go!

• etc

私たちの最新の変更は、それが4回寝たと断言しているだけですが、それらの睡眠は順序が狂って起こる可能性があります。

テストが十分な自信を与えていると確信していない場合にテストを作成するときは、テストを中断してください。 （ただし、変更を最初にソース管理にコミットしたことを確認してください）。

コードを次のように変更します

func Countdown(out io.Writer, sleeper Sleeper) {
    for i := countdownStart; i > 0; i-- {
        sleeper.Sleep()
    }

    for i := countdownStart; i > 0; i-- {
        fmt.Fprintln(out, i)
    }

    sleeper.Sleep()
    fmt.Fprint(out, finalWord)
}

テストを実行すると、実装が間違っていてもテストは成功するはずです。

新しいテストで再度スパイを使用して、操作の順序が正しいことを確認してみましょう。

2つの異なる依存関係があり、それらのすべての操作を1つのリストに記録したいと考えています。 ですから、両方のスパイを1つ作成します。

type CountdownOperationsSpy struct {
    Calls []string
}

func (s *CountdownOperationsSpy) Sleep() {
    s.Calls = append(s.Calls, sleep)
}

func (s *CountdownOperationsSpy) Write(p []byte) (n int, err error) {
    s.Calls = append(s.Calls, write)
    return
}

const write = "write"
const sleep = "sleep"

CountdownOperationsSpyはio.WriterとSleeperの両方を実装し、すべての呼び出しを1つのスライスに記録します。このテストでは操作の順序のみを考慮しているため、名前付き操作のリストとして記録するだけで十分です。

テストスイートにサブテストを追加して、スリープと表示が希望する順序で動作することを確認します。

t.Run("sleep before every print", func(t *testing.T) {
    spySleepPrinter := &CountdownOperationsSpy{}
    Countdown(spySleepPrinter, spySleepPrinter)

    want := []string{
        sleep,
        write,
        sleep,
        write,
        sleep,
        write,
        sleep,
        write,
    }

    if !reflect.DeepEqual(want, spySleepPrinter.Calls) {
        t.Errorf("wanted calls %v got %v", want, spySleepPrinter.Calls)
    }
})

このテストは失敗するはずです。Countdownをテストの修正前の状態に戻します。

Sleeperをスパイする2つのテストができたので、テストをリファクタリングして、1つは表示されているものをテストし、もう1つは表示の合間に確実にスリープするようにします。 最後に、最初のスパイは使用されなくなったので削除できます。

func TestCountdown(t *testing.T) {

    t.Run("prints 3 to Go!", func(t *testing.T) {
        buffer := &bytes.Buffer{}
        Countdown(buffer, &CountdownOperationsSpy{})

        got := buffer.String()
        want := `3
2
1
Go!`

        if got != want {
            t.Errorf("got %q want %q", got, want)
        }
    })

    t.Run("sleep before every print", func(t *testing.T) {
        spySleepPrinter := &CountdownOperationsSpy{}
        Countdown(spySleepPrinter, spySleepPrinter)

        want := []string{
            sleep,
            write,
            sleep,
            write,
            sleep,
            write,
            sleep,
            write,
        }

        if !reflect.DeepEqual(want, spySleepPrinter.Calls) {
            t.Errorf("wanted calls %v got %v", want, spySleepPrinter.Calls)
        }
    })
}

これで、機能とその2つの重要なプロパティが適切にテストされました。

スリーパーを構成可能に拡張

Sleeperが構成可能であることは素晴らしい機能です。これは、メインプログラムでスリープ時間を調整できることを意味します。

最初にテストを書く

まず、設定とテストに必要なものを受け入れる ConfigurableSleeperの新しいタイプを作成しましょう。

type ConfigurableSleeper struct {
    duration time.Duration
    sleep    func(time.Duration)
}

スリープ時間を設定するためにdurationを使用し、スリープ関数を渡す方法としてsleepを使用しています。 sleepのシグネチャはtime.Sleepのシグネチャと同じであり、実際の実装でtime.Sleepを使用して、テストで次のスパイを使用できます。

type SpyTime struct {
    durationSlept time.Duration
}

func (s *SpyTime) Sleep(duration time.Duration) {
    s.durationSlept = duration
}

スパイを配置したら、構成可能なスリーパーの新しいテストを作成できます。

func TestConfigurableSleeper(t *testing.T) {
    sleepTime := 5 * time.Second

    spyTime := &SpyTime{}
    sleeper := ConfigurableSleeper{sleepTime, spyTime.Sleep}
    sleeper.Sleep()

    if spyTime.durationSlept != sleepTime {
        t.Errorf("should have slept for %v but slept for %v", sleepTime, spyTime.durationSlept)
    }
}

このテストには何も新しいものはなく、以前の模擬テストと非常によく似た設定になっています。

テストを試して実行する

sleeper.Sleep undefined (type ConfigurableSleeper has no field or method Sleep, but does have sleep)

ConfigurableSleeperで作成されたSleepメソッドがないことを示す非常に明確なエラーメッセージが表示されます。

テストを実行し、失敗したテスト出力を確認するための最小限のコードを記述します

func (c *ConfigurableSleeper) Sleep() {
}

新しいSleep関数が実装されたため、テストに失敗しました。

countdown_test.go:56: should have slept for 5s but slept for 0s

成功させるのに十分なコードを書く

ここで行う必要があるのは、ConfigurableSleeperのSleep関数を実装することだけです。

func (c *ConfigurableSleeper) Sleep() {
    c.sleep(c.duration)
}

この変更により、すべてのテストが再び成功し、メインプログラムがまったく変更されなかったので、なぜすべての面倒な作業に不思議に思うかもしれません。 うまくいけば、次のセクションで明らかになります。

クリーンアップとリファクタリング

最後に行う必要があるのは、メイン関数で実際に ConfigurableSleeperを使用することです。

func main() {
    sleeper := &ConfigurableSleeper{1 * time.Second, time.Sleep}
    Countdown(os.Stdout, sleeper)
}

テストとプログラムを手動で実行すると、すべての動作が同じであることがわかります。

ConfigurableSleeperを使用しているので、DefaultSleeper実装を削除しても安全です。 私たちのプログラムをまとめ、より多くのgeneric任意の長いカウントダウンを備えたスリーパーを用意します。

しかし、モックを行うのは悪ではないのか？

モックは悪だと聞いたことがあるかもしれません。ソフトウェア開発と同様に、DRYのように悪く使用することができます。

人々は通常、テストを行っていない、そして、リファクタリング段階を尊重していない場合、悪い状態に陥ります。

通常、それはモックコードが複雑になったり、何かをテストするためにたくさんのものをモックアウトしたりする必要がある場合は、その悪い感情に耳を傾け、コードについて考える必要があります。

• テストしているのは、あまりにも多くのことをしなければならないことです（モックするには依存関係が多すぎるためです）。

  • モジュールを分解して、効率を下げます

• 依存関係が細かすぎる

  • これらの依存関係のいくつかを1つの意味のあるモジュールに統合する方法を考えてください

• テストは実装の詳細にあまりにも関係しています

  • 実装ではなく期待される動作のテストを優先する

通常、コードのモックポイントの多くは、 悪い抽象化 を指します。

ここで見られるのはTDDの弱点ですが、それは実際には長所です。多くの場合、貧弱なテストコードは、設計が悪い結果であるか、より適切に設計されたコードをテストすることは簡単です。

でも、模試やテストのせいで生活が苦しくなってきました!

この状況に遭遇したことがありますか？

• リファクタリングを行いたい

• これを行うには、多くのテストを変更することになります

• TDDに質問し、「モッキングは有害と見なされます」というタイトルのメディアに投稿します

これは通常、実装の詳細をテストしすぎていることを示しています。 システムの実行にとって実装が本当に重要でない限り、テストが有用な動作をチェックするようにしてください。

正確にテストするために、どのレベルかを知るのは難しい場合がありますが、ここに私が従おうとするいくつかの思考プロセスとルールがあります。

• リファクタリングの定義では、コードは変更されますが、動作は同じです。理論的にリファクタリングを行うことに決めた場合は、テストを変更せずにコミットを実行できるはずです。だからテストを書くときは自問してください

  • 必要な動作や実装の詳細をテストしていますか？

  • このコードをリファクタリングする場合、テストに多くの変更を加える必要がありますか？

• Goではプライベート関数をテストできますが、プライベート関数は実装に関係しているため、避けたいと思います。

• テストが3つ以上のモックで動作している場合、それは危険信号であるように感じます（デザインを再検討する時間）

• スパイは注意して使用してください。スパイを使用すると、作成中のアルゴリズムの内部を確認できます。これは非常に便利ですが、テストコードと実装の間の結合がより緊密になることを意味します。 これらをスパイする場合は、これらの詳細に注意してください

いつものように、ソフトウェア開発のルールは実際にはルールではなく、例外がある場合があります。 ボックルおじさんの「モックするとき」の記事には、優れた指針がいくつかあります。

まとめ

TDDアプローチの詳細

• ささいな例に直面した場合は、問題を「薄いスライス」に分解してください。ウサギの穴に入り込み、「ビッグバン」アプローチをとらないように、できるだけ早く_testsで動作するソフトウェアを使用できるようにしてください。

• 動作するソフトウェアを入手したら、必要なソフトウェアにたどり着くまで小さなステップで繰り返すのが簡単です。

「反復開発を使用する場合？反復開発は、成功させたいプロジェクトでのみ使用する必要があります。」

マーティン・ファウラー（Martin Fowler）。

モック

• コードの重要な領域をモックしないと、テストされません。私たちのケースでは、各表示の間にコードが一時停止することをテストすることはできませんが、他にも数え切れないほどの例があります。失敗する可能性のあるサービスを呼び出していますか？特定の状態でシステムをテストしたいですか？モックなしでこれらのシナリオをテストすることは非常に困難です。

• モックがないと、単純なビジネスルールをテストするためだけに、データベースや他のサードパーティの設定が必要になる場合があります。テストが遅くなり、フィードバックループが遅くなる可能性があります。

• 何かをテストするためにデータベースまたはWebサービスをスピンアップする必要があるため、そのようなサービスの信頼性が低いために、壊れやすいテストを受ける可能性があります。

開発者がモックについて学ぶと、システムの 機能 ではなく 機能 の観点から、システムのあらゆる側面を過剰にテストすることが非常に簡単になります。 テストの価値と、それらが将来のリファクタリングに与える影響について常に注意してください。

モックに関するこの投稿では、モックの一種であるスパイのみを取り上げました。 モックにはさまざまな種類があります。 ボブおじさんは非常に読みやすい記事でタイプについて説明しています。

後の章では、データを他の人に依存するコードを書く必要があります。この場所でスタブの動作を示します。