JUnit Jupiter Extension

The JUnit Jupiter extension is available since version 0.10.0.

Starting with version 3.0.0, it’s possible to choose the major Jetty version:

  • It means that code samples below might be a bit different if you’re using junit-servers-jetty-9, junit-servers-jetty-10 or junit-servers-jetty-11.
  • The following will assume you are using junit-servers-jetty-9, but please check commented code for instructions to adapt.

Here is a simple example using the JUnit Jupiter extension:

import com.github.mjeanroy.junit.servers.jetty.EmbeddedJettyConfiguration;
import com.github.mjeanroy.junit.servers.jupiter.JunitServerExtension;

// If you're using `junit-servers-jetty-9`
import com.github.mjeanroy.junit.servers.jetty9.EmbeddedJetty;

// If you're using `junit-servers-jetty-10`
// import com.github.mjeanroy.junit.servers.jetty10.EmbeddedJetty;

// If you're using `junit-servers-jetty-11`
// import com.github.mjeanroy.junit.servers.jetty11.EmbeddedJetty;

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.ExtendWith;
import org.junit.jupiter.api.Test;

@ExtendWith(JunitServerExtension.class)
class MyTest {

  @Test
  void should_have_index(EmbeddedJetty jetty, EmbeddedJettyConfiguration configuration) {
    // Note how the tomcat embedded server has been injected as a parameter of the test method.
    // Note also how the configuration can be injected.

    OkHttpClient client = new OkHttpClient();
    Request request = new Request.Builder()
      .url(jetty.getUrl())
      .build();

    Response response = client.newCall(request).execute();

    Assertions.assertNotNull(configuration);
    Assertions.assertEquals(200, response.code());
  }
}

What happens here:

  • The JunitServerExtension extension:
    • Will automatically start the embedded server before all test and shutdown the server after all test.
    • Automatically inject EmbeddedJetty parameter into the test method (also works with BeforeEach methods, etc.). The extension can also inject the server instance using the TestServer annotation, but it is recommended to use the parameter injection instead.
    • Note that the configuration can also be injected into test methods, exactly like the EmbeddedJetty parameter in the previous example.
  • The default configuration is used.
  • Note that:
    • I use OkHttp as HTTP client, but you are free to use your favorite library.
    • You may want to try the HTTP Client API documented here.

The previous example use the default configuration but you can also provide the server configuration using the TestServerConfiguration annotation. The extension will scan the tested class to see if this annotation is present and:

  • If the annotation is present on a static method, the method is executed and the result is used as the configuration.
  • If the annotation is present on a static field, the field value is used as the configuration.

See the example below:

import com.github.mjeanroy.junit.servers.annotations.TestServerConfiguration;
import com.github.mjeanroy.junit.servers.jetty.EmbeddedJettyConfiguration;
import com.github.mjeanroy.junit.servers.jupiter.JunitServerExtension;

// If you're using `junit-servers-jetty-9`
import com.github.mjeanroy.junit.servers.jetty9.EmbeddedJetty;

// If you're using `junit-servers-jetty-10`
// import com.github.mjeanroy.junit.servers.jetty10.EmbeddedJetty;

// If you're using `junit-servers-jetty-11`
// import com.github.mjeanroy.junit.servers.jetty11.EmbeddedJetty;

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.ExtendWith;
import org.junit.jupiter.api.Test;

@ExtendWith(JunitServerExtension.class)
class MyTest {

  // The custom configuration that will be used to start the embedded jetty server.
  @TestServerConfiguration
  static EmbeddedJettyConfiguration configuration = EmbeddedJettyConfiguration.builder()
    .withPath("/app")
    .withPort(8080)
    .withProperty("spring.profiles.active", "test")
    .build();

  @Test
  void should_have_index(EmbeddedJetty jetty) {
    OkHttpClient client = new OkHttpClient();
    Request request = new Request.Builder()
      .url(jetty.getUrl())
      .build();

    Response response = client.newCall(request).execute();

    Assertions.assertEquals(200, response.code());
  }
}

Alternatively, you can use the RegisterExtension API to provide a custom configuration:

Note that:

  • The extension, if used with static, will start/stop server before all/after all tests (recommended).
  • The extension, if not used with static, will start/stop server before each/after each tests.
import com.github.mjeanroy.junit.servers.annotations.TestServerConfiguration;
import com.github.mjeanroy.junit.servers.jetty.EmbeddedJettyConfiguration;
import com.github.mjeanroy.junit.servers.jupiter.JunitServerExtension;

// If you're using `junit-servers-jetty-9`
import com.github.mjeanroy.junit.servers.jetty9.EmbeddedJetty;

// If you're using `junit-servers-jetty-10`
// import com.github.mjeanroy.junit.servers.jetty10.EmbeddedJetty;

// If you're using `junit-servers-jetty-11`
// import com.github.mjeanroy.junit.servers.jetty11.EmbeddedJetty;

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.RegisterExtension;
import org.junit.jupiter.api.Test;

class MyTest {

  // The extension is used with `static`.
  // Remove it to start/stop server before each/after each test (not recommended).
  @RegisterExtension
  static JunitServerExtension extension = new JunitServerExtension(
    EmbeddedJettyConfiguration.builder()
      .withPath("/app")
      .withPort(8080)
      .withProperty("spring.profiles.active", "test")
      .build()
  );

  @Test
  void should_have_index(EmbeddedJetty jetty) {
    OkHttpClient client = new OkHttpClient();
    Request request = new Request.Builder()
      .url(jetty.getUrl())
      .build();

    Response response = client.newCall(request).execute();

    Assertions.assertEquals(200, response.code());
  }
}

Note: available options are documented here.