如何测试运行命令的 Go 函数？

Question

按照https://golang.org/pkg/os/exec/#Cmd.StdoutPipe的示例，假设我有一个getPerson()如下定义的函数：

package stdoutexample

import (

    "encoding/json"

    "os/exec"

)

// Person represents a person

type Person struct {

    Name string

    Age  int

}

func getPerson() (Person, error) {

    person := Person{}

    cmd := exec.Command("echo", "-n", `{"Name": "Bob", "Age": 32}`)

    stdout, err := cmd.StdoutPipe()

    if err != nil {

        return person, err

    }

    if err := cmd.Start(); err != nil {

        return person, err

    }

    if err := json.NewDecoder(stdout).Decode(&person); err != nil {

        return person, err

    }

    if err := cmd.Wait(); err != nil {

        return person, err

    }

    return person, nil

}

在我的“真实”应用程序中，命令运行可以有不同的输出，我想为每个场景编写测试用例。但是，我不知道该怎么做。

到目前为止，我所拥有的只是一个案例的测试用例：

package stdoutexample

import (

    "testing"

    "github.com/stretchr/testify/assert"

    "github.com/stretchr/testify/require"

)

func TestGetPerson(t *testing.T) {

    person, err := getPerson()

    require.NoError(t, err)

    assert.Equal(t, person.Name, "Bob")

    assert.Equal(t, person.Age, 32)

}

也许解决这个问题的方法是将这个函数分成两部分，一个部分将命令的输出写入字符串，另一个部分解码字符串的输出？

Answer 1

我建议您使用表驱动测试方法，而不是为每个测试编写单独的测试函数。这是一个例子，func Test_getPerson(t *testing.T) {    tests := []struct {        name          string        commandOutput []byte        want          Person    }{        {            name:          "Get Bob",            commandOutput: []byte(`{"Name": "Bob", "Age": 32}`),            want: Person{                Name: "Bob",                Age:  32,            },        },        {            name:          "Get Alice",            commandOutput: []byte(`{"Name": "Alice", "Age": 25}`),            want: Person{                Name: "Alice",                Age:  25,            },        },    }    for _, tt := range tests {        t.Run(tt.name, func(t *testing.T) {            got, err := getPerson(tt.commandOutput)            require.NoError(t, err)            assert.Equal(t, tt.want.Name, got.Name)            assert.Equal(t, tt.want.Age, got.Age)        })    }}只需将测试用例添加到切片中，即可运行所有测试用例。

Answer 2

您的实现设计主动拒绝细粒度测试，因为它不允许任何注入。然而，从这个例子来看，除了使用 TestTable 之外，没有太多需要改进的地方。现在，在实际工作负载中，您可能会因调用外部二进制文件而遇到不可接受的速度减慢。这可能证明另一种方法是合理的，该方法涉及设计重构以模拟和设置多个测试存根。为了模拟您的实现，您可以使用interface功能。为了存根你的执行，你创建一个模拟来输出你想要检查的东西。package mainimport (    "encoding/json"    "fmt"    "os/exec")type Person struct{}type PersonProvider struct {    Cmd outer}func (p PersonProvider) Get() (Person, error) {    person := Person{}    b, err := p.Cmd.Out()    if err != nil {        return person, err    }    err = json.Unmarshal(b, &person)    return person, err}type outer interface{ Out() ([]byte, error) }type echo struct {    input string}func (e echo) Out() ([]byte, error) {    cmd := exec.Command("echo", "-n", e.input)    return cmd.Output()}type mockEcho struct {    output []byte    err    error}func (m mockEcho) Out() ([]byte, error) {    return m.output, m.err}func main() {    fmt.Println(PersonProvider{Cmd: echo{input: `{"Name": "Bob", "Age": 32}`}}.Get())    fmt.Println(PersonProvider{Cmd: mockEcho{output: nil, err: fmt.Errorf("invalid json")}}.Get())}

Answer 3

我通过将函数分为两部分来添加单元测试：一部分将输出读取到字节切片，另一部分将该输出解析为Person：package stdoutexampleimport (    "bytes"    "encoding/json"    "os/exec")// Person represents a persontype Person struct {    Name string    Age  int}func getCommandOutput() ([]byte, error) {    cmd := exec.Command("echo", "-n", `{"Name": "Bob", "Age": 32}`)    return cmd.Output()}func getPerson(commandOutput []byte) (Person, error) {    person := Person{}    if err := json.NewDecoder(bytes.NewReader(commandOutput)).Decode(&person); err != nil {        return person, err    }    return person, nil}以下测试用例通过：package stdoutexampleimport (    "testing"    "github.com/stretchr/testify/assert"    "github.com/stretchr/testify/require")func TestGetPerson(t *testing.T) {    commandOutput, err := getCommandOutput()    require.NoError(t, err)    person, err := getPerson(commandOutput)    require.NoError(t, err)    assert.Equal(t, person.Name, "Bob")    assert.Equal(t, person.Age, 32)}func TestGetPersonBob(t *testing.T) {    commandOutput := []byte(`{"Name": "Bob", "Age": 32}`)    person, err := getPerson(commandOutput)    require.NoError(t, err)    assert.Equal(t, person.Name, "Bob")    assert.Equal(t, person.Age, 32)}func TestGetPersonAlice(t *testing.T) {    commandOutput := []byte(`{"Name": "Alice", "Age": 25}`)    person, err := getPerson(commandOutput)    require.NoError(t, err)    assert.Equal(t, person.Name, "Alice")    assert.Equal(t, person.Age, 25)}其中Bob和Alice测试用例模拟可以由命令生成的不同输出。