测试框架 Mocha 实例教程

原作者: 阮一峰
原作地址:http://www.ruanyifeng.com/blog/2015/12/a-mocha-tutorial-of-examples.html

Mocha
(发音”摩卡”)诞生于 201一 年,是现行反革命最流行的 JavaScript
测试框架之1,在浏览器和 Node 环境都足以轻易使用。

所谓”测试框架”,就是运维测试的工具。通过它,可以为 JavaScript
应用添加测试,从而确认保证代码的质感。

正文周密介绍怎么着利用
Mocha,让你轻轻松松上手。借使您在此以前对测试一窍不通,本文也足以用作 JavaScript
单元测试入门。值得一表达的是,除了 Mocha 以外,类似的测试框架还有
JasmineKarmaTape
等,也很值得学习。

图片 1

image

一、安装


原文者为了本文,写了1个演示库
Mocha-demos,清闲安装那么些库。

$ git clone https://github.com/ruanyf/mocha-demos

借使您的处理器未有安装 Git,则可以直接下载
zip压缩包,实行解压。

下一场,进入 mocha-demos 目录,在各类 demo 中装置注重(你的电脑必须有
Node)。

$ cd mocha-demos
$ npm ** install

地点的代码会在目录内部安装 Mocha,为了操作便利,请在大局环境也设置一下
Mocha。

$ npm install -g mocha

二、测试脚本的写法


Mocha
的功用是运作测试脚本,首先必须学会写测试脚本。所谓”测试脚本”,正是用来测试源码的台本。上边是3个加法模块
add.js 的代码。

// add.js
function add(x, y) {
  return x + y;
}

module.exports = add;

要测试这些加法模块是还是不是科学,就要写测试脚本。

一般,测试脚本与所要测试的源码脚本同名,但是后缀名称为.test.js(表示测试)大概 .spec.js(表示原则)。比如 add.js
的测试脚本名字便是 add.test.js。

// add.test.js
var add = require('./add.js');
var expect = require('chai').expect;

describe('加法函数的测试', function(){
    it('1 加 1 应该等于 2', function(){
        expect(add(1, 1)).to.be.equal(2);
    });
});

上面那段代码,正是测试脚本,它能够独自执行。测试脚本里面应该包涵2个或多个describe 块,各类 describe 块应该包蕴多少个或几个 it 块。

describe 块被誉为”测试套件”(test
suite),表示一组有关的测试。它是贰个函数,第1个参数是测试套件的称号(“加法函数的测试”),第一个参数是贰个事实上执行的函数。

it 块被称之为”测试用例”(test
case),表示3个独自的测试,是测试的微小单位。它是一个函数,第3个参数是测试用例的名称(”1加 一 相应相等 二”),第一个参数是二个实际上执行的函数。

三、断言库的用法


下边的测试脚本里面,有一句断言。

expect(add(1, 1)).to.be.equal(2);

所谓”断言”,正是判断源码的莫过于施行结果与预期结果是还是不是①律,即使不1样就抛出四个不当。下边那句断言的情趣是,调用
add(1, 一) 函数,结果应该等于 二。

不无的测试用例(it块)都应当包涵一句或多句的断言。它是编写制定测试用例的根本。断言功能由断言库来落到实处,Mocha
自己不带断言库,所以必须引入断言库。

var expect = require('chai').expect;

断言库有比比皆是种,Mocha 并不限定使用哪一种。上边代码引入的断言库是
chai,并且钦命使用它的 expect 断言风格。

expect 断言的略微是很接近自然语言,下边是有个别例子:

// 相等或不相等
expect(4 + 5).to.be.equal(9);
expect(4 + 5).to.be.not.equal(10);
expect(foo).to.be.deep.equal({ bar: 'baz' });

// 布尔值为true
expect('everthing').to.be.ok;
expect(false).to.not.be.ok;

// typeof
expect('test').to.be.a('string');
expect({ foo: 'bar' }).to.be.an('object');
expect(foo).to.be.an.instanceof(Foo);

// include
expect([1,2,3]).to.include(2);
expect('foobar').to.contain('foo');
expect({ foo: 'bar', hello: 'universe' }).to.include.keys('foo');

// empty
expect([]).to.be.empty;
expect('').to.be.empty;
expect({}).to.be.empty;

// match
expect('foobar').to.match(/^foo/);

大多,expect 断言的写法都以1致的。尾部是 expect
方法,尾巴部分是预感方法,比如 equal、a/an、ok、match 等。两者之间使用 to 或
to.be 连接。

壹旦 expect
断言不创制,就会抛出一个张冠李戴,事实上,只要不抛出错误,测试用例就算通过。

it('1 加 1 应该等于 2', function(){});

