测试删除目录的最佳实践是什么？

在编写单元测试时，删除文件或目录时，使用真实的文件系统进行测试可能不可行。因此，推荐使用模拟或虚拟化文件系统的方法。这些方法可以通过覆盖函数来替换文件系统调用，或创建临时文件来进行测试。本文介绍了三种不同的方法：使用全局变量覆盖函数、使用接口和存根目录，以及使用第三方库进行全面虚拟化。最后，还提供了一个使用第三方库进行模拟的示例代码。

我正在制作一个 cli，它更多地用于学习目的并创建我自己的 cli，它可以做一些事情。无论如何，我正在测试 delete 函数，它工作正常并给了我正确的答案。但是，我不认为这是最佳实践，并且想知道您是否可以让我知道这是否可以。

测试文件

func testdeleteconfig(t *testing.t) {
    err := cm.deleteconfig()
    if err != nil {
        t.errorf("error when deleting the folder: %s", err)
    }

    usr, err := user.current()
    if err != nil {
        t.errorf("error when getting user current: %s", err)
    }

    fp := filepath.join(usr.homedir, ".config", "godot", "config.json")
    fmt.println("the path of the config file", fp)

    if _, e := os.stat(fp); !os.isnotexist(e) {
        t.errorf("error path still exists: %v", e)
    }
}

正在测试的功能

func DeleteConfig() error {

    usr, err := user.Current()
    if err != nil {
        return err
    }

    err = os.RemoveAll(filepath.Join(usr.HomeDir, ".config", "godot"))
    if err != nil {
        return err
    }

    return nil
}

问题是我不希望 deleteconfig() 接受任何参数，因为这是一条困难路径。我有一个单独的函数用于删除单个文件，其中的帮助也可以解决该问题 func deletefile(p string) 错误 {}。

因此，出于测试目的，我是否应该在单独的路径（在测试内）创建一个 foo 目录，删除该目录，并假设如果它在 foo 路径上工作，那么它应该与 godot 目录一起工作？

解决方案

这有点哲学。

如果您绝对不想存根/模拟代码的任何部分来代替访问真实的文件系统来进行测试，那么我们正在讨论您所说的系统或集成测试。这本身就很好：例如，您可以在一次性容器中作为 ci 管道的一部分运行此类测试。

但是使用这种方法，您无法明智地进行所谓的单元测试。

要对您的函数进行单元测试，您需要将其使用的东西替换为“虚拟化”的东西。究竟如何做到这一点是一个悬而未决的问题。

方法：make可以覆盖os.removeall

例如，您可以有一个包含“删除整个目录”功能的私有全局变量，如下所示：

var removeall = os.removeall

func deleteconfig() error {

    usr, err := user.current()
    if err != nil {
        return err
    }

    err = removeall(filepath.join(usr.homedir, ".config", "godot"))
    if err != nil {
        return err
    }

    return nil
}

然后，为了测试它，您只需使用自己的实现对函数进行猴子修补，该实现将具有与 os.removeall 相同的签名，如下所示：

func testdeleteconfig(t *testing.t) {
  var actualpath string

  removeall = func(path string) {
    actualpath = path
    return nil
  }
  defer func() { removeall = os.removeall }()

  deleteconfig()

  if actualpath != expectedpath {
    t.errorf("unexpected path: want %s, got %s", expectedpath, actualpath)
  }
}

这种方法还允许测试您的函数如何处理错误：只需将其替换为生成错误的内容，然后检查您的测试下的函数是否返回该错误（或以预期的方式包装它，无论如何）。 p>

尽管如此，由于多种原因，它的技术含量有点低：

• 涉及全局变量，因此您必须确保没有两个测试同时运行猴子补丁，或者所有补丁都在运行这些测试之前完成。
• 如果不同的测试需要将其设置为不同的值，则必须将它们序列化。

方法：不要硬编码“用户”或“配置”的概念

另一种方法是注意，测试的问题基本上源于您对用户进行硬编码的事实。

抛开您获取配置位置所采取的有缺陷的方法（您应该使用 something which implements the XDG spec），如果您可以轻松覆盖“根”目录（这是代码中用户的主目录）的获取，您可以轻松地将函数定位为对调用 io/ioutil.TempDir 的结果进行操作。

