当前位置: 首页 > 科技观察

如何使用Python进行单元测试

时间:2023-03-16 22:02:43 科技观察

在本文中,我将通过讨论以下主题来研究如何使用Python创建单元测试。单元测试基础可用的Python测试框架测试设计原则代码覆盖率单元测试基础我使用FizzBu??zz编码风格创建了示例单元测试。编码类型是程序员的练习。在这个练习中,程序员试图解决一个特定的问题。但主要目标不是解决问题,而是练习编程。FizzBu??z是一种简单的代码类型,非常适合在Python中解释和演示单元测试。单元测试单元测试是由程序员编写的自动化测试,用于测试程序的一小部分。单元测试应该运行得很快。与文件系统、数据库或网络交互的测试不是单元测试。为了在Python中创建我的第一个FizzBu??zz单元测试,我定义了一个继承自unittest.TestCase的类。unittest模块在Python的标准安装中可用。importunittestclassFizzBu??zzTest(unittest.TestCase):deftest_one_should_return_one(self):fizzbuzz=FizzBu??zz()result=fizzbuzz.filter(1)self.assertEqual('1',result)deftest_two_should_return_two(self):fizzbuzz=fil.res=filzz(2)self.assertEqual('2',result)第一个测试用例验证数字1是否通过FizzBu??zz过滤器,它将返回字符串'1'。使用self来验证结果。断言相等方法。该方法的第一个参数是预期结果,第二个参数是实际结果。测试用例我们调用测试用例FizzBu??zzTest类中的test_one_should_return_one()方法。测试用例是测试程序特定部分的实际测试代码。第一个测试用例验证数字1是否通过了FizzBu??zz过滤器,该过滤器返回字符串“1”。使用self来验证结果。断言相等方法。该方法的第一个参数是预期结果,第二个参数是实际结果。如果查看这两个测试用例,您会发现它们都创建了FizzBu??zz类的实例。第一个在第6行,另一个在第11行。我们可以通过重构这两个方法创建FizzBu??zz实例来改进代码。importunittestclassFizzBu??zzTest(unittest.TestCase):defsetUp(self):self.fizzbuzz=FizzBu??zz()deftearDown(self):passdeftest_one_should_return_one(self):result=self.fizzbuzz.filter(1)self.assertEqual('1',result)defldtest_return_two(self):result=self.fizzbuzz.filter(2)self.assertEqual('2',result)我们使用setUp方法创建FizzBu??zz类的一个实例。TestCase基类的设置在每个测试用例之前执行。另一个方法tearDown在每次单元测试执行后调用。您可以使用它来清理或关闭资源。测试夹具方法的设置和拆卸是测试夹具的一部分。测试夹具用于配置和构建被测单元。每个测试用例都可以使用这些通用条件。在这个例子中,我用它来创建FizzBu??zz类的一个实例。要运行单元测试,我们需要一个测试运行器。测试运行器测试运行器是执行所有单元测试并报告结果的程序。Python的标准测试运行器可以使用以下命令在终端上运行。python-munittesttest_fizzbuzz.py测试套件单元测试词汇表中的最后一个术语是测试套件。测试套件是测试用例或测试套件的集合。通常一个测试套件包含应该一起运行的测试用例。单元测试设计测试用例应该设计得很好。考试的题目和结构是最重要的。测试用例名称测试的名称非常重要。它就像一个总结考试内容的标题。如果测试失败,这是您看到的第一件事。因此,名称应该清楚地表明哪些功能不起作用。测试用例名称列表应该读起来像摘要或场景列表。这有助于读者理解被测单元的行为。构建测试用例方法体一个设计良好的测试用例由三部分组成。第一部分,对测试对象进行整理设置。第二部分Act练习被测单元。最后,第三部分,即断言,对应该发生的事情做出断言。有时我在单元测试中将这三个部分添加为注释以使其更清楚。importunittestclassFizzBu??zzTest(unittest.TestCase):deftest_one_should_return_one(self):#Arrangefizzbuzz=FizzBu??zz()#Actresult=fizzbuzz.filter(1)#Assertself.assertEqual('1',result)每个测试用例的单个断言尽管在测试用例中中可能有很多断言。我总是尝试使用单个断言。原因是,当断言失败时,测试用例的执行就会停止。所以你永远不知道你的测试用例中的下一个断言是否会成功。使用pytest进行单元测试在上一节中,我们使用了unittest模块。Python的默认安装会安装此模块。unittest模块于2001年首次推出。它基于JUnit,这是由KentBeck和EricGamma开发的流行的Java单元测试框架。另一个模块pytest是目前最流行的Python单元测试框架。它比unittest框架更pythonic。您可以将测试用例定义为函数,而不是从基类派生。因为pytest不在默认的Python安装中,所以我们使用Python的包安装程序PIP来安装它。可以通过在终端中执行以下命令来安装pytest。pipinstallpytest下面我将第一个FizzBu??zz测试用例转换为pytest。deftest_one_should_return_one():fizzbuzz=FizzBu??zz()result=fizzbuzz.filter(1)assert'1'==result有3处不同。首先,您不需要导入任何模块。其次,您不需要实现类并从基类派生。最后,您可以使用标准的Python断言方法而不是自定义方法。测试夹具您还记得,单元测试模块使用setUp和tearDown来配置和构建被测单元。相反,pytest使用@pytest.fixture属性。在您的测试用例中,您可以使用用此属性装饰的方法的名称作为参数。pytest框架在运行时将它们连接起来,并将fizzBu??zz实例注入到测试用例中。@pytest.fixturedeffizzBu??zz():returnFizzBu??zz()deftest_one_should_return_one(fizzBu??zz):result=fizzBu??zz.filter(1)assertresult=='1'deftest_two_should_return_two(fizzBu??zz):result=fizzBu??zz.filter(2)assertresult=='来模拟行为单元测试的tearDown()方法,可以用同样的方法实现。不使用return,而是使用yield关键字。然后你可以把清理代码放在yield之后。@pytest.fixturedefizzBu??zz():yieldFizzBu??zz()#putyourcleanupcodeherepytestmarks标记是测试各种功能时可以使用的属性。例如,如果您向测试用例添加跳过标记,测试运行器将跳过测试。@pytest.mark.skip(reason="WIP")deftest_three_should_return_fizz(fizzBu??zz):result=fizzBu??zz.filter(3)assertresult=='Fizz'pytest插件生态系统pytest有许多添加额外功能的插件。截至我撰写本文时,已有近900个插件。例如,pytest-html和pytest-sugar。pytest-htmlpytest-html是pytest的一个插件,可以为测试结果生成HTML报告。当您在构建服务器上运行单元测试时,这很有用。pytest-sugarpytest-sugar改变了pytest的默认外观。它添加了一个进度条并立即显示失败的测试。创建代码覆盖率报告有一些工具可以创建代码覆盖率报告。此代码覆盖率报告显示您的单元测试执行了哪些代码。我使用Coverage和pytest-cov来创建代码覆盖率报告。Coverage是一个用于衡量代码覆盖率的通用包。模块pytest-cov是pytest连接Coverage的插件。两者都可以使用pip安装。pipinstallcoveragepipinstallpytest-cov安装这两个命令后,您可以使用这两个命令生成覆盖率报告。在终端或命令行中运行它们。coveragerun-mpytestcoveragehtml首先生成覆盖率数据。第二个命令将数据转换为HTML报告。Coverage将报告存储在文件系统的htmlcov文件夹中。如果您在浏览器中打开index.html,它将显示每个文件的覆盖范围概览。如果您选择一个文件,它会显示下面的屏幕。覆盖率向源代码添加指示,显示单元测试覆盖了哪些行。下面我们看到我们的单元测试没有覆盖第12和16行。BranchcoveragemetricsCoverage也支持分支覆盖指标。使用分支覆盖,如果您的程序中有一行跳转到多于下一行,则覆盖会跟踪是否访问了这些目的地。您可以通过执行以下命令来创建具有分支覆盖率的覆盖率报告。pytest--cov-reporthtml:htmlcov--cov-branch--cov=alarm我指示pytest生成带有分支覆盖率的HTML覆盖率报告。它应该将结果存储在htmlcov中。我没有为所有文件生成覆盖率报告,而是告诉覆盖率只使用alarm.py。