地点的这几个测试用例,内部没有此外轮代理公司码,由于尚未抛出了错误,所以照旧会经过。

4、Mocha的中坚用法


有了测试脚本未来,就可以用Mocha运行它。请进来 demo01子目录,执行下边的授命。

$ mocha add.test.js

  加法函数的测试
    ✓ 1 加 1 应该等于 2

  1 passing (8ms)

下边包车型大巴运作结果表示,测试脚本通过了测试,一共只有 壹 个测试用例,耗费时间是 8飞秒。

mocha 命令后面紧跟测试脚本的门道和文件名,能够钦命四个测试脚本。

$ mocha file1 file2 file3

Mocha 默许运行 test 子目录里面的测试脚本。所以,一般都会把测试脚本放在
test 目录里面,然后实施 mocha 就不须求参数了。请进来 demo0二子目录,运行下边包车型地铁下令:

$ mocha

  加法函数的测试
    ✓ 1 加 1 应该等于 2
    ✓ 任何数加0应该等于自身

  2 passing (9ms)

此时能够看看,test 子目录里面包车型客车测试脚本实施了。但是,你打开 test
子目录,会发现下边还有3个 test/dir 子目录,里面还有三个测试脚本
multiply.test.js,并未收获推行。原来,Mocha 暗中认可只进行 test
子目录下边第3层的测试用例,不会执行更下层的用例。

为了改变那种行为,就非得抬高 –recursive 参数,那时 test
子目录上边全体的测试用例—-不管在哪壹层—-都会进行。

$ mocha --recursive

  加法函数的测试
    ✓ 1 加 1 应该等于 2
    ✓ 任何数加0应该等于自身

  乘法函数的测试
    ✓ 1 乘 1 应该等于 1

  3 passing (9ms)

五、通配符


命令行钦命测试脚本时,能够使用通配符,同事钦命五个文件。

$ mocha spec/{my, awesome}.js
$ mocha test/unit/*.js

地方的首先行命令,内定执行 spec 目录上边包车型客车 my.js 和
awesome.js。第一行命令,钦赐执行 test/unit 目录上边包车型的士富有 js 文件。

除了选择 Shell 通配符,还是能够应用 Node 通配符。

$ mocha 'test/**/*.@(js|jsx)'

地点代码钦命运维 test 目录上面任何子目录中、文件后缀名称为 js 或 jsx
的测试脚本。注意,Node 的通配符要放在单引号之中,不然星号(*)会先被
Shell 解释。

地点那行 Node 通配符,要是改用 Shell 通配符,要写成上面这样:

$ mocha test/{,**/}*.{js|jsx}

陆、命令行参数


除了前边介绍的 –recursive,Mocha 还足以添加其余命令行参数。请在 demo02子目录里面,运维上边包车型地铁指令,查看效果:

6.1 –help,-h

–help 或 -h 参数,用来查看 Mocha 的享有命令行参数

$ mocha --help
6.2 –reporter, -R

–reporter 参数用来钦命测试报告的格式,暗中认可是 spec 格式。

$ mocha
# 等同于
$ mocha --reporter spec

除此而外 spec
格式,官方网址还提供了别样许多报告格式

$ mocha --reporter tap

1..2
ok 1 加法函数的测试 1 加 1 应该等于 2
ok 2 加法函数的测试 任何数加0应该等于自身
# tests 2
# pass 2
# fail 0

下面是 tap 格式报告的显得结果。

–reporters 参数能够彰显全体内置的告知格式:

$ mocha --reporters

利用 mochawesome 模块,能够转变美貌的 HTML 格式的告知:

图片 2

image

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

地方代码中,mocha 命令使用了花色内安装的本子,而不是大局安装的本子,因为
mochawesome 模块是安装在类型内的。

下一场,测试结果报告就在 mochaawesome-reports 子目录生成。

6.3 –growl,-G

开辟 –growl 参数,就会将测试结果在桌面上显示。

$ mocha --growl

图片 3

image

6.4 –watch -W

–watch 参数用来监视钦命的测试脚本。只要测试脚本有转移,就会活动运行Mocha。

$ mocha --watch

下面命令行执行今后,并不会退出。这年你能够别的打开四个极端窗口,修改
test 目录上边包车型大巴测试脚本
add.test.js,比如删除2个测试用例,壹旦保存,Mocha 就会再一次自动运转。

6.5 –bail, -b

–bail
参数钦点只要有三个测试用例未有通过,就停下实施前边的测试用例,那对绵绵集成很有赞助。

$ mocha --bail
6.6 –grep, -g

–grep 参数用于搜索测试用例的称谓(即 it
块的第伍个参数),然后只进行匹配的测试用例。

$ mocha --grep "1 加 1"