因此，可能的一种方法是拥有一个像这样的接口类型

type configstore interface {
  dir() string
}

其中 dir() 方法应该返回配置存储根目录的路径。

然后，您的 deleteconfig() 将开始接受 configstore 类型的单个参数，并且在您的程序中，您将拥有它的具体实现，并且在您的测试代码中 - 一个实现相同接口并管理临时的存根目录。

方法：全面虚拟化

目前，一项工作正在 bringing filesystem virtualization right into the Go standard library 上完成，但虽然还没有，但这样做的第 3 方软件包已经存在很长时间了，例如 github.com/spf13/afero。

基本上，它们允许您不直接使用 os ，而是以某种方式编写所有代码，以便它调用实现特定接口的类型实例上的方法，而不是 os 包：在生产代码中，该对象是一个瘦的os 包的垫片，在测试代码中它被替换为您想要的任何内容； afero 有一个现成的内存中 fs 后端 to do this。

为文件系统检查编写单元测试并非易事。您不应该在系统上创建真实的文件，因为这样您的测试将取决于文件系统本身的 i/o。最后的手段是模拟文件系统。有很多强大的库，例如 spf13/afero 用于此目的（模拟文件系统）。这些包将在后台创建临时文件并随后进行清理。

main.go

package main

import (
    "log"
    "os/user"
    "path/filepath"

    iowrap "github.com/spf13/afero"
)

var (
    // fs is simulated filesystem interface
    fs iowrap.fs
    // fsutil is the struct of the simulated interface
    fsutil *iowrap.afero
)

func init() {
    fs = iowrap.newosfs()
    fsutil = &iowrap.afero{fs: fs}
}

// deleteconfig removes ~/.config/godot if exists
func deleteconfig() error {

    usr, err := user.current()
    if err != nil {
        return err
    }

    path := filepath.join(usr.homedir, ".config", "godot")
    log.println(path)
    err = fsutil.removeall(path)
    return err
}

func main() {
    err := deleteconfig()
    if err != nil {
        log.fatal(err)
    }
}

main_test.go

package main

import (
    "os/user"
    "path/filepath"
    "testing"

    iowrap "github.com/spf13/afero"
)

func init() {
    fs = iowrap.newmemmapfs()
    fsutil = &iowrap.afero{fs: fs}

    usr, _ := user.current()
    pathdir := filepath.join(usr.homedir, ".config")
    filepath := filepath.join(pathdir, "godot")
    fs.mkdirall(pathdir, 0755)
    iowrap.writefile(fs, filepath, []byte("0-7\n"), 0644)
}

const (
    succeed = "\u2713"
    failed  = "\u2717"
)

func testdeleteconfig(t *testing.t) {
    t.log("given the need to test downloading a webpage content")
    {
        usr, _ := user.current()
        pathdir := filepath.join(usr.homedir, ".config")
        filepath := filepath.join(pathdir, "godot")
        t.logf("\ttest 0:\twhen deleting the %v with 0644 permissions", filepath)
        {
            err := deleteconfig()
            if err != nil {
                t.fatalf("\t%s\tthe file couldn't be deleted: %v", failed, err)
            }
            t.logf("\t%s\tthe file has been successfully deleted.", succeed)
        }
    }
}

功能测试：

touch c:/users/drpan/.config/godot
ls -l c:/users/drpan/.config/godot     output: -rw-r--r-- 1 drpan 197609 0 nov  2 19:38 c:/users/drpan/.config/godot
./deletedirectory.exe
 ls -l c:/users/drpan/.config/godot     output: ls: cannot access 'c:/users/drpan/.config/godot': no such file or directory

单元测试：

$ touch C:/Users/drpan/.config/godot
$ go test
2020/11/02 19:55:35 C:\Users\drpan\.config\godot
PASS
ok      github.com/drpaneas/deletedirectory     0.162s

$ ls -l C:/Users/drpan/.config/godot            Output: -rw-r--r-- 1 drpan 197609 0 Nov  2 19:55 C:/Users/drpan/.config/godot

今天关于《测试删除目录的最佳实践是什么？》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！