Servizio WireMock

wdio-wiremock-service è un pacchetto di terze parti, per maggiori informazioni consultare GitHub | npm

Questo servizio ti aiuta a eseguire WireMock senza problemi quando esegui test con WebdriverIO. Utilizza il ben noto repository Maven per scaricare il file jar di WireMock per te, che viene poi automaticamente installato, avviato e arrestato. Rimani aggiornato unendoti alla community su Gitter per aiuto e supporto.

Installazione

npm i -D wdio-wiremock-service

Le istruzioni su come installare WebdriverIO possono essere trovate qui.

Utilizzo

Nella directory principale (predefinita ./mock) si trovano due sottodirectory, __files e mappings che vengono utilizzate per i tuoi fixture e mock.

Per ulteriori informazioni, consulta la documentazione ufficiale di WireMock.

Configurazione

Per utilizzare il servizio con il testrunner wdio è necessario aggiungerlo all'array dei servizi:

// wdio.conf.js
export.config = {
  // ...
  services: ['wiremock'],
  // ...
};

Quando si utilizza webdriverio standalone è necessario aggiungere il servizio e attivare manualmente gli hook onPrepare e onComplete. Un esempio può essere trovato qui (l'esempio utilizza Jest):

Opzioni

Le seguenti opzioni possono essere aggiunte al servizio.

port

Porta su cui WireMock dovrebbe funzionare.

Tipo: Number

Predefinito: 8080

Esempio:

// wdio.conf.js
export const config = {
	// ...
	services: [['wiremock', { port: 8181 }]],
	// ...
};

rootDir

Percorso in cui WireMock cercherà i file.

Tipo: String

Predefinito: ./mock

Esempio:

// wdio.conf.js
export const config = {
	// ...
	services: [['wiremock', { rootDir: './mock' }]],
	// ...
};

version

Versione di WireMock da scaricare e utilizzare.

Tipo: String

Predefinito: 3.3.1

Esempio:

// wdio.conf.js
export const config = {
	// ...
	services: [['wiremock', { version: '2.25.1' }]],
	// ...
};

skipWiremockInstall

Dice al servizio di saltare il download di WireMock.

Tipo: Boolean

Predefinito: false

Esempio:

// wdio.conf.js
export const config = {
	// ...
	services: [['wiremock', { skipWiremockInstall: true }]],
	// ...
};

binPath

Percorso personalizzato per un binario locale di Wiremock (spesso utilizzato in combinazione con skipWiremockInstall).

Tipo: String

Predefinito: './wiremock-standalone-3.0.0.jar' (relativo dal servizio)

Esempio:

// wdio.conf.js
export const config = {
	// ...
	services: [['wiremock', { binPath: './my-custom/example-path/wiremock-standalone-3.0.0.jar' }]],
	// ...
};

silent

Modalità silenziosa per registrare l'output di WireMock (inclusa la registrazione aggiuntiva dal servizio stesso).

Tipo: Boolean

Predefinito: false

Esempio:

// wdio.conf.js
export const config = {
	// ...
	services: [['wiremock', { silent: true }]],
	// ...
};

mavenBaseUrl

URL di base per il download da Maven.

Tipo: String

Predefinito: https://repo1.maven.org/maven2

Esempio:

// wdio.conf.js
export const config = {
	// ...
	services: [['wiremock', { mavenBaseUrl: 'https://repo1.maven.org/maven2' }]],
	// ...
};

args

Elenco in cui è possibile passare tutti gli argomenti supportati per configurare WireMock

Nota: non è possibile passare le opzioni (port, rootDir, stdio, mavenBaseUrl) qui perché verranno ignorate.

Tipo: Array

Esempio:

// wdio.conf.js
export const config = {
	// ...
	services: [
		[
			'wiremock',
			{
				args: ['--verbose', '--match-headers'],
			},
		],
	],
	// ...
};

Scrivere test

Scrivere il primo test è davvero semplice:

Utilizzo del testrunner WDIO

import fetch from 'node-fetch'; // puoi usare qualsiasi client HTTP che preferisci
import { equal } from 'node:assert'; // puoi usare qualsiasi libreria di asserzioni che preferisci

describe('example', () => {
	it(`should assert the mock data`, async () => {
		const body = await fetch('http://localhost:8080/api/mytest');
		equal(body.text(), 'Hello world!');
	});
});

Utilizzo di WebdriverIO Standalone

import fetch from 'node-fetch'; // puoi usare qualsiasi client HTTP che preferisci
import { equal } from 'node:assert'; // puoi usare qualsiasi libreria di asserzioni che preferisci
import { remote } from 'webdriverio';
import { launcher } from 'wdio-wiremock-service';

const WDIO_OPTIONS = {
	capabilities: {
		browserName: 'chrome',
	},
};

describe('example', () => {
	let wiremockLauncher;
	let client;

	beforeAll(async () => {
		wiremockLauncher = new launcher(); // crea un'istanza del servizio
		await wiremockLauncher.onPrepare(WDIO_OPTIONS); // esegui l'hook onPrepare
		client = await remote(WDIO_OPTIONS);
	});

	afterAll(async () => {
		await client.deleteSession();
		await wiremockLauncher.onComplete(); // esegui l'hook onComplete
	});

	test('should showoff a mocked api response', async () => {
		const body = await fetch('http://localhost:8080/api/mytest');
		equal(body.text(), 'Hello world!');
	});
});

Per ulteriori informazioni su WebdriverIO, consulta la homepage.