Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/perfana/test-events-wiremock

Events to load and change wiremock stubs during load tests.
https://github.com/perfana/test-events-wiremock

Last synced: 2 days ago
JSON representation

Events to load and change wiremock stubs during load tests.

Host: GitHub
URL: https://github.com/perfana/test-events-wiremock
Owner: perfana
License: apache-2.0
Created: 2019-03-01T14:40:09.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2023-10-04T09:51:37.000Z (over 1 year ago)
Last Synced: 2023-10-04T18:54:25.805Z (over 1 year ago)
Language: Java
Size: 139 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# test-events-wiremock

Events to load and change wiremock stubs during load tests.

Properties:
* `wiremockFilesDir` the directory where to find the wiremock files
* `wiremockUrl` the wiremock base url, e.g. `http://wiremock:9999/`
* `useProxy` true/false calls localhost proxy on port 8888, for example to use with mitmproxy
* `continueOnUploadError` if true, continue uploading other files if an upload error occurs, default is true

Custom events:
* `wiremock-change-mappings` --- change delay of wiremock mapping file(s)
* uses the `/__admin/mappings` endpoint
* `wiremock-change-settings` --- change delay of wiremock settings file
* uses the `/__admin/settings` endpoint
* `wiremock-change-import` --- change delay of wiremock import file
* uses the `/__admin/mappings/import` endpoint

Use the correct type of file for each event. For import use the exported file of wiremock studio
that contains multiple mappings.

All files should end in `.json`.

Example wiremock response (single mapping) with a dynamic delay:

```json
{
"request": {
"method": "GET",
"url": "/delay"
},
"response": {
"status": 200,
"body": "Hello world! from Wiremock, with delay :-)",
"fixedDelayMilliseconds": ${delay},
"headers": {
"Content-Type": "text/plain"
}
}
}
```
Put this in a mapper file located in the `wiremockFilesDir` and it gets uploaded with
the specific delay. The `$delay` will be replaced by the values in the `eventSchedulerScript`.

You can define multiple delays in multiple mapping files.

Define the delays in a `eventSchedulerScript`, example in use with events-gatling-maven-plugin:

```xml

```
This means: set delay to 400 milliseconds at the start of the Gatling load test.
Then increase the response time to 4000 milliseconds after 30 seconds.
And increase response time to 8000 milliseconds after 1 minute and 30 seconds.

The second part (`wiremock-change-mappings(fast)`) is an event name plus annotation that
is sent as event annotation as made visible in Perfana and in graphs.

To replace multiple delays, use multiple replace tags in your mapper files,
e.g. `${delay-1}`, `${delay-2}`, `${delay-3}`, you can use a `;` separator in one event line:

PT30S|wiremock-change-mappings|delay-1=4000;delay-2=3000;delay-3=2000

## specific file

When no `file` or `directory` is specified, all `.json` files in the `wiremockFilesDir` will have the
replacements applied and will be uploaded.

To just upload one specific file, use the file parameter. Example, only the `wiremock-settings.json` will be
processed and replaced:

```
PT10S|wiremock-change-settings|file=wiremock-settings.json;delay=400
```

## directories

Instead of using replacements, you can also create multiple directories that contain
the `mappings`, `settings` or `import` files. By pointing to different directories at certain times,
the files in that directory will be loaded.

Example schedules:

### mappings

The mappings are replaced. You need the same mappings to override the previous ones.

```xml

```

### imports

Import files will also replaced, the imported mapping are not deleted.
The uuid's of the mappings need to be the same in each file for this to succeed.

```xml

```

### settings

The settings file will be replaced.

```xml

```

Make sure the directories are sub-directories of the `wiremockFilesDir`.

## use proxy

Use a proxy like [mitmproxy](https://mitmproxy.org/) to debug the http traffic between the
plugin and wiremock. Set `useProxy` to true and use activate proxy on `http://localhost:8888`.

## Use with events-*-maven-plugin

You can use the `test-events-wiremock` as a plugin of the `events-*-maven-plugin`
by putting the `test-events-wiremock` jar on the classpath of the plugin.

You can use the `dependencies` element inside the `plugin` element.

For example (from [example-pom.xml](src/test/resources/example-pom.xml)):

```xml

io.perfana
event-scheduler-maven-plugin

true
true
true
true

${eventScheduleScript}

WiremockEvent1
src/test/resources/wiremock-stubs
http://localhost:9999/__admin/mappings
false

${systemUnderTest}
${version}
${workload}
${testEnvironment}
${testRunId}
${buildResultsUrl}
${rampupTimeInSeconds}
${constantLoadTimeInSeconds}
${annotations}
${tags}

io.perfana
test-events-wiremock
${test-events-wiremock.version}

```

You can substitute `event-scheduler-maven-plugin` by `event-gatling-maven-plugin`, `event-jmeter-maven-plugin`
and others when available.

Try this by calling:

java -jar wiremock-standalone-[version].jar -v --port 9999

and

mvn -f src/test/resources/example-pom.xml event-scheduler:test

Works with the Perfana event-scheduler framework:
* https://github.com/perfana/event-scheduler
* https://github.com/perfana/events-gatling-maven-plugin