@128technology/mocha-junit-reporter 中文文档教程

Question

JUnit Reporter for Mocha

生成 JUnit 样式的 XML 测试结果。

Installation

$ npm install mocha-junit-reporter --save-dev

或者作为全局模块

$ npm install -g mocha-junit-reporter

Usage

使用 mocha-junit-reporter 运行 mocha：

$ mocha test --reporter mocha-junit-reporter

这将在 ./test-results.xml 输出结果文件。 您可以选择通过设置声明结果 XML 文件的备用位置 环境变量 MOCHA_FILE 或在 reporterOptions 中指定 mochaFile：

$ MOCHA_FILE=./path_to_your/file.xml mocha test --reporter mocha-junit-reporter

或者

$ mocha test --reporter mocha-junit-reporter --reporter-options mochaFile=./path_to_your/file.xml

也

var mocha = new Mocha({
    reporter: 'mocha-junit-reporter',
    reporterOptions: {
        mochaFile: './path_to_your/file.xml'
    }
});

Append properties to testsuite

可以在 testsuite 下向报告添加属性. 如果您希望您的 CI 环境向报告添加额外的构建道具以用于分析目的，这将很有用

<testsuites>
  <testsuite>
    <properties>
      <property name="BUILD_ID" value="4291"/>
    </properties>
    <testcase/>
    <testcase/>
    <testcase/>
  </testsuite>
</testsuites>

。这样做可以通过环境变量传递它们：

PROPERTIES=BUILD_ID:4291 mocha test --reporter mocha-junit-reporter

或者

var mocha = new Mocha({
    reporter: 'mocha-junit-reporter',
    reporterOptions: {
        properties: {
            BUILD_ID: 4291
        }
    }
})

Results Report

结果 XML 文件名可以包含 [hash]，例如 ./path_to_your/test-results.[hash].xml. [hash] 替换为测试结果 XML 的 MD5 哈希。 这样就可以支持并行执行多个mocha-junit-reporter的写入测试结果在单独的文件中。

为了显示完整的套件标题（包括父级），只需指定 testsuitesTitle 选项

var mocha = new Mocha({
    reporter: 'mocha-junit-reporter',
    reporterOptions: {
        testsuitesTitle: true,
        suiteTitleSeparatedBy: '.' // suites separator, default is space (' '), or period ('.') in jenkins mode
    }
});

。 >testCaseSwitchClassnameAndName 记者选项。

var mocha = new Mocha({
    reporter: 'mocha-junit-reporter',
    reporterOptions: {
        testCaseSwitchClassnameAndName: true
    }
});

以下是使用 testCaseSwitchClassnameAndName 选项时的 XML 输出示例：

value	XML output
true	<testcase name="should behave like so" classname="Super Suite should behave like so">
false (default)	<testcase name="Super Suite should behave like so" classname="should behave like so">

您还可以通过设置 reporterOptions.testsuitesTitle 和通过设置 reporterOptions.rootSuiteTitle 获取根套件的 name 属性。

System out and system err

JUnit 格式定义了一对标签 - 和 - 用于描述测试生成的输出 和错误流，分别。 可以将测试输出/错误作为文本行数组传递：

it ('should report output', function () {
  this.test.consoleOutputs = [ 'line 1 of output', 'line 2 of output' ];
});
it ('should report error', function () {
  this.test.consoleErrors = [ 'line 1 of errors', 'line 2 of errors' ];
});

因为这个模块只是一个报告器而不是一个独立的测试运行器，它不执行 输出捕获本身。 因此，测试的作者有责任提供一种机制 通过它填充输出/错误数组。

如果只捕获 console.log/console.error 是一个选项，一个简单的（如果有点 hack-ish）解决方案是替换 这些函数的全局实现，如下所示：

var util = require('util');

describe('my console tests', function () {
  var originalLogFunction = console.log;
  var originalErrorFunction = console.error;
  beforeEach(function _mockConsoleFunctions() {
    var currentTest = this.currentTest;
    console.log = function captureLog() {
      var formattedMessage = util.format.apply(util, arguments);
      currentTest.consoleOutputs = (currentTest.consoleOutputs || []).concat(formattedMessage);
    };
    console.error = function captureError() {
      var formattedMessage = util.format.apply(util, arguments);
      currentTest.consoleErrors = (currentTest.consoleErrors || []).concat(formattedMessage);
    };
  });
  afterEach(function _restoreConsoleFunctions() {
    console.log = originalLogFunction;
    console.error = originalErrorFunction;
  });
  it('should output something to the console', function() {
    // This should end up in <system-out>:
    console.log('hello, %s', 'world');
  });
});

如果您想要 XML 格式的测试输出，请记住使用 --reporter-options outputs=true 运行。

Attachments

启用 attachments 配置选项将允许在 JUnit Attachments Plugin< 中附加文件和屏幕截图/a> 格式。

附件路径可以注入到测试对象

it ('should include attachment', function () {
  this.test.attachments = ['/absolut/path/to/file.png'];
});

中 XML 输出如下所示：

<system-out>output line 1
output line 2
[[ATTACHMENT|path/to/file]]</system-out>

Full configuration options

Parameter	Default	Effect
mochaFile	test-results.xml	configures the file to write reports to
includePending	false	if set to a truthy value pending tests will be included in the report
properties	null	a hash of additional properties to add to each test suite
toConsole	false	if set to a truthy value the produced XML will be logged to the console
useFullSuiteTitle	false	if set to a truthy value nested suites' titles will show the suite lineage
suiteTitleSeparatedBy	(space)	the character to use to separate nested suite titles. (defaults to ' ', '.' if in jenkins mode)
testCaseSwitchClassnameAndName	false	set to a truthy value to switch name and classname values
rootSuiteTitle	Root Suite	the name for the root suite. (defaults to 'Root Suite')
testsuitesTitle	Mocha Tests	the name for the testsuites tag (defaults to 'Mocha Tests')
outputs	false	if set to truthy value will include console output and console error output
attachments	false	if set to truthy value will attach files to report in JUnit Attachments Plugin format (after console outputs, if any)
antMode	false	set to truthy value to return xml compatible with Ant JUnit schema
antHostname	process.env.HOSTNAME	hostname to use when running in antMode will default to environment HOSTNAME
jenkinsMode	false	if set to truthy value will return xml that will display nice results in Jenkins