安装必要的包
nodejs的单元测试最常用的是使用mocha
包。首先确保你本地安装nodejs
,之后按照mocha
包。
npm install mocha -g
然后还需要安装相关的断言工具,Node.js中常用的断言库有:
- assert: TDD风格
- should: BDD风格
- expect: BDD风格
- chai: BDD/TDD风格
使用npm install
安装这些断言库其中之一即可。
PHPStorm配置nodejs单元测试环境
在PHPStorm中选择菜单:Run -> Edit Configurations,点击右上角添加mocha
。
分别填写下面几项,关于
mocha
单元测试可以参考官网:https://mochajs.org/
- Name: 随便一个运行配置的名称,如MochaTest
- Working directory: 当前项目目录
- Mocha package: Mocha安装包的目录,node_modules\mocha
- User interface: 测试类型,这里选择TDD(对应
assert
库) - Test directory: 这一项可以选择测试目录或文件
- All in directory: 整个目录都进行测试
- File patterns: 某种模式的文件,可以填正则表达式
- Test file: 某个特定的测试文件
填写完成并且没有报错后点击OK。
Nodejs进行单元测试
这里我们选择assert
库,TDD模式进行单元测试。在上面选定的Test directory
目录下新建一个测试文件test.js
.
const assert = require('assert');
// 测试Array类型的方法
suite('Array', function() {
// 测试 indexOf方法
suite('#indexOf()', function() {
// 测试用例
test('should return -1 when not present', function() {
assert.equal(-1, [1, 2, 3].indexOf(4));
});
});
});
点击选择Mocha运行,在PHPStorm下面的输出框中有测试的结果,绿色表示通过,红色表示失败。
assert断言函数
下面列举assert
库中常用的断言函数,详情可参考官网:https://www.npmjs.com/package/assert
- assert.fail(actual, expected, message, operator)
- assert(value, message), assert.ok(value, [message])
- assert.equal(actual, expected, [message])
- assert.notEqual(actual, expected, [message])
- assert.deepEqual(actual, expected, [message])
- assert.notDeepEqual(actual, expected, [message])
- assert.strictEqual(actual, expected, [message])
- assert.notStrictEqual(actual, expected, [message])
- assert.throws(block, [error], [message])
- assert.doesNotThrow(block, [message])
- assert.ifError(value)
其中的参数说明如下:
- value: 实际值
- actual: 实际值
- expected: 期望值
- block: 语句块
- message: 附加信息
几种常见的测试风格代码举例
BDD
BDD提供的接口有:describe(), context(), it(), specify(), before(), after(), beforeEach(), and afterEach().
describe('Array', function() {
before(function() {
// ...
});
describe('#indexOf()', function() {
context('when not present', function() {
it('should not throw an error', function() {
(function() {
[1, 2, 3].indexOf(4);
}.should.not.throw());
});
it('should return -1', function() {
[1, 2, 3].indexOf(4).should.equal(-1);
});
});
context('when present', function() {
it('should return the index where the element first appears in the array', function() {
[1, 2, 3].indexOf(3).should.equal(2);
});
});
});
});
TDD
提供的接口有: suite(), test(), suiteSetup(), suiteTeardown(), setup(), and teardown():
suite('Array', function() {
setup(function() {
// ...
});
suite('#indexOf()', function() {
test('should return -1 when not present', function() {
assert.equal(-1, [1, 2, 3].indexOf(4));
});
});
});
QUNIT
和TDD类似,使用suite()和test()标记测试永烈,包含的接口有:before(), after(), beforeEach(), and afterEach()。
function ok(expr, msg) {
if (!expr) throw new Error(msg);
}
suite('Array');
test('#length', function() {
var arr = [1, 2, 3];
ok(arr.length == 3);
});
test('#indexOf()', function() {
var arr = [1, 2, 3];
ok(arr.indexOf(1) == 0);
ok(arr.indexOf(2) == 1);
ok(arr.indexOf(3) == 2);
});
suite('String');
test('#length', function() {
ok('foo'.length == 3);
});