如何使用 Supertest 进行 Koa 应用测试？

推荐答案

// www.javascriptcn.com code example
const request = require('supertest');
const Koa = require('koa');
const app = new Koa();

app.use(async ctx => {
  ctx.body = 'Hello World';
});

describe('GET /', () => {
  it('should return Hello World', async () => {
    const res = await request(app.callback())
      .get('/')
      .expect(200);

    expect(res.text).toBe('Hello World');
  });
});

本题详细解读

1. 安装 Supertest

首先，你需要安装 supertest 和 jest（或其他测试框架）来进行测试。你可以使用 npm 或 yarn 来安装它们：

npm install supertest jest --save-dev

2. 创建 Koa 应用

在测试之前，你需要创建一个简单的 Koa 应用。这个应用可以是一个简单的路由处理器，返回一个字符串。

const Koa = require('koa');
const app = new Koa();

app.use(async ctx => {
  ctx.body = 'Hello World';
});

3. 使用 Supertest 进行测试

supertest 是一个用于测试 HTTP 请求的库。它允许你发送 HTTP 请求并验证响应。你可以使用 supertest 来测试 Koa 应用的路由和中间件。

// www.javascriptcn.com code example
const request = require('supertest');

describe('GET /', () => {
  it('should return Hello World', async () => {
    const res = await request(app.callback())
      .get('/')
      .expect(200);

    expect(res.text).toBe('Hello World');
  });
});

4. 解释代码

• request(app.callback())：app.callback() 返回一个适合 http.createServer() 的函数，supertest 使用这个函数来启动一个临时的 HTTP 服务器。
• .get('/')：发送一个 GET 请求到根路径 /。
• .expect(200)：断言响应状态码为 200。
• expect(res.text).toBe('Hello World')：断言响应体为 Hello World。

5. 运行测试

你可以使用 jest 或其他测试框架来运行测试。如果你使用 jest，只需在终端中运行：

npx jest

这将运行所有测试文件并输出结果。