Nodejs 折腾 Coffee + mocha + Travis-CI 单元测试与覆盖率报告

Node.js 折腾 Coffee + Mocha + Travis-CI 单元测试与覆盖率报告

在调研了几个库之后，我选用了 coffee-coverage 和 mocha 这两个库。

"devDependencies": {
  "mocha": "^1.21.5",
  "chai": "^1.9.2",
  "coffee-coverage": "^0.4.2"
}

在 test/support/env.coffee 引入 coffee-coverage:

if process.env.COV_TEST == 'true'
  require('coffee-coverage').register
    path: 'relative'
    basePath: "#{__dirname}/../.."
    exclude: ['test', 'node_modules', '.git', 'sample', 'static']
    initAll: true

coffee-coverage 的文档上写的 exclude 示例是 /test, /node_modules, /.git，但我在被坑了一个半小时之后才发现前面不能加斜杠。我发了一个 Pull Request，目前还没被处理。

在 test/app.coffee 里写第一个测试：

describe 'app', ->
  it 'should can startup', ->
    # 在我的机器上启动需要差不多 15 秒时间.....
    @timeout 20000 
    require '../../app'

Mocha 默认的测试报告只会显示测试的通过情况，不会显示测试覆盖率，因此我们需要扩展一下 Mocha 默认的测试报告。在 test/support/reporter-cov-summary.js:

var fs = require('fs');
var util = require('util');
var Spec = require('mocha/lib/reporters/spec');

exports = module.exports = CovSummary;

function CovSummary(runner) {
  Spec.call(this, runner);
  runner.on('end', report);
}

function report() {
  var cov = global._$jscoverage || {};
  var files = Object.keys(cov);

  var covered_lines = 0;
  var total_lines = 0;

  files.forEach(function(file) {
    cov[file].forEach(function(line) {
      if (line !== undefined) {
        total_lines++;

        if (line !== 0) {
          covered_lines++;
        }
      }
    });
  });

  var covered = (covered_lines / total_lines * 100).toFixed(1);
  console.log(util.format('Coverage Summary: %s lines of %s lines, %s%% covered \n', covered_lines, total_lines, covered));
}

CovSummary.prototype.__proto__ = Spec.prototype;

这个文件是用 JavaScript 写的，我实在没搞清楚 Mocha 怎么直接用 CoffeeScript 的测试报告；它会在测试运行结束后输出一个覆盖率概要，类似于：

Coverage Summary: 305 lines of 2056 lines, 14.8% covered

在 package.json 中加上 scripts:

"scripts": {
  "start": "./node_modules/.bin/coffee app.coffee",
  "test": "COV_TEST=true ./node_modules/.bin/mocha --compilers coffee:coffee-script/register --require test/support/env --reporter test/support/reporter-cov-summary.js -- test",
  "test-only": "./node_modules/.bin/mocha --compilers coffee:coffee-script/register --require test/support/env -- test",
  "test-cov-html": "COV_TEST=true ./node_modules/.bin/mocha --compilers coffee:coffee-script/register --require test/support/env --reporter html-cov -- test > coverage-reporter.html"
},

start 是启动应用，test 是运行测试和覆盖率报告，test-only 只运行测试，test-cov-html 会生成 HTML 格式的测试覆盖率报告。

然后还要改一下 .gitignore，加上 /coverage-reporter.html。

最后是 .travis.yml:

language: node_js

node_js:
  - "0.10"

差不多就是这样。

针对“Nodejs 折腾 Coffee + mocha + Travis-CI 单元测试与覆盖率报告”这个主题，我们可以通过以下步骤来设置CoffeeScript + Mocha + Travis-CI环境，并生成单元测试与覆盖率报告。以下是关键点及示例代码。

1. 安装依赖

首先，安装必要的开发依赖包：

npm install --save-dev mocha chai coffee-coverage

2. 配置环境文件

在test/support/env.coffee中引入coffee-coverage，并配置覆盖率工具：

if process.env.COV_TEST == 'true'
  require('coffee-coverage').register
    path: 'relative'
    basePath: "#{__dirname}/../.."
    exclude: ['test', 'node_modules', '.git', 'sample', 'static']
    initAll: true

注意排除规则中的路径不需要前缀斜杠。

3. 编写测试文件

在test/app.coffee中编写测试案例：

describe 'app', ->
  it 'should can startup', ->
    @timeout 20000
    require '../../app'

4. 创建自定义报告器

创建一个名为test/support/reporter-cov-summary.js的文件，用于输出覆盖率报告：

const fs = require('fs');
const util = require('util');
const Spec = require('mocha/lib/reporters/spec');

class CovSummary extends Spec {
  constructor(runner) {
    super(runner);
    runner.on('end', this.report.bind(this));
  }

  report() {
    const cov = global._$jscoverage || {};
    const files = Object.keys(cov);

    let coveredLines = 0;
    let totalLines = 0;

    files.forEach(file => {
      cov[file].forEach(line => {
        if (line !== undefined) {
          totalLines++;

          if (line !== 0) {
            coveredLines++;
          }
        }
      });
    });

    const covered = ((coveredLines / totalLines) * 100).toFixed(1);
    console.log(util.format(
      'Coverage Summary: %s lines of %s lines, %s%% covered\n',
      coveredLines,
      totalLines,
      covered
    ));
  }
}

module.exports = CovSummary;

5. 更新 package.json

添加脚本命令：

"scripts": {
  "start": "node app.js",
  "test": "COV_TEST=true mocha --compilers coffee:coffee-script/register --require test/support/env --reporter test/support/reporter-cov-summary.js -- test",
  "test-only": "mocha --compilers coffee:coffee-script/register --require test/support/env -- test",
  "test-cov-html": "COV_TEST=true mocha --compilers coffee:coffee-script/register --require test/support/env --reporter html-cov -- test > coverage-reporter.html"
}

6. 配置 .travis.yml

添加 .travis.yml 文件：

language: node_js
node_js:
  - "14"
script:
  - npm run test

7. 添加忽略文件

在.gitignore中添加覆盖率报告文件：

/coverage-reporter.html

以上步骤将帮助你在Node.js项目中集成CoffeeScript、Mocha和Travis-CI，并生成单元测试与覆盖率报告。