js单元测试怎么写2021

JS单元测试怎么写2021

JS单元测试的关键步骤包括选择合适的测试框架、编写测试用例、使用断言库、集成测试覆盖率工具。 这些步骤确保了你的JavaScript代码在开发过程中保持高质量和可维护性。

选择合适的测试框架是关键的一步。2021年主流的JavaScript测试框架包括Jest、Mocha和Jasmine。Jest由于其简单易用和功能强大，成为许多开发者的首选。它集成了断言库、测试覆盖率工具和模拟功能，使得单元测试更加便捷。

一、选择合适的测试框架

选择合适的测试框架是进行JavaScript单元测试的第一步。当前主流的JavaScript测试框架包括Jest、Mocha和Jasmine。

Jest：

Jest是由Facebook开发的一个强大的JavaScript测试框架，它集成了断言库、测试覆盖率工具和模拟功能。Jest的优点包括：

简单易用：Jest提供了一个简单的API，使得编写测试变得非常容易。
内置功能强大：Jest集成了断言库、测试覆盖率工具和模拟功能，减少了对其他库的依赖。
快速执行：Jest支持并行测试，提高了测试执行速度。

下面是一个使用Jest编写的简单单元测试示例：

// sum.js
function sum(a, b) {
  return a + b;
}
module.exports = sum;
// sum.test.js
const sum = require('./sum');
test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});

Mocha：

Mocha是一个灵活的JavaScript测试框架，它允许开发者选择自己的断言库和测试覆盖率工具。Mocha的优点包括：

灵活性高：Mocha允许开发者选择自己喜欢的断言库和测试覆盖率工具。
插件丰富：Mocha有丰富的插件生态系统，可以满足各种测试需求。

下面是一个使用Mocha和Chai编写的简单单元测试示例：

// sum.js
function sum(a, b) {
  return a + b;
}
module.exports = sum;
// sum.test.js
const sum = require('./sum');
const { expect } = require('chai');
describe('Sum function', () => {
  it('should add 1 + 2 to equal 3', () => {
    expect(sum(1, 2)).to.equal(3);
  });
});

Jasmine：

Jasmine是一个行为驱动开发（BDD）的JavaScript测试框架，提供了内置的断言库和测试覆盖率工具。Jasmine的优点包括：

内置断言库：Jasmine提供了内置的断言库，减少了对其他库的依赖。
易于上手：Jasmine的API设计简单易用，适合初学者。

下面是一个使用Jasmine编写的简单单元测试示例：

// sum.js
function sum(a, b) {
  return a + b;
}
module.exports = sum;
// sum.test.js
const sum = require('./sum');
describe('Sum function', () => {
  it('should add 1 + 2 to equal 3', () => {
    expect(sum(1, 2)).toBe(3);
  });
});

二、编写测试用例

编写测试用例是单元测试的核心。一个好的测试用例应该覆盖代码的各种可能情况，包括正常情况和异常情况。

1. 正常情况测试：

正常情况测试是指测试代码在正常情况下的行为。例如，对于一个加法函数，我们需要测试它在不同输入下的输出是否正确。

// sum.test.js
const sum = require('./sum');
test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});
test('adds -1 + -1 to equal -2', () => {
  expect(sum(-1, -1)).toBe(-2);
});

2. 异常情况测试：

异常情况测试是指测试代码在异常情况下的行为。例如，对于一个加法函数，我们需要测试它在输入非数值时是否能够正确处理。

// sum.test.js
const sum = require('./sum');
test('throws error when inputs are not numbers', () => {
  expect(() => sum('a', 2)).toThrow('Inputs must be numbers');
  expect(() => sum(1, 'b')).toThrow('Inputs must be numbers');
});

三、使用断言库

断言库是单元测试的重要组成部分，它提供了一系列用于验证代码行为的函数。常用的断言库包括Jest的内置断言库、Chai和Expect。

Jest的内置断言库：

Jest的内置断言库提供了丰富的断言函数，例如toBe、toEqual、toThrow等。

// sum.test.js
const sum = require('./sum');
test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});
test('throws error when inputs are not numbers', () => {
  expect(() => sum('a', 2)).toThrow('Inputs must be numbers');
});

Chai：

Chai是一个流行的断言库，提供了三种断言风格：should、expect和assert。下面是使用expect风格的示例：

// sum.test.js
const sum = require('./sum');
const { expect } = require('chai');
describe('Sum function', () => {
  it('should add 1 + 2 to equal 3', () => {
    expect(sum(1, 2)).to.equal(3);
  });
  it('should throw error when inputs are not numbers', () => {
    expect(() => sum('a', 2)).to.throw('Inputs must be numbers');
  });
});

Expect：

Expect是一个轻量级的断言库，适用于Node.js环境。它提供了类似于Jest和Chai的断言函数。

// sum.test.js
const sum = require('./sum');
const expect = require('expect');
describe('Sum function', () => {
  it('should add 1 + 2 to equal 3', () => {
    expect(sum(1, 2)).toBe(3);
  });
  it('should throw error when inputs are not numbers', () => {
    expect(() => sum('a', 2)).toThrow('Inputs must be numbers');
  });
});

四、集成测试覆盖率工具

测试覆盖率工具用于衡量测试用例对代码的覆盖程度。常用的测试覆盖率工具包括Istanbul和Jest的内置覆盖率工具。

Istanbul：

Istanbul是一个强大的JavaScript测试覆盖率工具，它可以生成详细的覆盖率报告。Istanbul通常与Mocha一起使用。

# 安装Istanbul npm install nyc --save-dev 使用Istanbul运行测试并生成覆盖率报告 nyc mocha

Jest的内置覆盖率工具：

