最新翻译(2020/12/1)已更新在个人博客:https://www.nothinghere.cn/gauge/overview/
测试结果报告应该是易于理解,对所有利益相关者应该都是有用的。
HTML报告
报告使用HTML-report
插件生成,默认情况HTML报告被添加到项目中。
specs执行后,html报告默认生成在项目的reports
目录内。
备注
- 一个全面的测试结果报告模版,以HTML格式作为准备,提供总体总结,深入了解每个阶段和功能测试期间执行的测试用例和花费的时间
- 它提供了在运行期间发现的缺陷的细节
- 它通过颜色标明测试结果:失败(红色),通过(绿色)和跳过(灰色)
- 可以使用堆栈跟踪和截图进行失败分析(捕获除了未覆盖的)
- 跳过的测试用例可以通过给出的原因来分析
- 报告中的自定义信息允许用户在运行时添加信息
配置
HTML报告插件可以通过项目中的env/default.properties
文件中的属性设置来配置。
可配置属性如下:
gague_reports_dir
- 指定执行报告生成目录的路径
- 应该是相对于项目目录或者绝对路径,默认情况下设置为项目中的
reports
目录
overwrite_reports
- 如果报告必须覆盖每次执行结果,只保留最新的执行报告,则设置为
true
- 如果设置为
false
,则将在包含时间戳目录中的reports目录中生成执行的新报告 - 默认情况是
true
GAUGE_HTML_REPORT_THEME_PATH
- 指定自定义报告目录的路径
- 可以是相对于项目的目录或者绝对路径
- 默认情况下,使用的是
defalut
主题
重新生成报告
如果因为某些原因生成报告失败了,我们不需要再次重新运行测试。
HTML报告插件现在会在报告目录的根目录下生成最新的运行结果文件last_run_result.json
,在同一位置下还有一个html-report可执行文件的符号链接。
生成报告
- 找到reports目录
- 执行
./html-report –input=last_run_result.json –output=”/some/path”
注意:输入目录已创建,留意不要覆盖已有的目录。
生成报告采用默认的主题,可以使用--theme
标志来指定自定义主题。
XML报告
XML报告插件生成JUnit XML测试结果文档可供比如Go,jenkins工具来读取。当specs被执行时,xml报告便生成在项目的reports目录。XML报告格式基于Junit XML Schema。
简单的XML报告文档
<testsuites>
<testsuite id="1" tests="1" failures="0" package="specs/hello_world.spec" time="0.002" timestamp="2015-09-09T13:52:00" name="Specification Heading" errors="0" hostname="INcomputer.local">
<properties></properties>
<testcase classname="Specification Heading" name="First scenario" time="0.001"></testcase>
<system-out></system-out>
<system-err></system-err>
</testsuite>
</testsuites>
安装
安装xml报告插件:
> gauge install xml-report
安装指定版本的xml报告插件使用--version
标志:
> gauge install xml-report --version 0.0.2
离线安装
如果插件应该从压缩文件安装而不是从插件库下载,请使用--file
或者-f
标志。
> gauge install xml-report --file ZIP_FILE_PATH
从Github Releases下载插件ZIP文件。
配置
为添加xml报告插件到您的项目,执行下列的命令:
> gauge add xml-report
XML报告可以通过项目中的env/default.properties
文件内的属性进行配置。
配置属性如下:
gauge_report_dir
指定生成的执行报告的目录的路径。
- 可以是相对的项目目录或者绝对路径,默认设置是项目中的
reports
目录
overwrite_reports
如果报告必须在每次执行时被覆盖,则设置为true
,因此只保留最新的执行报告。
- 如果设置为
false
,则将在包含时间戳目录中的reports目录中生成执行的新报告 - 默认情况是
true
Spectacle
它是从specs/markdown文件生成静态HTML文件的gauge插件,可以筛选specs和场景。
安装
安装:
> gauge install spectacle
安装指定版本的spectacle插件使用--version
标志:
> gauge install spectacle --version 0.0.2
离线安装:
如果插件应该从压缩文件安装而不是从插件库下载,请使用--file
或者-f
标志。
> gauge install xml-report --file ZIP_FILE_PATH
从Github Releases下载插件ZIP文件。
使用
在Gauge项目中执行下列命令导出HTML文件、
> gauge docs spectacle < path to specs dir>
简单的Spectacle报告
基于标签过滤spec/场景
标签允许您过滤spec和场景。将标签添加到报告中的文本框以查看标有某些标签的所有spec和禅境。 使用运算符标记表达式|
,&
,!
被支持。
下图中,specs和场景使用标签表达式(refactoring & !api
)过滤。
Flash
实时执行报告插件,观看测试运行变绿色或者红色。将其安装到您的CI/CD设置中,并使用浏览器连接到flash,以查看您的测试套件在做什么。
安装
安装flash插件:
> gauge install flash
安装指定版本的flash插件使用--version
标志:
> gauge install flash --version 0.0.1
离线安装:
如果插件应该从ZIP文件安装,而不是从插件库下载,使用--file
或--f
标志。
> gauge install flash --file ZIP_FILE_PATH
从Github Release下载ZIP插件。
使用
添加flash插件到您的项目,执行下列命令:
> gauge add flash
执行specs文件,然后用浏览器打开控制台输出显示的URL。
配置
flash插件可以通过项目中的env/default.properties
文件的设置来进行配置。
可以配置属性是:
FLASH_SERVER_PORT
要使用指定的端口,将FLASH_SERVER_PORT={port}
设置为环境变量,或者设置在env/default/flash.properties
文件中。
章节指引
一、安装
二、快速开始
三、深入开始
四、Gauge使用
五、语法
六、插件
七、语言特点
八、报告
九、配置
十、故障处理
十一、项目实例
十二、怎么做?