如何使用Go中的测试包进行测试设置

Question

我如何进行整体测试设置处理,为使用测试包时的所有测试设置阶段？

作为Nunit的一个例子,有一个[SetUp]属性.

[TestFixture]
public class SuccessTests
{
  [SetUp] public void Init()
  { /* Load test data */ }
}

Answer 1

从Go 1.4开始,您可以实现设置/拆卸(无需在每次测试之前/之后复制您的功能).该文档概括这里的主要部分:

TestMain在主goroutine中运行,可以执行任何设置,并且在调用m.Run时需要拆卸.然后应该使用m.Run的结果调用os.Exit

我花了一些时间才弄清楚这意味着如果测试包含一个函数,func TestMain(m *testing.M)那么将调用此函数而不是运行测试.在这个函数中,我可以定义测试的运行方式.例如,我可以实现全局设置和拆解:

func TestMain(m *testing.M) {
    setup()
    code := m.Run() 
    shutdown()
    os.Exit(code)
}

其他几个例子可以在这里找到.

Answer 2

这可以通过init()在_test.go文件中放入一个函数来实现.这将在init()函数之前运行.

// package_test.go
package main

func init() {
     /* load test data */
}

_test.init()将在包init()函数之前调用.

Answer 3

使用以下模板，您可以在每个执行设置和拆卸的测试方法中进行一行调用。

func setupTest() func() {
    // Setup code here

    // tear down later
    return func() {
        // tear-down code here
    }
}

func TestMethod(t *testing.T) {
    defer setupTest()()
    // asserts, ensures, requires... here
}

Answer 4

给定单元测试的简单功能:

package math

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

您可以使用返回拆卸功能的设置功能对其进行测试.在调用setup()之后,您可以对teardown()进行延迟调用.

package math

import "testing"

func setupTestCase(t *testing.T) func(t *testing.T) {
    t.Log("setup test case")
    return func(t *testing.T) {
        t.Log("teardown test case")
    }
}

func setupSubTest(t *testing.T) func(t *testing.T) {
    t.Log("setup sub test")
    return func(t *testing.T) {
        t.Log("teardown sub test")
    }
}

func TestAddition(t *testing.T) {
    cases := []struct {
        name     string
        a        int
        b        int
        expected int
    }{
        {"add", 2, 2, 4},
        {"minus", 0, -2, -2},
        {"zero", 0, 0, 0},
    }

    teardownTestCase := setupTestCase(t)
    defer teardownTestCase(t)

    for _, tc := range cases {
        t.Run(tc.name, func(t *testing.T) {
            teardownSubTest := setupSubTest(t)
            defer teardownSubTest(t)

            result := Sum(tc.a, tc.b)
            if result != tc.expected {
                t.Fatalf("expected sum %v, but got %v", tc.expected, result)
            }
        })
    }
}

Go测试工具将在shell控制台中报告日志记录语句:

% go test -v
=== RUN   TestAddition
=== RUN   TestAddition/add
=== RUN   TestAddition/minus
=== RUN   TestAddition/zero
--- PASS: TestAddition (0.00s)
    math_test.go:6: setup test case
    --- PASS: TestAddition/add (0.00s)
        math_test.go:13: setup sub test
        math_test.go:15: teardown sub test
    --- PASS: TestAddition/minus (0.00s)
        math_test.go:13: setup sub test
        math_test.go:15: teardown sub test
    --- PASS: TestAddition/zero (0.00s)
        math_test.go:13: setup sub test
        math_test.go:15: teardown sub test
    math_test.go:8: teardown test case
PASS
ok      github.com/kare/go-unit-test-setup-teardown 0.010s
% 

您可以使用此方法将一些其他参数传递给setup/teardown.

Answer 5

通常,go中的测试不会以与其他语言相同的样式编写.通常,测试函数相对较少,但每个都包含一组由表驱动的测试用例.请参阅Go团队之一撰写的这篇文章.

使用表驱动测试,您只需在执行表中指定的各个测试用例的循环之前放置任何设置代码,然后再放入任何清理代码.

如果你仍然在测试函数之间有共享设置代码,你可以将共享设置代码提取到一个函数中,并使用一个sync.Once重要的是它只执行一次(或者作为另一个答案暗示,使用init(),但这有一个缺点,即设置即使测试用例没有运行也会完成(也许是因为你通过使用限制了测试用例go test -run <regexp>.)

我想如果你认为你需要在不同的测试之间进行共享设置,只要你真的需要它就应该进行一次思考,并且如果表驱动的测试不会更好.

Answer 6

Go测试框架没有任何与NUnit的SetUp属性等价的东西(标记在套件中的每个测试之前调用的函数).但有几个选择:

1. 只需SetUp在需要的每个测试中调用您的函数.

2. 使用Go的测试框架的扩展来实现xUnit范例和概念.我想到了三个强大的选择:

   • gocheck
   • 作证
   • gunit

这些库中的每一个都鼓励您将测试组织到类似于其他xUnit框架的套件/夹具中,并在每个Test*方法之前调用套件/夹具类型的设置方法.

Answer 7

如果有人正在寻找 @BeforeEach （在测试文件中的每个测试之前运行）和 @AfterEach （在测试文件中的测试之后运行）的替代方案，这里有一个帮助程序片段。

func CreateForEach(setUp func(), tearDown func()) func(func()) {
    return func(testFunc func()) {
        setUp()
        testFunc()
        tearDown()
    }
}

您可以在 TestMain 的帮助下像下面这样使用它

var RunTest = CreateForEach(setUp, tearDown)

func setUp() {
   // SETUP METHOD WHICH IS REQUIRED TO RUN FOR EACH TEST METHOD
   // your code here
}

func tearDown() {
  // TEAR DOWN METHOD WHICH IS REQUIRED TO RUN FOR EACH TEST METHOD
  // your code here
}

fun TestSample(t *testing.T) {
  RunTest(func() {
    // YOUR CODE HERE
  })
}

你也可以检查：go-beforeeach