Jest内置了覆盖率工具，可以通过命令行选项启用覆盖率报告。

# 使用Jest运行测试并生成覆盖率报告 jest --coverage

五、编写异步代码的单元测试

在现代JavaScript开发中，异步代码非常常见。编写异步代码的单元测试需要使用特定的工具和方法，例如回调函数、Promise和async/await。

1. 回调函数：

对于使用回调函数的异步代码，可以使用Jest的done回调函数来编写单元测试。

// fetchData.js
function fetchData(callback) {
  setTimeout(() => {
    callback('data');
  }, 1000);
}
module.exports = fetchData;
// fetchData.test.js
const fetchData = require('./fetchData');
test('fetches data', done => {
  function callback(data) {
    try {
      expect(data).toBe('data');
      done();
    } catch (error) {
      done(error);
    }
  }
  fetchData(callback);
});

2. Promise：

对于返回Promise的异步代码，可以使用Jest的resolves和rejects方法来编写单元测试。

// fetchData.js
function fetchData() {
  return new Promise((resolve) => {
    setTimeout(() => {
      resolve('data');
    }, 1000);
  });
}
module.exports = fetchData;
// fetchData.test.js
const fetchData = require('./fetchData');
test('fetches data', () => {
  return expect(fetchData()).resolves.toBe('data');
});

3. async/await：

对于使用async/await的异步代码，可以直接在测试函数中使用async/await语法。

// fetchData.js
async function fetchData() {
  return new Promise((resolve) => {
    setTimeout(() => {
      resolve('data');
    }, 1000);
  });
}
module.exports = fetchData;
// fetchData.test.js
const fetchData = require('./fetchData');
test('fetches data', async () => {
  const data = await fetchData();
  expect(data).toBe('data');
});

六、使用模拟（Mock）函数

模拟函数用于替代真实的函数，以便在单元测试中隔离依赖。Jest提供了强大的模拟功能，可以轻松创建和管理模拟函数。

1. 使用Jest模拟函数：

Jest的jest.fn方法可以创建一个模拟函数，jest.spyOn方法可以监视一个现有函数。

// userService.js
const fetchData = require('./fetchData');
async function getUserData() {
  const data = await fetchData();
  return data.user;
}
module.exports = getUserData;
// userService.test.js
const getUserData = require('./userService');
const fetchData = require('./fetchData');
jest.mock('./fetchData');
test('gets user data', async () => {
  fetchData.mockResolvedValue({ user: 'John Doe' });
  const user = await getUserData();
  expect(user).toBe('John Doe');
});

2. 使用Sinon模拟函数：

Sinon是一个独立的测试库，提供了强大的模拟、存根和间谍功能。

// userService.test.js
const sinon = require('sinon');
const getUserData = require('./userService');
const fetchData = require('./fetchData');
describe('getUserData', () => {
  it('should get user data', async () => {
    const fetchDataStub = sinon.stub(fetchData, 'default').resolves({ user: 'John Doe' });
    const user = await getUserData();
    expect(user).toBe('John Doe');
    fetchDataStub.restore();
  });
});

七、集成CI/CD工具

将单元测试集成到CI/CD工具中，可以在每次代码提交时自动运行测试，确保代码质量。常用的CI/CD工具包括Jenkins、Travis CI和GitHub Actions。

1. 使用Jenkins：

Jenkins是一个开源的CI/CD工具，可以通过Jenkinsfile配置自动化流程。

pipeline {
  agent any
  stages {
    stage('Install dependencies') {
      steps {
        sh 'npm install'
      }
    }
    stage('Run tests') {
      steps {
        sh 'npm test'
      }
    }
    stage('Generate coverage report') {
      steps {
        sh 'jest --coverage'
      }
    }
  }
  post {
    always {
      junit 'reports/*.xml'
      cobertura coberturaReportFile: 'coverage/cobertura-coverage.xml'
    }
  }
}

2. 使用Travis CI：

Travis CI是一个基于云的CI/CD工具，可以通过.travis.yml文件配置自动化流程。

language: node_js node_js: - '14' script: - npm install - npm test - jest --coverage after_success: - bash <(curl -s https://codecov.io/bash)

3. 使用GitHub Actions：

GitHub Actions是GitHub提供的CI/CD工具，可以通过workflow文件配置自动化流程。

name: Node.js CI on: push: branches: [ main ] pull_request: branches: [ main ] jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Install dependencies run: npm install - name: Run tests run: npm test - name: Generate coverage report run: jest --coverage - name: Upload coverage to Codecov uses: codecov/codecov-action@v1 with: file: './coverage/*/*.json' flags: unittests name: codecov-umbrella

八、使用项目管理工具

在进行JavaScript单元测试时，使用项目管理工具可以提高团队协作效率，确保项目按时完成。推荐使用研发项目管理系统PingCode和通用项目协作软件Worktile。

PingCode：

PingCode是一款专为研发团队设计的项目管理系统，提供了需求管理、任务分配、缺陷追踪等功能。通过PingCode，团队可以更好地管理单元测试任务，确保代码质量。

Worktile：

Worktile是一款通用的项目协作软件，适用于各种类型的项目管理。通过Worktile，团队可以方便地分配和跟踪单元测试任务，提高协作效率。

结论

编写高质量的JavaScript单元测试是确保代码稳定性和可维护性的关键。通过选择合适的测试框架、编写全面的测试用例、使用断言库和测试覆盖率工具，以及集成CI/CD工具和项目管理工具，你可以有效地提高单元测试的质量和效率。在2021年及以后，这些最佳实践将帮助你编写更好的JavaScript单元测试，确保代码在各种情况下都能正常运行。