用于模拟目录和生成测试文件的 Python 单元测试用例

Question

我们可以在 python 单元测试用例中模拟测试目录和几个文件吗？

扫描.py:

import re
from pathlib import Path

class Scan():


    def scan_files(self, dir_path, filter_regex=None):
        for item in Path(dir_path).iterdir():
            if not item.is_symlink():
                if item.is_dir():
                    for child_item in self.scan_files(item, filter_regex=filter_regex):
                        yield child_item
                else:
                    if filter_regex is None:
                        yield item
                    elif filter_regex:
                        if re.match(filter_regex, item.name, re.IGNORECASE):
                            yield item
                    else:
                        pass

测试扫描.py:

import unittest
from mock import patch
from scan import Scan


class TestScan(unittest.TestCase):
    def setUp(self) -> None:
        """Unit Test default 
        """
        pass

    def instantiate_scan_class(self):
        scan = Scan()

        return scan

    def test_scan_files(self):
        dir_path = "/my/test/path"
        
        # Create the UploadWatchService object
        scan = self.instantiate_scan_class()

        result = scan.scan_files(dir_path=dir_path)
        for item in result:
            print(item)




if __name__ == '__main__':
    unittest.main()

我像下面一样跑步

python3 -m unittest discover

我收到以下错误：

======================================================================
ERROR: test_scan_files (test_scan.TestScan)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/vcimalap/code/watchservice/src/main/test_scan.py", line 24, in test_scan_files
    for item in result:
  File "/Users/vcimalap/code/watchservice/src/main/scan.py", line 12, in scan_files
    for item in Path(dir_path).iterdir():
  File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/pathlib.py", line 1160, in iterdir
    for name in self._accessor.listdir(self):
FileNotFoundError: [Errno 2] No such file or directory: '/my/test/path'

有人可以帮我模拟以下项目，以便我可以实施单元测试或帮助我对 scan.py 进行任何示例单元测试

 1. mocking directory path
 2. Generating few test files
 3. mocking item.is_symlink()
 4. mocking item.is_dir()

一种方法是我们可以使用 path.object，我猜这是为了设置方法调用输出。

Answer 1

生成测试目录和空文件

只需使用tempfile（来自标准库）。

import tempfile

tempfile.TemporaryDirectory().name  
# output: '/tmp/tmpr6ugakay'

由于这些是文件操作，我不建议您模拟这些东西。相反，使用 tempfile 创建临时目录（和文件），这些临时目录（和文件）将在系统重启时刷新（或根据对应的系统策略）。

类似于tempfile.TemporaryDirectory，还有一个tempfile.NamedTemporaryFile。

tempfile.NamedTemporaryFile(prefix="my_temp_file", suffix=".txt").name  
# output: '/tmp/my_temp_file8aq0dsoo.txt'

生成带有虚假内容的测试文件

要为您的文件生成虚假内容，您可以使用Faker。

Faker安装

pip install faker

Faker用法

导入和初始化

import tempfile
from pathlib import Path

from faker import Faker

FAKER = Faker()

创建一个包含虚假内容的 TXT 文件

file = Path(tempfile.NamedTemporaryFile(suffix=".txt").name)
file.write_text(FAKER.text())

创建一个包含虚假内容的 PNG 文件

file = Path(tempfile.NamedTemporaryFile(suffix=".png").name)
file.write_bytes(FAKER.image())

创建一个包含虚假内容的 ZIP 文件

file = Path(tempfile.NamedTemporaryFile(suffix=".zip").name)
file.write_bytes(FAKER.zip())

查看faker docs了解更多。

您还可以使用faker-file，它允许您更好地控制生成的内容，支持更多文件类型（DOCX、PDF 等）和远程存储（例如 AWS S3、Azure 云存储和谷歌云存储） .

faker-file安装

pip install faker-file[all]

faker-file用法

导入和初始化

from faker import Faker

from faker_file.providers.docx_file import DocxFileProvider
from faker_file.providers.pdf_file import PdfFileProvider
from faker_file.providers.txt_file import TxtFileProvider
from faker_file.providers.zip_file import ZipFileProvider
# many more formats supported, check the docs

from faker_file.providers.helpers.inner import create_inner_docx_file

FAKER = Faker()
FAKER.add_provider(DocxFileProvider)
FAKER.add_provider(PdfFileProvider)
FAKER.add_provider(TxtFileProvider)
FAKER.add_provider(ZipFileProvider)

使用随机生成的虚假内容创建一个 TXT 文件

file = FAKER.txt_file()

使用提供的内容创建一个 TXT 文件

file = FAKER.txt_file(content="Lorem ipsum dolor sit amet")

使用随机生成的虚假内容创建 PDF 文件

file = FAKER.pdf_file()

使用提供的内容创建 PDF 文件

file = FAKER.pdf_file(content="Lorem ipsum dolor sit amet")

使用随机生成的虚假内容创建 DOCX 文件

file = FAKER.docx_file()

使用提供的内容创建 DOCX 文件

file = FAKER.docx_file(content="Lorem ipsum dolor sit amet")

创建一个 ZIP 文件，其中包含 3 个 DOCX 文件，其中包含随机生成的虚假内容

file = FAKER.zip_file(
    options={
        "count": 3,
        "create_inner_file_func": create_inner_docx_file,
        "create_inner_file_args": {
            "max_nb_chars": 1_024,
        },
    }
)

使用提供的内容创建一个包含 1 个 DOCX 文件的 ZIP 文件

file = FAKER.zip_file(
    options={
        "count": 1,
        "create_inner_file_func": create_inner_docx_file,
        "create_inner_file_args": {
            "content": "Lorem ipsum dolor sit amet",
        },
    }
)

查看faker-file docs了解更多。