BeautifulReport介绍

BeautifulReport是一个基于unittest.TestResult模块实现的测试用例模板,可以把测试中的结果整合成一个可视化的HTML测试报告。
1. 安装BeautifulReport
pip install BeautifulReport
BeautifulReport.report

report (
filename     -> 测试报告名称, 如果不指定默认文件名为report.html
description  -> 测试报告用例名称展示 report_dir='.' -> 报告文件写入路径 theme='theme_default'  -> 报告主题样式 theme_default theme_cyan theme_candy theme_memories
)

· 主题样式

image.png

theme: 报告主题名 theme_default、theme_cyan、theme_candy、theme_memories
image.png

· BeautifulReport.add_test_img
如果使用报告过程中需要把测试报告的截图放在报告中, 可以使用add_test_img方法
· add_test_img ( *pargs )
可以在测试用例上挂载一个装饰器, 实例内容如下
· 默认存放图片路径是img,需要在当前测试项目启动路径下,创建一个img文件夹;
· 传递给装饰器的图片,在运行测试前可以不存在,运行测试之后生成即可;
先使用unittest框架编写测试用例脚本, 例如先创建一个AutoTestCase.py文件,用来编写测试用例脚本;

import unittest
import time, os
from selenium import webdriver
from BeautifulReport import BeautifulReport

class AutoTestCase(unittest.TestCase):
   # 定义一个保存截图函数(必须)
   def save_img(self, test_method):
   root_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))).replace('\\', '/')
   img_path = root_dir + '/img'
   self.driver.get_screenshot_as_file('{}/{}.png'.format(img_path, test_method))

 # 启动函数,每个用例测试开始前,都会执行该函数
 def setUp(self):
   self.driver = webdriver.Chrome()
   self.driver.maximize_window()
   self.driver.get('https://www.baidu.com')

 # 结束函数,每个用例测试结束后,都会执行该函数
 def tearDown(self):
   self.driver.quit()

 @BeautifulReport.add_test_img('test_01_ldh')
 def test_01_ldh(self):
   """case1:搜索关键词刘德华"""
   try:
     # 这里的id我故意写错,用来查看失败效果
     self.driver.find_element_by_id('kw1').send_keys('刘德华') 
     self.driver.find_element_by_id('su').click()
     time.sleep(2)
   except Exception as error:
     # 失败后会有报错截图,注意命名必要格式:类名_函数名
     self.save_img("AutoTestCase_test_01_ldh")
     print("case1:测试执行失败!")
     raise error # 必须要抛出异常,不然测试报告中会认为测试成功
   else:
     print("case1:测试执行通过。")

 @BeautifulReport.add_test_img('test_02_test')
 def test_02_test(self):
   """case2:搜索关键词test"""
   try:
     self.driver.find_element_by_id('kw').send_keys('test')
     self.driver.find_element_by_id('su').click()
     time.sleep(2)
   except Exception as error:
     self.save_img("AutoTestCase_test_02_test")
     print("case1:测试执行失败!")
     raise error
   else:
    print("case1:测试执行通过。")

 @unittest.skip('跳过该测试用例') # 跳过,但会在测试报告中显示该用例
 def test_03_zdh(self):
   """case3:搜索关键词自动化测试"""
   self.driver.find_element_by_id('kw').send_keys('自动化测试')
   self.driver.find_element_by_id('su').click()
   time.sleep(3)

 @BeautifulReport.stop # 不执行,且测试报告中不会显示该用例
 def test_04_selenium(self):
   self.driver.find_element_by_id('kw').send_keys('selenium')
   self.driver.find_element_by_id('su').click()
   time.sleep(3)

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

然后编写执行文件test_execute_cases.py

# -*- coding: UTF-8 -*-
import os
import unittest
import datetime
from BeautifulReport import BeautifulReport

root_dir = os.path.dirname(os.path.abspath(__file__)).replace('\\', '/')
# 用例存放位置
test_dir = root_dir + '/Test_cases'
# 测试报告存放位置
report_dir = root_dir + '/Test_report/test'
# 测试报告名称
now = datetime.datetime.now().strftime('%Y_%m%d_%H%M%S')
filename = '自动化测试报告' + str(now)
# 用例名称
description = '功能自动化测试报告'
# 需要执行哪些用例,如果目录下的全部,可以改为"*.py",如果是部分带test后缀的,可以改为"test*.py"
pattern = "AutoTestCase.py"

if __name__ == '__main__':
  test_suite = unittest.defaultTestLoader.discover(test_dir, pattern=pattern)
  result = BeautifulReport(test_suite)
  result.report(filename=filename, description=description, report_dir=report_dir)

运行执行文件后生成如下测试报告;


image.png

image.png

image.png

解析BeautifulReport的截图装饰器

C:\Python\Python38\Lib\site-packages\BeautifulReport\BeautifulReport.py
可以看到,将图片拼接到HTML实际上是add_test_img()装饰器的业务。点进去看代码如下:

image.png

首先,装饰器的固定写法,定义一个_wrap(),然后再写一个__wrap()用@wraps保留原函数的属性。
接下去就是具体的业务逻辑了,先定义img_path的路径,然后用try except尝试去运行原函数,如果运行成功,将原函数的结果记入result变量;如果失败,则在原函数的参数里检查是否存在save_img函数,如果有,则说明需要保存图片,通过getattr函数获得save_img函数,并将当前函数的名字func.__name__设为其参数并运行。默认的save_img函数在BR库的另一个py文件里:BeautifulReport/tests/test_make_report.py
image.png

这样,如果用户定义过save_img函数,那在执行抛异常时,就会自动去调用save_img函数去截图。 然后再将截图结果通过image2base函数转一下格式,赋给一个data变量。 可以看到image2base函数很简单,就是转格式而已:
image.png

转好的base64格式字符串会被填充到一个HTML_IMG_TEMPLATE常量里。 这个HTML_IMG_TEMPLATE在之前定义过,可以点进去看是这么一个值:
image.png

其实就是把图片拼接到一个HTML里啦。
经过这一步步操作,BeautifulRepor就做到了在抛异常时,自动截图并嵌入HTML的操作。
后面还有一段代码:
image.png

这都很好理解了,就是有多个截图时,逐个去截并镶嵌到HTML里。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,616评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,020评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,078评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,040评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,154评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,265评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,298评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,072评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,491评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,795评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,970评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,654评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,272评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,985评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,815评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,852评论 2 351

推荐阅读更多精彩内容

  • 一、自动化测试所属分类(站在代码可见度角度分类) 1. 黑盒测试(功能测试)2. 灰盒测试(接口测试)3. 白盒测...
    MAVIS_42bf阅读 895评论 0 0
  • 前言:此代码,网上实例+同事提供思路+自己编码,100%手工完成,希望能认识更多的同道中人,一起探讨。 已下是简单...
    hao0_0阅读 21,030评论 4 14
  • 在自动化测试中,我们更希望能够得到一个直观、清晰的可视化报告,而不是一个文本文件、或者是日志格式的报告,在Pyth...
    测试allen说阅读 857评论 0 8
  • 表情是什么,我认为表情就是表现出来的情绪。表情可以传达很多信息。高兴了当然就笑了,难过就哭了。两者是相互影响密不可...
    Persistenc_6aea阅读 124,630评论 2 7
  • 16宿命:用概率思维提高你的胜算 以前的我是风险厌恶者,不喜欢去冒险,但是人生放弃了冒险,也就放弃了无数的可能。 ...
    yichen大刀阅读 6,042评论 0 4