Як перевірити паніку?


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 . Навіть якщо вам не потрібна повна система Гінкго, ви можете використовувати лише її відповідну бібліотеку, 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()
}

@IgorMikushkin в Go 1.11, використовуючи першу форму, описану Роб Нап’єром, насправді працює для висвітлення.
FGM

Чи є якась причина, якою ви користуєтесь, r := recover(); r == nilа не просто recover() == nil?
Дункан Джонс,

@DuncanJones Не дуже в цьому випадку. Це справді типовий шаблон Go, щоб зробити помилку доступною в блоці, тому, мабуть, це було звичним для ОП писати її так (і я переніс його код вперед), але насправді він не використовується в цьому випадку.
Роб Нейпір,

44

Якщо ви використовуєте свідчення / твердження , то це однокласний:

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")
}

Якщо ви ще не пробували свідчити, тоді також ознайомтеся зі свідченням / знущанням . Супер прості твердження та насмішки.


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
Надійніше затверджувати тип на певному типі помилки (наприклад, os.SyscallError), ніж порівнювати повідомлення про помилки, які можуть змінюватися (наприклад) від одного випуску Go до іншого.
Майкл

+ Майкл Ауг, це, мабуть, кращий підхід, коли є певний тип.
joonas.fi

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

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.