org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactoryTests.java Source code

Java tutorial

Introduction

Here is the source code for org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactoryTests.java

Source

/*
 * Copyright 2002-2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.context.embedded;

import java.io.FileWriter;
import java.io.IOException;
import java.net.SocketException;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.Date;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;

import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.MultiThreadedHttpConnectionManager;
import org.apache.commons.httpclient.methods.GetMethod;
import org.junit.After;
import org.junit.Ignore;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.rules.TemporaryFolder;
import org.mockito.InOrder;
import org.springframework.http.HttpMethod;
import org.springframework.http.client.ClientHttpRequest;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.http.client.SimpleClientHttpRequestFactory;
import org.springframework.util.FileCopyUtils;
import org.springframework.util.StreamUtils;

import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.notNullValue;
import static org.junit.Assert.assertThat;
import static org.mockito.Matchers.anyObject;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;

/**
 * Base for testing classes that extends {@link AbstractEmbeddedServletContainerFactory}.
 * 
 * @author Phillip Webb
 * @author Greg Turnquist
 */
public abstract class AbstractEmbeddedServletContainerFactoryTests {

    @Rule
    public ExpectedException thrown = ExpectedException.none();

    @Rule
    public TemporaryFolder temporaryFolder = new TemporaryFolder();

    protected EmbeddedServletContainer container;

    @After
    public void teardown() {
        if (this.container != null) {
            try {
                this.container.stop();
            } catch (Exception ex) {
            }
        }
    }

    @Test
    public void startServlet() throws Exception {
        ConfigurableEmbeddedServletContainerFactory factory = getFactory();
        this.container = factory.getEmbeddedServletContainer(exampleServletRegistration());
        this.container.start();
        assertThat(getResponse("http://localhost:8080/hello"), equalTo("Hello World"));
    }

    @Test
    public void emptyServerWhenPortIsZero() throws Exception {
        ConfigurableEmbeddedServletContainerFactory factory = getFactory();
        factory.setPort(0);
        this.container = factory.getEmbeddedServletContainer(exampleServletRegistration());
        this.container.start();
        this.thrown.expect(SocketException.class);
        getResponse("http://localhost:8080/hello");
    }

    @Test
    public void stopServlet() throws Exception {
        ConfigurableEmbeddedServletContainerFactory factory = getFactory();
        this.container = factory.getEmbeddedServletContainer(exampleServletRegistration());
        this.container.start();
        this.container.stop();
        this.thrown.expect(SocketException.class);
        getResponse("http://localhost:8080/hello");
    }

    @Test
    @Ignore
    public void restartWithKeepAlive() throws Exception {
        ConfigurableEmbeddedServletContainerFactory factory = getFactory();
        this.container = factory.getEmbeddedServletContainer(exampleServletRegistration());
        this.container.start();
        MultiThreadedHttpConnectionManager connectionManager = new MultiThreadedHttpConnectionManager();
        HttpClient client = new HttpClient(connectionManager);
        GetMethod get1 = new GetMethod("http://localhost:8080/hello");
        assertThat(client.executeMethod(get1), equalTo(200));
        get1.releaseConnection();

        this.container.stop();
        this.container = factory.getEmbeddedServletContainer(exampleServletRegistration());

        GetMethod get2 = new GetMethod("http://localhost:8080/hello");
        assertThat(client.executeMethod(get2), equalTo(200));
        get2.releaseConnection();
    }

    @Test
    public void startServletAndFilter() throws Exception {
        ConfigurableEmbeddedServletContainerFactory factory = getFactory();
        this.container = factory.getEmbeddedServletContainer(exampleServletRegistration(),
                new FilterRegistrationBean(new ExampleFilter()));
        this.container.start();
        assertThat(getResponse("http://localhost:8080/hello"), equalTo("[Hello World]"));
    }

    @Test
    public void startBlocksUntilReadyToServe() throws Exception {
        ConfigurableEmbeddedServletContainerFactory factory = getFactory();
        final Date[] date = new Date[1];
        this.container = factory.getEmbeddedServletContainer(new ServletContextInitializer() {
            @Override
            public void onStartup(ServletContext servletContext) throws ServletException {
                try {
                    Thread.sleep(500);
                    date[0] = new Date();
                } catch (InterruptedException ex) {
                    throw new ServletException(ex);
                }
            }
        });
        this.container.start();
        assertThat(date[0], notNullValue());
    }

