如何使用python unittest对函数进行单元测试

Question

我有一个Python函数,可以将输出文件写入磁盘.

我想使用Python unittest模块为它编写单元测试.

我该如何断言文件的相等性？如果文件内容与预期的一个+差异列表不同,我想得到一个错误.与unix diff命令的输出一样.

有没有官方/推荐的方式呢？

Answer 1

我更喜欢让输出函数显式接受文件句柄(或类文件对象),而不是接受文件名并自己打开文件.这样,我可以StringIO在单元测试中将对象传递给输出函数,然后.read()从该StringIO对象传回内容(在.seek(0)调用之后)并与我的预期输出进行比较.

例如,我们将转换这样的代码

##File:lamb.py
import sys


def write_lamb(outfile_path):
    with open(outfile_path, 'w') as outfile:
        outfile.write("Mary had a little lamb.\n")


if __name__ == '__main__':
    write_lamb(sys.argv[1])



##File test_lamb.py
import unittest
import tempfile

import lamb


class LambTests(unittest.TestCase):
    def test_lamb_output(self):
        outfile_path = tempfile.mkstemp()[1]
        try:
            lamb.write_lamb(outfile_path)
            contents = open(tempfile_path).read()
        finally:
            # NOTE: To retain the tempfile if the test fails, remove
            # the try-finally clauses
            os.remove(outfile_path)
        self.assertEqual(result, "Mary had a little lamb.\n")

像这样的代码

##File:lamb.py
import sys


def write_lamb(outfile):
    outfile.write("Mary had a little lamb.\n")


if __name__ == '__main__':
    with open(sys.argv[1], 'w') as outfile:
        write_lamb(outfile)



##File test_lamb.py
import unittest
from io import StringIO

import lamb


class LambTests(unittest.TestCase):
    def test_lamb_output(self):
        outfile = StringIO()
        # NOTE: Alternatively, for Python 2.6+, you can use
        # tempfile.SpooledTemporaryFile, e.g.,
        #outfile = tempfile.SpooledTemporaryFile(10 ** 9)
        lamb.write_lamb(outfile)
        outfile.seek(0)
        content = outfile.read()
        self.assertEqual(content, "Mary had a little lamb.\n")

这种方法还有一个额外的好处,例如,如果您决定不想写入文件,而是某些其他缓冲区,则可以使输出函数更加灵活,因为它将接受所有类似文件的对象.

请注意,使用StringIO假定测试输出的内容可以适合主存储器.对于非常大的输出,您可以使用临时文件方法(例如,tempfile.SpooledTemporaryFile).

Answer 2

最简单的方法是编写输出文件,然后读取其内容,读取gold(预期)文件的内容,并将它们与简单的字符串相等进行比较.如果它们相同,请删除输出文件.如果它们不同,请提出断言.

这样,当测试完成后,每个失败的测试都将用输出文件表示,你可以使用第三方工具将它们与黄金文件区分开来(Beyond Compare非常适合这个).

如果你真的想提供自己的diff输出,请记住Python stdlib有difflib模块.Python 3.1中新的unittest支持包括一个assertMultiLineEqual使用它来显示差异的方法,类似于:

    def assertMultiLineEqual(self, first, second, msg=None):
        """Assert that two multi-line strings are equal.

        If they aren't, show a nice diff.

        """
        self.assertTrue(isinstance(first, str),
                'First argument is not a string')
        self.assertTrue(isinstance(second, str),
                'Second argument is not a string')

        if first != second:
            message = ''.join(difflib.ndiff(first.splitlines(True),
                                                second.splitlines(True)))
            if msg:
                message += " : " + msg
            self.fail("Multi-line strings are unequal:\n" + message)

Answer 3

我总是尽量避免将文件写入磁盘，即使它是一个专用于我的测试的临时文件夹：实际上不接触磁盘会使您的测试更快，尤其是当您在代码中与文件进行大量交互时。

假设您在名为 的文件中有这个“惊人”的软件main.py：

"""
main.py
"""

def write_to_file(text):
    with open("output.txt", "w") as h:
        h.write(text)

if __name__ == "__main__":
    write_to_file("Every great dream begins with a dreamer.")

要测试该write_to_file方法，您可以在名为 的同一文件夹中的文件中编写如下内容test_main.py：

"""
test_main.py
"""
from unittest.mock import patch, mock_open

import main


def test_do_stuff_with_file():
    open_mock = mock_open()
    with patch("main.open", open_mock, create=True):
        main.write_to_file("test-data")

    open_mock.assert_called_with("output.txt", "w")
    open_mock.return_value.write.assert_called_once_with("test-data")

Answer 4

import filecmp

然后

self.assertTrue(filecmp.cmp(path1, path2))