A Web server as external resource

The WebServer rule allows creation of files and folders that are guaranteed to be deleted when the test method finishes (whether it passes or fails):

public static class HasWebServer {
  @Rule
  public WebServer webServer = new WebServer();

  @Test
  public void testUsingWebServer() throws IOException {

    // ...
    this.webServer.addServlet(servlet, servletPath);
    // ...
  }
}

Creating the web-server

The creation of the web-server requires the HTTP port on which it will listen. The default listening port is '{{WebServer.DEFAULT_HTTP_PORT}'. You can use your own HTTP port using the right constructor:

  // A web server listening on the default HTTP port
  @Rule
  public WebServer webServer = new WebServer();

  // A web server listening on your own HTTP port
  @Rule
  public WebServer webServer = new WebServer(8080);

Registering servlet

A web-server maps URLs on servlets. If your test requires a servlet, you can register a servlet through the API 'WebServer.addServlet(httpServlet, path)', where 'httpServlet' is your servlet to map on the URL path part '{path}}':

public static class HasWebServer {
  @Rule
  public WebServer webServer = new WebServer();

  @Test
  public void testUsingWebServer() throws IOException {

    // ...
    this.webServer.addServlet(servlet, servletPath);
    // ...
  }
} 

Pre-defined servlets

Several servlets are provided into the Petals JUnit Framework:

• FileServlet that replies with the content of a file,
• TextServlet that replies with a plain-text content.

Working with FileServlet

The reply of this servlet is:

• the content-type that has been set when creating the servlet,
• the content of the given file when creating the servlet.

  public static class HasWebServer {
    @Rule
    public WebServer webServer = new WebServer();
  
    @Test
    public void testUsingWebServer() throws IOException {
  
      // ...
      final AbstractHttpServlet fileServlet = new FileServlet(
           new File(Thread.currentThread().getContextClassLoader().getResource("my-file").toURI()),
           MimeTypeConstants.APPLICATION_ZIP);
      this.webServer.addServlet(fileServlet, fileServlet.getPath());
      // ...
    }
  }