パニックをテストする方法は?


90

私は現在、特定のコードがパニックに陥ったかどうかをチェックするテストを作成する方法を考えていますか?Goがrecoverパニックをキャッチするために使用することは知っていますが、たとえばJavaコードとは異なり、パニックが発生した場合にスキップするコードや、何を持っているかを実際に指定することはできません。したがって、関数がある場合:

func f(t *testing.T) {
    defer func() {
        if r := recover(); r != nil {
            fmt.Println("Recovered in f", r)
        }
    }()
    OtherFunctionThatPanics()
    t.Errorf("The code did not panic")
}

OtherFunctionThatPanicsパニックになって回復したのか、機能がまったくパニックにならなかったのか、本当にわかりません。パニックがない場合にスキップするコードと、パニックがある場合に実行するコードを指定するにはどうすればよいですか?回復したパニックがあったかどうかを確認するにはどうすればよいですか?

回答:


106

testing実際には「成功」の概念はなく、失敗だけです。したがって、上記のコードはほぼ正しいです。このスタイルは少しわかりやすいかもしれませんが、基本的には同じです。

func TestPanic(t *testing.T) {
    defer func() {
        if r := recover(); r == nil {
            t.Errorf("The code did not panic")
        }
    }()

    // The following is the code under test
    OtherFunctionThatPanics()
}

私は一般的testingにかなり弱いと思います。Ginkgoのようなより強力なテストエンジンに興味があるかもしれません。完全なGinkgoシステムが必要ない場合でも、と一緒に使用できるマッチャーライブラリであるGomegaだけを使用できますtesting。Gomegaには、次のようなマッチャーが含まれています。

Expect(OtherFunctionThatPanics).To(Panic())

パニックチェックを単純な関数にまとめることもできます。

func TestPanic(t *testing.T) {
    assertPanic(t, OtherFunctionThatPanics)
}

func assertPanic(t *testing.T, f func()) {
    defer func() {
        if r := recover(); r == nil {
            t.Errorf("The code did not panic")
        }
    }()
    f()
}

Go 1.11の@IgorMikushkinは、Rob Napierによって記述された最初のフォームを使用して、実際にカバレッジに機能します。
FGM 2018

r := recover(); r == nilだけでなく、使用する理由はありますrecover() == nilか?
ダンカンジョーンズ

@DuncanJonesこの場合はそうではありません。ブロックでエラーを利用できるようにするのは本当に典型的なGoパターンなので、おそらくOPがそのように書くのが習慣でした(そして私は彼のコードを前に出しました)が、この場合は実際には使用されません。
ロブ・ネーピア

43

testify / assertを使用する場合、それはワンライナーです。

func TestOtherFunctionThatPanics(t *testing.T) {
  assert.Panics(t, OtherFunctionThatPanics, "The code did not panic")
}

または、OtherFunctionThatPanics以下以外の署名がある場合func()

func TestOtherFunctionThatPanics(t *testing.T) {
  assert.Panics(t, func() { OtherFunctionThatPanics(arg) }, "The code did not panic")
}

testifyをまだ試したことがない場合は、testify / mockもチェックしてください。超単純なアサーションとモック。


7

複数のテストケースをループするときは、次のようなものを選びます。

package main

import (
    "reflect"
    "testing"
)


func TestYourFunc(t *testing.T) {
    type args struct {
        arg1 int
        arg2 int
        arg3 int
    }
    tests := []struct {
        name      string
        args      args
        want      []int
        wantErr   bool
        wantPanic bool
    }{
        //TODO: write test cases
    }
    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            defer func() {
                r := recover()
                if (r != nil) != tt.wantPanic {
                    t.Errorf("SequenceInt() recover = %v, wantPanic = %v", r, tt.wantPanic)
                }
            }()
            got, err := YourFunc(tt.args.arg1, tt.args.arg2, tt.args.arg3)
            if (err != nil) != tt.wantErr {
                t.Errorf("YourFunc() error = %v, wantErr %v", err, tt.wantErr)
                return
            }
            if !reflect.DeepEqual(got, tt.want) {
                t.Errorf("YourFunc() = %v, want %v", got, tt.want)
            }
        })
    }
}