地方代码只测试名称中带有”一 加 1″的测试用例。

6.7 –invert, -i

— invert 参数表示只运维不符合条件的测试脚本,必须与 –grep
参数协作使用。

$ mocha --grep "1 加 1" --invert

七、配置文件 mocha.opts


Mocha 允许在 test 目录下边,放置配置文件
mocha.opts,把命令行参数写在内部。请先进入 demo03 目录,运行上边包车型地铁下令:

mocha --recursive --reporter tap --growl

地方那几个命令有多个参数 –recursive、–reporter tap、–growl。

然后,把那四个参数写入test目录下的 mocha.opts 文件。

--reporter tap
--recursive
--growl

比方测试用例不是存放在在 test 子目录,能够在 mocha.opts 写入一下内容。

server-tests
--recursive

地方代码钦定运维 server-tests 目录及其子目录之中的测试脚本。

八、ES6测试


假设测试脚本金和利息用 ES⑥ 来编排,那么运维测试在此以前,须求先用 Babel 转码。进入
demo0四 目录,打开 test/add.test.js 文件,能够见见这一个测试用例是用 ES6编写的。

import add from '../src/add.js';
import chai from 'chai';

let expect = chai.expect;

describe('加法函数的测试', function(){
    it('1 加 1 应该等于 2', function(){
        expect(add(1, 1)).to.be.equal(2);
    });
});

ES陆 转码,要求设置 Babel

$ npm install babel-core babel-preset-es2015 --save-dev

下一场,在项目目录上面,新建三个 .babelrc 配置文件。

{
    "presets": ["es2015"]
}

末尾,使用 –compilers 参数钦定测试脚本的转码器

$ mocha --compilers js:babel-core/register

地方代码中,–compilers
参数后边紧跟2个用冒号分隔的字符串,冒号左侧是文本的后缀名,左侧是用来拍卖那1类公事的模块名。上面代码表示,运营测试在此之前,先用
babel-core/register 模块,处理一下 .js
文件。由于此地的转码器安装在档次内,所以要选择项目内安装的
Mocha,假如转码器安装在大局,就足以行使全局的 Mocha。

下边是其它一个例证,使用 Mocha 测试 CoffeeScript 脚本。测试在此以前,先将
.coffee 文件转成 .js 文件。

$ mocha --compilers coffee:coffee-script/register

专注,贝布el 暗中认可不会对 Iterator、Generator、Promise、Map、Set
等全局对象,以及部分大局对象的方式(比如
Object.assign)转码,假若您想要对那一个指标转码,就要安装 babel-polyfill。

$ npm install --save-dev babel-polyfill

接下来,在您的台本尾部加上1行:

import 'babel-polyfill'

九、异步测试


Mocha 私下认可每种测试用例最多执行 3000飞秒,借使到时未有博得结果,就报错。对于涉及异步操作的测试用例,那一个时刻屡屡是不够的,须要用
-t 或 –timeout 参数钦点超时门槛。

跻身 demo0五 子目录,打开测试脚本 timeout.test.js:

it('测试应该 5000 毫秒后结果', function(done){
    var x = true;
    var f = function(){
        x = false;
        expect(x).to.be.not.ok;
        done();// 通知 Mocha 测试结束
    };
    setTimeout(f, 4000);
});

上边的测试用例,必要 6000 阿秒之后,才有运行结果。所以,需求用 -t 或
–timeout 参数,改变默许的超时设置。

$ mocha -t 5000 timeout.test.js

地点命令将测试的晚点时间限制钦点为 四千 微秒。

别的,上面的测试用例里面,有2个 done 函数。it 块执行的时候,传入三个done 参数,当测试截止的时候,必须显式调用那么些函数,告诉 Mocha
测试甘休了。不然,Mocha
就无法知晓,测试是或不是得了,会直接等到过期报错。你可以把那行代码删除试试看。

Mocha 私下认可会高亮展现抢先 75 纳秒的测试用例,能够用 -s 或 –slow
调整这么些参数。

$ mocha -t 5000 -s 1000 timeout.test.js

地点命令钦定高亮显示耗时超越 一千 纳秒的测试用例。

上边是其它二个异步测试的例证 async.test.js

it('异步请求应该返回一个对象', function(done){
    request.get('https://api.github.com')
        .end(function(err, res){
            expect(res).to.be.an('object');
            done();
        });
});

运转上面发号施令,可以看来那一个测试会通过。

$ mocha -t 10000 async.test.js

除此以外,Mocha 内置对 Promiss 的扶助,允许直接重返Promiss,等到它的场合改变,在推行断言,而不用呈现调用 done 方法。请看
promise.test.js。

