WireMock 服务

wdio-wiremock-service 是一个第三方包，更多信息请查看 GitHub | npm

这个服务帮助您在使用 WebdriverIO 运行测试时无缝运行 WireMock。它使用知名的 Maven 仓库为您下载 WireMock jar 包，然后自动安装、启动和停止。加入 Gitter 社区获取帮助和支持，及时获取最新信息。

安装

npm i -D wdio-wiremock-service

关于如何安装 WebdriverIO 的说明可以在这里找到。

使用方法

在根目录（默认为 ./mock）中，您会找到两个子目录，__files 和 mappings，用于存放您的固定数据和模拟。

更多信息，请查看 WireMock 的官方文档。

配置

为了在 wdio 测试运行器中使用该服务，您需要将其添加到服务数组中：

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

当使用 webdriverio 独立模式时，您需要手动添加服务并触发 onPrepare 和 onComplete 钩子。示例可以在这里找到（示例使用了 Jest）：

选项

以下选项可以添加到服务中。

port

WireMock 应该运行的端口。

类型：Number

默认值：8080

示例：

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

rootDir

WireMock 查找文件的路径。

类型：String

默认值：./mock

示例：

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

version

要下载和使用的 WireMock 版本。

类型：String

默认值：3.3.1

示例：

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

skipWiremockInstall

告诉服务跳过下载 WireMock。

类型：Boolean

默认值：false

示例：

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

binPath

本地 Wiremock 二进制文件的自定义路径（通常与 skipWiremockInstall 结合使用）。

类型：String

默认值：'./wiremock-standalone-3.0.0.jar'（相对于服务）

示例：

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

silent

WireMock 输出的静默模式（包括来自服务本身的额外日志记录）。

类型：Boolean

默认值：false

示例：

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

mavenBaseUrl

Maven 的基础下载 URL。

类型：String

默认值：https://repo1.maven.org/maven2

示例：

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

args

您可以传递所有支持的 WireMock 配置参数的列表。

注意：您不能在这里传递选项（port、rootDir、stdio、mavenBaseUrl），因为它们将被忽略。

类型：Array

示例：

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

编写测试

编写您的第一个测试非常简单：

使用 WDIO 测试运行器

import fetch from 'node-fetch'; // you can use any HTTP client you like
import { equal } from 'node:assert'; // you can use any assertion library you like

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

使用 WebdriverIO 独立模式

import fetch from 'node-fetch'; // you can use any HTTP client you like
import { equal } from 'node:assert'; // you can use any assertion library you like
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(); // create instance of the service
		await wiremockLauncher.onPrepare(WDIO_OPTIONS); // run the onPrepare hook
		client = await remote(WDIO_OPTIONS);
	});

	afterAll(async () => {
		await client.deleteSession();
		await wiremockLauncher.onComplete(); // run the onComplete hook
	});

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

有关 WebdriverIO 的更多信息，请参阅主页。