使用不同的数据多次运行相同的 mocha 测试

Question

问题

我有几个测试在 mocha 中做同样的事情。对我来说，这是重复，当您希望您的系统可维护时，这是最糟糕的事情。

var exerciseIsPetitionActive = function (expected, dateNow) {
    var actual = sut.isPetitionActive(dateNow);
    chai.assert.equal(expected, actual);
};

test('test_isPetitionActive_calledWithDateUnderNumSeconds_returnTrue', function () {
    exerciseIsPetitionActive(true, new Date('2013-05-21 13:11:34'));
});

test('test_isPetitionActive_calledWithDateGreaterThanNumSeconds_returnFalse', function () {
    exerciseIsPetitionActive(false, new Date('2013-05-21 13:12:35'));
});

我需要什么

我需要一种将重复的 mocha 测试合并为一个的方法。

例如，在 PhpUnit（和其他测试框架）中，您有 dataProviders。
在 phpUnit 中，dataProvider 以这种方式工作：

<?php class DataTest extends PHPUnit_Framework_TestCase {
    /**
     * @dataProvider provider
     */
    public function testAdd($a, $b, $c)
    {
        $this->assertEquals($c, $a + $b);
    }

    public function provider()
    {
        return array(
          array(0, 0, 0),
          array(0, 1, 1),
          array(1, 0, 1),
          array(1, 1, 3)
        );
    }
}

这里的provider给测试注入参数，测试执行所有的case。非常适合重复测试。

我想知道mocha中是否有类似的东西，例如这样的：

var exerciseIsPetitionActive = function (expected, dateNow) {
    var actual = sut.isPetitionActive(dateNow);
    chai.assert.equal(expected, actual);
};

@usesDataProvider myDataProvider
test('test_isPetitionActive_calledWithParams_returnCorrectAnswer', function (expected, date) {
    exerciseIsPetitionActive(expected, date);
});

var myDataProvider = function() {
  return {
      {true, new Date(..)},
      {false, new Date(...)}
  };
};

我已经看过的内容

有一种技术叫做Shared Behaviours。但它并没有直接用测试套件解决问题，它只是解决了具有重复测试的不同组件的问题。

问题

你知道在 mocha 中实现 dataProviders 的任何方法吗？

Answer 1

Mocha 没有为此提供工具，但您自己很容易做到。您只需要在循环中运行测试并使用闭包将数据提供给测试函数：

suite("my test suite", function () {
    var data = ["foo", "bar", "buzz"];
    var testWithData = function (dataItem) {
        return function () {
            console.log(dataItem);
            //Here do your test.
        };
    };

    data.forEach(function (dataItem) {
        test("data_provider test", testWithData(dataItem));
    });
});

Answer 2

我发现mocha-testcheck 是最简单的工具。它生成各种数据。它将缩小导致测试失败的输入范围。

Answer 3

下面使用mocha-testdata 库描述了一个更简单的解决方案。

问题的示例解决方案。

import * as assert from assert;
import { givenAsync } from mocha-testdata;

suite('My async test suite', function () {
  given([0, 0, 0], [0, 1, 1], [1, 0, 1], [1, 1, 3]).test('sum to 6', function (a, b, c) {
    assert.strictEqual(a + b + c, 6);
  });
});

如果您需要测试 node.js 应用程序中最常见的异步函数调用，请改用 givenAsync。

import * as assert from assert;
import { givenAsync } from mocha-testdata;

suite('My async test suite', function () {
  givenAsync([1, 2, 3], [3, 2, 1]).test('sum to 6', function (done, a, b, c) {
    doSomethingAsync(function () {
        assert.strictEqual(a + b + c, 6);
        done();
    });
  });
});

Answer 4

使用不同数据运行相同测试的基本方法是在提供数据的循环中重复测试：

describe('my tests', function () {
  var runs = [
    {it: 'options1', options: {...}},
    {it: 'options2', options: {...}},
  ];

  before(function () {
    ...
  });

  runs.forEach(function (run) {
    it('does sth with ' + run.it, function () {
      ...
    });
  });
});

before 在describe 中的所有its 之前运行。如果您需要使用before 中的某些选项，请勿将其包含在forEach 循环中，因为mocha 将首先运行所有befores 和所有its，这可能是不想要的。您可以将整个 describe 放入循环中：

var runs = [
  {it: 'options1', options: {...}},
  {it: 'options2', options: {...}},
];

runs.forEach(function (run) {
  describe('my tests with ' + run.it, function () {
    before(function () {
      ...
    });

    it('does sth with ' + run.it, function () {
      ...
    });
  });
});

如果你不想用多个describes 污染你的测试，你可以使用有争议的模块sinon 来解决这个问题：

var sinon = require('sinon');

describe('my tests', function () {
  var runs = [
    {it: 'options1', options: {...}},
    {it: 'options2', options: {...}},
  ];

  // use a stub to return the proper configuration in `beforeEach`
  // otherwise `before` is called all times before all `it` calls
  var stub = sinon.stub();
  runs.forEach(function (run, idx) {
    stub.onCall(idx).returns(run);
  });

  beforeEach(function () {
    var run = stub();
    // do something with the particular `run.options`
  });

  runs.forEach(function (run, idx) {
    it('does sth with ' + run.it, function () {
      sinon.assert.callCount(stub, idx + 1);
      ...
    });
  });
});

诗乃感觉很脏但很有效。一些辅助模块（例如 leche）是基于 sinon 的，但可以说没有必要引入进一步的复杂性。

Answer 5

Leche 将该功能添加到 Mocha。请参阅announcement 和docs。

这比简单地循环测试要好，因为如果测试失败，它会告诉您涉及哪个数据集。

更新：

我不喜欢 Leche 的设置，也没有设法让它与 Karma 一起使用，所以最终我将数据提供者提取到了 separate file 中。

如果您想使用它，只需grab the source。文档可在 in the Leche readme 获得，您可以在文件本身中找到更多信息和使用提示。

Answer 6

根据@Kaizo 的回答，这是我为我的测试（它是一个从请求中获取一些参数的控制器）想出的，以模拟 PHPUnit 中的数据提供者。 getParameters 方法将接收来自 Express 的请求，然后使用 req.param 检查一些查询参数，例如，GET /jobs/?page=1&per_page=5。这也显示了如何存根 Express 请求对象。

希望它也可以帮助某人。

// Core modules.
var assert = require('assert');

// Public modules.
var express = require('express');
var sinon = require('sinon');

// Local modules.
var GetJobs = require(__base + '/resources/jobs/controllers/GetJobs');

/**
 * Test suite for the `GetJobs` controller class.
 */
module.exports = {
    'GetJobs.getParameters': {
        'should parse request parameters for various cases': function () {
            // Need to stub the request `param` method; see http://expressjs.com/3x/api.html#req.param
            var stub = sinon.stub(express.request, 'param');
            var seeds = [
                // Expected, page, perPage
                [{limit: 10, skip: 0}],
                [{limit: 5, skip: 10}, 3, 5]
            ];
            var controller = new GetJobs();

            var test = function (expected, page, perPage) {
                stub.withArgs('page').returns(page);
                stub.withArgs('per_page').returns(perPage);

                assert.deepEqual(controller.getParameters(express.request), expected);
            };

            seeds.forEach(function (seed) {
                test.apply({}, seed);
            });
        }
    }
};

唯一的缺点是 Mocha 不计算实际断言（就像 PHPUnit 一样），它只是显示为一个测试。