npm 包 mocha-testlink-reporter 使用教程

mocha-testlink-reporter 是一个基于 mocha 的测试报告生成工具。它可以生成符合 TestLink 格式的报告，方便我们将测试结果与 TestLink 进行对接。本文将详细介绍如何使用这个工具。

安装

在使用 mocha-testlink-reporter 之前，需要先安装它。可以通过 npm 进行安装：

npm install mocha-testlink-reporter --save-dev

在安装的过程中，添加 --save-dev 参数可以将它作为开发工具来保存。

配置

在安装完毕之后，我们需要在 mocha 的配置文件中进行配置。在 mocha 的配置文件 mocha.opts 或 mocha.config.js 中，添加 reporter 以及 reporter-option 参数即可。例如，我们想要使用 mocha-testlink-reporter 作为测试报告生成工具：

--reporter mocha-testlink-reporter
--reporter-options configFile=testlink.json

配置文件

必须创建 JSON 格式的配置文件来设置您的 TestLink 实例参数以及测试套件。

{
  "testlinkURL": "http://yourtestlink.com/lib/api/xmlrpc/v1/xmlrpc.php",
  "testlinkKey": "e7f643b14c27f7d286f65950a3a3fcdf",
  "prefix": "MyApplication",
  "planName": "MyProject - Test Plan",
  "buildName": "Build 1.0",
  "platformName": "MacOS",
  "customFieldName": "my_custom_field",
}

在配置文件中，您需要设置以下参数：

• testlinkURL - 您的 TestLink 实例地址。
• testlinkKey - 您的 TestLink API 密钥，用于进行身份验证。
• prefix - 您要用于生成的 Test Case 前缀。
• planName - 您要将测试用例添加到的测试计划的名称。
• buildName - 您要将测试结果添加到的构建名称。
• platformName - 您要为测试结果指定的平台名称。
• customFieldName（可选）- 如果您的测试用例中有自定义字段，则可以在此处指定它们的名称。

使用

在配置完毕之后，我们就可以用 mocha 进行测试了。测试完成之后，我们可以在 TestLink 实例中看到生成的测试报告。

可以通过以下命令来运行测试：

mocha test --reporter mocha-testlink-reporter --reporter-options configFile=testlink.json

如果需要在进行测试时输出调试信息，可以在运行该命令时添加 -D：

mocha test --reporter mocha-testlink-reporter --reporter-options configFile=testlink.json -D

示例代码

考虑到 mocha-testlink-reporter 是在 mocha 上运行的，因此这里我们简单从 mocha 的测试用例入手，以示例代码来介绍使用方法。

test.js

const assert = require('assert');

describe('Array', function() {
  describe('#indexOf()', function() {
    it('should return -1 when the value is not present', function() {
      assert.strictEqual([1,2,3].indexOf(4), -1);
    });
    it('should return the correct index when the value is present', function() {
      assert.strictEqual([1,2,3].indexOf(2), 1);
    });
  });
});

mocha.opts

--reporter mocha-testlink-reporter
--reporter-options configFile=testlink.json

testlink.json

{
  "testlinkURL": "http://yourtestlink.com/lib/api/xmlrpc/v1/xmlrpc.php",
  "testlinkKey": "e7f643b14c27f7d286f65950a3a3fcdf",
  "prefix": "MyApplication",
  "planName": "MyProject - Test Plan",
  "buildName": "Build 1.0",
  "platformName": "MacOS",
  "customFieldName": "my_custom_field",
}

结束语

通过使用 mocha-testlink-reporter，我们可以方便地将 mocha 的测试结果与 TestLink 进行对接。在测试完成之后，我们可以在 TestLink 实例中查看生成的测试报告，以了解测试结果及其覆盖率细节。同时，这也有助于提供测试用例的可追溯性，并且可以帮助开发者更好地进行测试代码的重构。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/600673dffb81d47349e53c45