如何使用Python進(jìn)行單元測(cè)試
在本文中，我將通過(guò)討論以下主題來(lái)研究如何使用Python創(chuàng)建單元測(cè)試。
- 單元測(cè)試基礎(chǔ)
- 可用的Python測(cè)試框架
- 測(cè)試設(shè)計(jì)原則
- 代碼覆蓋率
單元測(cè)試基礎(chǔ)
我使用FizzBuzz編碼方式創(chuàng)建了單元測(cè)試示例。編碼類型是程序員的練習(xí)。在這個(gè)練習(xí)中，程序員試圖解決一個(gè)特定的問(wèn)題。但主要目標(biāo)不是解決問(wèn)題，而是練習(xí)編程。FizzBuz是一個(gè)簡(jiǎn)單的代碼類型，非常適合解釋和展示Python中的單元測(cè)試。
單元測(cè)試
單元測(cè)試是程序員為測(cè)試程序的一小部分而編寫(xiě)的自動(dòng)化測(cè)試。單元測(cè)試應(yīng)該運(yùn)行得很快。與文件系統(tǒng)、數(shù)據(jù)庫(kù)或網(wǎng)絡(luò)交互的測(cè)試不是單元測(cè)試。
為了在Python中創(chuàng)建第一個(gè)FizzBuzz單元測(cè)試，我定義了一個(gè)繼承自u(píng)nittest.TestCase的類。這個(gè)unittest模塊可以在Python的標(biāo)準(zhǔn)安裝中獲得。
- import unittest
- class FizzBuzzTest(unittest.TestCase):
- def test_one_should_return_one(self):
- fizzbuzz = FizzBuzz()
- result = fizzbuzz.filter(1)
- self.assertEqual('1', result)
- def test_two_should_return_two(self):
- fizzbuzz = FizzBuzz()
- result = fizzbuzz.filter(2)
- self.assertEqual('2', result)
第一個(gè)測(cè)試用例驗(yàn)證數(shù)字1是否通過(guò)了FizzBuzz過(guò)濾器，它將返回字符串' 1 '。使用self驗(yàn)證結(jié)果。assertEqual方法。方法的第一個(gè)參數(shù)是預(yù)期的結(jié)果，第二個(gè)參數(shù)是實(shí)際的結(jié)果。
測(cè)試用例
我們?cè)跍y(cè)試用例FizzBuzzTest類中調(diào)用test_one_should_return_one()方法。測(cè)試用例是測(cè)試程序特定部分的實(shí)際測(cè)試代碼。
第一個(gè)測(cè)試用例驗(yàn)證數(shù)字1是否通過(guò)了FizzBuzz過(guò)濾器，它將返回字符串' 1 '。使用self驗(yàn)證結(jié)果。assertEqual方法。方法的第一個(gè)參數(shù)是預(yù)期的結(jié)果，第二個(gè)參數(shù)是實(shí)際的結(jié)果。
如果您查看這兩個(gè)測(cè)試用例，您會(huì)看到它們都創(chuàng)建了FizzBuzz類的一個(gè)實(shí)例。第一個(gè)在第6行，另一個(gè)在第11行。
我們可以從這兩個(gè)方法中重構(gòu)FizzBuzz實(shí)例的創(chuàng)建，從而改進(jìn)代碼。
- import unittest
- class FizzBuzzTest(unittest.TestCase):
- def setUp(self):
- self.fizzbuzz = FizzBuzz()
- def tearDown(self):
- pass
- def test_one_should_return_one(self):
- result = self.fizzbuzz.filter(1)
- self.assertEqual('1', result)
- def test_two_should_return_two(self):
- result = self.fizzbuzz.filter(2)
- self.assertEqual('2', result)
我們使用setUp方法創(chuàng)建FizzBuzz類的實(shí)例。TestCase基類的設(shè)置在每個(gè)測(cè)試用例之前執(zhí)行。
另一個(gè)方法tearDown是在每個(gè)單元測(cè)試執(zhí)行之后調(diào)用的。你可以用它來(lái)清理或關(guān)閉資源。
測(cè)試夾具
方法的設(shè)置和拆卸是測(cè)試夾具的一部分。測(cè)試夾具用于配置和構(gòu)建被測(cè)試單元。每個(gè)測(cè)試用例都可以使用這些通用條件。在本例中，我使用它創(chuàng)建FizzBuzz類的實(shí)例。
要運(yùn)行單元測(cè)試，我們需要一個(gè)測(cè)試運(yùn)行器。
測(cè)試運(yùn)行器
測(cè)試運(yùn)行程序是執(zhí)行所有單元測(cè)試并報(bào)告結(jié)果的程序。Python的標(biāo)準(zhǔn)測(cè)試運(yùn)行器可以使用以下命令在終端上運(yùn)行。
python -m unittest test_fizzbuzz.py
測(cè)試套件
單元測(cè)試詞匯表的最后一個(gè)術(shù)語(yǔ)是測(cè)試套件。測(cè)試套件是測(cè)試用例或測(cè)試套件的集合。通常一個(gè)測(cè)試套件包含應(yīng)該一起運(yùn)行的測(cè)試用例。
單元測(cè)試設(shè)計(jì)
測(cè)試用例應(yīng)該被很好地設(shè)計(jì)。考試的名稱和結(jié)構(gòu)是最重要的。
測(cè)試用例名稱
測(cè)試的名稱非常重要。它就像一個(gè)總結(jié)考試內(nèi)容的標(biāo)題。如果測(cè)試失敗，你首先看到的就是它。因此，名稱應(yīng)該清楚地表明哪些功能不起作用。
測(cè)試用例名稱的列表應(yīng)該讀起來(lái)像摘要或場(chǎng)景列表。這有助于讀者理解被測(cè)單元的行為。
構(gòu)造測(cè)試用例方法體
一個(gè)設(shè)計(jì)良好的測(cè)試用例由三部分組成。第一部分，安排、設(shè)置要測(cè)試的對(duì)象。第二部分，Act，練習(xí)被測(cè)單元。最后，第三部分，斷言，對(duì)應(yīng)該發(fā)生的事情提出主張。
有時(shí)，我在單元測(cè)試中添加這三個(gè)部分作為注釋，以使其更清楚。
- import unittest
- class FizzBuzzTest(unittest.TestCase):
- def test_one_should_return_one(self):
- # Arrange
- fizzbuzz = FizzBuzz()
- # Act
- result = fizzbuzz.filter(1)
- # Assert
- self.assertEqual('1', result)
每個(gè)測(cè)試用例的單個(gè)斷言
盡管在一個(gè)測(cè)試用例中可能有很多斷言。我總是嘗試使用單個(gè)斷言。
原因是，當(dāng)斷言失敗時(shí)，測(cè)試用例的執(zhí)行就會(huì)停止。因此，您永遠(yuǎn)不會(huì)知道測(cè)試用例中的下一個(gè)斷言是否成功。
使用pytest進(jìn)行單元測(cè)試
在上一節(jié)中，我們使用了unittest模塊。Python的默認(rèn)安裝安裝這個(gè)模塊。unittest模塊于2001年首次引入。基于Kent Beck和Eric Gamma開(kāi)發(fā)的流行的Java單元測(cè)試框架JUnit。
另一個(gè)模塊pytest是目前最流行的Python單元測(cè)試框架。與unittest框架相比，它更具有python風(fēng)格。您可以將測(cè)試用例定義為函數(shù)，而不是從基類派生。
因?yàn)閜ytest不在默認(rèn)的Python安裝中，所以我們使用Python的包安裝程序PIP來(lái)安裝它。通過(guò)在終端中執(zhí)行以下命令，可以安裝pytest。
pip install pytest
下面我將第一個(gè)FizzBuzz測(cè)試用例轉(zhuǎn)換為pytest。
- def test_one_should_return_one():
- fizzbuzz = FizzBuzz()
- result = fizzbuzz.filter(1)
- assert '1' == result
有三個(gè)不同點(diǎn)。首先，您不需要導(dǎo)入任何模塊。其次，您不需要實(shí)現(xiàn)一個(gè)類并從基類派生。最后，您可以使用標(biāo)準(zhǔn)的Python assert方法來(lái)代替自定義的方法。
測(cè)試裝置
您還記得，單元測(cè)試模塊使用setUp和tearDown來(lái)配置和構(gòu)建測(cè)試中的單元。相反，pytest使用@pytest.fixture屬性。在您的測(cè)試用例中，您可以使用用該屬性裝飾的方法的名稱作為參數(shù)。
pytest框架在運(yùn)行時(shí)將它們連接起來(lái)，并將fizzBuzz實(shí)例注入測(cè)試用例中。
- @pytest.fixture
- def fizzBuzz():
- return FizzBuzz()
- def test_one_should_return_one(fizzBuzz):
- result = fizzBuzz.filter(1)
- assert result == '1'
- def test_two_should_return_two(fizzBuzz):
- result = fizzBuzz.filter(2)
- assert result == '2'
如果您想要模擬單元測(cè)試tearDown()方法的行為，可以使用相同的方法來(lái)實(shí)現(xiàn)。不使用return，而是使用yield關(guān)鍵字。然后，您可以將清理代碼放在yield之后。
- @pytest.fixture
- def fizzBuzz():
- yield FizzBuzz()
- # put your clean up code here
pytest標(biāo)記
標(biāo)記是可以在測(cè)試各種函數(shù)時(shí)使用的屬性。例如，如果您將跳過(guò)標(biāo)記添加到您的測(cè)試用例中，測(cè)試運(yùn)行器將跳過(guò)測(cè)試。
- @pytest.mark.skip(reason="WIP")
- def test_three_should_return_fizz(fizzBuzz):
- result = fizzBuzz.filter(3)
- assert result == 'Fizz'
pytest插件生態(tài)系統(tǒng)
pytest有很多插件可以添加額外的功能。到我寫(xiě)這篇文章的時(shí)候，已經(jīng)有將近900個(gè)插件了。例如，pytest-html和pytest-sugar。
pytest-html
pytest- HTML是pytest的插件，它為測(cè)試結(jié)果生成HTML報(bào)告。當(dāng)您在構(gòu)建服務(wù)器上運(yùn)行單元測(cè)試時(shí)，這非常有用。
pytest-sugar
pytest-sugar改變pytest的默認(rèn)外觀和感覺(jué)。它會(huì)添加一個(gè)進(jìn)度條，并立即顯示失敗的測(cè)試。
創(chuàng)建代碼覆蓋率報(bào)告
有一些工具可以創(chuàng)建代碼覆蓋率報(bào)告。這個(gè)代碼覆蓋率報(bào)告顯示了您的單元測(cè)試執(zhí)行了哪些代碼。
我使用Coverage和pytest-cov來(lái)創(chuàng)建代碼覆蓋率報(bào)告。覆蓋率是度量代碼覆蓋率的通用包。模塊pytest-cov是pytest的一個(gè)插件，用于連接到Coverage。
都可以使用pip安裝。
- pip install coverage
- pip install pytest-cov
在您安裝了這兩個(gè)命令之后，您可以使用這兩個(gè)命令生成覆蓋率報(bào)告。在終端或命令中運(yùn)行它們。
- coverage run -m pytest
- coverage html
第一個(gè)生成覆蓋率數(shù)據(jù)。第二個(gè)命令將數(shù)據(jù)轉(zhuǎn)換為HTML報(bào)告。Coverage將報(bào)告存儲(chǔ)在文件系統(tǒng)的htmlcov文件夾中。
如果你在瀏覽器中打開(kāi)index.html，它會(huì)顯示每個(gè)文件覆蓋率的概覽。
如果您選擇一個(gè)文件，它將顯示下面的屏幕。覆蓋率向源代碼添加了一個(gè)指示，顯示單元測(cè)試覆蓋了哪一行。
下面我們看到我們的單元測(cè)試并沒(méi)有涵蓋第12行和第16行。
分支覆蓋度量
覆蓋率還支持分支覆蓋率度量。有了分支覆蓋率，如果您的程序中有一行可以跳轉(zhuǎn)到下一行以上，覆蓋率跟蹤是否訪問(wèn)了這些目的地。
您可以通過(guò)執(zhí)行以下命令來(lái)創(chuàng)建帶有分支覆蓋率的覆蓋率報(bào)告。
- pytest——cov-report html:htmlcov——cov-branch——cov=alarm
我指示pytest生成一個(gè)帶有分支覆蓋的HTML覆蓋報(bào)告。它應(yīng)該將結(jié)果存儲(chǔ)在htmlcov中。而不是為所有文件生成覆蓋率報(bào)告，我告訴覆蓋率只使用alarm.py。
