nightwatch-plugin-mailhog

A TypeScript based @nightwatchjs plugin for interacting with, and asserting on, data within a @mailhog instance.

Installation

1npm install nightwatch-plugin-mailhog --save-dev

Configuration

Include the plugin, and its dependency on the @nightwatchjs/apitesting plugin, in your nightwatch.conf.js file.

1plugins: ['@nightwatch/apitesting', 'nightwatch-plugin-mailhog']
2// If you don't already have a global variables file, create one.
3globals_path: 'nightwatch/globals.ts'

Define your mailhog API endpoint within your global variables file:

1import {NightwatchGlobals} from 'nightwatch';
2
3const globals: NightwatchGlobals = {
4	mailhog: 'http://localhost:4566/mailhog/api',
5};
6export default globals;

Example Usage

1import {type NightwatchTests} from 'nightwatch';
2// Import type definition to enable intellisense for mailhog commands.
3import 'nightwatch-plugin-mailhog';
4
5const email: NightwatchTests = {
6	async 'can retrieve messages'() {
7		// Because this is using 0 for the check, it only confirms that the
8		// MailHog API returns a 200 status code from the request.
9		await browser.assert.mailhogInboxCount(0, 'greaterThanOrEqual');
10	},
11
12	async 'find by keyword and id'() {
13		let email: MailHogItem | undefined = undefined;
14		
15		await browser.mailhog().findEmails('Subject, body, or recipient', items => {
16			if (items.length > 0) {
17				email = items[0];
18			}
19		});
20		
21		await browser.assert.ok(email !== undefined);
22		await browser.assert.ok(email.Content.Body.includes('Some keywords'));
23		await browser.assert.ok(email.Content.Headers.Subject[0].includes('Some keywords'));
24
25		await browser.mailhog().getEmail(email.ID, found => {
26			browser.assert.strictEqual(found.ID, email.ID);
27		});
28	},
29
30	async 'retrieve one-time-password and delete'() {
31		let otpCode: string | undefined = undefined;
32		await browser.mailhog().getOneTimeCode('Your OTP subject', code => {
33			otpCode = code;
34		});
35		await browser.assert.ok(otpCode);
36	},
37
38	async 'delete all messages'() {
39		await browser.mailhog().deleteAllEmails();
40	},
41};
42
43export default email;