jenspiegsa / wiremock-extension

The wiremock-extension is a JUnit 5 extension that starts WireMock before running tests and stops it afterwards. It is similar to the WireMockRule for JUnit 4.

wiremock-extension

The wiremock-extension is a JUnit 5 extension that starts WireMock before running tests and stops it afterwards. It is similar to the WireMockRule (docs) for JUnit 4.

Usage

Step 1. Add the JitPack repository to your pom.xml file

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Step 2. Add the wiremock-extension dependency

<dependency>
    <groupId>com.github.JensPiegsa</groupId>
    <artifactId>wiremock-extension</artifactId>
    <version>0.4.0</version>
    <scope>test</scope>
</dependency>

Step 3. Annotate test classes by @ExtendWith(WireMockExtension.class)

• see ExampleTest for further configuration and different use cases.

Contribute

Feedback is welcome. The source is available on Github. Please report any issues.

About

Plugin originally created by Jens Piegsa.

wiremock-extension's Issues

Reusing server(s) between each test

Hi,

First of all, I would like to thank you for this extension. I really like this simple but expressive API :).

I have a suggestion for the extension lifecycle callback: I think creating and stopping server(s) for every test is unnecessarily costly. Was there a reason why you did it that way ?

One way would be to do like the WireMockClassRule rule:

• Before each method, we check whether the server is running using the method WireMockServer#isRunning().
  - If it is running, reset the mappings on the server's client
  - If it is not running, start and configure it

Another solution would be to use JUnit 5's store, so that we can easily share server instances between tests (while not forgetting to reset the server(s) before or after each test).

With your current implementation it might require some refactoring. That's why I wanted to have your opinion before submitting a PR.

Thank you !

java.net.BindException: Address already in use error with some disabled tests

Hello,

First of all, thanks for this nice WireMockExtension, it's really appreciated.
I just get an error on the 0.3.1 version. When you have some disabled tests in a test class, it seems that the WireMockExtension start a server in the postProcessTestInstance but never stop it. So the other next tests just fail cause there is already a running server on this port. Obviously I have this issue cause I need to run my WireMock server on the same port for each test.
Let see this simple example to show the problem :

@ExtendWith(WireMockExtension.class)
class SimpleTest {
    @InjectServer
    private WireMockServer server;

    @ConfigureWireMock
    private final Options options = wireMockConfig();

    @Test
    void should_not_fail_test() {
        assertThat(server.isRunning()).isTrue(); // (1) OK
    }

    @Test
    @Disabled
    void should_not_fail_disabled_test() {
        assertThat(server.isRunning()).isTrue(); // (2) OK, disabled
    }

    @Test
    @Disabled
    void should_not_fail_another_disabled_test() {
        assertThat(server.isRunning()).isTrue(); // (3) Failed with Address already in use
    }
}

Thanks in advance.

Overriding wiremock version

Please provide more info how to override wiremock version to use bufixed version 2.32.2

the dependencies should be set to <scope>provided</scope>

I'm trying to use it in my junit 5 based app and getting version conflicts. I had to exclude below to make it work:

<exclusions>
                <exclusion>
                    <groupId>junit</groupId>
                    <artifactId>junit</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.junit.jupiter</groupId>
                    <artifactId>junit-jupiter-api</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.apache.commons</groupId>
                    <artifactId>commons-lang3</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>com.fasterxml.jackson.core</groupId>
                    <artifactId>jackson-core</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>com.fasterxml.jackson.core</groupId>
                    <artifactId>jackson-annotations</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>com.fasterxml.jackson.core</groupId>
                    <artifactId>jackson-databind</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>commons-logging</groupId>
                    <artifactId>commons-logging</artifactId>
                </exclusion>
            </exclusions>