如何在 Golang 代码中测试 filepath.Abs​​ 失败？

Question

在我的 Go 代码中，我必须多次使用 filepath.Abs​​()，这可能会导致我的方法返回不同的错误。

func (s *service) myFunc(path string) error {
    dir := s.Component().Dir()
    absDir, err := filepath.Abs(dir)

    if err != nil {
        return my_errors.NewFailedToGetAbsoluteComponentDir()
    }

    absPath, err := filepath.Abs(path)
    if absPath != nil {
        return my_errors.NewFailedToGetAbsPath()
    }

    // more code...
    return nil
}

在我的单元测试中，我想测试它，但我能想到的唯一方法是将 filepath.Abs​​ 作为依赖项注入到我的结构中。

还有其他我没想到的办法吗？或者你认为这种测试没有必要？

Answer 1

如果我们查看filepath.Abs标准库中该函数的源代码，我们可以看到它何时返回错误，然后尝试在我们的测试中触发该条件。 filepath.Abs根据编译目标操作系统的不同，有不同的实现，但Unix 实现如下所示：

func unixAbs(path string) (string, error) {
    if IsAbs(path) {
        return Clean(path), nil
    }
    wd, err := os.Getwd()
    if err != nil {
        return "", err
    }
    return Join(wd, path), nil
}

所以它唯一会返回错误的时候就是os.Getwd()返回错误的时候。使os.Getwd()return 错误的一个简单方法是确保当前工作目录不存在。这可以在测试中完成，如下所示：

func unixAbs(path string) (string, error) {
    if IsAbs(path) {
        return Clean(path), nil
    }
    wd, err := os.Getwd()
    if err != nil {
        return "", err
    }
    return Join(wd, path), nil
}

现在存在的问题是它更改了整个过程的工作目录，这可能会干扰其他测试。因此，在此测试运行后重置工作目录并确保没有其他依赖于该工作目录的测试同时运行非常重要。

要重置它，请将其放在测试开始时：

    dir, _ := os.MkdirTemp("", "") // Create a temporary directory
    os.Chdir(dir)                  // Change to that directory
    os.RemoveAll(dir)              // Delete that directory
    fmt.Println(os.Getwd())        // This will now return an error

为了确保没有其他冲突的测试同时运行，请不要调用t.Parallel()您的测试。

值得测试这个吗？通常不会。您的工作目录多久可能无效？在大多数情况下，永远不会。如果这描述了您，我根本不会测试您的这部分代码。

然而，如果您正在构建一个 CLI 工具，例如，工作目录不断变化或经常未知，那么这样的测试可能确实值得。

在付出如此多的努力之前，请确保您的测试提供了一些实际价值:)

我制作了一个讨论这个问题的视频，以及任何有兴趣对该主题进行更长时间讨论的人的一般问题： 回答 StackOverflow：如何在 Go 中测试 filepath.Abs​​？