Python unittest 是 Python 標準庫中內置的測試框架,可用於編寫自動化測試案例,驗證程式碼的正確性。對於開發人員來說,測試是確保程式碼品質和穩定性的關鍵步驟。本文將引導您從零開始,探索如何使用 Python unittest 來測試您的 API。無論您是新手還是有經驗的開發人員,都可以輕鬆上手,學習並實踐測試的基本原則。透過本文的指引,您將了解如何建立測試案例,執行測試,並分析測試結果。開始使用 Python unittest,提高您的程式碼品質,並確保您的 API 在不斷發展的軟體環境中保持穩定和可靠。
目錄
基本 Python unittest api 測試,新手入門必學
程式碼連結: GitHub
python unittest 資料夾架構
由於範例主要測試 code status 200,因此架構不會太多層級可參考下方
每個區塊檔案用途與說明
- config
- 放置相關測試資料、設定檔案
- main.py
- 主要執行檔案
- report
- 測試完後,會產生 test_report.html 放置到此資料夾
- src
- 放置外部引用函數或是自己客製化的函數
- test_cases
- 針對自己寫的測試案例規劃測試案例
unittest api 程式碼簡易說明
主要會講 main.py 與 web_checkout_status_code_test_cases.py 這兩個檔案,相對比較需要多一點解釋,其他的的檔案相對簡單。
web_checkout_status_code_test_cases
這段程式碼是一個使用 Python unittest 框架編寫的測試案例類別。
它包含了三個測試方法:
test_share_web_check_status_200
test_google_web_check_status_200
test_yahoo_web_check_status_200
每個測試方法都會發送一個 HTTP GET 請求到特定的網址,並檢查返回的狀態碼是否為 200。
如果狀態碼不是 200,則會產生一個錯誤訊息,提示需要進行驗證。
在測試過程中,程式會將每個測試的網址和返回的請求狀態輸出到終端機上。
這樣的測試方法可用於驗證 Web API 是否正常運作,並確保返回的狀態碼符合預期。
main
這段程式碼是一個用於執行 API 測試的管理器類別 RunApiTestManager
。
在 __init__
方法中,初始化了測試報告的標題、描述和報告文件的路徑。
在 run_case
方法中,使用 unittest.defaultTestLoader.discover
方法來自動發現指定目錄下的所有測試用例文件,並根據指定的檔案模式選擇要運行的測試用例。
然後使用 HTMLTestRunner
類別來執行所有測試用例並生成 HTML 格式的測試報告,最後將報告寫入到指定的報告文件中。
在 __main__
塊中,創建了一個 RunApiTestManager
實例,並指定了要運行的測試用例檔案模式,然後調用 run_case
方法來執行測試並生成報告。
unittest api HTMLTestRunner 測試報告測試報告
延伸閱讀
簡單上手 Python unittest:從零開始測試您的 API
使用 Robot Framework 進行自動化測試:加速您的測試流程!
Jenkins 教學手冊:打造持續集成和持續部署的最佳實踐!