2.0.0

Midway Hooks 提供了单元测试工具来帮你完成单测。

请安装：@midwayjs/hooks-testing-library

测试规范

测试文件需满足以下任一条件：

  • 测试文件在 /src/apis 中
  • 测试文件以 .server.test.ts 结尾

API

createApp

创建用于测试的 Application

  1. import { createApp, HooksApplication } from '@midwayjs/hooks-testing-library'
  3. describe('test new features', () => {
  4.   let app: HooksApplication
  5.   beforeAll(async () => {
  6.     app = await createApp()
  7.   })
  9.   afterAll(async () => {
  10.     await app.close()
  11.   })
  12. })

createFunctionApp

用法同 createApp，用于测试 Midway FaaS 应用

  1. import {
  2.   createFunctionApp,
  3.   HooksApplication,
  4. } from '@midwayjs/hooks-testing-library'
  6. describe('test new features', () => {
  7.   let app: HooksApplication
  8.   beforeAll(async () => {
  9.     app = await createFunctionApp()
  10.   })
  12.   afterAll(async () => {
  13.     await app.close()
  14.   })
  15. })

app.runFunction

通过 runFunction 来便捷调用函数并测试

  1. import { createApp, HooksApplication } from '@midwayjs/hooks-testing-library'
  2. import api, { get, post } from '.'
  4. describe('test new features', () => {
  5.   let app: HooksApplication
  6.   beforeAll(async () => {
  7.     app = await createApp()
  8.   })
  10.   it('runFunction', async () => {
  11.     expect(await app.runFunction(api)).toMatchInlineSnapshot(`
  12.       Object {
  13.         "message": "Hello World",
  14.         "method": "GET",
  15.       }
  16.     `)
  17.     expect(await app.runFunction(post, 'Jake')).toMatchInlineSnapshot(
  18.       `"postJake"`
  19.     )
  20.   })
  22.   afterAll(async () => {
  23.     await app.close()
  24.   })
  25. })

app.request

通过 app.request 来运行完整的 http 单元测试。

  1. import { createApp, HooksApplication } from '@midwayjs/hooks-testing-library'
  2. import api, { get, post } from '.'
  4. describe('test new features', () => {
  5.   let app: HooksApplication
  6.   beforeAll(async () => {
  7.     app = await createApp()
  8.   })
  10.   afterAll(async () => {
  11.     await app.close()
  12.   })
  14.   it('request', async () => {
  15.     const response = await app.request(get).expect(200)
  16.     expect(response.text).toMatchInlineSnapshot(`"get"`)
  17.   })
  18. })

app.close

关闭创建的 App

  1. import { createApp, HooksApplication } from '@midwayjs/hooks-testing-library'
  2. import api, { get, post } from '.'
  4. describe('test new features', () => {
  5.   let app: HooksApplication
  6.   beforeAll(async () => {
  7.     app = await createApp()
  8.   })
  10.   afterAll(async () => {
  11.     await app.close()
  12.   })
  13. })

完整单测例子

接口 src/apis/index.ts

  1. import { useContext } from '@midwayjs/hooks'
  3. function useKoaContext() {
  4.   return useContext()
  5. }
  7. export default async () => {
  8.   return {
  9.     message: 'Hello World',
  10.     method: useKoaContext().method,
  11.   }
  12. }
  14. export const get = async () => {
  15.   return 'get'
  16. }
  18. export const post = async (name: string) => {
  19.   return 'post' + name
  20. }

测试 src/apis/index.test.ts

  1. import { createApp, HooksApplication } from '@midwayjs/hooks-testing-library'
  2. import api, { get, post } from '.'
  4. describe('test new features', () => {
  5.   let app: HooksApplication
  6.   beforeAll(async () => {
  7.     app = await createApp()
  8.   })
  10.   afterAll(async () => {
  11.     await app.close()
  12.   })
  14.   it('runFunction', async () => {
  15.     expect(await app.runFunction(api)).toMatchInlineSnapshot(`
  16.       Object {
  17.         "message": "Hello World",
  18.         "method": "GET",
  19.       }
  20.     `)
  21.     expect(await app.runFunction(post, 'Jake')).toMatchInlineSnapshot(
  22.       `"postJake"`
  23.     )
  24.   })
  26.   it('request', async () => {
  27.     const response = await app.request(get).expect(200)
  28.     expect(response.text).toMatchInlineSnapshot(`"get"`)
  29.   })
  30. })