Python 的 unittest 框架提供了一套完善的工具，讓開發者可以有效地進行單元測試。為了更好地控制測試流程和結果，我們可以自訂測試執行器和測試結果類別，例如重寫 addSuccess 和 addFailure 方法來輸出更詳細的資訊。此外，unittest 也支援使用裝飾器簡化測試程式碼，例如 @skipIf 可以根據條件跳過特定測試。更進一步，子測試功能允許在一個測試方法中執行多個相關的斷言，提供更細粒度的測試結果。在實務上，我們經常需要模擬外部依賴，例如 API 呼叫或資料函式庫操作，以確保測試的獨立性和穩定性。unittest.mock 模組提供了一個強大的模擬工具，可以替換外部依賴並驗證其行為。

基本概念

unittest 框架提供了豐富的 API，用於定製測試結果的報告。其中，TextTestResult 類別是用於處理測試結果的基本類別。透過繼承這個類別，可以實作自訂的測試結果報告。

自訂測試結果報告的步驟

定義自訂測試結果類別：繼承 unittest.TextTestResult 類別，定義自己的測試結果類別。
重寫相關方法：根據需要，重寫 addSuccess、addFailure 等方法，以實作自訂的測試結果報告。
定義自訂測試執行器類別：繼承 unittest.TextTestRunner 類別，定義自己的測試執行器類別，並指定使用自訂的測試結果類別。
使用自訂測試執行器：在測試程式中，使用自訂的測試執行器來執行測試。

範例

import unittest

class CustomTestResult(unittest.TextTestResult):
    def addSuccess(self, test):
        super().addSuccess(test)
        print(f"SUCCESS: {test}")

    def addFailure(self, test, err):
        super().addFailure(test, err)
        print(f"FAILURE: {test} - {err}")

class CustomTestRunner(unittest.TextTestRunner):
    resultclass = CustomTestResult

class SampleTest(unittest.TestCase):
    def test_pass(self):
        self.assertTrue(True)

    def test_fail(self):
        self.assertEqual(1, 0)

if __name__ == '__main__':
    runner = CustomTestRunner(verbosity=2)
    runner.run(unittest.makeSuite(SampleTest))

在這個範例中，CustomTestResult 類別繼承了 unittest.TextTestResult 類別，並重寫了 addSuccess 和 addFailure 方法，以實作自訂的測試結果報告。CustomTestRunner 類別繼承了 unittest.TextTestRunner 類別，並指定使用 CustomTestResult 類別作為測試結果類別。

Mermaid 圖表：自訂測試結果報告流程

  flowchart TD
    A[開始] --> B[定義自訂測試結果類別]
    B --> C[重寫相關方法]
    C --> D[定義自訂測試執行器類別]
    D --> E[使用自訂測試執行器]
    E --> F[執行測試]
    F --> G[產生自訂測試結果報告]

圖表翻譯：

這個 Mermaid 圖表描述了自訂測試結果報告的流程。首先，定義自訂測試結果類別；然後，重寫相關方法以實作自訂的測試結果報告；接下來，定義自訂測試執行器類別並指定使用自訂的測試結果類別；最後，使用自訂測試執行器來執行測試，並產生自訂的測試結果報告。

自定義測試報告和裝飾器

在單元測試中，自定義測試報告和裝飾器可以大大提高測試的靈活性和可讀性。以下是如何實作這些功能的示例。

自定義測試報告

unittest.main() 函式可以接受一個 testRunner 引數，用於自定義測試報告。這個引數可以是一個 TestRunner 例項，該例項負責控制測試的執行和報告。

import unittest

class CustomTestRunner(unittest.TextTestRunner):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    def run(self, test):
        result = super().run(test)
        # 在這裡新增自定義的報告邏輯
        print("自定義測試報告")
        return result

if __name__ == '__main__':
    runner = CustomTestRunner()
    unittest.main(testRunner=runner, exit=False)

自定義裝飾器

裝飾器可以用於封裝常見的測試模式，例如設定操作、跳過邏輯或模擬環境條件。以下是如何實作一個自定義裝飾器的示例：

import unittest
import sys
import functools

def skip_if(condition, reason):
    def decorator(test_func):
        @functools.wraps(test_func)
        def wrapper(*args, **kwargs):
            if condition():
                raise unittest.SkipTest(reason)
            return test_func(*args, **kwargs)
        return wrapper
    return decorator

def is_windows():
    return sys.platform.startswith('win')

class PlatformSpecificTest(unittest.TestCase):
    @skip_if(is_windows, "Test not supported on Windows")
    def test_unix_specific_feature(self):
        # 實作需要 Unix-like 系統的功能
        self.assertTrue(True)

if __name__ == '__main__':
    unittest.main()

子測試

子測試（subtest）是 Python 3.4 中引入的一個功能，允許在單個測試方法中執行多個相關的斷言。這可以減少樣板程式碼，並提供更細粒度的失敗輸出，而不會提前終止包含的測試。

import unittest

