规范报告器

一个 WebdriverIO 插件，用于以规范样式报告。

安装

最简单的方法是将 @wdio/spec-reporter 作为开发依赖项保留在您的 package.json 中，通过

npm install @wdio/spec-reporter --save-dev

有关如何安装 WebdriverIO 的说明，请参见此处。

配置

以下代码显示了默认的 wdio 测试运行器配置。只需将 'spec' 作为报告器添加到数组中。

// wdio.conf.js
module.exports = {
  // ...
  reporters: ['dot', 'spec'],
  // ...
};

规范报告器选项

符号

为 passed、failed 或 skipped 测试提供自定义符号

类型：object 默认值：{passed: '✓', skipped: '-', failed: '✖'}

示例

[
  "spec",
  {
    symbols: {
      passed: '[PASS]',
      failed: '[FAIL]',
    },
  },
]

sauceLabsSharableLinks

默认情况下，Sauce Labs 中的测试结果只能由同一团队的团队成员查看，而不能由不同团队的团队成员查看。此选项将默认启用可共享链接，这意味着在 Sauce Labs 中执行的所有测试都可以供所有人查看。只需在报告器选项中添加 sauceLabsSharableLinks: false（如下所示）即可禁用此功能。

类型：boolean 默认值：true

示例

[
  "spec",
  {
    sauceLabsSharableLinks: false,
  },
]

onlyFailures

仅打印失败的规范结果。

类型：boolean 默认值：false

示例

[
  "spec",
  {
    onlyFailures: true,
  },
]

addConsoleLogs

设置为 true 以在最终报告中显示步骤中的控制台日志

类型：boolean 默认值：false

[
  "spec",
  {
    addConsoleLogs: true,
  },
]

realtimeReporting

设置为 true 以实时显示测试状态，而不仅仅是在运行结束时显示

类型：boolean 默认值：false

[
  "spec",
  {
    realtimeReporting: true,
  },
]

showPreface

设置为 false 以禁用报告中的 [ MutliRemoteBrowser ... ] 前缀。

类型：boolean 默认值：true

[
  "spec",
  {
    showPreface: false,
  },
]

将其设置为 false 时，您将看到如下输出：

Running: loremipsum (v50) on Windows 10
Session ID: foobar

» /foo/bar/loo.e2e.js
Foo test
   green ✓ foo
   green ✓ bar

» /bar/foo/loo.e2e.js
Bar test
   green ✓ some test
   red ✖ a failed test
   red ✖ a failed test with no stack

而使用 true（默认值）时，每一行都将以该前缀为前缀

[loremipsum 50 Windows 10 #0-0] Running: loremipsum (v50) on Windows 10
[loremipsum 50 Windows 10 #0-0] Session ID: foobar
[loremipsum 50 Windows 10 #0-0]
[loremipsum 50 Windows 10 #0-0] » /foo/bar/loo.e2e.js
[loremipsum 50 Windows 10 #0-0] Foo test
[loremipsum 50 Windows 10 #0-0]    green ✓ foo
[loremipsum 50 Windows 10 #0-0]    green ✓ bar
[loremipsum 50 Windows 10 #0-0]
[loremipsum 50 Windows 10 #0-0] » /bar/foo/loo.e2e.js
[loremipsum 50 Windows 10 #0-0] Bar test
[loremipsum 50 Windows 10 #0-0]    green ✓ some test
[loremipsum 50 Windows 10 #0-0]    red ✖ a failed test
[loremipsum 50 Windows 10 #0-0]    red ✖ a failed test with no stack
[loremipsum 50 Windows 10 #0-0]

color

设置为 true 以在终端中显示彩色输出

类型：boolean 默认值：true

[
  "spec",
  {
    color: true,
  },
]

环境选项

可以通过环境变量设置某些选项

FORCE_COLOR

如果设置为 true，例如通过 FORCE_COLOR=0 npx wdio run wdio.conf.js，则所有终端颜色将被禁用。