遊び場に行く


4

パニックの内容を確認する必要がある場合は、復元された値をタイプキャストできます。

func TestIsAheadComparedToPanicsWithDifferingStreams(t *testing.T) {
    defer func() {
        err := recover().(error)

        if err.Error() != "Cursor: cannot compare cursors from different streams" {
            t.Fatalf("Wrong panic message: %s", err.Error())
        }
    }()

    c1 := CursorFromserializedMust("/foo:0:0")
    c2 := CursorFromserializedMust("/bar:0:0")

    // must panic
    c1.IsAheadComparedTo(c2)
}

テストしているコードがパニックにならないか、エラーでパニックになるか、期待するエラーメッセージでパニックにならない場合、テストは失敗します(これはあなたが望むものです)。


1
Goリリースごとに変更される可能性のあるエラーメッセージを比較するよりも、特定のエラータイプ(os.SyscallErrorなど)でタイプアサートする方が堅牢です。
マイケル

+ Michael Aug、特定のタイプが利用可能な場合は、おそらくそれがより良いアプローチです。
joonas.fi 2018

3

あなたの場合、あなたは次のことができます:

func f(t *testing.T) {
    recovered := func() (r bool) {
        defer func() {
            if r := recover(); r != nil {
                r = true
            }
        }()
        OtherFunctionThatPanics()
        // NOT BE EXECUTED IF PANICS
        // ....
    }
    if ! recovered() {
        t.Errorf("The code did not panic")

        // EXECUTED IF PANICS
        // ....
    }
}

一般的なパニックルーター機能として、これも機能します

https://github.com/7d4b9/recover

package recover

func Recovered(IfPanic, Else func(), Then func(recover interface{})) (recoverElse interface{}) {
    defer func() {
        if r := recover(); r != nil {
            {
                // EXECUTED IF PANICS
                if Then != nil {
                    Then(r)
                }
            }
        }
    }()

    IfPanic()

    {
        // NOT BE EXECUTED IF PANICS
        if Else != nil {
            defer func() {
                recoverElse = recover()
            }()
            Else()
        }
    }
    return
}

var testError = errors.New("expected error")

func TestRecover(t *testing.T) {
    Recovered(
        func() {
            panic(testError)
        },
        func() {
            t.Errorf("The code did not panic")
        },
        func(r interface{}) {
            if err := r.(error); err != nil {
                assert.Error(t, testError, err)
                return
            }
            t.Errorf("The code did an unexpected panic")
        },
    )
}

3

簡潔な方法

私にとって、以下のソリューションは読みやすく、テスト対象のコードの自然なコードフローを示しています。

func TestPanic(t *testing.T) {
    // No need to check whether `recover()` is nil. Just turn off the panic.
    defer func() { recover() }()

    OtherFunctionThatPanics()

    // Never reaches here if `OtherFunctionThatPanics` panics.
    t.Errorf("did not panic")
}

より一般的な解決策については、次のようにすることもできます。

func TestPanic(t *testing.T) {
    shouldPanic(t, OtherFunctionThatPanics)
}

func shouldPanic(t *testing.T, f func()) {
    defer func() { recover() }()
    f()
    t.Errorf("should have panicked")
}

0

パニックに入力を与えることで、どの機能がパニックになったかをテストできます

package main

import "fmt"

func explode() {
    // Cause a panic.
    panic("WRONG")
}

func explode1() {
    // Cause a panic.
    panic("WRONG1")
}

func main() {
    // Handle errors in defer func with recover.
    defer func() {
        if r := recover(); r != nil {
            var ok bool
            err, ok := r.(error)
            if !ok {
                err = fmt.Errorf("pkg: %v", r)
                fmt.Println(err)
            }
        }

    }()
    // These causes an error. change between these
    explode()
    //explode1()

    fmt.Println("Everything fine")

}

http://play.golang.org/p/ORWBqmPSVA

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.