如何对需要内部mock的Cobra CLI命令进行单元测试

Question

我已经定义了以下Cobra子命令，我想测试使用verify的输出：

var childCmd = &cobra.Command{
Args:  cobra.MinimumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
id := args[0]
conn := getConn()
c := newClient(conn)
out, err := c.getResult(cmd.Context(), id)
if err != nil {
return err
}
fmt.Printf(
"Name:t%v %vnCity:t%vn",
out.GetFirstName().String(),
out.GetLastName().String(),
out.GetCity().String(),
)
return nil
},
}
func init() {
rootCmd.AddCommand(childCmd)
}

我可以用这样的东西来测试实际输出：

func executeCommand(root *cobra.Command, args ...string) (output string, err error) {
buf := new(bytes.Buffer)
root.SetOut(buf)
root.SetErr(buf)
root.SetArgs(args)
err = root.Execute()
if err != nil {
fmt.Println(err)
}
return buf.String(), err
}
func TestGetResult(t *testing.T) {
rootCmd.AddCommand(childCmd)
output, _ := executeCommand(rootCmd, "child", "1")
assert.Equal(t, "test", output)
}

但我缺少的是如何模拟gRPC客户端及其对getResult的相应调用。有没有比在RunE函数中创建一个新的gRPC客户端更好的方法来帮助简化mocking？到目前为止，单元测试尝试连接到一个不存在的gRPC客户端，但失败了。

Answer 1

一个选项是在单元测试中使用随机端口运行gRPC服务器，并让客户端连接到该端口。如果您的树中也有gRPC服务器，并且它不会带来其他无法模拟的东西，那么这是可能的。

更简单的选择是将gRPC初始化提取到一个函数变量，并将其设置为在单元测试期间返回一个mock：

// Get connection and return client
func GetGRPCClient() (MyClient,error) {
...
}
var getClient = GetGRPCClient
var childCmd = &cobra.Command{
// use getClient in the command implementation
}

***_test.go:
func getTestGRPCClient() (MyClient,error) {
// Construct a mock client and return it
}
func TestCommand(t *testing.T) { 
getClient=getTestGRPCClient
// Run the test
}