Блог

Главная - Вопросы по программированию - Пытаюсь научиться писать тесты, как мне писать, когда у меня есть обещание?

Пытаюсь научиться писать тесты, как мне писать, когда у меня есть обещание?

#javascript #unit-testing #jestjs #tdd #sendbird

#javascript #модульное тестирование #jestjs #tdd #sendbird

Вопрос:

Я создал функцию, которая подключается к API и возвращает обещание.. Я хотел протестировать эту функцию, поэтому в шутку создал фиктивную функцию, чтобы справиться с ней, однако я не совсем уверен, что делаю это правильно, и мне очень трудно найти хорошие ресурсы о том, как писать хорошие модульные тесты..

 export const sbConnect = (userId) => {
  return new Promise((resolve, reject) => {
    const sb = new SendBird({appId: APP_ID});
    sb.connect(userId, API_Token, (user, error) => {
      if (error) {
        reject(error);
      } else {
        resolve(user);
      }
    });
  });
};

Это та функция, которую я пытаюсь протестировать. Я создал тест и пробовал это до сих пор..

 import {sbConnect} from '../helpers/sendBirdSetupActions';

const SendBird = jest.fn();

describe('Connects to SendBird API', () => {
  it('Creates a new SB instance', () => {
    let userId = 'testUser';
    let APP_ID = 'Testing_App_ID_001';
    sbConnect(userId);
    expect(SendBird).toBeCalled();
  });
});

Комментарии:

1. jest.fn() В вашем тесте нет никакой связи ни с чем, что происходит в реальном коде. Предположительно SendBird import , это внесено в тестируемый код, так что взгляните на jestjs.io/docs/en/es6-class-mocks . Что касается написания тестов, включающих обещания, см. jestjs.io/docs/en/tutorial-async .

2. Я читал оба этих документа, чтобы зайти так далеко, я продолжу изучать и посмотрю, начнет ли это иметь смысл.

Ответ №1:

Вы можете использовать jest.mock(moduleName, factory, options) для создания макета sendbird модуля вручную.

Макет SendBird конструктора, экземпляра и его методов.

Например.

index.ts :

 import SendBird from 'sendbird';

const API_Token = 'test api token';
const APP_ID = 'test api id';

export const sbConnect = (userId) => {
  return new Promise((resolve, reject) => {
    const sb = new SendBird({ appId: APP_ID });
    sb.connect(userId, API_Token, (user, error) => {
      if (error) {
        reject(error);
      } else {
        resolve(user);
      }
    });
  });
};

index.test.ts :

 import { sbConnect } from './';
import SendBird from 'sendbird';

const mSendBirdInstance = {
  connect: jest.fn(),
};
jest.mock('sendbird', () => {
  return jest.fn(() => mSendBirdInstance);
});

describe('65220363', () => {
  afterAll(() => {
    jest.resetAllMocks();
  });
  it('should get user', async () => {
    const mUser = { name: 'teresa teng' };
    mSendBirdInstance.connect.mockImplementationOnce((userId, API_Token, callback) => {
      callback(mUser, null);
    });
    const actual = await sbConnect('1');
    expect(actual).toEqual(mUser);
    expect(SendBird).toBeCalledWith({ appId: 'test api id' });
    expect(mSendBirdInstance.connect).toBeCalledWith('1', 'test api token', expect.any(Function));
  });

  it('should handle error', async () => {
    const mError = new Error('network');
    mSendBirdInstance.connect.mockImplementationOnce((userId, API_Token, callback) => {
      callback(null, mError);
    });
    await expect(sbConnect('1')).rejects.toThrow(mError);
    expect(SendBird).toBeCalledWith({ appId: 'test api id' });
    expect(mSendBirdInstance.connect).toBeCalledWith('1', 'test api token', expect.any(Function));
  });
});

результат модульного теста:

  PASS  src/stackoverflow/65220363/index.test.ts (11.115s)
  65220363
    ✓ should get user (6ms)
    ✓ should get user (3ms)

----------|----------|----------|----------|----------|-------------------|
File      |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
----------|----------|----------|----------|----------|-------------------|
All files |      100 |      100 |      100 |      100 |                   |
 index.ts |      100 |      100 |      100 |      100 |                   |
----------|----------|----------|----------|----------|-------------------|
Test Suites: 1 passed, 1 total
Tests:       2 passed, 2 total
Snapshots:   0 total
Time:        12.736s

исходный код: https://github.com/mrdulin/jest-codelab/tree/master/src/stackoverflow/65220363