    @Test
    public void specificPort() throws Exception {
        ConfigurableEmbeddedServletContainerFactory factory = getFactory();
        factory.setPort(8081);
        this.container = factory.getEmbeddedServletContainer(exampleServletRegistration());
        this.container.start();
        assertThat(getResponse("http://localhost:8081/hello"), equalTo("Hello World"));
    }

    @Test
    public void specificContextRoot() throws Exception {
        ConfigurableEmbeddedServletContainerFactory factory = getFactory();
        factory.setContextPath("/say");
        this.container = factory.getEmbeddedServletContainer(exampleServletRegistration());
        this.container.start();
        assertThat(getResponse("http://localhost:8080/say/hello"), equalTo("Hello World"));
    }

    @Test
    public void contextPathMustStartWithSlash() throws Exception {
        this.thrown.expect(IllegalArgumentException.class);
        this.thrown.expectMessage("ContextPath must start with '/ and not end with '/'");
        getFactory().setContextPath("missingslash");
    }

    @Test
    public void contextPathMustNotEndWithSlash() throws Exception {
        this.thrown.expect(IllegalArgumentException.class);
        this.thrown.expectMessage("ContextPath must start with '/ and not end with '/'");
        getFactory().setContextPath("extraslash/");
    }

    @Test
    public void contextRootPathMustNotBeSlash() throws Exception {
        this.thrown.expect(IllegalArgumentException.class);
        this.thrown.expectMessage("Root ContextPath must be specified using an empty string");
        getFactory().setContextPath("/");
    }

    @Test
    public void doubleStop() throws Exception {
        ConfigurableEmbeddedServletContainerFactory factory = getFactory();
        this.container = factory.getEmbeddedServletContainer(exampleServletRegistration());
        this.container.start();
        this.container.stop();
        this.container.stop();
    }

    @Test
    public void multipleConfigurations() throws Exception {
        ConfigurableEmbeddedServletContainerFactory factory = getFactory();
        ServletContextInitializer[] initializers = new ServletContextInitializer[6];
        for (int i = 0; i < initializers.length; i++) {
            initializers[i] = mock(ServletContextInitializer.class);
        }
        factory.setInitializers(Arrays.asList(initializers[2], initializers[3]));
        factory.addInitializers(initializers[4], initializers[5]);
        this.container = factory.getEmbeddedServletContainer(initializers[0], initializers[1]);
        this.container.start();
        InOrder ordered = inOrder((Object[]) initializers);
        for (ServletContextInitializer initializer : initializers) {
            ordered.verify(initializer).onStartup((ServletContext) anyObject());
        }
    }

    @Test
    public void documentRoot() throws Exception {
        FileCopyUtils.copy("test", new FileWriter(this.temporaryFolder.newFile("test.txt")));
        AbstractEmbeddedServletContainerFactory factory = getFactory();
        factory.setDocumentRoot(this.temporaryFolder.getRoot());
        this.container = factory.getEmbeddedServletContainer();
        this.container.start();
        assertThat(getResponse("http://localhost:8080/test.txt"), equalTo("test"));
    }

    @Test
    public void mimeType() throws Exception {
        FileCopyUtils.copy("test", new FileWriter(this.temporaryFolder.newFile("test.xxcss")));
        AbstractEmbeddedServletContainerFactory factory = getFactory();
        factory.setDocumentRoot(this.temporaryFolder.getRoot());
        MimeMappings mimeMappings = new MimeMappings();
        mimeMappings.add("xxcss", "text/css");
        factory.setMimeMappings(mimeMappings);
        this.container = factory.getEmbeddedServletContainer();
        this.container.start();
        ClientHttpResponse response = getClientResponse("http://localhost:8080/test.xxcss");
        assertThat(response.getHeaders().getContentType().toString(), equalTo("text/css"));
        response.close();
    }

    // FIXME test error page

    protected String getResponse(String url) throws IOException, URISyntaxException {
        ClientHttpResponse response = getClientResponse(url);
        try {
            return StreamUtils.copyToString(response.getBody(), Charset.forName("UTF-8"));
        } finally {
            response.close();
        }
    }

    protected ClientHttpResponse getClientResponse(String url) throws IOException, URISyntaxException {
        SimpleClientHttpRequestFactory clientHttpRequestFactory = new SimpleClientHttpRequestFactory();
        ClientHttpRequest request = clientHttpRequestFactory.createRequest(new URI(url), HttpMethod.GET);
        ClientHttpResponse response = request.execute();
        return response;
    }

    protected abstract AbstractEmbeddedServletContainerFactory getFactory();

    private ServletContextInitializer exampleServletRegistration() {
        return new ServletRegistrationBean(new ExampleServlet(), "/hello");
    }
}