如何让Go项目测试适配外部工具tree-sitter-cli的安装状态？

问题背景 #

我正在开发一个Go项目，核心功能是实现文件与Git分支间的语义差异对比（semantic diff），同时同步为功能编写测试。最新功能的行为依赖于外部工具tree-sitter-cli是否安装，以及它是否具备对应语言的语法支持能力。

不管外部工具（或其可选语法包）是否存在，只要我的工具sdt能返回对应预期结果，就视为正常工作。比如我有一个测试用例，原本用来验证非tree-sitter分析的语言的语义等价性：

func TestNoSemanticDiff(t *testing.T) {
    // Narrow the options to these test files
    opts := options
    opts.Source = file0.name
    opts.Destination = file1.name

    report := treesitter.Diff("", opts, config)

    if !strings.Contains(report, "| No semantic differences detected") {
        t.Fatalf("Failed to recognize semantic equivalence of %s and %s",
            opts.Source, opts.Destination)
    }
}

现在各支持语言的测试逻辑基本一致，但需要根据外部工具的状态判断预期结果：

• 如果tree-sitter-cli未安装，预期收到| No available semantic analyzer for this format
• 如果工具已安装但无对应语言支持，也预期上述提示
• 如果工具正常且有语言支持，预期收到| No semantic differences detected

我希望只在测试文件开头执行一次外部工具状态检测，而不是在每个测试用例中重复逻辑，理想的测试结构是：

if !treeSitterInstalled { // 测试文件开头仅检查一次
    if !strings.Contains(report, "appropriate response") { ... }
} else if treeSitterNoLangSupport { // 同样仅初始化一次
    if !strings.Contains(report, "this other thing") { ... }
} else {
    if !strings.Contains(report, "the stuff where it's installed") { ... }
}

实现方案 #

1. 定义全局变量存储检测结果 #

在测试文件的包级别定义全局变量，用来保存一次性检测后的状态：

package yourpackage

import (
    "os/exec"
    "testing"
    "os"
)

var (
    treeSitterInstalled     bool
    treeSitterHasLangSupport bool
)

2. 用TestMain执行初始化检测 #

Go测试框架提供的TestMain函数会在所有测试用例执行前运行，正好用来做一次性的外部工具检测：

func TestMain(m *testing.M) {
    // 检测tree-sitter-cli是否已安装
    _, err := exec.LookPath("tree-sitter")
    treeSitterInstalled = err == nil

    // 如果已安装，进一步检测是否支持目标语言（示例以Go语言为例）
    if treeSitterInstalled {
        // 这里的检测逻辑可以根据你的需求调整，比如检测语法包是否存在
        cmd := exec.Command("tree-sitter", "parse", "--lang=go", "/dev/null")
        err := cmd.Run()
        treeSitterHasLangSupport = err == nil
    }

    // 执行所有测试用例并返回结果
    os.Exit(m.Run())
}

3. 在测试用例中复用检测结果 #

现在可以在各个测试用例中直接使用全局变量的结果，不用重复执行检测逻辑：

func TestNoSemanticDiff(t *testing.T) {
    opts := options
    opts.Source = file0.name
    opts.Destination = file1.name

    report := treesitter.Diff("", opts, config)

    switch {
    case !treeSitterInstalled || !treeSitterHasLangSupport:
        if !strings.Contains(report, "| No available semantic analyzer for this format") {
            t.Fatalf("Expected missing analyzer message, got: %s", report)
        }
    default:
        if !strings.Contains(report, "| No semantic differences detected") {
            t.Fatalf("Failed to recognize semantic equivalence of %s and %s", opts.Source, opts.Destination)
        }
    }
}

4. 可选：封装断言逻辑减少重复 #

如果有大量同类型测试用例，可以把断言逻辑封装成辅助函数，进一步简化代码：

func assertExpectedReport(t *testing.T, report string) {
    t.Helper() // 标记为辅助函数，让测试错误指向调用处而非函数内部
    switch {
    case !treeSitterInstalled || !treeSitterHasLangSupport:
        if !strings.Contains(report, "| No available semantic analyzer for this format") {
            t.Fatalf("Expected missing analyzer message, got: %s", report)
        }
    default:
        if !strings.Contains(report, "| No semantic differences detected") {
            t.Fatalf("Expected no semantic diff message, got: %s", report)
        }
    }
}

// 测试用例中直接调用辅助函数
func TestNoSemanticDiff(t *testing.T) {
    opts := options
    opts.Source = file0.name
    opts.Destination = file1.name

    report := treesitter.Diff("", opts, config)
    assertExpectedReport(t, report)
}

内容的提问来源于stack exchange，提问作者David Mertz