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

Question

我定义了以下 Cobra 子命令，我想使用 testify 测试输出：

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 %v\nCity:\t%v\n",
            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 客户端更好的方法来帮助促进模拟？截至目前，单元测试尝试连接到不存在的 gRPC 客户端并失败。

Answer 1

一种选择是使用随机端口在单元测试中运行 gRPC 服务器并让客户端连接到该服务器。如果您的树中也有 gRPC 服务器，并且它不会引入您无法模拟的其他内容，则这是可能的。

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

// 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
}