如何Mock embed.FS？Go语言模块测试中的依赖替换方案咨询

问题场景 #

你有如下代码结构：
a.go模块：

//go:embed *.txt
var textFiles embed.FS

func DoSomething() fs.FS {
    fmt.Println(textFiles)
    return textFiles
}

另一个模块中调用该函数：

func OtherF() {
    DoSomething()
}

需要测试OtherF，但textFiles是私有包级变量，无法直接修改，该如何Mock？

解决方案 #

方法1：重构代码实现依赖注入（推荐） #

这是最符合Go设计理念的方案，通过重构让DoSomething依赖外部传入的fs.FS，而非硬编码包级变量：

// 修改a.go，新增带参数的版本，兼容原有调用
func DoSomething(fs fs.FS) fs.FS {
    fmt.Println(fs)
    return fs
}

// 保留原有函数，使用默认的textFiles作为参数
func DoSomethingWithDefault() fs.FS {
    return DoSomething(textFiles)
}

之后修改OtherF的调用逻辑，改为传入fs.FS实例：

func OtherF(fs fs.FS) {
    DoSomething(fs)
}

测试时直接传入Mock的文件系统（比如用memfs这类内存文件库）：

func TestOtherF(t *testing.T) {
    // 创建Mock文件系统并添加测试文件
    mockFS := memfs.New()
    if err := mockFS.MkdirAll("", 0755); err != nil {
        t.Fatal(err)
    }
    if err := mockFS.CreateFile("test.txt", []byte("mock content")); err != nil {
        t.Fatal(err)
    }

    // 调用待测试函数
    OtherF(mockFS)

    // 这里添加你的验证逻辑
}

如果不想修改OtherF的签名，也可以在a.go中新增一个可配置的包级变量，测试时替换：

// a.go中新增
var defaultFS = textFiles

func DoSomething() fs.FS {
    fmt.Println(defaultFS)
    return defaultFS
}

测试时可将defaultFS设为导出变量（大写开头）直接赋值，或用反射修改私有版本。

方法2：用反射修改私有包级变量（不推荐） #

如果无法重构代码，可以用Go的反射机制绕过私有访问限制，修改textFiles的值，但这种方法依赖Go内部实现，版本更新可能失效：

func TestOtherF(t *testing.T) {
    // 创建Mock文件系统
    mockFS := memfs.New()
    if err := mockFS.CreateFile("test.txt", []byte("mock content")); err != nil {
        t.Fatal(err)
    }

    // 通过反射获取私有变量并修改
    funcVal := reflect.ValueOf(DoSomething)
    pkgScope, ok := funcVal.Type().PkgScope()
    if !ok {
        t.Fatal("无法获取包作用域")
    }
    textFilesVar := pkgScope.FieldByName("textFiles")
    if !textFilesVar.IsValid() {
        t.Fatal("找不到textFiles变量")
    }
    // 绕过私有检查设置值
    textFilesVar.Set(reflect.ValueOf(mockFS))

    // 调用待测试函数
    OtherF()
}

注意：这种方法破坏了封装性，仅作为临时方案使用。

方法3：通过Build Tag替换实现 #

使用Go的构建标签，在测试时替换DoSomething的实现：

1. 给原有a.go添加构建标签：

//go:build !testmock
// +build !testmock

package yourpackage

import (
    "embed"
    "fmt"
    "io/fs"
)

//go:embed *.txt
var textFiles embed.FS

func DoSomething() fs.FS {
    fmt.Println(textFiles)
    return textFiles
}

2. 创建a_mock.go，添加testmock构建标签：

//go:build testmock
// +build testmock

package yourpackage

import (
    "fmt"
    "io/fs"
    "github.com/hanwen/go-fuse/v2/fs/memfs"
)

func DoSomething() fs.FS {
    mockFS := memfs.New()
    if err := mockFS.CreateFile("test.txt", []byte("mock content")); err != nil {
        panic(err)
    }
    fmt.Println(mockFS)
    return mockFS
}

3. 运行测试时指定标签：

go test -tags testmock ./...

这种方法无需修改原有业务代码，适合无法重构的场景。

内容的提问来源于stack exchange，提问作者Paweł Lis