it('异步请求应该返回一个对象', function(){
    return fetch('https://api.github.com')
        .then(function(res){
            return res.json();
        }).then(function(json){
            expect(json).to.be.an('object');
        });
});

十、测试用例的钩子


Mocha 在 describe
块之中,提供测试用例的多个钩:before()、after()、beforeEach()、afterEach()。它们会在内定的年月执行。

describe('hooks', function(){

    before(function(){
        // 在本区块的所有测试用例之前执行
    });

    after(function() {
        // 在本区块的所有测试用例之后执行
    });

    beforeEach(function() {
        // 在本区块的每个测试用例之前执行
    });

    afterEach(function() {
        // 在本区块的每个测试用例之后执行
    });

    // test cases
});

进去 demo0陆 子目录,能够观察上边四个例子。首先是 beforeEach 的例证
beforeEach.test.js。

// beforeEach.test.js
describe('beforeEach示例', function() {
  var foo = false;

  beforeEach(function() {
    foo = true;
  });

  it('修改全局变量应该成功', function() {
    expect(foo).to.be.equal(true);
  });
});

上面代码中,beforeEach 会在 it 之前实施,所以会修改全局变量。

另三个例证 beforeEach-async.test.js 则是出现说法,如何在 beforeEach
之中使用异步操作。

// beforeEach-async.test.js
describe('异步 beforeEach 示例', function(){
    var foo = false;

    beforeEach(function(done){
        setTimeout(function(){
            foo = true;
            done();
        }, 50);
    });

    it('全局变量异步修改应该成功', function(){
        expect(foo).to.be.equal(true);
    });
});

10壹、测试用例管理


大型项目有过多测试用例。有时,我们期待只运行在这之中的几个,那时能够用 only
方法。 describe 块和 it 块都允许调用 only
方法,表示只运营有些测试套件或测试用例。

跻身 demo0七 子目录,测试脚本 test/add.test.js 就利用了 only。

it.only('1 加 1 应该等于 2', function(){
    expect(add(1, 1)).to.be.equal(2);
});

it('任何数加0应该等于自身', function() {
    expect(add(1, 0)).to.be.equal(1);
});

地方代码中,唯有带有 only 方法的测试用例会运营:

$ mocha test/add.test.js

  加法函数的测试
    ✓ 1 加 1 应该等于 2

  1 passing (10ms)

除此以外,还有 skip 方法,表示跳过内定的测试套件或测试用例。

it.skip('任何数加0应该等于自身', function(){
    expect(add(1, 0)).to.be.equal(1);
});

地方代码的那么些测试用例不会实施。

102、浏览器测试


除了那一个之外在命令行运维,Mocha 还足以在浏览器运营

图片 4

image

第三,使用 mocha init 命令在钦点目录生成开端化文件。

$ mocha init demo08

运行方面命令,就会在 demo0八 目录下生成 index.html
文件,以及配套的本子和样式表。

<!DOCTYPE html>
<html>
    <body>
        <h1>Unit.js test in the browser with Mocha</h1>
        <div id="mocha"></div>
        <script type="text/javascript" src="mocha.js"></script>
        <script type="text/javascript">
            mocha.setup('bdd');
        </script>
        <script type="text/javascript" src="tests.js"></script>
        <script type="text/javascript">
            mocha.run();
        </script>
    </body>
</html>

接下来,新建三个源码文件 add.js:

// add.js
function add(x, y){
    return x + y;
}

下一场,把这么些文件,以及断言库 chai.js,参与 index.html;

<script type="text/javascript">
    mocha.setup('bdd');
</script>
<script type="text/javascript" src="http://chaijs.com/chai.js"></script>
<script type="text/javascript" src="tests.js"></script>
<script type="text/javascript">
    mocha.run();
</script>

谈到底,在 tests.js 里面写入测试脚本。

var expect = chai.expect;

describe('加法函数的测试', function(){
    it('1 加 1 应该等于 2', function(){
        expect(add(1, 1)).to.be.equal(2);
    });

    it('任何数加0应该等于自身', function(){
        expect(add(1, 0)).to.be.equal(1);
        expect(add(0, 0)).to.be.equal(0);
    });
});

现在,在浏览器里面打开 index.html,就足以看出测试脚本的运作结果。

103、生成规格文件


Mocha 补助从测试用例生成标准化文件。

图片 5

image

跻身 demo0玖 子目录,运营上面包车型大巴指令:

$ mocha --recursive -R markdown > spec.md

上边命令依照 test 目录的有所测试脚本,生成八个规格文件 spec.md。-Sportagemarkdown 参数内定规格报告是 markdown 格式。

只要想生成 HTML 格式的告知 spec.html,使用上边包车型客车通令:

$ mocha --recursive -R doc > spec.html