package io.dropwizard.testing.junit5;
import com.fasterxml.jackson.databind.ObjectMapper;
import io.dropwizard.setup.Environment;
import io.dropwizard.testing.common.DropwizardClient;
import java.net.URI;
import java.net.URL;
//@formatter:off
Test your HTTP client code by writing a JAX-RS test double class and let this extension start and stop a
Dropwizard application containing your doubles.
Example:
@Path("/ping") public static class PingResource { @GET public String ping() { return "pong"; } } public static DropwizardClientExtension dropwizard = new DropwizardClientExtension(new PingResource()); @Test public void shouldPing() throws IOException { URL url = new URL(dropwizard.baseUri() + "/ping"); String response = new BufferedReader(new InputStreamReader(url.openStream())).readLine(); assertEquals("pong", response); }
Of course, you'd use your http client, not URL.openStream()
.
The DropwizardClientExtension
takes care of:
- Creating a simple default configuration.
- Creating a simplistic application.
- Adding a dummy health check to the application to suppress the startup warning.
- Adding your resources to the application.
- Choosing a free random port number.
- Starting the application.
- Stopping the application.
/**
* Test your HTTP client code by writing a JAX-RS test double class and let this extension start and stop a
* Dropwizard application containing your doubles.
* <p>
* Example:
* <pre><code>
{@literal @}Path("/ping")
public static class PingResource {
{@literal @}GET
public String ping() {
return "pong";
}
}
public static DropwizardClientExtension dropwizard = new DropwizardClientExtension(new PingResource());
{@literal @}Test
public void shouldPing() throws IOException {
URL url = new URL(dropwizard.baseUri() + "/ping");
String response = new BufferedReader(new InputStreamReader(url.openStream())).readLine();
assertEquals("pong", response);
}
</code></pre>
* Of course, you'd use your http client, not {@link URL#openStream()}.
* </p>
* <p>
* The {@link DropwizardClientExtension} takes care of:
* <ul>
* <li>Creating a simple default configuration.</li>
* <li>Creating a simplistic application.</li>
* <li>Adding a dummy health check to the application to suppress the startup warning.</li>
* <li>Adding your resources to the application.</li>
* <li>Choosing a free random port number.</li>
* <li>Starting the application.</li>
* <li>Stopping the application.</li>
* </ul>
* </p>
*/
//@formatter:off
public class DropwizardClientExtension implements DropwizardExtension {
private final DropwizardClient client;
public DropwizardClientExtension(Object... resources) {
this.client = new DropwizardClient(resources);
}
public URI baseUri() {
return client.baseUri();
}
public ObjectMapper getObjectMapper() {
return client.getObjectMapper();
}
public Environment getEnvironment() {
return client.getEnvironment();
}
@Override
public void before() throws Throwable {
client.before();
}
@Override
public void after() {
client.after();
}
}