def square(n):
    return n * n

class SubtestExample(unittest.TestCase):
    def test_squares(self):
        test_values = [(-2, 4), (-1, 1), (0, 0), (1, 1), (2, 4)]
        for input_val, expected in test_values:
            with self.subTest(i=input_val):
                self.assertEqual(square(input_val), expected)

if __name__ == '__main__':
    unittest.main()

這些功能可以幫助您建立更強大、更靈活的單元測試，從而提高您的程式碼品質和可靠性。

使用 Pytest-BDD 進行行為驅動開發

在軟體開發中，確保系統行為符合需求是非常重要的。Pytest-BDD 是一個根據 Pytest 的行為驅動開發（Behavior-Driven Development, BDD）框架，允許開發者使用自然語言風格的測試來驗證系統行為。

行為驅動開發的優點

橋接開發者、測試者和領域專家的溝通鴻溝
建立生動的檔案，驗證系統行為是否符合規格
減少誤解，提高團隊協作效率

使用 Pytest-BDD

安裝 Pytest-BDD：使用 pip 安裝 Pytest-BDD：pip install pytest-bdd
建立功能檔案：使用 Gherkin 語言編寫功能檔案（.feature），描述預期行為或工作流程。
```
```gherkin
```
功能: 使用者登入為了存取個人化功能做為一個註冊使用者我想登入系統場景大綱: 成功登入具有有效憑證假設有一個使用者存在，使用者名稱為 “"，密碼為 “” 當使用者嘗試使用使用者名稱 “” 和密碼 “” 登入那麼登入應該成功示例: | 使用者名稱 | 密碼 | | alice | secret | | bob | 123456 |
定義步驟：連線純語言規範到 Python 步驟定義。每個步驟定義實作了模擬描述行為所需的邏輯。
```
```python
```
import pytest from pytest_bdd import scenario, given, when, then, parsers

連線場景到功能檔案

@scenario(“login.feature”, “成功登入具有有效憑證”) def test_successful_login(): pass

用於設定測試使用者的 fixture；可以擴充套件以包含資料函式庫操作

@pytest.fixture def user_store(): store = {} yield store store.clear()

