美文网首页Web Developer测试相关
【前端单元测试入门01】Mocha与chai

【前端单元测试入门01】Mocha与chai

作者: 韩子卢 | 来源:发表于2018-01-17 17:15 被阅读0次

    Mocha 的简介

    Mocha是流行的JavaScript测试框架之一,通过它添加和运行测试,从而保证代码质量

    Mocha 的安装与配置

    全局安装Mocha

    npm install -g mocha
    

    项目中也安装Mocha

    npm install --save-dev mocha
    

    在package.json中加入下面脚本:

    "scripts": {
        "test": "mocha"
    }
    

    Mocha 的使用

    在使用前,我们先看一下我们用来使用的测试项目的结构:


    项目结构图

    如上图所示,测试文件需要放在test目录下,mocka运行时会执行test目录下的所有js文件(仅限于test以下这一层级,对test/subtest这一层级并不执行)。

    其中index.js为我们的被测试代码:

    /**
     * 加法函数
     * @param {第一个数} a 
     * @param {第二个数} b 
     */
    function addNum(a,b){
        return a+b;
    }
    module.exports=addNum;
    

    而index.test.js为我们的测试代码(注意这里的命名加了一个test,并不是必须的,只是为了好区分哪些是测试文件):

    var addNum=require('../src/index')
    
    describe('测试index.js', function() {
      describe('测试addNum函数', function() {
        it('两数相加结果为两个数字的和', function() {
           if(addNum(1,2)!==3){
             throw new Error("两数相加结果不为两个数字的和");
           }
        });
      });
    });
    

    解析一下以上代码的语法:

    测试脚本里面应该包括一个或多个describe块,每个describe块应该包括一个或多个it块。
    describe块称为"测试套件"(test suite),表示一组相关的测试。它是一个函数,第一个参数是测试套件的名称("测试index.js"),第二个参数是一个实际执行的函数。
    it块称为"测试用例"(test case),表示一个单独的测试,是测试的最小单位。它也是一个函数,第一个参数是测试用例的名称("两数相加结果为两个数字的和"),第二个参数是一个实际执行的函数。

    在上面的例子中,测试addNum函数,如果运行错误就抛出异常

    此时运行

    npm test
    

    就可得到以下结果


    运行正确的结果图

    为了看一下运行错误的结果,此时我们修改index.js的代码为:

    function addNum(a,b){
        return a+b-1;
    }
    module.exports=addNum;
    

    再次运行

    npm test
    

    结果如下:


    image.png

    Mocha与断言库chai

    在上面的Mocha例子中,测试失败用抛异常来处理,多少有点繁琐,所以就有了断言库的出现。
    这里我们介绍一个常用的断言库chai。
    可以简单理解为这就是对我们上面抛异常方法的一个封装,当判断失败时会抛出一个异常。
    首先安装chai:

    npm install --save-dev chai
    

    接着让我们用chai修改一下上面的index.test.js:

    var expect = require('chai').expect;
    var addNum=require('../src/index')
    
    describe('测试index.js', function() {
      describe('测试addNum函数', function() {
        it('两数相加结果为两个数字的和', function() {
          expect(addNum(1,2)).to.be.equal(3);
        });
      });
    });
    

    上面的语法很接近自然语言,expect(期待)一个表达式的结果equal(等于)一个表达式。
    运行

    npm test
    

    得到以下结果:


    断言库chai结果

    可以看出图中的断言库还打印出了期望的结果3和实际的结果2。
    如果用判断来抛异常的话会繁琐得多。

    以上语法为chai的expect语法,它还有should语法和asset语法。
    如果是以前用过java和.NET的话,对asset可能更适应一点:

    var assert = require('chai').assert;
    
    assert.typeOf(foo, 'string');
    assert.equal(foo, 'bar');
    assert.lengthOf(foo, 3)
    assert.property(tea, 'flavors');
    assert.lengthOf(tea.flavors, 3);
    

    这其中的语法意思很明显,这里就不再赘述了。

    Mocha的更多使用

    如果想测试单一的测试js,可以用:

    mocha test/index.test.js
    

    或者多个js

    mocha test/index.test.js test/add.test.js
    

    当然也可以用通配符测试某个文件夹下所有的js和jsx:

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

    Mocha与ES6

    在上面我们用的并非是ES6的语法,那么让我们把其中的代码都改为ES6的语法。
    其中index.js为:

    /**
     * 加法函数
     * @param {第一个数} a 
     * @param {第二个数} b 
     */
    export default (a,b)=>{
        return a+b-1;
    }
    

    而index.test.js为:

    import {assert} from 'chai'
    import addNum from '../src/index'
    
    describe('测试index.js',()=> {
      describe('测试addNum函数', ()=> {
        it('两数相加结果为两个数字的和', ()=> {
          assert.equal(addNum(1,2),3)
        })
      })
    })
    

    此时直接运行mock肯定是不行的,我们现需要安装一下babel:

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

    然后,在项目目录下面,新建一个.babelrc文件:

    {
      "presets": [ "es2015" ]
    }
    

    接着讲package.json中的脚本改为:

    "scripts": {
      "test": "mocha --compilers js:babel-core/register"
    },
    

    其中--compilers参数用来指定测试脚本的转码器,这行命令的意思是运行mocha时先用babel-core/register模块,处理一下.js文件

    注意:
    --compilers将会在未来被移除,官方称它是redundant(累赘的),而作为替代方案的是

    "scripts": {
      "test": "mocha --require babel-core/register"
    },
    

    命令变得更加简单了

    Mocha测试用例执行的超时和高亮

    Mocha默认每个测试用例最多执行2000毫秒,如果到时没有得到结果,就报错。以下命令设置超时时间为5000:

    mocha -t 5000 index.test.js
    

    Mocha默认会高亮显示超过75毫秒的测试用例,以下命令设置高亮判断的临界值:

    mocha -s 1000 index.test.js
    

    Mocha测试的钩子

    Mocha在describe块之中,提供测试用例的四个钩子:before()、after()、beforeEach()和afterEach()。它们会在指定时间执行。

    describe('测试index.js',()=> {
      before(()=>console.info("在本区块的所有测试用例之前执行"))
    
      after(()=>console.info("在本区块的所有测试用例之后执行"))
    
      beforeEach(()=>console.info("在本区块的每个测试用例之前执行"))
    
      afterEach(()=>console.info("在本区块的每个测试用例之后执行"))
    
      describe('测试addNum函数', ()=> {
        it('两数相加结果为两个数字的和', ()=> {
          assert.equal(addNum(1,2),3)
        })
      })
    })
    

    小结

    关于mock和chai常用的一些玩法都讲了,更多的关于mock的测试结果输出格式,以及skip跳过测试和only仅测试当前用例等玩法就不讲述了。

    相关文章

      网友评论

        本文标题:【前端单元测试入门01】Mocha与chai

        本文链接:https://www.haomeiwen.com/subject/drquoxtx.html