小伙伴们对Golang编程感兴趣吗？是否正在学习相关知识点？如果是，那么本文《如何在go中实现CLI命令的单元测试》，就很适合你，本篇文章讲解的知识点主要包括。在之后的文章中也会多多分享相关知识点，希望对大家的知识积累有所帮助！
问题内容我正在启动一个利用 spf13/cobra 的新 OSS CLI 工具。作为 golang 新手，我很难找出单独测试命令的最佳方法。有人能给我一个如何测试命令的例子吗？一些注意事项：
- 您无法从 init 函数返回 cobra.Command
- cmd 目录中不能有
get_test.go...我的印象是 golang 最佳实践。 - 我是 golang 新手，请慢慢来：sweat_smile：
如有错误，请指正。
这是我尝试测试的 cmd：https://github.com/sahellebusch/raider/blob/3-add-get-alerts/cmd/get.go。
接受想法、建议、批评等等。
解决方案
使用 go 实现 cli 的方法有多种。这是我开发的 cli 的基本结构，主要受 docker cli 的影响，并且我还添加了单元测试。
您需要的第一件事是使用 cli 作为界面。这将位于名为“cli”的包内。
package cli
type cli interface {
// have interface functions here
sayhello() error
}这将由 2 个 cli 实现：hellocli（我们真正的 cli）和 mockcli（用于单元测试）
package cli
type hellocli struct {
}
func newhellocli() *hellocli {
cli := &hellocli{
}
return cli
}这里hellocli将实现sayhello函数，如下所示。
package cli
func (cli *hellocli) sayhello() error {
// implement here
}类似地，名为 test 的包中会有一个模拟 cli，它将实现 cli 接口，并且还将实现 sayhello 函数。
package test
type mockcli struct {
}
func newmockcli() *hellocli {
cli := &mockcli{
}
return cli
}
func (cli *mockcli) sayhello() error {
// mock implementation here
}现在我将展示如何添加该命令。首先，我将拥有主包，这是我添加所有新命令的地方。
package main
func newclicommand(cli cli.cli) *cobra.command {
cmd := &cobra.command{
use: "foo <command>"
}
cmd.addcommand(
newhellocommand(cli),
)
return cmd
}
func main() {
hellocli := cli.newhellocli()
cmd := newclicommand(hellocli)
if err := cmd.execute(); err != nil {
// do something here if execution fails
}
}
func newhellocommand(cli cli.cli) *cobra.command {
cmd := &cobra.command{
use: "hello",
short: "prints hello",
run: func(cmd *cobra.command, args []string) {
if err := pkg.runhello(cli, args[0]); err != nil {
// do something if command fails
}
},
example: " foo hello",
}
return cmd
}这里，我有一个名为 hello 的命令。接下来，我将在一个名为“pkg”的单独包中实现。
package pkg
func runhello(cli cli.cli) error {
// do something in this function
cli.sayhello()
return nil
}单元测试也将包含在此包中名为 hello_test 的文件中。
package pkg
func TestRunHello(t *testing.T) {
mockCli := test.NewMockCli()
tests := []struct {
name string
}{
{
name: "my test 1",
},
{
name: "my test 2"
},
}
for _, tst := range tests {
t.Run(tst.name, func(t *testing.T) {
err := SayHello(mockCli)
if err != nil {
t.Errorf("error in SayHello, %v", err)
}
})
}
}当您执行 foo hello 时，hellocli 将被传递给 sayhello() 函数，当您运行单元测试时，mockcli 将被传递。
您可以检查 cobra 本身是如何执行此操作的 - https://github.com/spf13/cobra/blob/master/command_test.go
基本上，您可以将实际的命令逻辑（运行函数）重构为单独的函数并测试该函数。您可能想要正确命名您的函数，而不是仅仅将其命名为 run。
以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持编程网！更多关于Golang的相关知识，也可关注编程网公众号。
