最快最便捷的pytest使用allure测试报告

一、前言

最近通过群友了解到了allure这个报告，开始还不以为然，但还是逃不过真香定律。

经过试用之后，发现这个报告真的很好，很适合自动化测试结果的展示。下面说说我的探索历程吧。

选用的项目为Selenium自动化测试Pytest框架实战，在这个项目的基础上说allure报告。

二、allure安装

首先安装python的allure-pytest包

<code class="language-shell">pip install allure-pytest
</code>

然后安装allure的command命令行程序

MacOS直接使用homebrew工具执行 brew install allure 即可安装，不用配置下载包和配置环境

在GitHub下载安装程序https://github.com/allure-framework/allure2/releases

但是由于GitHub访问太慢，我已经下载好并放在了群文件里面

下载完成后解压放到一个文件夹。我的路径是D:\Program Files\allure-2.13.3

然后配置环境变量：在系统变量path中添加D:\Program Files\allure-2.13.3\bin，然后确定保存。

打开cmd，输入allure，如果结果显示如下则表示成功了：

<code class="language-powershell">C:\Users\hoou>allure
Usage: allure [options] [command] [command options]
Options:
--help
Print commandline help.
-q, --quiet
Switch on the quiet mode.
Default: false
-v, --verbose
Switch on the verbose mode.
Default: false
--version
Print commandline version.
Default: false
Commands:
generate Generate the report
Usage: generate [options] The directories with allure results
Options:
-c, --clean
Clean Allure report directory before generating a new one.
Default: false
--config
Allure commandline config path. If specified overrides values from
--profile and --configDirectory.
--configDirectory
Allure commandline configurations directory. By default uses
ALLURE_HOME directory.
--profile
Allure commandline configuration profile.
-o, --report-dir, --output
The directory to generate Allure report into.
Default: allure-report
serve Serve the report
Usage: serve [options] The directories with allure results
Options:
--config
Allure commandline config path. If specified overrides values from
--profile and --configDirectory.
--configDirectory
Allure commandline configurations directory. By default uses
ALLURE_HOME directory.
-h, --host
This host will be used to start web server for the report.
-p, --port
This port will be used to start web server for the report.
Default: 0
--profile
Allure commandline configuration profile.
open Open generated report
Usage: open [options] The report directory
Options:
-h, --host
This host will be used to start web server for the report.
-p, --port
This port will be used to start web server for the report.
Default: 0
plugin Generate the report
Usage: plugin [options]
Options:
--config
Allure commandline config path. If specified overrides values from
--profile and --configDirectory.
--configDirectory
Allure commandline configurations directory. By default uses
ALLURE_HOME directory.
--profile
Allure commandline configuration profile.
</code>

三、allure初体验

改造一下之前的测试用例代码

<code class="language-python">#!/usr/bin/env python3
# -*- coding:utf-8 -*-
import re
import pytest
import allure
from utils.logger import log
from common.readconfig import ini
from page_object.searchpage import SearchPage
@allure.feature("测试百度模块")
class TestSearch:
 @pytest.fixture(scope='function', autouse=True)
def open_baidu(self, drivers):
"""打开百度"""
search = SearchPage(drivers)
search.get_url(ini.url)
 @allure.story("搜索selenium结果用例")
def test_001(self, drivers):
"""搜索"""
search = SearchPage(drivers)
search.input_search("selenium")
search.click_search()
result = re.search(r'selenium', search.get_source)
log.info(result)
assert result
 @allure.story("测试搜索候选用例")
def test_002(self, drivers):
"""测试搜索候选"""
search = SearchPage(drivers)
search.input_search("selenium")
log.info(list(search.imagine))
assert all(["selenium" in i for i in search.imagine])
if __name__ == '__main__':
pytest.main(['TestCase/test_search.py', '--alluredir', './allure'])
os.system('allure serve allure')
</code>

然后运行一下：

注意：如果你使用的是pycharm编辑器，请跳过该运行方式，直接使用.bat或.sh的方式运行

<code class="language-shell">***
------------------------------- generated html file: file://C:\Users\hoou\PycharmProjects\web-demotest\report.html --------------------------------
Results (12.97s):
2 passed
Generating report to temp directory...
Report successfully generated to C:\Users\hoou\AppData\Local\Temp\112346119265936111\allure-report
Starting web server...
2020-06-18 22:52:44.500:INFO::main: Logging initialized @1958ms to org.eclipse.jetty.util.log.StdErrLog
Server started at <http://172.18.47.241:6202/>. Press <Ctrl+C> to exit
</code>

命令行会出现如上提示，接着浏览器会自动打开：

点击左下角En即可选择切换为中文。

是不是很清爽很友好，比pytest-html更舒服。

四、allure装饰器介绍

五、报告的生成和展示

刚才的两个命令：

生成allure原始报告到report/allure目录下，生成的全部为json或txt文件。

<code class="language-powershell">pytest TestCase/test_search.py --alluredir ./allure
</code>

在一个临时文件中生成报告并启动浏览器打开

<code class="language-powershell">allure serve allure
</code>

但是在关闭浏览器之后这个报告就再也打不开了。不建议使用这种。

所以我们必须使用其他的命令，让allure可以指定生成的报告目录。

我们在项目的根目录中创建run_case.py文件，内容如下：

