python單元測試指南，並結成pytest

本文探討軟件測試的意義以及為何你應該重視它。我們將學習如何設計單元測試以及如何編寫 Python 單元測試。特別是，我們將探討 Python 中兩個最常用的單元測試框架：unittest 和 pytest。

關鍵要點

• 單元測試是軟件開發中至關重要的環節，它允許開發人員測試程序的特定組件或單元，以確保它們按預期運行。 Python 中流行的單元測試框架包括 unittest 和 pytest。
• 設計良好的單元測試應該快速、獨立、可重複、可靠且命名恰當。 “準備、執行、斷言 (AAA)”模式通常用於組織單元測試，將設置、執行和驗證分開。
• unittest 框架是 Python 標準庫的一部分，其靈感來自 Java 的單元測試框架 JUnit。它使用特殊的斷言方法，並要求將測試編寫為繼承自 unittest.TestCase 類的類的方法。
• pytest 框架允許使用更少的代碼進行複雜的測試，支持 unittest 測試套件，並提供超過 800 個外部插件。與 unittest 不同，pytest 使用普通的 Python 斷言方法，使其更簡單、更直觀。
• 儘管單元測試有很多優點，但必須記住，測試只能證明缺陷的存在，而不能證明缺陷的缺失。即使所有測試都通過，也不能證明軟件系統沒有錯誤。

軟件測試簡介

軟件測試是檢查軟件產品行為以評估和驗證其是否符合規範的過程。軟件產品可能包含數千行代碼和數百個協同工作的組件。如果一行代碼無法正常工作，則錯誤可能會傳播並導致其他錯誤。因此，為了確保程序按預期運行，必須對其進行測試。

由於現代軟件可能相當複雜，因此存在多個級別的測試來評估正確性的不同方面。根據 ISTQB 認證測試基礎級別教學大綱，軟件測試有四個級別：

1. 單元測試：測試特定的代碼行
2. 集成測試：測試多個單元之間的集成
3. 系統測試：測試整個系統
4. 驗收測試：檢查是否符合業務目標

本文將討論單元測試，但在深入探討之前，我想介紹軟件測試中一個重要的原則。

測試只能證明缺陷的存在，而不能證明缺陷的缺失。

— ISTQB CTFL 教學大綱 2018

換句話說，即使你運行的所有測試都沒有顯示任何失敗，也不能證明你的軟件系統沒有錯誤，或者另一個測試用例不會發現你軟件行為中的缺陷。

什麼是單元測試？

這是第一個測試級別，也稱為組件測試。在此部分中，對單個軟件組件進行測試。根據編程語言的不同，軟件單元可能是類、函數或方法。例如，如果你有一個名為 ArithmeticOperations 的 Java 類，其中包含 multiply 和 divide 方法，則 ArithmeticOperations 類的單元測試需要測試 multiply 和 divide 方法的正確行為。

單元測試通常由軟件測試人員執行。要運行單元測試，軟件測試人員（或開發人員）需要訪問源代碼，因為源代碼本身就是被測試的對象。因此，這種直接測試源代碼的軟件測試方法稱為白盒測試。

你可能想知道為什麼你應該擔心軟件測試，以及它是否值得。在下一節中，我們將分析測試軟件系統背後的動機。

為什麼你應該進行單元測試

軟件測試的主要優點是它提高了軟件質量。軟件質量至關重要，尤其是在軟件處理我們日常活動中各種各樣的世界中。提高軟件質量仍然是一個過於模糊的目標。讓我們嘗試更好地說明我們所說的軟件質量。根據 ISO/IEC 標準 9126-1 ISO 9126，軟件質量包括以下因素：

• 可靠性
• 功能性
• 效率
• 可用性
• 可維護性
• 可移植性

如果你擁有一家公司，那麼你應該仔細考慮軟件測試活動，因為它會影響你的業務。例如，2022 年 5 月，特斯拉召回了 130,000 輛汽車，原因是車輛信息娛樂系統出現問題。然後通過“空中”分發的軟件更新解決了這個問題。這些故障給公司造成了時間和金錢損失，也給客戶帶來了問題，因為他們有一段時間無法使用他們的汽車。測試軟件確實需要花錢，但公司也可以節省數百萬的技術支持費用。

單元測試側重於檢查軟件是否正確運行，這意味著檢查輸入和輸出之間的映射是否都正確完成。作為低級別測試活動，單元測試有助於儘早識別錯誤，從而不會將其傳播到軟件系統的更高級別。

