How to get wiremock running before the spring boot application status up?

Question

I have an integration test for a spring boot micro-service. The problem is that the service calls an external service (via REST) on startup. I’m using WireMock to mock the call. Spring makes the application start before WireMock is started. Because of this, the rest call fails and so does the service.

The call is made by a library that is also made by our company, so I cannot change anything there.

Do you have any suggestions for me?

score 11 · Accepted Answer · answered Jan 03 '18 at 04:45

11

you might create static instance of WireMockServer in your test. Here is a code sample:

@RunWith(SpringRunner.class)
@SpringBootTest
public class YourApplicationTests {
    static WireMockServer mockHttpServer = new WireMockServer(10000); // endpoint port here

    @BeforeClass
    public static void setup() throws Exception {
        mockHttpServer.stubFor(get(urlPathMatching("/")).willReturn(aResponse().withBody("test").withStatus(200)));
        mockHttpServer.start();
    }

    @AfterClass
    public static void teardown() throws Exception {
        mockHttpServer.stop();
    }

    @Test
    public void someTest() throws Exception {
        // your test code here
    }
}

answered Jan 03 '18 at 04:45

Alex M981

2,264
14
24

Thanks for the suggestion. I Will try this and let you know of that dit the trick. – Yacine Ait Yaiz Jan 03 '18 at 07:05
4

This still can cause raise conditions. WireMock start can take some time, since `start()` is not blocking operation and it takes some time to init stubs. As a result it can be not started yet fully, when the first request from test are being fired. – Vladyslav Nikolaiev Jul 21 '20 at 20:38

score 2 · Answer 2 · answered Jan 03 '18 at 10:28

2

The Spring Boot team have built a WireMock integration. Might be worth checking it out rather than rolling your own: http://cloud.spring.io/spring-cloud-static/spring-cloud-contract/1.1.2.RELEASE/#_spring_cloud_contract_wiremock

answered Jan 03 '18 at 10:28

Tom

3,471
21
14

2

Thanks for the feedback. I used the spring cloud contract version of wiremock first. But this version is only started after the application context is already started. And that is actually my problem. The accepted answer is working for me. – Yacine Ait Yaiz Jan 03 '18 at 13:02

score 1 · Answer 3 · answered Aug 04 '20 at 04:31

I'm late to the party here, but I've been struggling with the same thing several times, and while the accepted answer can work in many cases, here's the solution I came up with:

https://github.com/ThomasKasene/wiremock-junit-extension

It's a custom JUnit Jupiter extension that you put over your test class, and it'll start up the server for you, much like Spring Cloud Contract's version. The difference is that it's detached from the Spring context so it can be started before Spring spins up its context.

score 1 · Answer 4 · answered Sep 14 '21 at 19:43

If you are running Wiremock programmatically inside JUnit tests you might run into race condition since start() is non blocking. Check official documentation here it states that in context of JUnit tests:

For JUnit 4.x and JUnit 5 Vintage you should use JUnit rule included in WireMock
For JUnit 5+ Jupiter use JUnit Jupiter extension

Vincent F · Answer 5 · 2023-03-04T06:53:15.370

In my case, the static config was working locally and in our CI, until we migrated our CI to cloud.. for some reason, one test was failing, because one Spring bean initiates its cache at startup by calling a remote service, and wiremock was not available at that time.. so the cache would be empty.

why did this start to happen ? I have no idea.. but after adding more logs, to track when the Spring bean was getting instantiated vs when Wiremock was being setup, I realized that the Spring beans were being reused from a previous test.

so my solution, in addition to the static config, was to add @DirtiesContext(classMode = ClassMode.BEFORE_CLASS) on my test, to make sure that the whole Spring context was being reloaded before running the tests

How to get wiremock running before the spring boot application status up?

5 Answers5