<code class="language-python">#!/usr/bin/env python3
# -*- coding:utf-8 -*-
import sys
import subprocess
WIN = sys.platform.startswith('win')
def main():
"""主函数"""
steps = [
"venv\\Script\\activate" if WIN else "source venv/bin/activate",
"pytest --alluredir allure-results --clean-alluredir",
"allure generate allure-results -c -o allure-report",
"allure open allure-report"
]
for step in steps:
subprocess.run("call " + step if WIN else step, shell=True)
if __name__ == "__main__":
main()
</code>

命令释义：

1、使用pytest生成原始报告，里面大多数是一些原始的json数据，加入--clean-alluredir参数清除allure-results历史数据。

<code class="language-powershell">pytest --alluredir allure-results --clean-alluredir
</code>

--clean-alluredir 清除allure-results历史数据

2、使用generate命令导出HTML报告到新的目录

<code class="language-powershell">allure generate allure-results -o allure-report
</code>

-c 在生成报告之前先清理之前的报告目录
-o 指定生成报告的文件夹

3、使用open命令在浏览器中打开HTML报告

<code class="language-powershell">allure open allure-report
</code>

好了我们运行一下该文件。

<code class="language-powershell">Results (12.85s):
2 passed
Report successfully generated to c:\Users\hoou\PycharmProjects\web-demotest\allure-report
Starting web server...
2020-06-18 23:30:24.122:INFO::main: Logging initialized @260ms to org.eclipse.jetty.util.log.StdErrLog
Server started at <http://172.18.47.241:7932/>. Press <Ctrl+C> to exit
</code>

可以看到运行成功了。

在项目中的allure-report文件夹也生成了相应的报告。

六、allure发生错误截图

上面的用例全是运行成功的，没有错误和失败的，那么发生了错误怎么样在allure报告中生成错误截图呢，我们一起来看看。

首先我们先在config/conf.py文件中添加一个截图目录和截图文件的配置。

<code class="language-python">+++
class ConfigManager(object):
...
 @property
def screen_path(self):
"""截图目录"""
screenshot_dir = os.path.join(self.BASE_DIR, 'screen_capture')
if not os.path.exists(screenshot_dir):
os.makedirs(screenshot_dir)
now_time = dt_strftime("%Y%m%d%H%M%S")
screen_file = os.path.join(screenshot_dir, "{}.png".format(now_time))
return now_time, screen_file
...
+++
</code>

然后我们修改项目目录中的conftest.py：

<code class="language-python">#!/usr/bin/env python3
# -*- coding:utf-8 -*-
import base64
import pytest
import allure
from py.xml import html
from selenium import webdriver
from config.conf import cm
from common.readconfig import ini
from utils.times import timestamp
from utils.send_mail import send_report
driver = None
@pytest.fixture(scope='session', autouse=True)
def drivers(request):
global driver
if driver is None:
driver = webdriver.Chrome()
driver.maximize_window()
def fn():
driver.quit()
request.addfinalizer(fn)
return driver
@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_makereport(item):
"""
当测试失败的时候，自动截图，展示到html报告中
:param item:
"""
pytest_html = item.config.pluginmanager.getplugin('html')
outcome = yield
report = outcome.get_result()
report.description = str(item.function.__doc__)
extra = getattr(report, 'extra', [])
if report.when == 'call' or report.when == "setup":
xfail = hasattr(report, 'wasxfail')
if (report.skipped and xfail) or (report.failed and not xfail):
screen_img = _capture_screenshot()
if screen_img:
html = '<div><img src="data:image/png;base64,%s" alt="screenshot" style="width:1024px;height:768px;" ' \
'onclick="window.open(this.src)" align="right"/></div>' % screen_img
extra.append(pytest_html.extras.html(html))
report.extra = extra
def pytest_html_results_table_header(cells):
cells.insert(1, html.th('用例名称'))
cells.insert(2, html.th('Test_nodeid'))
cells.pop(2)
def pytest_html_results_table_row(report, cells):
cells.insert(1, html.td(report.description))
cells.insert(2, html.td(report.nodeid))
cells.pop(2)
def pytest_html_results_table_html(report, data):
if report.passed:
del data[:]
data.append(html.div('通过的用例未捕获日志输出.', class_='empty log'))
def pytest_html_report_title(report):
report.title = "pytest示例项目测试报告"
def pytest_configure(config):
config._metadata.clear()
config._metadata['测试项目'] = "测试百度官网搜索"
config._metadata['测试地址'] = ini.url
def pytest_html_results_summary(prefix, summary, postfix):
# prefix.clear() # 清空summary中的内容
prefix.extend([html.p("所属部门: XX公司测试部")])
prefix.extend([html.p("测试执行人: 随风挥手")])
def pytest_terminal_summary(terminalreporter, exitstatus, config):
"""收集测试结果"""
result = {
"total": terminalreporter._numcollected,
'passed': len(terminalreporter.stats.get('passed', [])),
'failed': len(terminalreporter.stats.get('failed', [])),
'error': len(terminalreporter.stats.get('error', [])),
'skipped': len(terminalreporter.stats.get('skipped', [])),
# terminalreporter._sessionstarttime 会话开始时间
'total times': timestamp() - terminalreporter._sessionstarttime
}
print(result)
if result['failed'] or result['error']:
send_report()
def _capture_screenshot():
"""截图保存为base64"""
now_time, screen_file = cm.screen_path
driver.save_screenshot(screen_file)
allure.attach.file(screen_file,
"失败截图{}".format(now_time),
allure.attachment_type.PNG)
with open(screen_file, 'rb') as f:
imagebase64 = base64.b64encode(f.read())
return imagebase64.decode()
</code>