@given(parsers.cfparse(“有一個使用者存在，使用者名稱為 “{username}"，密碼為 “{password}””)) def user_exists(user_store, username, password): # 實作使用者存在的邏輯 pass


### 高階用法

*   **模組化和重用**：專注於設計模組化、可重用的場景，以捕捉快樂路徑條件和邊緣案例。
*   **避免實作細節**：指定業務意圖，而不是實作細節。
*   **結合 fixture 和 helper 函式**：結構化步驟定義，以防止程式碼重複。

透過 Pytest-BDD，您可以提高測試的精確度和可讀性，同時促進團隊之間的合作。這使得您的軟體系統更加可靠和易於維護。

## 使用 pytest-bdd 進行行為驅動開發

pytest-bdd 是一個根據 Pytest 的行為驅動開發（BDD）框架，允許開發人員使用自然語言定義測試案例。以下是使用 pytest-bdd 進行行為驅動開發的範例。

### 安裝 pytest-bdd

首先，需要安裝 pytest-bdd。可以使用 pip 安裝：
```bash
pip install pytest-bdd

定義功能檔案

功能檔案（feature file）是用於定義測試案例的檔案。以下是範例功能檔案 login.feature：

功能: 登入功能
  場景: 成功登入
    假設 有一個使用者存在，名稱為 "user"，密碼為 "password"
    當 使用者嘗試登入，名稱為 "user"，密碼為 "password"
    那麼 登入應該成功

實作步驟定義

步驟定義（step definition）是用於實作功能檔案中定義的步驟的函式。以下是範例步驟定義：

import pytest
from pytest_bdd import scenario, given, when, then, parsers

@scenario('login.feature', '成功登入')
def test_login():
    pass

@given(parsers.cfparse('有一個使用者存在，名稱為 "{username}"，密碼為 "{password}"'))
def user_exists(username, password):
    # 建立使用者
    user_store[username] = password

@when(parsers.cfparse('使用者嘗試登入，名稱為 "{username}"，密碼為 "{password}"'))
def attempt_login(username, password):
    # 模擬登入操作
    user_store[username] = password

@then('登入應該成功')
def check_login_success():
    # 驗證登入結果
    assert user_store['user'] == 'password'

執行測試

可以使用 Pytest 執行測試：

pytest tests/

支援非同步操作

pytest-bdd 也支援非同步操作。以下是範例：

import asyncio
import pytest
from pytest_bdd import scenario, given, when, then, parsers

@scenario('login.feature', '成功登入')
async def test_login_async():
    pass

@given(parsers.cfparse('有一個使用者存在，名稱為 "{username}"，密碼為 "{password}"'))
async def user_exists_async(username, password):
    # 建立使用者
    await asyncio.sleep(0.01)  # 模擬非同步操作
    user_store[username] = password

@when(parsers.cfparse('使用者嘗試登入，名稱為 "{username}"，密碼為 "{password}"'))
async def attempt_login_async(username, password):
    # 模擬登入操作
    await asyncio.sleep(0.01)  # 模擬非同步操作
    user_store[username] = password

@then('登入應該成功')
async def check_login_success_async():
    # 驗證登入結果
    assert user_store['user'] == 'password'

使用場景大綱和引數化範例

pytest-bdd 也支援場景大綱和引數化範例。以下是範例：

功能: 登入功能
  場景大綱: 成功登入
    假設 有一個使用者存在，名稱為 "<username>"，密碼為 "<password>"
    當 使用者嘗試登入，名稱為 "<username>"，密碼為 "<password>"
    那麼 登入應該成功

  範例:
    | username | password |
    | user     | password |
    | admin    | admin    |

自訂鉤子

pytest-bdd 也支援自訂鉤子。以下是範例：

def pytest_bdd_before_scenario(request, feature, scenario):
    # 執行前置操作
    print("Before scenario")

def pytest_bdd_after_scenario(request, feature, scenario):
    # 執行後置操作
    print("After scenario")

行為驅動開發（BDD）與 Pytest-BDD

行為驅動開發（BDD）是一種軟體開發方法，強調透過合作與溝通來實作軟體功能。Pytest-BDD 是一種根據 Pytest 的 BDD 框架，允許開發者使用 Gherkin 語法定義測試案例。

BDD 的優點

提高團隊合作：BDD 鼓勵開發者、測試者和業務人員之間的合作，確保所有人都瞭解軟體的需求和行為。
減少誤解：透過使用自然語言定義測試案例，BDD 減少了誤解的可能性，確保所有人都在同一頁面上。
提高測試效率：BDD 測試案例可以重覆使用，減少測試的時間和成本。

Pytest-BDD 的功能

支援 Gherkin 語法：Pytest-BDD 支援 Gherkin 語法，允許開發者使用自然語言定義測試案例。
整合 Pytest：Pytest-BDD 整合 Pytest，允許開發者使用 Pytest 的功能，例如引數化測試和平行測試。
支援步驟定義：Pytest-BDD 支援步驟定義，允許開發者定義測試案例的步驟。

模擬和測試依賴

模擬是測試中的一個重要概念，允許開發者隔離被測試單元的外部依賴。Python 的 unittest.mock 模組提供了一個強大的模擬工具，允許開發者替換被測試單元的外部依賴。

模擬的優點

減少測試複雜度：模擬可以減少測試的複雜度，允許開發者專注於被測試單元的行為。
提高測試效率：模擬可以提高測試的效率，允許開發者快速地執行測試案例。

使用 `unittest.mock` 的範例

import unittest
from unittest.mock import patch

def external_api_call(param):
    # Simulate an expensive or unreliable external API call.
    pass

def function_under_test(param):
    result = external_api_call(param)
    return result * 2

class TestFunction(unittest.TestCase):
    def test_function_under_test(self):
        with patch(__name__ + '.external_api_call', return_value=10) as mock_api:
            self.assertEqual(function_under_test(5), 20)
            mock_api.assert_called_once_with(5)

if __name__ == '__main__':
    unittest.main()

在這個範例中，external_api_call 函式被模擬為傳回一個固定值。測試案例 test_function_under_test 測試 function_under_test 函式的行為，並驗證 external_api_call 函式被呼叫一次且帶有正確的引數。

使用 Mocking 進行單元測試

在進行單元測試時，模擬（Mocking）是一種強大的技術，可以幫助我們隔離被測試的單元，並確保測試的可靠性和穩定性。以下是使用 Mocking 進行單元測試的範例和解釋。

從軟體測試的效能評估視角來看，本文深入探討了 Python unittest 框架的自訂測試報告、裝飾器、子測試，以及行為驅動開發（BDD）工具pytest-bdd 和模擬測試的應用。透過繼承TextTestResult和TextTestRunner，開發者可以根據專案需求客製化測試報告，展現高度的彈性。裝飾器和子測試的運用則簡化了測試程式碼，提升了測試效率。pytest-bdd框架的匯入，則將 BDD 的優勢融入 Python 測試實踐，促進了開發、測試和業務團隊間的協作，有效降低溝通成本。此外，文章也闡明瞭模擬技術在隔離外部依賴、簡化測試複雜度和提升測試效率上的重要性，並以unittest.mock 函式庫示範了模擬的實務應用。然而，過度依賴複雜的模擬設定也可能導致測試與實際執行環境脫節，因此，在實踐中需要權衡模擬的粒度和範圍。展望未來，隨著測試自動化和持續整合/持續交付的普及，更便捷、更智慧的測試工具和框架將持續湧現，進一步提升軟體品質和交付效率。對於追求高效能測試的團隊而言，持續學習和應用新的測試技術和方法至關重要。

玄貓

技術愛好者，專注於分享程式開發、雲端技術與 AI 應用的心得體會。

Python單元測試框架Mock應用技巧