【Pytest教學】從0開始：Python 開發者的最佳測試工具


在快節奏的軟體開發領域，維持代碼的高質量是關鍵成功因素之一。Python，作為全球廣泛使用的編程語言，提供了多種測試框架以支持開發者執行精準的代碼測試。在這些框架中，Pytest因其卓越性能和使用便利性而脫穎而出，已成為眾多Python自動化測試的首選工具。這篇文章深入講解了Pytest的核心特性、安裝方法及其配置過程，旨在為讀者提供一個全面的Pytest入門指南，從基礎概念到進階應用，逐步揭示如何有效利用Pytest提升測試效率和代碼品質。

第一部分：Pytest基礎

Pytest的優勢與特點

Pytest 是一個功能豐富的Python測試框架，它支援從簡單的單元測試到複雜的功能測試。相較於其他測試框架，Pytest 提供以下幾個顯著優勢：

  • 簡潔的語法：Pytest 允許開發者以最少的代碼寫出表達力強的測試。
  • 強大的Fixture支援：透過fixture，開發者可以輕鬆地為測試提供特定的設置或資源，無需重複代碼。
  • 自動化測試發現：Pytest 可以自動發現測試文件和測試函數，使測試運行更為便捷。
  • 豐富的插件生態：Pytest 擁有一個活躍的插件生態系統，提供了許多擴展功能，如測試覆蓋率報告和並行測試。

與unittest的比較

雖然unittest是Python標準庫的一部分，提供了基本的測試功能，但Pytest 在多個方面提供了更佳的體驗和功能。例如，Pytest 的fixture機制比unittest中的setUp/tearDown模式更為靈活和強大。此外，Pytest 的語法更為簡潔，能夠使測試代碼更加易讀和維護。

安裝與設定

如何安裝Pytest

安裝Pytest，只需在terminal或命令提示字元中執行以下命令：

pip install pytest

這條命令會從Python Package Index (PyPI)安裝最新版本的Pytest，讓開發者能夠立即開始編寫測試。

基本設定介紹

為了最大化Pytest的效用，開發者可以進行一些基本設定。這些設定可以在pytest.ini、tox.ini或pyproject.toml文件中進行。例如，可以定義自定義的標記（markers），使測試更加組織化：

[pytest]
markers =
    slow: 標記運行時間較長的測試

透過這樣的設定，開發者能夠更好地控制測試運行的行為，例如僅運行或排除特定標記的測試。

Pytest 以其強大的功能和易用性，在Python測試框架中獨樹一幟。無論是對於新手還是有經驗的開發者，Pytest 都是提升測試質量和效率的理想選擇。

第二部分：撰寫Pytest測試範例

在軟體開發的過程中，自動化測試扮演著至關重要的角色。它不僅可以確保代碼的穩定性和可靠性，還能大幅提升開發效率。Pytest 作為 Python 中最受歡迎的測試框架之一，提供了強大的功能來幫助開發者撰寫和組織測試用例。這一部分將深入介紹如何使用 Pytest 撰寫一個測試，包括測試函式的結構、使用 assert 進行斷言，以及如何通過測試類別和標籤來組織測試用例。

測試函式的結構

Pytest 允許你以非常直觀和簡潔的方式來撰寫測試函式。一個基本的測試函式結構如下：

def test_example():
    # 測試邏輯
    assert 條件, "測試失敗時的錯誤訊息"

在這個結構中，test_example 是測試函式的名稱，Pytest 會自動識別以 test_ 開頭的函式作為測試用例。測試邏輯部分則包含了執行的代碼和檢查結果的斷言。

使用 assert 進行斷言

在 Pytest 中，assert 語句是用來進行斷言的關鍵。如果 assert 後面的條件為 True，則測試通過；如果為 False，則測試失敗，並拋出錯誤訊息。Pytest會自動找到 test_ 開頭的檔案來進行測試。例如，我們創建一個test_add.py測試文件，並編寫測試用例如下。

import pytest

def add(x, y):
    """加法函式，返回兩個數字的和"""
    return x + y

