调色器插件
通过 contact-commons v1 为 CodeceptJS 添加了 Alure 插件
3⁄4 ̄ ̧漯B 这个插件在"CodeceptJS"中被贬值了,因为"诱因-通俗"v1不再被维持了. 文档和源代码被移入了这个寄存器. 此时此刻,我们不打算将其迁移到Allure v2,但是社区可以创建自己的执行
启用 Allure 记者 .
使用量
开始请安装 allure-commandline 软件包(需要Java 8)
npm install -g allure-commandline --save-dev
将此插件添加到配置文件 :
plugins: {
allure: {
enabled: true,
require: '@codeceptjs/allure-legacy',
}
}
默认情况下,引出报告将被保存到 output 目录.
启动 Allure 服务器, 并在上面的截图上看到报告:
allure serve output
配置
outputDir- 应储存诱饵报告的目录。 标准输出目录默认设置.enableScreenshotDiffPlugin- 用于添加截图 diff 的布尔旗. 要附加,tou需要附加三个文件到报告上——"diff.png","actual.png","expected.png". 见 显示屏幕截图插件
公共 API
从其他插件可以访问的公共API方法很少.
const allure = codeceptjs.container.plugins('allure');
allure 对象有下列方法:
addAttachment(name, buffer, type)- 在当前测试/套件中添加附件addLabel(name, value)- 在当前测试中添加标签addParameter(kind, name, value)- 在当前测试中添加参数createStep(name, stepFunc)- 创建一个步骤,步骤Func可以包含一个附件 使用实例:
allure.createStep('New created step', () => {
allure.addAttachment(
'Request params',
'{"clientId":123, "name":"Tom", "age":29}',
'application/json'
);
});
addScreenDiff(name, expectedImg, actualImg, diffImg)- 在当前测试中添加一个特殊的屏幕 diff 块 图像必须是代表以 base64 编码的预期图像文件内容的字符串 使用实例:
const expectedImg = fs.readFileSync('expectedImg.png', { encoding: 'base64' });
...
allure.addScreenDiff('Screen Diff', expectedImg, actualImg, diffImg);
severity(value)- 增加重度标签epic(value)- 添加史诗标签feature(value)- 添加特性标签story(value)- 添加故事标签issue(value)- 添加问题标签setDescription(description, type)- 设定描述
添加附件
在当前测试例中添加附件
参数
name[弦 [1] 附件名称buffer[负担][2] 附件缓冲type[弦 [1] 附件的 MIME 类型
添加标签
向当前测试报告添加带有给定名称和值的标签
参数
name[弦 [1] 要添加的标签名称value[弦 [1] 要添加的标签值
添加页
向当前测试报告添加带有给定类型、名称和值的参数
参数
kind[弦 [1] 要添加的参数类型name[弦 [1] 要添加的参数名称value[弦 [1] 要添加的参数值
添加Screen Diff 数据
为当前测试大小写添加一个特殊的屏幕 diff 块
参数
name[弦 [1] 屏幕 diff 块的名称expectedImg[弦 [1] 字符串代表以 base64 编码的预期图像文件的内容actualImg[弦 [1] 代表实际图像文件内容的字符串, 编码为 base64diffImg[弦 [1] 代表被编码为 base64 的 diff 图像文件内容的字符串 . 可以通过图像比较 lib 生成, 如“ 像素匹配” 或替代
创建步骤
一种在测试中创建步骤的方法.
参数
name[弦 [1] 阶之名.stepFunc[功能][3] 此步骤应执行的函数 。 (可选,默认)()=>{}(中文(简体) )
回返 任意 分步函数的结果.
设置
设置当前测试大小写的说明
参数
description[弦 [1] 测试案例说明type[弦 [1] 描述的 MIME 类型( 可选, 默认)'text/plain'(中文(简体) )
诱惑
调味记者
[4]
参数
config
诱惑
创建诱饵记录器实例
参数
config配置 诱饵记者配置( 可选, 默认){outputDir:global.output_dir}(中文(简体) )
回返 [标 [9] 诱惑记者的例子