Node项目添加测试用例、测试覆盖率

「爱情、让人受尽委屈。」 2022-11-14 10:27 218阅读 0赞

# 简介 #

文章使用相关环境、模块版本如下：

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Node.js</td> 
   <td>12.15.0</td> 
  </tr> 
  <tr> 
   <td>mocha</td> 
   <td>8.3.2</td> 
  </tr> 
  <tr> 
   <td>nyc</td> 
   <td>15.1.0</td> 
  </tr> 
 </tbody> 
</table>

# 一、demo程序 #

创建一个`demo`文件夹，在该文件夹下创建文件`index.js`，编写如下内容：

/** * @description 加法函数 * @param {Number} a - 数1 * @param {Number} b - 数2 * @returns */
    function add(a, b) { 
      return a + b;
    }
    
    module.exports = add;

# 二、添加测试用例 #

## 2.1 初始化package.json ##

使用如下命令初始化`package.json`

npm init

依次根据提示填入对应项即可，一路回车也可。

## 2.1 安装测试框架 ##

测试框架选择`mocha`

以`npm`为例：

npm i mocha --save-dev

`--save-dev`参数是将该依赖保存为开发依赖，在生产环境该依赖就无需进行安装，节省空间。

## 2.2 编写测试用例 ##

在`demo`文件夹下创建文件夹`test`  
以`demo/test/index.spec.js`为例

const assert = require('assert').strict;
    
    const add = require('../index');
    
    describe('测试集合', () => { 
      it('demo测试1', () => { 
        const a = 123;
        const b = 456;
        const result = add(a, b);
        assert.deepStrictEqual(result, b + a);
      });
    });

## 2.3 添加npm命令 ##

给`package.json`文件中的`scripts`对象添加如下内容：

"scripts": { 
      "test": "node_modules/.bin/mocha test/*.spec.js"
    }

**注意**

*  调用`mocha`要用`node_modules/.bin/mocha`，这样才能保证是使用的之前安装到项目下的`mocha`命令，否则会默认到全局安装下寻找`mocha`命令。（当然，直接把`mocha`安装到全局也是可以的）
 *  后的`test/*.spec.js`是指定测试文件，`mocha`会去寻找对应的测试文件，运行测试用例

## 2.4 运行测试 ##

在命令行中输入

npm run test

即可运行测试。

但是此时还是没能显示测试覆盖率，需要再添加一个`nyc`模块。

# 三、添加测试覆盖率 #

## 3.1 安装nyc ##

npm i nyc --save-dev

同理，该模块仅与开发有关，使用`--save-dev`即可。

## 3.2 添加npm命令 ##

给`package.json`文件中的`scripts`对象添加如下内容：

"scripts": { 
      "test": "node_modules/.bin/mocha test/*.spec.js",
      "test:cov": "node_modules/.bin/nyc --report=text node_modules/.bin/mocha test/*.spec.js"
    }

## 3.3 运行测试 ##

执行命令

npm run test:cov

此时将会在控制台中显示代码的测试覆盖率，且在项目下生成文件夹`.nyc_output`。