單元測試的其他優點包括：

• 簡化集成：通過確保所有組件都能單獨正常工作，更容易解決集成問題。
• 最大限度地減少代碼回歸：通過大量的測試用例，如果將來對源代碼進行一些修改會導致問題，則更容易找到問題。
• 提供文檔：通過測試輸入和輸出之間的正確映射，單元測試提供了有關被測試方法或類的使用方法的文檔。

設計測試策略

現在讓我們看看如何設計測試策略。

測試範圍的定義

在開始規劃測試策略之前，有一個重要的問題需要回答。你想測試軟件系統的哪些部分？

這是一個關鍵問題，因為窮舉測試是不可能的。因此，你無法測試所有可能的輸入和輸出，但你應該根據所涉及的風險對測試進行優先級排序。

在定義測試範圍時，需要考慮許多因素：

• 風險：如果錯誤影響此組件，會產生什麼業務後果？
• 時間：你希望軟件產品多久準備好？你有沒有最後期限？
• 預算：你願意投資多少資金用於測試活動？

一旦你定義了測試範圍（指定你應該測試什麼以及不應該測試什麼），你就可以討論一個好的單元測試應該具備的特性了。

單元測試的特性

• 快速。單元測試大多是自動執行的，這意味著它們必須快速。緩慢的單元測試更有可能被開發人員跳過，因為它們不會提供即時反饋。
• 獨立。單元測試根據定義是獨立的。它們測試單個代碼單元，並且不依賴於任何外部因素（例如文件或網絡資源）。
• 可重複。單元測試會重複執行，並且結果必須隨時間保持一致。
• 可靠。只有當被測系統中存在錯誤時，單元測試才會失敗。環境或測試的執行順序不應該重要。
• 正確命名。測試的名稱應提供有關測試本身的相關信息。

在深入研究 Python 中的單元測試之前，還有一個步驟缺失。我們如何組織測試以使它們乾淨易讀？我們使用一種稱為準備、執行和斷言 (AAA) 的模式。

AAA 模式

準備、執行和斷言 (AAA) 模式是用於編寫和組織單元測試的常用策略。它的工作方式如下：

• 在準備階段，設置測試所需的所有對象和變量。
• 接下來，在執行階段，調用被測試的函數/方法/類。
• 最後，在斷言階段，我們驗證測試的結果。

此策略通過分離測試的所有主要部分（設置、執行和驗證）提供了一種干淨的方法來組織單元測試。此外，單元測試更容易閱讀，因為它們都遵循相同的結構。

Python 中的單元測試：unittest 或 pytest？

我們現在將討論 Python 中的兩個不同的單元測試框架。這兩個框架是 unittest 和 pytest。

unittest 簡介

Python 標準庫包含 unittest 單元測試框架。此框架的靈感來自 JUnit，它是 Java 中的單元測試框架。

正如官方文檔中所述，unittest 支持我們將在這篇文章中提到的幾個重要概念：

• 測試用例，這是測試的單個單元
• 測試套件，這是一組一起執行的測試用例
• 測試運行器，這是處理所有測試用例的執行和結果的組件

unittest 有自己的編寫測試的方法。特別是，我們需要：

1. 將我們的測試編寫為繼承自 unittest.TestCase 類的類的方法
2. 使用特殊的斷言方法

由於 unittest 已經安裝，我們準備編寫我們的第一個單元測試！

使用 unittest 編寫單元測試

假設我們有 BankAccount 類：

import unittest

class BankAccount:
  def __init__(self, id):
    self.id = id
    self.balance = 0

  def withdraw(self, amount):
    if self.balance >= amount:
      self.balance -= amount
      return True
    return False

  def deposit(self, amount):
    self.balance += amount
    return True

我們不能提取超過存款可用額度的錢，所以讓我們測試一下我們的源代碼是否正確處理這種情況。

在同一個 Python 文件中，我們可以添加以下代碼：

class TestBankOperations(unittest.TestCase):
    def test_insufficient_deposit(self):
      # Arrange
      a = BankAccount(1)
      a.deposit(100)
      # Act
      outcome = a.withdraw(200)
      # Assert
      self.assertFalse(outcome)

我們正在創建一個名為 TestBankOperations 的類，它是 unittest.TestCase 的子類。通過這種方式，我們正在創建一個新的測試用例。

在這個類中，我們定義了一個單個測試函數，其方法以 test 開頭。這很重要，因為每個測試方法都必須以單詞 test 開頭。

