测试 filepath.walk 函数的使用方法

本文介绍了测试 filepath.walk 函数的两种方法。第一种方法使用依赖注入，将函数修改为接受 fs.fs 实现。第二种方法修改 getpdffiles() 函数，使其接受与 path.walkdir() 具有相同签名的目录遍历器函数。通过使用模拟文件系统或空目录，可以编写测试来测试错误处理和文件收集。

我有一个函数，可以获取目录中的所有 pdf 文件并返回文件（如果有）。

func getpdffiles(path string) ([]string, error) {
var files []string
err := filepath.walk(path, func(path string, info fs.fileinfo, err error) error {
    if strings.hassuffix(path, ".pdf") {
        files = append(files, path)
    }
    return nil
})
if err != nil {
    return nil, err
}
if files == nil {
    return nil, errors.new("no pdffiles found.")
}
return files, nil
}

我的测试函数从 filepath.walk 函数中获取错误：nil，该函数需要一个返回错误的匿名函数，但它应该从 if 语句中获取错误，就像第二个测试用例没有文件的情况一样应该返回errors.new(“未找到pdff​​iles。”)。 我怎样才能正确测试它。

func TestGetPdfFiles(t *testing.T) {
type args struct {
    path string
}

cwd, err := os.Getwd()
if err != nil {
    log.Fatal(err)
}

tests := []struct {
    name    string
    args    args
    want    []string
    wantErr bool
}{
    {name: "2PdfFiles", args: args{path: fmt.Sprintf("%s/testData/", cwd)}, want: []string{fmt.Sprintf("%s/testData/test-1.pdf", cwd), fmt.Sprintf("%s/testData/test-2.pdf", cwd)}, wantErr: false},
    {name: "noPdfFiles", args: args{path: fmt.Sprintf("%s", cwd)}, want: nil, wantErr: true},
}
for _, tt := range tests {
    t.Run(tt.name, func(t *testing.T) {
        got, err := GetPdfFiles(tt.args.path)
        if (err != nil) != tt.wantErr {
            t.Errorf("GetPdfFiles() error = %v, wantErr %v", err, tt.wantErr)
            return
        }
        if !reflect.DeepEqual(got, tt.want) {
            t.Errorf("GetPdfFiles() got = %v, want %v", got, tt.want)
        }
    })
}
}

正确答案

您使用 dependency injection，并修改您的函数以接受 fs.fs 的实现。这让您的测试可以将模拟文件系统传递给它。

• https://bitfieldconsulting.com/golang/filesystems

• https://www.gopherguides.com/articles/golang-1.16-io-fs-improve-test-performance

或者，对于您的用例来说可能更简单，修改您的 getpdffiles() 以接受与 path.walkdir() 具有相同签名的目录遍历器函数：

package main

import (
  "io/fs"
  "path"
  "path/filepath"
  "strings"
)

func getpdffiles(root string) ([]string, error) {
  return getpdffileswithwalker(root, filepath.walkdir)
}

type directorywalker = func(string, fs.walkdirfunc) error

func getpdffileswithwalker(root string, walk directorywalker) (fns []string, err error) {
  
  collectpdffiles := func(fn string, info fs.direntry, err error) error {
    if ext := strings.tolower(path.ext(fn)); ext == ".pdf" {
      fns = append(fns, fn)
    }
    return nil
  }
  
  err = walk(root, collectpdffiles)
  
  return fns, err
}

现在，您的 getpdffiles() 是一个不执行任何操作的包装器，它注入默认实现（来自 path/filepath），核心位于 getpdffileswithwalker() 中，您可以根据它编写测试，并传入合适的模拟。

您甚至可以构建一个将返回错误的模拟，以便您可以测试您的错误处理。

您的模拟目录遍历器可以像这样简单（特别是因为您只使用传递给回调的 path：

func mockdirectorywalker(root string, visit fs.walkdirfunc) (err error) {
  paths := [][]string{
    {root, "a"},
    {root, "a", "a.pdf"},
    {root, "a", "b.txt"},
    {root,"a", "b"},
    {root, "a", "b", "c.pdf"},
    {root, "a", "b", "d.txt"},
  }
  for _, p := range paths {
    fqn := path.join(p...)
    var di fs.direntry
    visit(fqn, di, nil)
  }

  return err
}

每次使用 T.TempDir() 作为唯一的空目录怎么样？这将保证结果的可重复性。测试包还将负责清理：

func TestGetPdfFiles(t *testing.T) {
    type args struct {
        path string
    }

    tests := []struct {
        name    string
        args    args
        want    []string
        wantErr bool
    }{
        {name: "noPdfFiles", args: args{path: t.TempDir()}, want: nil, wantErr: true},
    }
    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            got, err := GetPdfFiles(tt.args.path)
            if (err != nil) != tt.wantErr {
                t.Errorf("GetPdfFiles() error = %v, wantErr %v", err, tt.wantErr)
                return
            }
            if !reflect.DeepEqual(got, tt.want) {
                t.Errorf("GetPdfFiles() got = %v, want %v", got, tt.want)
            }
        })
    }
}

以上就是《测试 filepath.walk 函数的使用方法》的详细内容，更多关于的资料请关注golang学习网公众号！