React - 如何在 Jest 中对 API 调用进行单元测试?

IT技术 reactjs unit-testing jestjs enzyme
2021-04-25 18:58:58

我有一堆要进行单元测试的 API 调用。据我所知,单元测试 API 调用并不涉及实际进行这些 API 调用。据我所知,您会模拟这些 API 调用的响应,然后测试 DOM 更改,但是我目前正在努力做到这一点。我有以下代码:

应用程序.js

function App() {

  const [text, setText] = useState("");

  function getApiData() {
        fetch('/api')
        .then(res => res.json())
        .then((result) => {
          console.log(JSON.stringify(result));
          setText(result); 
        })
      }

  return (
    <div className="App">
      {/* <button data-testid="modalButton" onClick={() => modalAlter(true)}>Show modal</button> */}
      <button data-testid="apiCall" onClick={() => getApiData()}>Make API call</button>
      <p data-testid="ptag">{text}</p>
    </div>
  );
}

export default App;

应用程序.test.js

it('expect api call to change ptag', async () => {
  const fakeUserResponse = {'data': 'response'};
  var {getByTestId} = render(<App />)
  var apiFunc = jest.spyOn(global, 'getApiData').mockImplementationOnce(() => {
    return Promise.resolve({
      json: () => Promise.resolve(fakeUserResponse)
    })
  })


  fireEvent.click(getByTestId("apiCall"))
  const text = await getByTestId("ptag")
  expect(text).toHaveTextContent(fakeUserResponse['data'])
})

我试图在此处模拟 getApiData() 的结果,然后测试 DOM 更改(p 标记更改为结果)。上面的代码给了我错误:

无法监视 getApiData 属性,因为它不是函数;改为给出未定义

我如何访问该类函数?

编辑:

我已经修改了代码,但我仍然遇到了一些麻烦:

应用程序.js

function App() {

  const [text, setText] = useState("");

  async function getApiData() {
        let result = await API.apiCall()
        console.log("in react side " + result)
        setText(result['data'])
      }

  return (
    <div className="App">
      {/* <button data-testid="modalButton" onClick={() => modalAlter(true)}>Show modal</button> */}
      <button data-testid="apiCall" onClick={() => getApiData()}>Make API call</button>
      <p data-testid="ptag">{text}</p>
    </div>
  );
}

export default App;

apiController.js

export const API = {
    apiCall() {
        return fetch('/api')
        .then(res => res.json())
    }
}

服务器.js

const express = require('express')
const app = express()
const https = require('https')
const port = 5000

app.get('/api', (request, res) => {
    res.json("response")
})

app.listen(port, () => console.log(`Example app listening at http://localhost:${port}`))

应用程序.test.js

import React from 'react';
import { render, shallow, fireEvent } from '@testing-library/react';
import App from './App';
import {API} from './apiController'
//import shallow from 'enzyme'

it('api call returns a string', async () => {
  const fakeUserResponse = {'data': 'response'};
  var apiFunc = jest.spyOn(API, 'apiCall').mockImplementationOnce(() => {
    return Promise.resolve({
      json: () => Promise.resolve(fakeUserResponse)
    })
  })
  var {getByTestId, findByTestId} = render(<App />)
  fireEvent.click(getByTestId("apiCall"))
  expect(await findByTestId("ptag")).toHaveTextContent('response');
})

我得到的错误是

expect(element).toHaveTextContent()

   Expected element to have text content:
     response
   Received:

     14 |   var {getByTestId, findByTestId} = render(<App />)
     15 |   fireEvent.click(getByTestId("apiCall"))
   > 16 |   expect(await findByTestId("ptag")).toHaveTextContent('response');
        |                                      ^
     17 | })
     18 | 
     19 | // it('api call returns a string', async () => {

可重用单元测试(希望如此):

    it('api call returns a string', async () => {
      const test1 = {'data': 'response'};
       const test2 = {'data': 'wrong'}

      var apiFunc = (response) => jest.spyOn(API, 'apiCall').mockImplementation(() => {
        console.log("the response " + JSON.stringify(response))
        return Promise.resolve(response)
        })

      var {getByTestId, findByTestId} = render(<App />)

      let a = await apiFunc(test1);
      fireEvent.click(getByTestId("apiCall"))
      expect(await findByTestId("ptag")).toHaveTextContent('response');
      let b = await apiFunc(test2);
      fireEvent.click(getByTestId("apiCall"))
      expect(await findByTestId("ptag")).toHaveTextContent('wrong');

    })

2个回答

您无法访问,getApiData因为它是其他函数(闭包)中的私有函数,并且没有暴露在全局范围内。这意味着global变量没有属性getApiData,而您将获得undefined given instead.

为此,您需要以某种方式导出此函数,我建议将其移动到不同的文件,但同样的也应该没问题。这是一个简单的例子:

export const API = {
  getData() {
    return fetch('/api').then(res => res.json())
  }
}

在您的组件中的某处:

API.getData().then(result => setText(result))

并在测试中:

var apiFunc = jest.spyOn(API, 'getData').mockImplementationOnce(() => {
    return Promise.resolve({
      json: () => Promise.resolve(fakeUserResponse)
    })
  })

还有其他方法可以实现这一点,但也许这个就足够了。

而且我认为还会有一个问题。您正在使用const text = await getByTestId("ptag"),但是getBy*react-testing-library 中的函数不是异步的(它们不返回您可以等待解决的Promise),因此您的测试将失败,因为您不会等待模拟请求完成。相反,请尝试findBy*您可以await使用的此功能的版本,并确保 promise 得到解决。

不要嘲笑 API 库。最好是存根服务器响应。如果您编写了一堆模拟 API 调用的测试,那么您将应用程序的实现绑定到您的测试。假设您不想使用fetch()但想使用诸如isomorphic-unfetchSSR 应用程序之东西切换整个模拟测试套件将非常痛苦。

相反,使用服务器存根库,如nockmsw将这些库视为 JSDOM,但适用于您的服务器。通过这种方式,您将测试套件绑定到后端而不是实现库。让我们重写您的示例以向您展示我的意思:

import React from 'react';
import nock from 'nock';
import { render, shallow, fireEvent } from '@testing-library/react';

import App from './App';

it('displays user data', async () => {
  const scope = nock('https://yoursite.com')
    .get('/api')
    .once()
    .reply(200, {
      data: 'response',
    });

  var {getByTestId, findByTestId} = render(<App />)
  fireEvent.click(getByTestId("apiCall"))
  expect(await findByTestId("ptag")).toHaveTextContent('response');
})

查看我写的博客文章,深入了解这个主题,测试进行 API 调用的组件