我們期望此測試方法返回 False，這意味著操作失敗了。為了斷言結果，我們使用一個名為 assertFalse() 的特殊斷言方法。

我們準備執行測試了。讓我們在命令行上運行此命令：

python -m unittest example.py

這裡，example.py 是包含所有源代碼的文件的名稱。輸出應該如下所示：

<code>.
----------------------------------------------------------------------
Ran 1 test in 0.001s

OK</code>

很好！這意味著我們的測試成功了。現在讓我們看看當出現故障時輸出是什麼樣的。我們將一個新的測試添加到之前的類中。讓我們嘗試存入負數金額，這當然是不可能的。我們的代碼會處理這種情況嗎？

這是我們的新測試方法：

  def test_negative_deposit(self):
    # Arrange
    a = BankAccount(1)
    # Act
    outcome = a.deposit(-100)
    # Assert
    self.assertFalse(outcome)

我們可以使用 unittest 的詳細模式來執行此測試，方法是使用 -v 標誌：

python -m unittest -v example.py

現在的輸出不同了：

<code>test_insufficient_deposit (example.TestBankOperations) ... ok
test_negative_deposit (example.TestBankOperations) ... FAIL

======================================================================
FAIL: test_negative_deposit (example.TestBankOperations)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "example.py", line 35, in test_negative_deposit
    self.assertFalse(outcome)
AssertionError: True is not false

----------------------------------------------------------------------
Ran 2 tests in 0.002s

FAILED (failures=1)</code>

在這種情況下，詳細標誌為我們提供了更多信息。我們知道 test_negative_deposit 失敗了。特別是，AssertionError 告訴我們，預期結果應該是 false，但 True 不是 false，這意味著該方法返回了 True。

unittest 框架根據我們的需求提供不同的斷言方法：

• assertEqual(x,y)，測試 x == y 是否成立
• assertRaises(exception_type)，檢查是否引發了特定異常
• assertIsNone(x)，測試 x 是否為 None
• assertIn(x,y)，測試 x 是否在 y 中

現在我們已經基本了解瞭如何使用 unittest 框架編寫單元測試，讓我們來看看另一個名為 pytest 的 Python 框架。

pytest 簡介

pytest 框架是一個 Python 單元測試框架，它具有一些相關的特性：

• 它允許使用更少的代碼進行複雜的測試
• 它支持 unittest 測試套件
• 它提供超過 800 個外部插件

由於 pytest 默認情況下未安裝，因此我們必須先安裝它。請注意，pytest 需要 Python 3.7 。

安裝 pytest

安裝 pytest 非常容易。你只需要運行以下命令：

import unittest

class BankAccount:
  def __init__(self, id):
    self.id = id
    self.balance = 0

  def withdraw(self, amount):
    if self.balance >= amount:
      self.balance -= amount
      return True
    return False

  def deposit(self, amount):
    self.balance += amount
    return True

然後通過鍵入以下內容檢查一切是否已正確安裝：

class TestBankOperations(unittest.TestCase):
    def test_insufficient_deposit(self):
      # Arrange
      a = BankAccount(1)
      a.deposit(100)
      # Act
      outcome = a.withdraw(200)
      # Assert
      self.assertFalse(outcome)

輸出應該如下所示：

python -m unittest example.py

很好！讓我們使用 pytest 編寫第一個測試。

使用 pytest 編寫單元測試

我們將使用之前編寫的 BankAccount 類，我們將測試與之前相同的 method。通過這種方式，更容易比較使用這兩個框架編寫測試所需的努力。

要使用 pytest 進行測試，我們需要：

• 創建一個目錄並將我們的測試文件放入其中。
• 在名稱以 test_ 開頭或以 _test.py 結尾的文件中編寫我們的測試。 pytest 將在當前目錄及其子目錄中查找這些文件。

因此，我們創建一個名為 test_bank.py 的文件並將其放入文件夾中。這是我們的第一個測試函數的樣子：

<code>.
----------------------------------------------------------------------
Ran 1 test in 0.001s

OK</code>

正如你所注意到的，與 unittest 版本相比，唯一改變的是 assert 部分。在這裡，我們使用普通的 Python 斷言方法。

現在我們可以看看 test_bank.py 文件：

  def test_negative_deposit(self):
    # Arrange
    a = BankAccount(1)
    # Act
    outcome = a.deposit(-100)
    # Assert
    self.assertFalse(outcome)

