Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wiremock/wiremock-testcontainers-java
WireMock module for Testcontainers for Java
https://github.com/wiremock/wiremock-testcontainers-java
api hacktoberfest java testcontainers testcontainers-junit-jupiter wiremock wiremock-java
Last synced: 6 days ago
JSON representation
WireMock module for Testcontainers for Java
- Host: GitHub
- URL: https://github.com/wiremock/wiremock-testcontainers-java
- Owner: wiremock
- License: apache-2.0
- Created: 2023-04-15T14:26:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-09T21:26:42.000Z (3 months ago)
- Last Synced: 2024-08-10T21:56:33.966Z (3 months ago)
- Topics: api, hacktoberfest, java, testcontainers, testcontainers-junit-jupiter, wiremock, wiremock-java
- Language: Java
- Homepage: https://wiremock.org/docs/solutions/testcontainers/
- Size: 288 KB
- Stars: 49
- Watchers: 2
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Testcontainers Java module for WireMock
[](https://github.com/wiremock/wiremock-testcontainers-java/releases)
[](https://slack.wiremock.org/)
[](https://github.com/wiremock/wiremock-testcontainers-java/graphs/contributors)
> NOTE: This project is under development, the GitHub Packages release is coming soon.
> Not all WireMock features are supported at the moment,
> and there might be incompatible changes before the 1.0 release.
> Contributions are welcome!
This module allows provisioning the WireMock server
as a standalone container
within your unit tests, based on [WireMock Docker](https://github.com/wiremock/wiremock-docker).
While you can run [WireMock Java](https://github.com/wiremock/wiremock)
with the same result for the most of the use-cases,
it might be helpful to isolate JVMs or to run on
Java versions and platforms not supported by WireMock.
A common example is using Wiremock 3.x with Java 1.8.
## Compatibility
The module is compatible with the following WireMock versions:
- WireMock (aka WireMock Java) `2.0.0` and above
- WireMock (aka WireMock Java) `3.x` versions.
Note that the official image for WireMock 3 is yet to be released and verified ([issue #59](https://github.com/wiremock/wiremock-testcontainers-java/issues/59))
Other WireMock implementations may work but have not been tested yet.
Please feel free to contribute the integration tests and compatibility layers!
## Usage
### Importing the dependency
The module is published to Maven Central and GitHub Packages.
You can also use [JitPack](https://jitpack.io/) to add the dependency in your projects.
#### Maven
```xml
org.wiremock.integrations.testcontainers
wiremock-testcontainers-module
${see the releases}
test
```
#### Gradle
```gradle
dependencies {
testImplementation 'org.wiremock.integrations.testcontainers:wiremock-testcontainers-module:${wiremock-testcontainers.version}'
}
```
#### GitHub Packages
GitHub Packages uses the official Maven coordinates (same as Maven Central above),
but you will need to configure the server and authentication.
#### JitPack
JitPack / Maven
```xml
com.github.wiremock
wiremock-testcontainers-java
${wiremock-testcontainers.version}
test
jitpack.io
https://jitpack.io
```
JitPack / Gradle
```gradle
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
dependencies {
testImplementation 'com.github.wiremock:wiremock-testcontainers-java:${wiremock-testcontainers.version}'
}
```
### Using the test container in JUnit 4/5
P.S: Javadoc is coming soon!
#### Sample Code using JUnit 5
```java
import org.junit.jupiter.api.*;
import org.testcontainers.junit.jupiter.*;
import org.wiremock.integrations.testcontainers.testsupport.http.*;
import static org.assertj.core.api.Assertions.assertThat;
@Testcontainers
class WireMockContainerJunit5Test {
@Container
WireMockContainer wiremockServer = new WireMockContainer("wiremock/wiremock:2.35.0")
.withMapping("hello", WireMockContainerJunit5Test.class, "hello-world.json");
@Test
void helloWorld() throws Exception {
// given
String url = wiremockServer.getUrl("/hello");
// when
HttpResponse response = new TestHttpClient().get(url);
// then
assertThat(response.getBody())
.as("Wrong response body")
.contains("Hello, world!");
}
}
```
#### Sample Code using JUnit 4
Show Code
```java
import org.junit.*;
import org.wiremock.integrations.testcontainers.testsupport.http.*;
import static org.assertj.core.api.Assertions.assertThat;
public class WireMockContainerJunit4Test {
@Rule
public WireMockContainer wiremockServer = new WireMockContainer("wiremock/wiremock:2.35.0")
.withMapping("hello", WireMockContainerJunit4Test.class, "hello-world.json");
@Test
public void helloWorld() throws Exception {
// given
String url = wiremockServer.getUrl("/hello");
// when
HttpResponse response = new TestHttpClient().get(url);
// then
assertThat(response.getBody())
.as("Wrong response body")
.contains("Hello, world!");
}
}
```
### Using WireMock extensions
The API supports adding [WireMock extensions](https://wiremock.org/docs/extending-wiremock/)
to the test container.
The extension can be sourced from the classpath for bundled extensions,
or added from the JAR file in the initializer.
#### Using external extensions
For the external extensions,
an extension Jar should be pulled to the test directory before running the test.
[Apache Maven Dependency Plugin](https://maven.apache.org/plugins/maven-dependency-plugin/) can be used for this purpose.
Make sure that all dependencies of the extension JAR, if any,
are also included.
Below you can see an examples of using the _JSON Body Transformer_ extension
from the [9cookies/wiremock-extensions](https://github.com/9cookies/wiremock-extensions).
Copying the dependency:
```xml
org.apache.maven.plugins
maven-dependency-plugin
3.5.0
copy
package
copy
com.ninecookies.wiremock.extensions
wiremock-extensions
0.4.1
jar-with-dependencies
${project.build.directory}/test-wiremock-extension
```
Mapping definition:
```json
{
"request": {
"method": "POST",
"url": "/json-body-transformer"
},
"response": {
"status": 201,
"headers": {
"content-type": "application/json"
},
"jsonBody": {
"message": "Hello, $(name)!"
},
"transformers" : ["json-body-transformer"]
}
}
```
Test sample:
##### Sample code using JUnit 5
```java
import org.junit.jupiter.api.*;
import org.testcontainers.junit.jupiter.*;
import org.wiremock.integrations.testcontainers.testsupport.http.*;
import java.nio.file.Paths;
import java.util.Collections;
import static org.assertj.core.api.Assertions.assertThat;
@Testcontainers
class WireMockContainerExtensionJunit5Test {
@Container
WireMockContainer wiremockServer = new WireMockContainer("wiremock/wiremock:2.35.0")
.withMapping("json-body-transformer", WireMockContainerExtensionJunit5Test.class, "json-body-transformer.json")
.withExtension("JSON Body Transformer",
Collections.singleton("com.ninecookies.wiremock.extensions.JsonBodyTransformer"),
Collections.singleton(Paths.get("target", "test-wiremock-extension", "wiremock-extensions-0.4.1-jar-with-dependencies.jar").toFile()));
@Test
void testJSONBodyTransformer() throws Exception {
// given
String url = wiremockServer.getUrl("/json-body-transformer");
String body = "{\"name\":\"John Doe\"}";
// when
HttpResponse response = new TestHttpClient().post(url, body);
// then
assertThat(response.getBody()).as("Wrong response body")
.contains("Hello, John Doe!");
}
}
```
##### Sample code using JUnit 4
Show Code
```java
import org.junit.*;
import org.wiremock.integrations.testcontainers.testsupport.http.*;
import java.nio.file.Paths;
import java.util.Collections;
import static org.assertj.core.api.Assertions.assertThat;
public class WireMockContainerExtensionJunit4Test {
@Rule
public WireMockContainer wiremockServer = new WireMockContainer("wiremock/wiremock:2.35.0")
.withMapping("json-body-transformer", WireMockContainerExtensionJunit4Test.class, "json-body-transformer.json")
.withExtension("JSON Body Transformer",
Collections.singleton("com.ninecookies.wiremock.extensions.JsonBodyTransformer"),
Collections.singleton(Paths.get("target", "test-wiremock-extension", "wiremock-extensions-0.4.1-jar-with-dependencies.jar").toFile()));
@Test
public void testJSONBodyTransformer() throws Exception {
// given
String url = wiremockServer.getUrl("/json-body-transformer");
String body = "{\"name\":\"John Doe\"}";
// when
HttpResponse response = new TestHttpClient().post(url, body);
// then
assertThat(response.getBody()).as("Wrong response body")
.contains("Hello, John Doe!");
}
}
```
## Contributing
This repository is implemented as a standard Maven project.
All contributions are welcome!
Just submit a pull request.
See [this page](https://wiremock.org/docs/participate/) for a generic WireMock Contributor Guide