如何修复Go测试输出中的行号?

时间:2015-03-06 23:30:02

标签: testing go

让我们考虑一下这个简单的测试代码。

(注意:assertSomething在这里非常简单,但通常我会为手头的任务编写一个更专业的帮助器,它可以查看多个内容,并且可以报告多种类型的错误。)

package hello

import "testing"

func TestFoo(t *testing.T) {
    assertSomething(t, 2+2 == 4) // line 6
    assertSomething(t, 2+3 == 6) // line 7
}

func assertSomething(t *testing.T, expected bool) {
    if !expected {
        t.Error("Something's not right") // line 12
    }
}

当我运行go test时,我得到以下内容:

--- FAIL: TestFoo (0.00s)
    hello.go:12: Something's not right
FAIL
exit status 1
FAIL    kos/hello   0.008s

我有两个问题:

1)错误指向第12行 - 为什么? t.Error如何找出从哪个行调用?

2)在帮助程序中,我想指定t.Error应该看起来更高的堆栈级别以确定要打印的行号,以便我得到这样的消息:

--- FAIL: TestFoo (0.00s)
    hello.go:7: Something's not right

Python允许我这样做,例如,在warnings.warn("message", stacklevel=2)中 - 我如何在这里实现等价物?

2 个答案:

答案 0 :(得分:12)

可以按照您的要求行事,您可以looking at the source code了解t.Error的工作原理。我认为函数decorate正是您所寻找的。

但是,如果您有大量的检查代码,并且由于某种原因它在测试中变得重复,最好将其作为返回错误的函数提取而不是通过测试。然后进行测试一个“断言”。实际上,在语言FAQ中明确不鼓励编写断言函数。

package hello

import "testing"

func TestFoo(t *testing.T) {
    if err := checkSomething(2+2 == 4); err != nil {
        t.Errorf("2+2=4 failed: %s", err)
    }
    if err := checkSomething(2+3 == 6); err != nil {
        t.Errorf("2+3=6 failed: %s", err)
    }
}

func checkSomething(v bool) error {
    if !v {
        return errors.New("something's not right")
    }
    return nil
}

但这就是我认为惯用测试代码的样子。它是表驱动的,案例包括输入和预期输出,当测试失败时,会产生非常明确的错误消息。

package hello

import "testing"

func TestFoo(t *testing.T) {
    cases := []struct {
        a, b, want int
    }{
        {2, 2, 4},
        {2, 3, 6},
    }
    for _, c := range cases {
        if got := operation(c.a, c.b); got != c.want {
            t.Errorf("operation(%d, %d) = %d, want %d", c.a, c.b, got, c.want)
        }
    }
}

func operation(a, b int) int {
    return a + b
}

答案 1 :(得分:8)

自1.9以来,事情已changed

Helper()方法已添加到testing.Ttesting.B。它旨在通过测试助手(例如assertSomething)来调用,以指示函数是一个帮助器,我们对来自它的行号不感兴趣。

package main

import "testing"

func TestFoo(t *testing.T) {
    assertSomething(t, 2+2 == 4) // line 6
    assertSomething(t, 2+3 == 6) // line 7
}

func assertSomething(t *testing.T, expected bool) {
    if !expected {
        t.Helper()
        t.Error("Something's not right") // line 12
    }
}

输出包含正确的行号:

=== RUN   TestFoo
--- FAIL: TestFoo (0.00s)
    main.go:7: Something's not right
FAIL

您也可以在Go Playground上try it