Golang用expect库测试CLI交互流程

使用 expect 库测试 CLI 交互流程的关键步骤是：1. 安装 expect 及其依赖；2. 编写或构建被测 CLI 程序；3. 启动子进程并创建 expect 实例；4. 使用 ExpectString 匹配提示信息；5. 使用 SendLine 模拟用户输入；6. 再次使用 ExpectString 验证输出结果；7. 延迟关闭 expect 实例以释放资源；同时需要注意缓冲、换行符、路径以及并发测试等问题以确保测试准确性和稳定性。

在写 CLI 工具时，测试交互流程是个让人头疼的问题。因为这类程序往往依赖用户的输入、命令行参数甚至多次交互才能完成任务。Golang 虽然没有内置的模拟终端机制，但借助 github.com/google/expect 这个库，我们可以很方便地模拟用户输入行为，实现对 CLI 交互流程的自动化测试。

安装 expect 库

首先需要引入 expect 包，它最初是为 Go 的测试用例设计的，支持与子进程通信并模拟输入输出。安装方式如下：

go get github.com/google/expect

这个包依赖 golang.org/x/crypto/ssh/terminal，所以确保你的开发环境能正常下载这些依赖。

编写一个简单的 CLI 程序作为测试对象

为了演示方便，我们先写一个非常基础的 CLI 程序：它会提示用户输入名字，并输出欢迎语句。

// cli.go
package main

import (
    "bufio"
    "fmt"
    "os"
)

func main() {
    reader := bufio.NewReader(os.Stdin)
    fmt.Print("请输入你的名字: ")
    name, _ := reader.ReadString('\n')
    fmt.Printf("你好, %s\n", name)
}

保存为 cli.go，然后构建成可执行文件，比如 mycli。

使用 expect 测试交互流程

接下来我们写一个测试文件来验证这个 CLI 是否正确处理了用户输入。

// cli_test.go
package main

import (
    "os/exec"
    "runtime"
    "testing"
    "time"

    "github.com/google/expect"
)

func TestCLIInteraction(t *testing.T) {
    // 构建要运行的命令
    binPath := "./mycli"
    if runtime.GOOS == "windows" {
        binPath += ".exe"
    }

    // 启动子进程
    cmd := exec.Command(binPath)
    exp, err := expect.NewExpect(cmd, time.Second)
    if err != nil {
        t.Fatal(err)
    }
    defer exp.Close()

    // 匹配提示信息
    _, err = exp.ExpectString("请输入你的名字: ")
    if err != nil {
        t.Errorf("未匹配到提示语: %v", err)
    }

    // 模拟用户输入
    err = exp.SendLine("Tom")
    if err != nil {
        t.Errorf("发送输入失败: %v", err)
    }

    // 验证输出结果
    _, err = exp.ExpectString("你好, Tom")
    if err != nil {
        t.Errorf("未匹配到预期输出: %v", err)
    }
}

关键点说明：

• 启动子进程：使用 exec.Command 创建目标程序的进程。
• 创建 expect 实例：传入命令和超时时间，用于控制后续的交互。
• ExpectString：等待特定字符串出现，可以是提示语或输出内容。
• SendLine：模拟用户输入一行文本（自动加上换行符）。
• Close：延迟关闭实例，释放资源。

注意：expect 默认有超时机制，如果你的程序执行较慢，可能需要适当调高超时时间。

常见问题与调试技巧

在实际使用中可能会遇到以下几种情况：

• ✅ 找不到提示语：可能是输出被缓冲了。尝试在 CLI 中加 fflush(stdout) 或者使用 fmt.Fprint(os.Stdout, ...) 替代 Println。
• ✅ SendLine 不生效：确认是否遗漏了换行符，或者输入后是否还需要按回车。可以用 SendLine() 自动带换行。
• ✅ Windows 上路径问题：注意构建后的可执行文件路径是否正确，特别是扩展名 .exe。
• ✅ 并发测试冲突：多个测试函数同时运行可能导致端口或资源占用冲突，建议给每个测试单独命名二进制文件。

基本上就这些。用 expect 来测试 CLI 交互流程虽然不是最直观的方式，但在 Golang 生态中已经算是比较成熟且实用的方案了。只要注意匹配时机和输出刷新逻辑，大多数场景都能覆盖。