python - 如何测试需要文件存在的方法？

Question

我是第一次使用Python创建一个库，我想借此机会在这个项目中学习单元测试。我已经写了第一个方法，我想为它写一些单元测试。 (是的，我知道 TDD 要求我先编写测试，我会到达那里，真的。)

该方法相当简单，但它希望该类有一个 file 属性集，该属性指向一个现有文件，并且该文件是某种存档(目前仅使用 zip 文件、tar、rar 等，稍后添加)。该方法应该返回存档中的文件数。

我在我的项目中创建了一个名为 files 的文件夹，其中包含一些示例文件，并且我已经手动测试了该方法，到目前为止它可以正常工作。手动测试如下所示，位于 archive_file.py 文件中:

if __name__ == '__main__':
    archive = ArchiveFile()

    script_path = path.realpath(__file__)
    parent_dir = path.abspath(path.join(script_path, os.pardir))
    targ_dir = path.join(parent_dir, 'files')
    targ_file = path.join(targ_dir, 'test.zip' )

    archive.file = targ_file

    print(archive.file_count())

然后我所做的就是确保打印的内容符合我对 test.zip 内容的预期。

这是 file_count 的样子:

def file_count(self):
    """Return the number of files in the archive."""
    if self.file == None:
        return -1

    with ZipFile(self.file) as zip:
        members = zip.namelist()
        # Remove folder members if there are any.
        pruned = [item for item in members if not item.endswith('/')]
        return len(pruned)

出于某些原因，将其直接转换为单元测试对我来说似乎是错误的，其中一些可能是无效的。我指望测试文件相对于当前脚本文件的精确位置，我需要大量手动创建的存档文件样本以确保我正在测试足够多的变体，当然，我手动将返回值与我的预期进行比较，因为我知道测试存档中有多少文件。

在我看来，似乎这应该尽可能自动化，但似乎这样做会非常复杂。

为此类类方法创建单元测试的正确方法是什么？

Answer 1

有很多不同的方法可以解决这个问题。我喜欢思考什么对测试有值(value)，在我的脑海中，我可以想到几件事:

• 验证逻辑(if self.file == None)
• 修剪逻辑
• 声称支持的所有文件类型实际上都受支持

此测试可以在两个级别上进行:

1. 单元测试你的逻辑
2. 测试集成(即针对文件系统支持的归档类型)

单元测试逻辑

对存档对象的逻辑进行单元测试应该是微不足道的。您的 file_count 方法中似乎有一些有值(value)的测试:

• test_no_file_returns_negative_one(错误条件“​​希望”不是经常执行的代码路径，并且是测试的理想候选者。特别是如果您的客户期望此 -1 返回值。

• test_zip_file_pruned_logic 这在您的代码中看起来是非常重要的功能，如果实现不当，它将完全打乱您的代码声称能够返回的计数

• test_happy_path_file_count_successful 我喜欢使用模拟依赖项 ZipFile 来执行整个函数的单元测试，以确保涵盖所有内容，而无需运行集成测试。

测试集成

我认为对每种支持的存档类型进行测试将非常有值(value)。这些可能是存在于您的存储库中的静态固定装置，并且您的测试已经知道每个存档有多少文件并将断言。

我认为您的所有担忧都是有道理的，并且可以以可维护的方式解决和测试所有这些问题:

我指望测试文件相对于当前脚本文件的精确位置

这可以通过将文件装置存储在测试包的子目录中，然后使用 python 获取测试包的文件路径的惯例来解决:

FIXTURE_DIR = os.path.join(os.path.dirname(__file__), 'fixtures')

对于可移植代码，动态生成这些路径很重要。

我需要大量手动创建的存档文件样本，以确保我正在测试足够多的变体

是的，有多少是足够好的？至少对每个支持的存档类型进行测试。 (netflix 必须针对他们拥有应用程序的每一台设备进行测试 :)，许多公司必须针对大型移动设备矩阵进行测试)我认为这里的测试覆盖率至关重要，但请尝试将所有边缘情况放在一起需要包含在单元测试中。

我手动将返回值与预期值进行比较，因为我知道测试存档中有多少文件。

存档必须变为静态，您的测试将存储该信息。

---

要记住的一件事是测试的范围。进行练习 ZipFile 的测试不会很有值(value)，因为它在 stdlibrary 中并且已经有测试。此外，测试您的代码是否适用于所有 python 文件系统/操作系统可能也不是很有值(value)，因为 python 已经进行了这些检查。

但是，我认为，确定您的测试范围以验证您的应用程序是否适用于它声称支持的所有文件类型是非常有值(value)的，因为它是您和您的客户之间的契约(Contract)，说“嘿，这确实有效，让我给你看”。就像 python 的测试是它和你说“嘿，我们支持 OSX/LINUX/不管我给你看什么”之间的契约一样