AirtestProject 生成 Airtest 报告总出错?这份总结收好了
此文章来源于项目官方公众号:“AirtestProject”
版权声明:允许转载,但转载必须保留原链接;请勿用作商业或者非法用途
1. 前言
最近发现还是有很多同学在生成 Airtest 报告上面有一些疑惑之处,比如:
为什么用 AirtestIDE 跑脚本就可以直接生成报告,换别的编辑器就不行?
为什么按照官方示例写的生成报告的脚本,到我这里不是找不到路径就是有别的报错?
为什么我一顿操作下来,生成了空白的 Airtest 报告(有些英文报告被译成中文甚至变成了空气报告......)?
这简直可以纳入迷惑行为大赏。所以今天,我们就一起来探讨一下为什么 1 个小小的 Airtest 报告,会出现这么多问题。
2. 为什么 AirtestIDE 跑脚本可以直接生成报告?
1)正式运行.air 脚本后可直接生成报告
这里需要注意的是,使用 AirtestIDE 跑脚本可以直接生成报告的情况是,正式运行完 .air
脚本之后,可以点击 查看报告
按钮,生成并查看本地 Airtest 报告。
还可以在生成本地的报告之后,右键单击脚本名称,选择 导出报告
,导出非本地也可以查看的 Airtest 报告:
这是因为在 AirtestIDE 跑 .air
脚本时,会自动帮我们保存 log 内容,之后在点击 查看报告
的按钮时,就会根据自动保存的 log 内容,来生成 Airtest 测试报告。
这从点击运行脚本和点击生成报告的按钮命令行可以看出来:
# 运行.air脚本的命令行
"D:\demo\AirtestIDE-win-1.2.13 (2)\AirtestIDE\AirtestIDE" runner "D:\demo\multi\multi-device-runner-master\test02.air" --device android://127.0.0.1:5037/HT7C51A04625?cap_method=MINICAP&&ori_method=MINICAPORI&&touch_method=MAXTOUCH --log "D:/test/test01\dc1584de62ad6aff26d33afe5ce0bc54"
============================================================
# 生成报告的命令行
============================================================
Generating HTML log:
D:\demo\AirtestIDE-win-1.2.13 (2)\AirtestIDE\AirtestIDE reporter D:\demo\multi\multi-device-runner-master\test02.air --log_root D:/test/test01\dc1584de62ad6aff26d33afe5ce0bc54 --outfile D:\test\test01\dc1584de62ad6aff26d33afe5ce0bc54\log.html --static_root D:\demo\AirtestIDE-win-1.2.13 (2)\AirtestIDE\airtest\report --lang zh --plugin airtest_selenium.report poco.utils.airtest.report
尽管我们在 .air
脚本里面,没有编写任何保存 log 内容的语句,但是 AirtestIDE 会自动帮我们保存到默认 Log 存放路径下:
我们可以看到,运行脚本时保存 log 的参数 --log "D:/test/test01\dc1584de62ad6aff26d33afe5ce0bc54
,和生成报告时指定的log_root
参数 --log_root D:/test/test01\dc1584de62ad6aff26d33afe5ce0bc54
是一致的,表明运行脚本后保存的 log 内容,会在生成报告的时候用到。
而 AirtestIDE 则是自动帮我们做好了这些事情,我们就可以非常轻松地在 AirtestIDE 运行脚本之后一键生成测试报告。
2)全选脚本右键运行后不能生成测试报告
有些同学在 AirtestIDE 运行脚本时,全选代码然后右键选择 只运行选中代码
,脚本运行之后,再点击 查看报告
时发现,弹窗提示 There's no log.txt file in log-directory
:
这是因为右键 只运行选中代码
并不会自动帮我们保存 log 内容,而报告生成需要依赖 log 内容,才会出现找不到 log.txt
文件的提示。
所以通过这种方式来 “调试” 脚本的同学,并不能一键生成 Airtest 测试报告,请点击 运行脚本
按钮正式运行完脚本之后,再来一键生成测试报告。
3)在 AirtestIDE 运行纯.py 脚本不能一键生成测试报告
在 AirtestIDE 中,运行 纯py
脚本和运行 .air
脚本的区别非常大,从运行的命令行可以看出:
# 运行纯py脚本的命令行
"D:\demo\AirtestIDE-win-1.2.13 (2)\AirtestIDE\AirtestIDE" pyrunner "D:\demo\test_log.py"
可以看到,此时 AirtestIDE 不会帮助我们补充任何运行参数,包含设备参数、log 保存路径参数等等。
所以在 AirtestIDE 运行 纯py
脚本,如需生成报告,则在编写脚本时,就需要加入保存 log 内容之类的语句,比如:
# -*- encoding=utf8 -*-
__author__ = "AirtestProject"
from airtest.core.api import *
from airtest.cli.parser import cli_setup
if not cli_setup():
auto_setup(__file__,devices=["android://127.0.0.1:5037/HT7C51A04625"],logdir=r"D:\demo\test_log")
这样运行结束之后,才会帮我们保存 log 内容到指定的 log 保存路径下,之后点击 查看报告
按钮时,手动选择设置的 log 保存路径即可:
3. 脱离 AirtestIDE 怎么生成测试报告?
1)使用 simple_report 接口
simple_report
接口,它其实是 1 个简化版的生成报告的接口,可以减少同学们的理解成本和使用成本:
-
filepath
:指定脚本的路径 -
logpath
:指定 log 内容的路径 -
logfile
:指定 log.txt 文件的路径 -
output
:指定 HTML 报告的生成路径,必须以.html
结尾
如果同学们不指定任何参数,该接口会使用默认的参数生成 1 份 HTML 格式的报告,output='log.html'
表示在当前脚本路径下生成名为 log.html
的 airtest 报告:
from airtest.report.report import simple_report
simple_report(__file__)
如果指定了 output
参数,则会按指定路径生成报告:
from airtest.core.api import *
from airtest.report.report import simple_report
auto_setup(__file__,logdir=True)
simple_report(__file__,logpath=True,output=r"D:\test\report02\log.html")
logdir
与logpath
生成 Airtest 报告需要依赖脚本运行过程保存的 log,所以如需生成报告,就需要保存脚本运行过程的 log,auto_setup
接口的logdir
参数可以设置 log 保存路径;使用simple_report
生成报告时,就可以设置logpath
,到logdir
指定的 log 保存路径下面去找脚本对应的 log 内容。
2)使用 LogToHtml()
类
使用脚本生成 Airtest 报告的另外一种方式是使用LogToHtml()
类:
这个类的参数相对于 simple_report()
就复杂的多了,包含:
-
script_root
,指定脚本路径 -
log_root
,指定 log 文件的路径 -
static_root
,指定部署静态资源的服务器路径 -
export_dir
,设置导出报告的存放路径 -
script_name
,脚本名称 -
logfile
,指定 log 文件 log.txt 的路径 -
lang
,指定报告的语言(中文:zh;英文:en) -
plugins
,指定报告插件,使用了 poco 或者 airtest-selenium 会用到
示例如下,我们在指定路径 D:\test\report02
中导出了 D:\test\report01.air
脚本的运行报告,报告语言为英文:
from airtest.report.report import LogToHtml
h1 = LogToHtml(script_root=r'D:\test\report01.air', log_root=r"D:\test\report01.air\log", export_dir=r"D:\test\report02" ,logfile=r'D:\test\report01.air\log\log.txt', lang='en', plugins=None)
h1.report()
从示例中我们可以看出,使用LogToHtml
类生成报告,我们需要先实例化一个LogToHtml
类,然后再调用类方法report()
,即可生成 Airtest 报告。
logdir
与log_root
上文我们已经提到,生成 Airtest 报告需要依赖脚本运行的 log 内容,所以我们在生成报告之前,需要保存脚本运行的 log 内容,然后生成报告时再指定参数让它去找对应的 log 内容。
以上述例子为例,我们在auto_setup
中指定logdir=True
,即将 log 内容保存在当前脚本的路径下面;那生成报告时,我们再利用LogToHtml
的log_root
参数,来指定 log 的查找路径。
实际上,我们将上述示例中的log_root=r"D:\test\report01.air\log"
改成log_root=True
也是一样的效果,即 log 保存路径logdir
与 log 查找路径log_root
必须是相同的。
更多详细内容可以参看我们官网文档教程: https://airtest.doc.io.netease.com/IDEdocs/airtest_framework/6_airtest_report/#airtest 。
4. 脱离 AirtestIDE 生成报告报错怎么办?
1)报错某个路径找不到
通常有 2 种路径找不到的情况,一种是在指定参数,比如指定 log 内容、log 文件路径时,给了不正确的路径。此时只要观察报错具体是哪个路径给错了,然后修改成正确的路径即可。特别是填写相对路径的同学,如果实在搞不清楚相对路径的情况,就直接填写绝对路径好了。
第二种是,指定报告生成路径、或者报告导出路径时,指定了一个新的路径,即同学们期望能在新路径下生成/导出报告,但实际上,这个新路径目前是不存在的。这种情况要特别注意,不论是生成报告路径还是导出报告路径,都必须是已经建好真实存在的路径,路径不存在 Airtest 也不会帮我们新建该路径。所以请同学们事先建好目标路径,再来填参!!!
2)为什么生成了空的/空气报告?
空气报告,即 Airtest 空的英文报告,被浏览器翻译成了空气报告。那为什么我们会生成空的测试报告呢?
通常是因为新手同学,将生成报告的代码放置在了脚本开头,下面跟了一系列实际操作:
# -*- encoding=utf8 -*-
__author__ = "AirtestProject"
from airtest.core.api import *
from airtest.report.report import simple_report,LogToHtml
auto_setup(__file__,logdir=True)
simple_report(__file__,log_path=True)
touch(Template(r"tpl1637219700366.png", record_pos=(-0.103, 0.27), resolution=(1920, 1080)))
sleep(1.0)
snapshot(msg="请填写测试点.")
# 此处省略N条脚本
这样编写的后果是,即使我们成功运行了整个脚本,但最后打开生成的报告查看时,会发现是一个空的报告;这是因为在脚本开头已经生成了测试报告,此时 log 未记录任何步骤的执行情况(实际运行步骤都在生成报告的脚本之后),所以将获得一个空的测试报告。
Airtest 官网:https://airtest.netease.com/
Airtest 教程官网:https://airtest.doc.io.netease.com/
搭建企业私有云服务:https://airlab.163.com/b2b
官方答疑 Q 群:117973773
呀~这么认真都看到这里啦,帮忙点击左下角的爱心,给我点个赞支持一下把,灰常感谢~