def test_add():
    assert add(1, 2) == 3, "應該返回兩個數字的和"
    assert add(-1, 1) == 0, "正負數相加應該為0"
    assert add(-1, -1) == -2, "兩個負數相加的結果檢查"

在這個測試用例中，我們測試了三種不同的情況：兩個正數相加、一正一負數相加以及兩個負數相加。使用 assert 斷言來檢查 add 函式的返回值是否符合預期。

最後，運行測試：

pytest

Pytest 會自動發現以 test_ 開頭的文件和函式，並執行這些測試。如果所有測試都通過，則意味著我們的 add 函式按預期工作。可以得到以下Pass的結果

假使我們有錯誤，則會有錯誤訊息。假設我們將測試資料改為如下。

import pytest

def add(x, y):
    """加法函式，返回兩個數字的和"""
    return x + y

def test_add():
    assert add(1, 2) == 4, "應該返回兩個數字的和"
    assert add(-1, 1) == 0, "正負數相加應該為0"
    assert add(-1, -1) == -2, "兩個負數相加的結果檢查"

就會得到以下錯誤的Report：

通過這個簡單的例子，我們看到了如何使用 Pytest 來測試 Python 函式。Pytest 的簡潔語法和強大功能使得撰寫和執行測試變得更加容易，是提高代碼質量的有效工具。透過實踐，開發者可以進一步掌握 Pytest，發掘其更多高級特性和最佳實踐，以支持更複雜的測試需求。

第三部分：進階特性

接下來將深入介紹Pytest中兩項強大的進階特性：Fixture和Parametrize，並透過實例演練來展示它們如何在實際測試中發揮關鍵作用。

Fixture的使用

Fixture的概念與應用

Fixture是Pytest中一個強大的功能，它允許開發者定義一套操作，這套操作會在測試函數執行前後自動運行，非常適合用於測試前的環境準備和測試後的資源清理工作。通過使用Fixture，可以避免在每個測試函數中重複相同的設置或清理代碼，從而使測試代碼更加乾淨、易維護。

例如，如果我們需要在多個測試中使用同一個數據庫連接，就可以定義一個Fixture來創建和關閉連接：

import pytest

@pytest.fixture
def db_connection():
    connection = create_connection()
    yield connection
    connection.close()

在測試函數中使用此Fixture非常簡單，只需將Fixture名稱作為測試函數的參數即可：

def test_query(db_connection):
    # 使用db_connection進行測試
    assert db_connection.query("SELECT * FROM table") is not None

使用Fixture處理測試前後的準備與清理工作

Fixture的真正強大之處在於其靈活性和可重用性。它不僅可以應用於數據庫連接，還可以用於任何需要在測試前後進行設置和清理的場景，如文件操作、網絡請求、資源模擬等。

Parametrize – 參數化測試

如何使用Parametrize增加測試的靈活性

Parametrize是Pytest提供的另一項功能，它允許開發者以參數的形式給測試函數提供多組輸入，從而實現同一測試函數對多種數據的測試。這大大增加了測試的靈活性和覆蓋範圍。

使用@pytest.mark.parametrize裝飾器可以輕鬆實現參數化測試：

import pytest

@pytest.mark.parametrize("test_input,expected", [(1, 2), (3, 4), (5, 6)])
def test_add(test_input, expected):
    assert add(test_input, 1) == expected

假設我們有一個add函數，需要測試它對不同輸入的處理能力。通過Parametrize，我們可以輕鬆定義多組輸入和預期輸出，Pytest會自動為每組參數運行一次測試函數，從而實現廣泛的測試覆蓋。

結合Fixture和Parametrize的使用，Pytest為Python開發者提供了強大的工具，以更高效、更靈活的方式進行自動化測試。掌握這些進階特性，將有助於提升測試質量，加速開發週期，並確保最終產品的穩定性和可靠性。

第四部分：Pytest插件與整合

