前端常用单元测试(工具+框架)步骤归纳

前言

单元测试,简单来说就是技术人员的白盒测试(程序测试)。为了减少产品的开发周期时间以及后期的修复代价,逐渐要求技术人员要在开发过程中梳理清晰自己开发功能逻辑,编写相对应的单元测试程序代码,用于对自己思维逻辑实现的一个校验测试。

前端开发人员编写单元测试的工具和框架有几个主流的,但查找了很多网站,发现没有哪个网站系统地讲述从零开始如何搭建前端的一个工具+框架自动化单元测试环境直至可以添加自文件可测试使用。所以,根据自己搭建的一些经验,我总结了一些步骤,搭建完成之后只需要保存一份,可以在其中添加不同的自定义js文件,都可以运行控制台命令针对js文件进行单元测试。(我的环境搭建是在window系统下的)

一、测试框架/工具

  • 测试管理工具: karma
  • 测试框架: mocha/jasmine(本文讲述的是mocha)
  • 断言库: chai
  • 测试浏览器: Phantomjs
  • 测试覆盖率: karma-coverage

二、构建基本的原生js单元测试

1. 创建项目的package.json
创建一个空项目文件夹,如mytest,在项目根目录下执行控制台命令:npm init

npm init

之后按照提示进行创建基础的package.json文件信息即可(我都是直接按Enter):

初始化package.json文件.png

2. 配置项目的package.json
分别执行以下控制台命令,将需要的工具/环境安装到项目中,安装完成后pakeage.json的devDependencies
中相应改变出现相关安装工具依赖。

执行的控制台命令:

npm install --save-dev karma

npm install --save-dev karma-mocha

npm install --save-dev karma-chai

npm install --save-dev karma-phantomjs-launcher

npm install --save-dev karma-coverage

npm install --save-dev mocha chai

所有工具/环境安装成功后,package.json中是devDependencies这样的:

"devDependencies": {
    "chai": "^3.5.0",
    "karma": "^1.4.1",
    "karma-chai": "^0.1.0",
    "karma-coverage": "^1.1.1",
    "karma-mocha": "^1.3.0",
    "karma-phantomjs-launcher": "^1.0.2",
    "mocha": "^3.2.0"
  }

3. 初始化Karma配置文件
在项目的根目录运行karma init,初始化配置成功后会在根目录下生成karma.conf.js文件。

karma init

按照截图进行初始化配置:

karma初始化配置.png

表示配置使用mocha框架以及PhantomJS无页面浏览器执行前端js代码的单元测试,配置需要被测试的代码和测试代码放在src/和test/文件夹中。

补充说明:
在项目下安装完所有局部环境之后,根目录下运行karma init命令行可能仍会报错(karma init为无效命令等)
解决方案:在本电脑全局下安装karma

npm i karma -g

4. 修改Karma基本配置
此时初始化的karma.conf.js只是最基本的karma配置,我们还需要手动修改一些地方。

  • 在其中的frameworks一项中增加chai:
frameworks: ['mocha','chai'],
  • 然后在config.set({})中添加:
plupins:[
        'karma-mocha',
        'karma-chai',
        'karma-phantomjs-launcher'
    ]

5. 针对覆盖率修改Karma配置文件

  • 在preprocessors和reporters中添加:
preprocessors: {
        'src/*.js':['coverage']
    },

    reporters: ['progress','coverage'],
  • 然后在config.set({})中的plugins中添加:
plugins:[
        'karma-mocha',
        'karma-chai',
        'karma-phantomjs-launcher',
        'karma-coverage'
    ]

6. 开始编写测试代码
经过上述步骤,基本上单元测试的工具/环境依赖已安装完成,可以开始进行源代码的编写测试。
在上文的初始化Karma配置时,已经告诉Karma,需要被测试的代码和测试代码放在src/和test/文件夹中,所以我们应该在src/文件夹下提供要被测试的代码,在test/文件夹下提供测试代码:

在src/文件夹中新建index.js文件,在这个文件中添加三个非常简单的函数:

function isNum(num){
    return typeof num === "number"
}
function isString(str){
    return typeof str === "string"
}
function isLarge10(num){
    return num > 10;
}

然后在test/文件夹中新建index.test.js文件。通常,测试脚本与所要测试的源码脚
本同名,但是后缀名为.test.js(表示测试)或者.spec.js(表示规格)。在该文件
中开始编写测试代码:

describe('index.js的测试',function(){
    it('1应该是数字',function(){
        //expect(isNum(1)).to.be.true
        isNum(1).should.equal(true);
    })
    it('"1"应该是字符',function(){
        //expect(isString("1")).to.be.true
        isString("1").should.equal(true);
    })
    it('11大于10',function(){
        //expect(isLarge10(11)).to.be.true
        isLarge10(11).should.equal(true);
    })
})

编写测试文件时,describe、it都是由mocha提供的测试用api:

describe块成为“测试套件”,表示一组相关的测试。他是一个函数,第一个参数是测试套件的名称,第二个参数是具体要执行的测试函数;

it块称为测试用例,表示一个单独的测试,即测试的最小单位。他也是一个函数,第一个参数表示测试用例的名称,第二个参数表示具体要求执行的断言函数;

7. 运行单元测试
被测试代码和测试代码编写完毕后,在项目根目录输入:karma start

karma start

如果测试不通过,测试套件和测试用例的描述都会在命令行输出,告诉你哪里测试失败了。并且这时你修改任意代码,单元测试便会在你保存后自动运行。
你的项目中便会多出一个coverage文件夹,文件夹中按照浏览器分了覆盖率统计结果,我们使用的是PhantomJs,自然会有一个PhantomJs*文件夹,用浏览器打开index.html便可查看测试覆盖率。

(补充说明:在我安装局部单元测试环境依赖后,会存在执行karma start命令时报错的情况,所以可能新手朋友们在此步骤执行时也会出现报错,我分析是因为只有karma在全局安装了,而其他的所有环境都是在项目目录下进行局部安装的,此时运行karma start使用全局环境karma去执行命令就会发现全局中没有其他模块而导致报错,基本上报错类型包括提示mocha模块出错,加载不了coverage模块,加载不了chai模块等等,目前我找到的解决方案就是对于报错的工具/环境进行全局执行安装,如全局安装mocha执行控制台命令:

npm install mocha -g

解决思路就是缺少什么就对什么进行全局安装。

好了,以上就是我自己在安装使用前端单元测试工具和框架时一些步骤的简单总结,根据这个步骤可以基本创建一个原生js文件的测试环境包,之后只需要把要测试的js源文件放进src文件夹,把对应源文件的自己根据chai断言库编写的单元测试用例文件放进test文件夹中,再执行karma start命令就可以测试自己的js逻辑。

推荐阅读更多精彩内容