网站开发定制合同,商城网站开发价,学习网站模板下载,谷歌推广和seo前言
Pytest框架可以使用两种测试报告#xff0c;其中一种就是使用pytest-html插件生成的测试报告#xff0c;但是报告中有一些信息没有什么用途或者显示的不太好看#xff0c;还有一些我们想要在报告中展示的信息却没有#xff0c;最近又有人问我pytest-html生成的报告其中一种就是使用pytest-html插件生成的测试报告但是报告中有一些信息没有什么用途或者显示的不太好看还有一些我们想要在报告中展示的信息却没有最近又有人问我pytest-html生成的报告能不能汉化答案是肯定的那么今天就教大家如何优化和汉化pytest-html测试报告解决上述问题
生成报告
我们先编写一个简单的测试代码生成一份原始的测试报告来看看哪些需要修改
测试代码
test_pytest_html.py ------------------------------------
Time : 2019/8/28 19:45
Auth : linux超
File : test_pytest_html.py
IDE : PyCharm
Motto: Real warriors,dare to face the bleak warning,dare to face the incisive error!
QQ : 28174043qq.com
GROUP: 878565760
------------------------------------import pytestdef login(username, password):模拟登录user linux超pwd linux超哥if user username and pwd password:return {code: 1001, msg: 登录成功, data: None}else:return {code: 1000, msg: 用户名或密码错误, data: None}test_data [# 测试数据{case: 用户名正确, 密码正确,user: linux超,pwd: linux超哥,expected: {code: 1001, msg: 登录成功, data: None}},{case: 用户名正确, 密码为空,user: linux超,pwd: ,expected: {code: 1000, msg: 用户名或密码错误, data: None}},{case: 用户名为空, 密码正确,user: ,pwd: linux超哥,expected: {code: 1000, msg: 用户名或密码错误, data: None}},{case: 用户名错误, 密码错误,user: linux,pwd: linux,expected: {code: 1000, msg: 用户名或密码错误, data: None}}
]class TestLogin(object):pytest.mark.parametrize(data, test_data)def test_login(self, data):result login(data[user], data[pwd])assert result data[expected]if __name__ __main__:pytest.main([-sv, D:\PythonTest\MyPytestHtml\pytest_html_optimization, --html, report.html])
原始报告 修改Environment
可以看到原始的测试报告里面的Environment中所有的信息和我们的被测系统的环境关系不是很大主要的信息其实是一些开发环境那么如果我想添加或者删除一些信息比如删除Java_Home添加测试接口地址该如何添加讷
我们需要在项目的根目录新键contest.py文件文件中添加如下代码
def pytest_configure(config):# 添加接口地址与项目名称config._metadata[项目名称] Linux超博客园自动化测试项目v1.0config._metadata[接口地址] https://www.cnblogs.com/linuxchao/# 删除Java_Homeconfig._metadata.pop(JAVA_HOME)
修改后的效果 修改Summary
原始的Summary部分只显示了测试用例数及用例执行时间那么如果我们想在这个位置添加测试人员等一些信息该如何实现同样在conftest.py文件中添加如下代码
pytest.mark.optionalhook
def pytest_html_results_summary(prefix):prefix.extend([html.p(所属部门: xx测试中心)])prefix.extend([html.p(测试人员: Linux超)])
修改后的效果 修改Results
Results主要展示的是测试结果信息而且这里也有一些不符合我们实际需求的信息比如Test列显示的内容很长它主要是测试用例所在的路径及测试类测试用例及测试数据拼接而成的可读性很差从这个描述根本看不出来我们的测试用例测试的是什么所以我们希望它能这样显示测试用例名称[user用户名-pwd密码] 如测试用户名正确密码正确[userLinux超-pwdLinux超哥]下面我们就来实现这样的效果
优化Test
先手我们分析一波源码看一下原始的测试报告的Test列表的信息是怎么生成的。找到我们pytest-html插件的安装位置打开plugin.py文件你会发现这样一块代码
1 class TestResult:
2 def __init__(self, outcome, report, logfile, config):
3 self.test_id report.nodeid
4 if getattr(report, when, call) ! call:
5 self.test_id ::.join([report.nodeid, report.when])
6 self.time getattr(report, duration, 0.0)
7 self.outcome outcome
第3行5行就是报告中Test信息的来源了test_pytest_html.py::TestLogin::test_login[data0] 这样一条信息实际是用例的nodeid而【data0】是测试用例参数化时的每个参数我之前写过一篇关于参数化方法pytest.mark.parametrize(data, test_data)的参数ids作用的文章ids的作用主要就是用来标记测试用例(不知道的可以去看一下那篇文章)增加测试用例执行后输出信息的可读性因此我们可以使用这个参数来改变【data0】让它显示我们的测试数据ok在我们的测试代码中添加并修改如下代码
# 改变输出结果
ids [测试{}-[用户名:{}-密码:{}-预期:{}].format(data[case], data[user], data[pwd], data[expected]) for data in test_data
]class TestLogin(object):# 添加ids参数pytest.mark.parametrize(data, test_data, idsids)def test_login(self, data):result login(data[user], data[pwd])assert result data[expected]
修改完之后再次执行我们的测试代码生成测试报告 很遗憾中文部分显示的都是乱码还得继续修改
解决中文乱码
在conftest.py文件中继续添加如下代码
import pytest
from py._xmlgen import htmlpytest.mark.hookwrapper
def pytest_runtest_makereport(item):outcome yieldreport outcome.get_result()getattr(report, extra, [])report.nodeid report.nodeid.encode(utf-8).decode(unicode_escape) # 解决乱码
再次执行测试代码查看报告输出 中文已经可以正常显示了很开心但是前面还是有一堆的目录及测试类我仍然不想要那么我们继续修改
删除多余部分
要删除前面多余的部分接下来只能通过修改报告的html了因为源码中我实在没找到在哪里能够修改这个显示我们查看一下html报告的页面元素属性 看到这里你想到用什么方法来修改了嘛我想到的是使用js代码改变这个元素的innerText, 我们先实验一下切换到【控制台】依次执行如下代码
// 找到Test列中所有的表格元素
var test_name document.getElementBysClassName(col-name);
// 修改第1个表格的innerText属性
test_name[0].innerText test_name[0].innerText.split(\[)[1].split([\])[0]; // 以[符号分割一次再以]分割一次得到目标字符串 以上带代码只能修改一个表格所以要修改多个表格只能使用循环了再次重写js代码
var case_name_td document.getElementsByClassName(col-name)for(var i 0; i case_name_td.length; i)try{case_name_td[i].innerText case_name_td[i].innerText.split(\[)[1].split(\])[0];}catch(err){// 如果表格中没有[]会抛异常如果抛异常我就显示null如果你想显示别的东西自己改吧因为通常只要我们使用参数化就有[]显示case_name_td[i].innerText null;}
js代码我们已经写好了 但是我们要放在哪里讷又是个问题通过查看报告的html源码我发现在html代码的开头引入了这样一些代码 在pytest-html插件的源码中发现插件的resource目录下有一个main.js文件里面的代码就是上述html代码中的js脚本一模一样的 而且在main.js中确实存在一个init()方法通过以上分析应该不难猜测生成测试报告时会自动把main.js文件加载到html中而且是从init()方法开始的因此我们尝试一下把我们编写的js代码放到init()方法内部实验一下
function init () {reset_sort_headers();add_collapse();show_filters();toggle_sort_states(find(.initial-sort));find_all(.sortable).forEach(function(elem) {elem.addEventListener(click,function(event) {sort_column(elem);}, false)});// 修改用例报告显示的用例名称 add by linux超var case_name_td document.getElementsByClassName(col-name)for(var i 0; i case_name_td.length; i)try{case_name_td[i].innerText case_name_td[i].innerText.split(\[)[1].split(\])[0];}catch(err){// 如果表格中没有[]会抛异常如果抛异常我就显示null如果你想显示别的东西自己改吧因为通常只要我们使用参数化就有[]显示case_name_td[i].innerText null;}};
添加完之后记得保存再次执行测试代码查看测试报告
修改后的效果 你没有看错确实成功了小小成就感还是有的哈哈
删除Links
报告中的links从来没看见有内容过所以我打算把这一列删除在contest.py文件中添加如下代码
pytest.mark.optionalhook
def pytest_html_results_table_header(cells):cells.pop(-1) # 删除link列pytest.mark.optionalhook
def pytest_html_results_table_row(report, cells):cells.pop(-1) # 删除link列
修改后的效果 增加失败截图与用例描述
用例添加失败截图和添加一列用例的描述信息在之前文章中已经说过了所以你可以通过以下链接去看我之前的文章错误截图只有web自动化测试才会有哦
https://www.cnblogs.com/linuxchao/p/linuxchao-pytest-report.html
https://www.cnblogs.com/linuxchao/p/linuxchao-pytest-Actual.html
完整的conftest.py代码
仅供参考 conftest.py
汉化报告
最后一步汉化我们的测试报告因为都是英文的可能有的同学不太喜欢或者说领导不太喜欢接下来就开始我们的汉化之路汉化还是比较简单的 只要小心谨慎即可
声明以下修改的所有文件均存在pytest-html插件的源码目录下 修改plugin.py
plugin.py文件主要用来生成测试报告的html代码的因此汉化肯定离不开修改这个文件了接下来一步一步按照我的步骤修改吧(注释部分是源码紧接着的是我修改后的代码)
# if len(log) 0:
# log html.div(class_empty log)
# log.append(No log output captured.)
if len(log) 0: # modify by linux超log html.div(class_empty log)log.append(未捕获到日志)
additional_html.append(log)
# head html.head(
# html.meta(charsetutf-8),
# html.title(Test Report),
# html_css)
head html.head( # modify by linux超html.meta(charsetutf-8),html.title(测试报告),html_css)
# outcomes [Outcome(passed, self.passed),
# Outcome(skipped, self.skipped),
# Outcome(failed, self.failed),
# Outcome(error, self.errors, labelerrors),
# Outcome(xfailed, self.xfailed,
# labelexpected failures),
# Outcome(xpassed, self.xpassed,
# labelunexpected passes)]
outcomes [Outcome(passed, self.passed, label通过),Outcome(skipped, self.skipped, label跳过),Outcome(failed, self.failed, label失败),Outcome(error, self.errors, label错误),Outcome(xfailed, self.xfailed,label预期失败),Outcome(xpassed, self.xpassed,label预期通过)]
# if self.rerun is not None:
# outcomes.append(Outcome(rerun, self.rerun))
if self.rerun is not None:outcomes.append(Outcome(重跑, self.rerun))# summary [html.p(
# {0} tests ran in {1:.2f} seconds. .format(
# numtests, suite_time_delta)),
# html.p(sfsf,
# class_filter,
# hiddentrue)]
summary [html.p( # modify by linux超执行了{0}个测试用例, 历时:{1:.2f}秒 . .format(numtests, suite_time_delta)),html.p((取消)勾选复选框, 以便筛选测试结果,class_filter,hiddentrue)]
# cells [
# html.th(Result,
# class_sortable result initial-sort,
# colresult),
# html.th(Test, class_sortable, colname),
# html.th(Duration, class_sortable numeric, colduration),
# html.th(Links)]# modify by linux超
cells [html.th(通过/失败,class_sortable result initial-sort,colresult),html.th(用例, class_sortable, colname),html.th(耗时, class_sortable numeric, colduration),html.th(链接)]
# results [html.h2(Results), html.table([html.thead(
# html.tr(cells),
# html.tr([
# html.th(No results found. Try to check the filters,
# colspanlen(cells))],
# idnot-found-message, hiddentrue),
# idresults-table-head),
# self.test_logs], idresults-table)]
results [html.h2(测试结果), html.table([html.thead( # modify by linux超html.tr(cells),html.tr([html.th(无测试结果, 试着选择其他测试结果条件,colspanlen(cells))],idnot-found-message, hiddentrue),idresults-table-head),self.test_logs], idresults-table)]
#html.p(Report generated on {0} at {1} by .format(
html.p(生成报告时间{0} {1} Pytest-Html版本.format( # modify by linux超
# body.extend([html.h2(Summary)] summary_prefix
# summary summary_postfix)
body.extend([html.h2(用例统计)] summary_prefix # modify by linux超 summary summary_postfix)
# environment [html.h2(Environment)]
environment [html.h2(测试环境)] # modify by linux超
plugin.py文件到这就修改完了你可以生成报告查看以下效果接下来修改main.js
修改main.js
/*
function add_collapse() {// Add links for show/hide allvar resulttable find(table#results-table);var showhideall document.createElement(p);showhideall.innerHTML a hrefjavascript:show_all_extras()Show all details/a / a hrefjavascript:hide_all_extras()Hide all details/a;resulttable.parentElement.insertBefore(showhideall, resulttable);
*/
function add_collapse() { // modify by linux超// Add links for show/hide allvar resulttable find(table#results-table);var showhideall document.createElement(p);showhideall.innerHTML a hrefjavascript:show_all_extras()显示详情/a / a hrefjavascript:hide_all_extras()隐藏详情/a;resulttable.parentElement.insertBefore(showhideall, resulttable);
修改style.css
最后修改style.css这个文件主要用来美化测试报告的如果你对css比较熟悉可以自定义报告样式
.expander::after {content: (展开详情);color: #BBB;font-style: italic;cursor: pointer;
}
.collapser::after {content: (隐藏详情);color: #BBB;font-style: italic;cursor: pointer;
}
到目前为止所有的汉化都已经完成了接下来我们执行一下测试代码查看一下报告的效果
最后报告效果 安装汉化版插件
为了方便大家使用跳过修改源码过程我已经把汉化版的pytest-html插件源码上传到了我的GitHub https://github.com/13691579846/pytest-html下面说一下使用方法
方法1
1.如果你已经安装过了pytest-html请先卸载 pip uninstall pytest-html
2.下载插件源码到本地git clone https://github.com/13691579846/pytest-html 或者按照下图方法下载 3.打开CMD切换到插件中setup.py文件所在目录执行如下命令
python setup.py install
方法2
1.如果你未安装过pytest-html插件请先执行如下命令安装
pip install pytest-html
2.按照方法1的方式下载汉化后的插件把下载后的插件中的部分分件覆盖到python第三方库目录下pytest-html下的部分文件 方法3
直接下载汉化后的源码把源码中的pytest_html直接丢到python第三方库存放目录也可
方法4
最后一个方法就是按照我的文章步骤一步一步修改自己的源码
方法5
下载pytest源码后使用pip install ./pytest-html 安装 这是我整理的《2024最新Python自动化测试全套教程》以及配套的接口文档/项目实战【网盘资源】需要的朋友可以下方视频的置顶评论获取。肯定会给你带来帮助和方向。 【已更新】B站讲的最详细的Python接口自动化测试实战教程全集实战最新版
