README-JUnit4.md

sparkjava-testing

A small testing library with a JUnit Rule for spinning up a Spark server for functional testing of HTTP clients.

Example usage

See the actual tests for example usage. But if you don't want to do that, here's a short example.

Generally you will want to use a JUnit @ClassRule so the server is spun up once before any test has run. Then your tests run, making HTTP requests to the test server, and finally the server is shut down once after all tests have run. In your JUnit 4 (haven't gotten around to doing this for JUnit 5 yet....) test class, declare a rule:

@ClassRule
public static final SparkServerRule SPARK_SERVER = new SparkServerRule(http -> {
    http.get("/ping", (request, response) -> "pong");
    http.get("/health", (request, response) -> "healthy");
});

In the above rule, there are two routes, /ping and /health, specified in the lambda which simply return 200 responses containing strings. Here's an example test using a Jersey client (I'm using AssertJ assertions in this test):

@Test
public void testSparkServerRule_PingRequest() {
    client = ClientBuilder.newBuilder().build();
    Response response = client.target(URI.create("http://localhost:4567/ping"))
            .request()
            .get();
    assertThat(response.getStatus()).isEqualTo(200);
    assertThat(response.readEntity(String.class)).isEqualTo("pong");
}

Since Spark runs on port 4567 by default that's the port our client test uses. Also, the client is closed in a test tear down method.

The SparkServerRule class has only one constructor that accepts a ServiceInitializer, which is a @FunctionalInterface so you can pass a lambda expression. The ServiceInitializer#init method takes one argument, an instance of Spark's Service class, on which you configure the server, add routes, filters, etc. For example, to start your test server on a different port, you can do this:

@ClassRule
public static final SparkServerRule SPARK_SERVER = new SparkServerRule(http -> {
    http.port(9876);
    http.get("/ping", (request, response) -> "pong");
    http.get("/health", (request, response) -> "healthy");
});

And if you want to change not only the port, but also the IP address and make the server secure, you can do it like this:

@ClassRule
public static final SparkServerRule SPARK_SERVER = new SparkServerRule(
        https -> {
            https.ipAddress("127.0.0.1");
            https.port(9876);
            URL resource = Resources.getResource("sample-keystore.jks");
            https.secure(resource.getFile(), "password", null, null);
            https.get("/ping", (request, response) -> "pong");
            https.get("/health", (request, response) -> "healthy");
        });

See the actual unit tests for concrete examples.