Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osskit/wiremock-client
Wiremock utility functions to ease your life
https://github.com/osskit/wiremock-client
jest nodejs tests wiremock
Last synced: about 2 months ago
JSON representation
Wiremock utility functions to ease your life
- Host: GitHub
- URL: https://github.com/osskit/wiremock-client
- Owner: osskit
- License: mit
- Created: 2022-05-25T08:36:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-07T14:46:55.000Z (12 months ago)
- Last Synced: 2024-09-23T05:19:18.417Z (3 months ago)
- Topics: jest, nodejs, tests, wiremock
- Language: TypeScript
- Homepage:
- Size: 153 KB
- Stars: 0
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# wiremock-client
## Useful common functions to easily use wiremock
## Install
```sh
yarn add --dev @osskit/wiremock-client
```
## Usage
### basic usage
```ts
import { setGlobalConfiguration, reset, createMapping, hasMadeCalls, waitForCalls } from '@osskit/wiremock-client';
setGlobalConfiguration({ baseUrl: 'http://localhost:9090' });
describe('tests', () => {
beforeEach(async () => {
await reset();
});
// check if a call has been made
it('hasMadeCalls', async () => {
const request = await createMapping({ request: { urlPathPattern: '/someUrl', method: HttpMethod.Post } });
await fetch('http://localhost:9090/someUrl', { method: HttpMethod.Post, body: '{}' });
await expect(hasMadeCalls(request)).resolves.toBeTruthy();
});
// Simulate error
it('Simulating errors', async () => {
await createMapping({
request: { urlPathPattern: '/someUrl', method: HttpMethod.Post },
response: { fault: 'CONNECTION_RESET_BY_PEER' },
});
await fetch('http://localhost:9090/someUrl', { method: HttpMethod.Post, body: '{}' });
});
// validate the calls that has been made
it('waitForCalls', async () => {
const request = await createMapping({ request: { urlPathPattern: '/someUrl', method: HttpMethod.Post } });
await fetch('http://localhost:9090/someUrl', { method: HttpMethod.Post, body: '{}' });
const calls = await waitForCalls(request);
expect(calls).toHaveLength(1);
expect(calls[0]).toHaveProperty('body', {});
});
});
```
### creating multiple clients
useful for parallel tests
```ts
import { WireMockClient } from '@osskit/wiremock-client';
const client = new WireMockClient('http://localhost:9090');
const client2 = new WireMockClient('http://localhost:8080');
describe('tests', () => {
beforeEach(async () => {
await client.reset();
await client2.reset();
});
// check if a call has been made
it('hasMadeCalls', async () => {
const request = await client.createMapping({ request: { urlPathPattern: '/someUrl', method: HttpMethod.Post } });
await fetch('http://localhost:9090/someUrl', { method: HttpMethod.Post, body: '{}' });
await expect(client.hasMadeCalls(request)).resolves.toBeTruthy();
});
// validate the calls that has been made
it('waitForCalls', async () => {
const request = await client2.createMapping({ request: { urlPathPattern: '/someUrl', method: HttpMethod.Post } });
await fetch('http://localhost:8080/someUrl', { method: HttpMethod.Post, body: '{}' });
const calls = await client2.waitForCalls(request);
expect(calls).toHaveLength(1);
expect(calls[0]).toHaveProperty('body', {});
});
});
```
## API
### setGlobalConfiguration(configuration)
Overrides the global configuration for the wiremock client.
Usually called once at the start of the tests.
#### configuration
Type: `Configuration`
##### baseUrl?
Type: `string`\
Default: `http://localhost:8080`
The url to the `wiremock` server.
### reset()
Resets the requests' mapping.
Returns a `Promise`.
### createMapping(mapping)
Creates mapping between request and response for the mocks to return.
Returns a `Promise` to the request, so it can later be used to get the calls or check if the request was made.
#### mapping
Type: `Mapping`
##### request
Type: `RequestPattern`
The pattern to match requests
###### url?
Type: `string`
###### urlPathPattern?
Type: `string`
###### method?
Type: `HttpMethod`
###### queryParameters?
Type: `Record`
###### bodyPatterns?
Type: `Record[]`
##### response?
Type: `Response`\
Default: `{ status: 200 }`
###### status
Type: `number`
###### jsonBody?
Type: `Record`
###### headers?
Type: `Record`
###### body?
Type: `string`
Body can be a template used to generate random responses, for example:
```ts
await createMapping({
request: { urlPathPattern: '/someUrl', method: HttpMethod.Post },
response: { status: 200, body: "{{randomValue length=33 type='ALPHANUMERIC'}}", transformers: ['response-template'] },
});
```
To use this feature, make sure to start the wiremock docker with the `--local-response-templating` option.
For more on templates see [wiremock docs](http://wiremock.org/docs/response-templating/)
###### base64Body?
Type: `string`
##### priority?
Type: `number`
### waitForCalls(request, options?)
Return a `Promise` to the calls that was made with the given request pattern.
Can be optionally ordered by a given `orderBy` method.
It waits to get the
requests from
wiremock with the given timeout and interval.
Defaults:
- options: { timeoutOptions: { timeoutInMs: 3000, intervalInMs: 500 } }
#### request
Type: `RequestPattern`
#### options
Type: `Options`
##### timeoutOptions
Type: `TimeoutOptions`\
Default: `{ timeoutInMs: 3000, intervalInMs: 500 }`
The options for waiting until calls has been made.
##### orderBy(callA, callB)?
Type: `Function`
An optional function to sort the returning calls, returns a `number`.
##### bodyAsString?
Type: `boolean`
Wheter to treat the `body` of the requests as `string`.
### hasMadeCalls(request, timeoutOptions?)
Returns a `Promise` to a `boolean` representing if any calls with the given request pattern were made.
#### request
Type: `RequestPattern`
#### timeoutOptions
Type: `TimeoutOptions`\
Default: `{ timeoutInMs: 3000, intervalInMs: 500 }`
The options for waiting until calls has been made.