要運行此測試，讓我們在包含 test_bank.py 文件的文件夾中打開一個命令提示符。然後，運行以下命令：

python -m unittest -v example.py

輸出將如下所示：

<code>test_insufficient_deposit (example.TestBankOperations) ... ok
test_negative_deposit (example.TestBankOperations) ... FAIL

======================================================================
FAIL: test_negative_deposit (example.TestBankOperations)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "example.py", line 35, in test_negative_deposit
    self.assertFalse(outcome)
AssertionError: True is not false

----------------------------------------------------------------------
Ran 2 tests in 0.002s

FAILED (failures=1)</code>

在這種情況下，我們可以看到編寫和執行測試是多麼容易。此外，我們可以看到與 unittest 相比，我們編寫的代碼更少。測試的結果也很容易理解。

讓我們繼續看看失敗的測試！

我們使用之前編寫的第二個方法，它被稱為 test_negative_deposit。我們重構 assert 部分，結果如下：

pip install -U pytest

我們像以前一樣運行測試，這應該是輸出：

pytest --version

通過解析輸出，我們可以讀取 collected 2 items，這意味著已經執行了兩個測試。向下滾動，我們可以看到在測試 test_negative_deposit 方法時發生了一個錯誤。特別是，錯誤發生在評估斷言時。此外，報告還指出 outcome 變量的值為 True，這意味著 deposit 方法包含錯誤。

由於 pytest 使用默認的 Python 斷言關鍵字，我們可以將獲得的任何輸出與存儲預期結果的另一個變量進行比較。所有這些都不需要使用特殊的斷言方法。

結論

總而言之，在本文中，我們介紹了軟件測試的基礎知識。我們發現了為什麼軟件測試至關重要以及為什麼每個人都應該測試他們的代碼。我們討論了單元測試以及如何在 Python 中設計和實現簡單的單元測試。

我們使用了兩個名為 unittest 和 pytest 的 Python 框架。兩者都具有有用的功能，並且它們是 Python 單元測試中最常用的兩個框架。

最後，我們看到了兩個基本的測試用例，以讓你了解如何按照準備、執行和斷言模式編寫測試。

我希望我已經說服你軟件測試的重要性。選擇一個框架，例如 unittest 或 pytest，然後開始測試——因為額外的努力是值得的！

如果你喜歡這篇文章，你可能還會發現以下內容有用：

• Cypress 測試：運行 Web 應用程序測試指南
• 如何使用 Jest 測試 React 組件
• 使用 Puppeteer 學習端到端測試
• 免提持續測試的 3 種方法
• 重新介紹 Jenkins：使用管道進行自動化測試

關於 Python 單元測試的常見問題

什麼是 Python 中的單元測試？ Python 中的單元測試是一種軟件測試技術，其中程序的單個單元或組件被隔離測試，以確保每個單元都能按預期工作。

為什麼單元測試在 Python 開發中很重要？單元測試有助於確保 Python 程序中各個組件的正確性。它有助於儘早發現錯誤，為代碼更改提供安全網，並支持代碼的可維護性。

如何在 Python 中編寫單元測試？ Python 中的單元測試通常使用內置的 unittest 模塊編寫。你創建繼承自 unittest.TestCase 的測試類，並在這些類中編寫測試方法。測試方法通常以“test”開頭。

除了 unittest，我還能使用哪些其他框架進行 Python 單元測試？是的，除了 unittest 之外，還有其他流行的 Python 測試框架，例如 pytest 和 nose2。這些框架提供了不同的功能和語法，使開發人員可以選擇最適合其需求的框架。

Python 單元測試中的 fixture 的作用是什麼？ Fixture 是一種在 Python 中設置前提條件並在測試後清理的方法。它們有助於確保測試是獨立的並且可以獨立運行。

什麼是測試覆蓋率，為什麼它很重要？測試覆蓋率衡量的是你的測試所執行的代碼庫的百分比。它有助於識別未經測試的代碼，並確保你的測試是全面的，從而減少發現錯誤的可能性。

在 Python 中編寫有效的單元測試有哪些最佳實踐？是的，一些最佳實踐包括編寫獨立和隔離的測試，使用描述性的測試方法名稱以及測試邊界情況。此外，要努力獲得良好的測試覆蓋率並經常運行測試。

以上是python單元測試指南，並結成pytest的詳細內容。更多資訊請關注PHP中文網其他相關文章！