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

一分耕耘，一分收获！既然打开了这篇文章《如何对 Cobra CLI 命令中的内部模拟进行单元测试？》，就坚持看下去吧！文中内容包含等等知识点...希望你能在阅读本文后，能真真实实学到知识或者帮你解决心中的疑惑，也欢迎大佬或者新人朋友们多留言评论，多给建议！谢谢！

我定义了以下 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 客户端并失败。

解决方案

一种选择是使用随机端口在单元测试中运行 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
}

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《如何对 Cobra CLI 命令中的内部模拟进行单元测试？》文章吧，也可关注golang学习网公众号了解相关技术文章。