模拟使用bufio.Scanner进行输入

在进行单元测试时，模拟文件系统输入是一个常见需求。文章介绍了如何使用 mockfile 和 mockfilesystem 来模拟 bufio.Scanner 输入。该解决方案解决了将读取器实例移出 readfunc 的问题，有效地模拟了文件系统的行为。通过提供具体实现和接口，文章展示了如何使用 os 包模拟文件系统。文章还强调了在模拟中使用 ioutil.nopcloser() 和 strings.newreader() 的技巧。

我在测试过程中定义接口和替换模拟方面取得了很多成功，但我在模拟 bufio.scanner 输入时遇到了问题：

file := &mockfile{
    readfunc: func(p []byte) (int, error) {
        reader := bufio.newreader(bytes.newreader([]byte(consulpropertiesfile)))
        return reader.read(p)
    },
    closefunc: func() error {
        return nil
    },
}

fs := &mockfilesystem{
    openfunc: func(name string) (file, error) {
        return file, nil
    },
}

properties, err := readconsulpropertiesfile(fs)

虽然这似乎有效，但一旦扫描仪到达字符串的末尾，它似乎就返回到开头，并且读取了太多内容（这次似乎读取了超过一行）。就像我需要在 readfunc 中的适当时间手动返回 eof 错误，但我不确定如何确定何时应该这样做......

扫描仪代码（从此处提取）：

f, err := file.open("/run/secrets/consul-web4.properties")
if err != nil {
    return nil, err
}
defer f.close()

properties := map[string]string{}

scanner := bufio.newscanner(f)
for scanner.scan() {
    line := scanner.text()
    if equal := strings.index(line, "="); equal >= 0 {
        if key := strings.trimspace(line[:equal]); len(key) > 0 {
            value := ""
            if len(line) > equal {
                value = strings.trimspace(line[equal+1:])
            }
            properties[key] = value
        }
    }
}

我还没有重构上面的内容......

我在测试字符串上尝试了以下变体：

const input = `key=value
key=value
key=value
`

const input = "key=value\nkey=value\nkey=value\n"

我尝试过 bufio.reader 和 io.reader 实现。

感谢任何帮助/见解！

解决方案

感谢@adrian：

我在回家的路上意识到这可能是由于每次调用该方法时都会实例化一个新的阅读器。将读取器实例移出我的 readfunc 效果非常好！

感谢 @thundercat 提供的 strings.newreader() 提示，更新的代码：

reader := ioutil.nopcloser(strings.newreader(consulpropertiesfile))

file := &mockfile{
    readfunc: func(p []byte) (int, error) {
        return reader.read(p)
    },
    closefunc: func() error {
        return nil
    },
}

对于任何看到这篇文章寻找有关如何模拟文件系统等信息的人：

用于打开和统计文件的接口，以及使用 os 包的具体实现：

// filesystem - interface to the filesystem
type filesystem interface {
    open(name string) (file, error)
    stat(name string) (os.fileinfo, error)
}

// osfs - filesystem backed by default os package
type osfs struct {
}

// open - open a file
func (o *osfs) open(name string) (file, error) {
    return os.open(name)
}

// stat - get file status
func (o *osfs) stat(name string) (os.fileinfo, error) {
    return os.stat(name)
}

上面提到的文件接口：

// file - file interface
type file interface {
    io.closer
    io.reader
    io.readerat
    io.seeker
    stat() (os.fileinfo, error)
}

模拟您希望文件系统返回的文件（实现您的代码将使用的方法）：

type mockfile struct {
    closefunc  func() error
    readfunc   func(p []byte) (int, error)
    readatfunc func(p []byte, off int64) (int, error)
    seekfunc   func(offset int64, whence int) (int64, error)
    statfunc   func() (os.fileinfo, error)
}

func (m *mockfile) close() error {
    return m.closefunc()
}

func (m *mockfile) read(p []byte) (int, error) {
    return m.readfunc(p)
}

func (m *mockfile) readat(p []byte, off int64) (int, error) {
    return m.readatfunc(p, off)
}

func (m *mockfile) seek(offset int64, whence int) (int64, error) {
    return m.seekfunc(offset, whence)
}

func (m *mockfile) stat() (os.fileinfo, error) {
    return m.statfunc()
}

---

reader := ioutil.nopcloser(strings.newreader("some string, replace with bytes etc"))

file := &mockfile{
    readfunc: func(p []byte) (int, error) {
        return reader.read(p)
    },
    closefunc: func() error {
        return nil
    },
}

并通过mockfilesystem返回你的mockfile：

fs := &mockFileSystem{
    OpenFunc: func(name string) (File, error) {
        return file, nil
    },
}

今天关于《模拟使用bufio.Scanner进行输入》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！