Mocha

环境搭建

项目环境安装，安装 mocha 和断言库 chai

yarn add mocha chai --dev

Hello 例子

简单的输出一个字符串文本 index.js

"use strict";
module.exports = () => "Hello Jecyu";

在 package.json 里添加脚本：

{
  "scripts": {
    "test:unit": "mocha"
  },
  "devDependencies": {
    "chai": "^4.2.0",
    "mocha": "^6.2.0"
  }
}

运行测试文件

const mylib = require("../src");
const { expert } = require("chai");
describe("My First Test", () => {
  it('should get "Hello DIST"', () => {
    expert(mylib()).to.be.equal("Hello DIST");
  });
});

测试成功，输出以下结果：

huasenyumideMacBook-Pro:01-hello linjy$ yarn test:unit
yarn run v1.9.4
$ mocha


  My First Test
    ✓ should get "Hello DIST"


  1 passing (10ms)

✨  Done in 0.48s.

测试用例钩子

describe 干的事情就是给测试用例分组。为了尽可能多的覆盖各种情况，测试用例往往会有很多。这时候通过分组就可以比较方便的管理（这里提一句，describe 是可以嵌套的，也就是说外层分组了之后，内部还可以分子组）。另外还有一个非常重要的特性，就是每个分组都可以进行预处理（before、beforeEach）和后处理（after, afterEach）。

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

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

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

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

  // test cases
});

这里 before 会在每个分组的所有测试用例运行前，相对的 after 则会在所有测试用例运行后执行，如果要以测试用例为粒度，可以使用 beforeEach 和 afterEach，这两个钩子则会分别在该分组每个测试用例运行前和运行后执行。由于很多代码都需要模拟环境，可以再这些 before 或 beforeEach 做这些准备工作，然后在 after 或 afterEach 里做回收操作。

配置文件

传统模式：mocha.opts 推荐：在项目的根目录下创建一个 .mocharc.js，然后导出一个对象(module.exports = {/.../})包含您的配置。还有其他的 JSON、YAML、package.json

module.exports = {
  extendsion: ["js"], // js 扩展名
  reporter: "spec", // spec 声明格式
  recursive: true, // 递归测试子文件
  watch: true, // 监听文件变化
};

引入 babel

如果测试脚本是用 ES6 写的，那么运行测试之前，需要先用 Babel 转码。(关于了解 babel)

node 不承认 es6 export/import ES6 转码，需要安装 Babel。

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

然后，在项目目录下面，新建一个.babelrc 配置文件。

{
  "presets": [ "es2015" ]
}

最后，使用--compilers参数指定测试脚本的转码器。

../node_modules/mocha/bin/mocha --compilers --require babel-core/register

当然，也可以写到配置文件中：

module.exports = {
  extendsion: ["js"],
  reporter: "spec",
  recursive: true,
  // spec: "test/**/*.spec.js",
  require: "babel-core/register", // es6
};

测试异步代码

回调

这里传入 it 的第二个参数的函数新增了一个 done 参数，当有这个参数时，这个测试用例会被认为是异步测试，只有在 done()执行时，才认为测试结束。那如果 done()一直没有执行呢？Mocha 会触发自己的超时机制，超过一定时间（默认是 2s，时长可以通过--timeout 参数设置）就会自动终止测试，并以测试失败处理。

源文件

module.exports = (bu, callback) =>
  process.nextTick(() => callback(`Hello ${bu}`));

测试文件

const expect = require("chai").expect;
const mylib = require("../src/callback");
describe("异步代码 callback 测试", () => {
  it('should get "Hello DIST"', (done) => {
    mylib("DIST", (rst) => {
      expect(rst).to.be.equal("Hello DIST");
      done(); // 通知测试结果
    });
  });
});

Promise

源文件

module.exports = (bu) => new Promise((resolve) => resolve(`Hello ${bu}`));

测试文件

const expect = require("chai").expect;
const mylib = require("../src/promise");
describe("异步代码支持 promise 测试", () => {
  it("Welcome to DIST", () => {
    mylib("DIST").then((str) => {
      expect(str).to.be.equal("Hello DIST");
    });
  });
});

整个文件异步

有时候，我们可能并不只是某个测试用例需要异步，而是整个测试过程都需要异步执行。比如测试 Gulp 插件的一个方案就是，首先运行 Gulp 任务，完成后测试生成的文件是否和预期的一致。那么如何异步执行整个测试过程呢？

Mocha 提供了异步启动测试，只需要在启动 Mocha 的命令后加上--delay参数，Mocha 就会以异步方式启动。这种情况下我们需要告诉 Mocha 什么时候开始跑测试用例，只需要执行run()方法即可

使用"mocha --delay"执行测试脚本。"mocha --delay"会添加一个特殊的函数 run()到全局的上下文。当异步操作完成后, 执行 run 函数可以开始执行测试用例。

const expect = require("chai").expect;
const mylib = require("../src/promise");
setTimeout(() => {
  run(); // 异步操作完成后，执行 run 函数可以开始执行测试用例
  describe("异步代码", () => {
    it("Welcome to DIST", () => {
      mylib("DIST").then((str) => {
        expect(str).to.be.equal("Hello DIST");
      });
    });
  });
}, 1000);

TypeScript

配置

安装 typeScript，把 .ts 文件编译成 js 文件

npm install typescript

安装 @type/mocha 和 ts-node， ts-node 它提供了 TypeScript 的运行环境，让我们免去了麻烦的编译这一步骤。最简单的例子，在注册 ts-node 之后，我们就可以直接加载并运行 ts 文件。

npm install @type/mocha && ts-node

在 mocharc.js 中添加上 ts 的处理

{
  "extension": ["ts"],
  "spec": "src/**/*.test.ts", // 制定测试文件
  "require": "ts-node/register"
}

进行测试

源文件 index.ts

export default function(incomingText: string) {
  return `Hello ${incomingText}`;
}

测试文件

import mylib from "../src";
import { expect } from "chai";
describe("My First Test", () => {
  it('should get "Hello DIST"', () => {
    expect(mylib("DIST")).to.be.equal("Hello DIST");
  });
});

# Mocha

# 环境搭建

# Hello 例子

# 测试用例钩子

# 配置文件

# 引入 babel

# 测试异步代码

# 回调

# Promise

# 整个文件异步

# TypeScript

# 配置

# 进行测试

Mocha

环境搭建

Hello 例子

测试用例钩子

配置文件

引入 babel

测试异步代码

回调

Promise

整个文件异步

TypeScript

配置

进行测试