一、介绍
在软件开发中,单元测试是一种测试方法,它用于查看单个软件组件(例如函数或办法)的正确性。Python 提供了一个内置的单元测试库,名为 unittest
,能够用来编写测试代码,而后运行测试,并报告测试后果。
本文将向你介绍如何应用 unittest
来编写和运行单元测试。通过浏览本文,你将理解 unittest
的根本应用办法,以及如何应用 unittest
中的断言办法和测试用例组织构造。
二、根底概念和办法
在 unittest
中,每个测试用例都是 unittest.TestCase
的一个实例,而测试用例的汇合就是一个测试套件。你能够通过实现 unittest.TestCase
的子类来定义你的测试用例,而后通过实例化这个子类的对象来创立具体的测试用例。
这是一个简略的示例,演示了如何定义和应用测试用例:
import unittest
class TestStringMethods(unittest.TestCase):
def test_upper(self):
self.assertEqual('foo'.upper(), 'FOO')
def test_isupper(self):
self.assertTrue('FOO'.isupper())
self.assertFalse('Foo'.isupper())
def test_split(self):
s = 'hello world'
self.assertEqual(s.split(), ['hello', 'world'])
# check that s.split fails when the separator is not a string
with self.assertRaises(TypeError):
s.split(2)
if __name__ == '__main__':
unittest.main()
在上述代码中,咱们定义了一个 TestStringMethods
类,这个类继承自 unittest.TestCase
。在这个类中,咱们定义了三个办法:test_upper
、test_isupper
和 test_split
。这三个办法就是咱们的三个测试用例。
unittest.TestCase
类提供了许多断言办法,例如 assertEqual(a, b)
、assertTrue(x)
和 assertFalse(x)
。这些断言办法用来查看咱们的代码是否满足预期的行为。
三、运行测试和查看测试后果
当咱们定义好测试用例后,就能够运行这些测试用例,并查看测试后果了。你能够通过执行 unittest.main()
来运行所有的测试用例。
在上述代码的最初,咱们调用了 unittest.main()
。这个函数会搜寻以后模块中所有 unittest.TestCase
的子类,而后运行这些子类中的所有以 test
结尾的办法。
当咱们运行这段代码时,unittest
将会输入一个测试报告,显示每个测试用例的运行后果。例如,如果所有测试用例都通过了,你会看到如下的输入:
....
----------------------------------------------------------------------
Ran 4 tests in 0.001s
OK
四、应用测试加载器和测试运行器
测试加载器用于搜寻和加载测试,而测试运行器则负责执行这些测试并报告后果。Python 的 unittest 库为咱们提供了默认的测试加载器和测试运行器,然而,你也能够自定义它们以满足非凡的需要。
上面是一个示例,演示了如何应用 unittest.TestLoader
来加载测试:
import unittest
class TestStringMethods(unittest.TestCase):
# ... 后面的内容 ...
def suite():
suite = unittest.TestSuite()
loader = unittest.TestLoader()
suite.addTest(loader.loadTestsFromTestCase(TestStringMethods))
return suite
if __name__ == '__main__':
runner = unittest.TextTestRunner()
runner.run(suite())
在这个例子中,咱们首先创立了一个 unittest.TestLoader
实例。而后,咱们调用了 loadTestsFromTestCase
办法,这个办法会加载 TestStringMethods
类中定义的所有测试。而后,咱们将这些测试增加到了测试套件中。
至于测试运行器,unittest
提供了 unittest.TextTestRunner
类作为默认的测试运行器。这个类的实例会在管制台上输入一个文本报告。如果你想自定义测试运行器,你能够通过继承 unittest.TestRunner
类来实现。
五、测试套件
测试套件是测试用例或测试套件的汇合。它用于指定 unittest
所需执行的测试。通过创立本人的测试套件,你能够准确管制 unittest
执行哪些测试。以下是一个创立测试套件并增加测试用例的例子:
import unittest
class TestStringMethods(unittest.TestCase):
# ... 与前文雷同 ...
def suite():
suite = unittest.TestSuite()
suite.addTest(TestStringMethods('test_upper'))
suite.addTest(TestStringMethods('test_isupper'))
return suite
if __name__ == '__main__':
runner = unittest.TextTestRunner()
runner.run(suite())
在这个例子中,咱们创立了一个 suite
函数,这个函数创立一个 unittest.TestSuite
实例,而后向这个实例增加测试用例。在 main
局部,咱们创立了一个 unittest.TextTestRunner
实例,而后调用它的 run
办法来运行测试套件。
六、setUp 和 tearDown 办法
除了用于测试的办法外,unittest.TestCase
还提供了两个非凡的办法:setUp
和 tearDown
。这两个办法在每个测试方法之前和之后运行,能够用于筹备测试环境和清理资源。
上面是一个应用 setUp
和 tearDown
的例子:
import unittest
class TestDatabaseMethods(unittest.TestCase):
def setUp(self):
self.conn = create_database_connection()
self.cur = self.conn.cursor()
def tearDown(self):
self.cur.close()
self.conn.close()
def test_insert(self):
self.cur.execute("INSERT INTO employees VALUES (1,'John')")
self.cur.execute("SELECT * FROM employees")
result = self.cur.fetchone()
self.assertEqual(result, (1, 'John'))
if __name__ == '__main__':
unittest.main()
在这个例子中,咱们在 setUp
办法中创立了数据库连贯和游标,在 tearDown
办法中敞开了它们。这样,咱们就能够确保每个测试方法都在洁净的数据库环境中运行。
七、unittest.mock:模仿对象和行为
在某些状况下,你可能想要替换测试中的一些对象,或者模仿特定的行为。unittest.mock
模块提供了一个 Mock
类和许多其余工具,能够帮忙你实现这一点。
上面是一个应用 unittest.mock
的例子:
from unittest import TestCase, mock
from my_module import MyObject
class TestMyObject(TestCase):
@mock.patch('my_module.MyObject')
def test_my_method(self, MockMyObject):
obj = MockMyObject()
obj.my_method.return_value = 42
assert obj.my_method() == 42
obj.my_method.assert_called_once()
在这个例子中,咱们应用了 unittest.mock.patch
装璜器来替换 MyObject
类。而后,咱们能够管制这个代替对象的行为,例如设置它的办法返回什么值,或者查看它的办法是否被正确调用。
总的来说,Python 的 unittest
框架为咱们提供了弱小而灵便的工具来进行单元测试。这只是 unittest
的冰山一角,它还有更多的性能期待你去发现和利用。