BeautifulReport報告

Project description

BeautifulReport

一個基於unittest.TestResult模塊實現的測試用例模板, 可把測試中的結果通過BeautifulReport整合成一個可視化的報表.

如何使用它?

>>> pip install BeautifulReport

import unittest from BeautifulReport import BeautifulReport if __name__ == '__main__': test_suite = unittest.defaultTestLoader.discover('./tests', pattern='test*.py') result = BeautifulReport(test_suite) result.report(filename='測試報告', description='測試deafult報告', report_dir='report', theme='theme_default') 

Report API簡介

• BeautifulReport.report

  • report (
    filename -> 測試報告名稱, 如果不指定默認文件名為report.html
    description -> 測試報告用例名稱展示
    report_dir='.' -> 報告文件寫入路徑
    theme='theme_default' -> 報告主題樣式 theme_default theme_cyan theme_candy theme_memories
    )

• BeautifulReport.add_test_img

如果使用報告過程中需要把測試報告的截圖放在報告中, 可以使用add_test_img方法

• add_test_img ( *pargs )

可以在測試用例上掛載一個裝飾器, 實例內容如下

• 默認存放的圖片路徑是img, 需要在當前測試項目的啟動路徑下, 創建一個img文件夾
• 傳遞給裝飾器的圖片,在運行測試前可以不存在, 運行測試之后生成即可.
• 當文件在報告中展示后, 想要看到原圖, 可以點擊報告中的縮略圖查看完整的截圖

import unittest from BeautifulReport import BeautifulReport class UnittestCaseSecond(unittest.TestCase): """ 測試代碼生成與loader 測試數據""" def test_equal(self): """  test 1==1  :return:  """ import time time.sleep(1) self.assertTrue(1 == 1) @BeautifulReport.add_test_img('測試報告.png') def test_is_none(self): """  test None object  :return:  """ save_some_img('測試報告.png') self.assertIsNone(None) 

• 運行sample之后生成如下報告

• 主題樣式

感謝原作者 TesterlifeRaymond 的代碼貢獻，本人在原基礎上修復了部分bug並增加了主題樣式的自定義