Testing mail-notifier in nodejs using jest

Question

Does anyone know how to test mail-notifier module in nodejs? I want to test the logic inside n.on():

const notifier = require('mail-notifier');

const imap = {
  user: 'mailId',
  password: 'password',
  host: 'host',
  port: 'port',
  tls: true,
  tlsOptions: { rejectUnauthorized: false }
};

const n = notifier(imap);

n.on('mail', async function (mail) {
  console.log('mail:', mail);
}).start();

Answer 1

Assuming your code exists in notifier.js it can be tested exactly as written as follows:

// mock 'mail-notifier'
jest.mock('mail-notifier', () => {
  // create mock for 'start'
  const startMock = jest.fn();
  // create mock for 'on', always returning the same result
  const onResult = { start: startMock };
  const onMock = jest.fn(() => onResult);
  // create mock for 'notifier', always returning the same result
  const notifierResult = { on: onMock };
  const notifierMock = jest.fn(() => notifierResult);
  // return the mock for notifier
  return notifierMock;
});

// get the mocks we set up from the mocked 'mail-notifier'
const notifierMock = require('mail-notifier');
const onMock = notifierMock().on;
const startMock = onMock().start;
// clear the mocks for notifier and on since we called
// them to get access to the inner mocks
notifierMock.mockClear();
onMock.mockClear();

// with all the mocks set up, require the file
require('./notifier');

describe('notifier', () => {

  it('should call notifier with the config', () => {
    expect(notifierMock).toHaveBeenCalledTimes(1);
    expect(notifierMock).toHaveBeenCalledWith({
      user: 'mailId',
      password: 'password',
      host: 'host',
      port: 'port',
      tls: true,
      tlsOptions: { rejectUnauthorized: false }
    });
  });

  it('should call on with mail and a callback', () => {
    expect(onMock).toHaveBeenCalledTimes(1);
    expect(onMock.mock.calls[0][0]).toBe('mail');
    expect(onMock.mock.calls[0][1]).toBeInstanceOf(Function);
  });

  it('should call start', () => {
    expect(startMock).toHaveBeenCalledTimes(1);
    expect(startMock).toHaveBeenCalledWith();
  });

  describe('callback', () => {

    const callback = onMock.mock.calls[0][1];

    it('should do something', () => {
      // test the callback here
    });

  });

});