来到编程网的大家,相信都是编程学习爱好者,希望在这里学习Golang相关编程知识。下面本篇文章就来带大家聊聊《如何测试运行命令的 Go 函数?》,介绍一下,希望对大家的知识积累有所帮助,助力实战开发!
问题内容按照 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)
}
也许解决这个问题的方法是将这个函数分成两部分,一个部分将命令的输出写入字符串,另一个部分解码字符串的输出?
解决方案
添加到 https://stackoverflow.com/a/58107208/9353289,
我建议您使用表驱动测试方法,而不是为每个测试编写单独的测试函数。 这是一个例子,
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)
})
}
}
只需将测试用例添加到切片中,即可运行所有测试用例。
我通过将函数分为两部分来添加单元测试:一个将输出读取到字节切片,另一个将输出读取到字节切片中。将该输出解析为 person
:
package stdoutexample
import (
"bytes"
"encoding/json"
"os/exec"
)
// person represents a person
type 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 stdoutexample
import (
"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
测试用例模拟可以由命令生成的不同输出。
终于介绍完啦!小伙伴们,这篇关于《如何测试运行命令的 Go 函数?》的介绍应该让你收获多多了吧!欢迎大家收藏或分享给更多需要学习的朋友吧~编程网公众号也会发布Golang相关知识,快来关注吧!