在現代軟體開發實踐中，持續整合（CI）和持續部署（CD）是確保軟體質量與快速迭代的關逅步驟。Pytest，作為Python開發者廣泛使用的測試框架，通過其豐富的插件生態系統以及與CI/CD工具的無縫整合，為自動化測試提供了強大支持。本文將探討幾款常用的Pytest插件，以及如何將Pytest整合進GitHub Actions實現CI/CD流程中，從而提高開發效率並確保代碼質量。

常用插件介紹

覆蓋率插件（如pytest-cov）

pytest-cov是一款廣受歡迎的Pytest插件，它允許開發者輕鬆生成測試覆蓋率報告。通過分析哪些代碼被測試覆蓋，哪些未被覆蓋，開發者可以更有效地優化測試案例，確保代碼質量。

安裝pytest-cov相當簡單：

pip install pytest-cov

使用時，只需在運行Pytest命令時加上--cov參數：

pytest --cov=my_project

這將生成一個詳細的覆蓋率報告，幫助開發者識別未被測試的代碼區域。

並行測試插件（如pytest-xdist）

pytest-xdist插件能夠顯著提高測試的執行速度，通過在多個CPU核心上並行運行測試來實現。對於擁有大量測試用例的項目來說，這一功能尤為重要。

安裝pytest-xdist也非常簡單：

pip install pytest-xdist

使用時，加上-n參數並指定並行工作數：

pytest -n 4

這樣Pytest將在4個並行工作中運行測試，從而加快測試執行速度。

與CI/CD工具的整合

如何將Pytest整合進持續整合/持續部署流程中

Pytest與CI/CD流程的整合，可以讓測試自動化並在每次代碼提交時執行，從而確保代碼更改不會破壞現有功能。GitHub Actions是一款強大的CI/CD工具，可以實現這一過程。

使用GitHub Actions運行Pytest

要在GitHub Actions中運行Pytest，首先需要在你的GitHub項目根目錄下創建一個.github/workflows目錄，並在該目錄下創建一個工作流文件（例如python-test.yml）。以下是一個基本的工作流配置示例：

name: Python application

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.8'
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install pytest pytest-cov
    - name: Run pytest
      run: |
        pytest

這個配置文件定義了一個工作流程，它會在每次推送到倉庫時自動運行。它會設置Python環境，安裝依賴，並運行Pytest。通過這樣的配置，開發團隊可以確保每次提交都會自動運行測試，及時發現並修復問題，進一步提升代碼質量和項目穩定性。

結合Pytest的強大插件和CI/CD工具的自動化流程，Python開發團隊可以構建一個高效、可靠的自動化測試體系，確保快速迭代的同時，保持高質量的軟體產品。

總結

這篇文章主要涵蓋了以下幾個重點：

  • Pytest基礎：介紹了Pytest的安裝、基本概念、與unittest的比較，以及如何撰寫第一個簡單測試。
  • 撰寫測試用例：深入探討了測試函式的結構、使用assert進行斷言、測試類別與測試套件的組織方式，以及使用標籤進行測試分類的方法。
  • 進階特性：介紹了Fixture的概念與應用，說明了如何使用Fixture處理測試前後的準備與清理工作，並探討了Parametrize功能，展示了如何進行參數化測試。
  • Pytest插件與整合：介紹了兩款常用的Pytest插件——pytest-cov和pytest-xdist，分別用於生成測試覆蓋率報告和進行並行測試。此外，詳細說明了如何將Pytest整合進持續整合/持續部署（CI/CD）流程中，特別是使用GitHub Actions自動運行Pytest測試。

開發者不僅學會了如何使用Pytest進行基礎測試，還了解了如何利用其進階特性和插件來擴展測試功能，以及如何在現代軟件開發實踐中，將自動化測試與CI/CD流程緊密整合。這些知識和技能對於提升開發效率、保障代碼質量，以及實現快速迭代開發至關重要。希望無論是新手還是有經驗的Python開發者，都能從中獲得實用的知識和技能。

標籤
X. Ryan
X. Ryan

Hello！我是一個在矽谷工作，有軟體工程背景的量子計算科學家。這裡分享的內容主要是把平常研究開發時所用的小工具以及看過的東西記錄下來，同時也分享一些日常生活瑣事。

文章: 45
相關文章