Skip to content

S
spring-boot
Commit 570b292d authored by Andy Wilkinson's avatar Andy Wilkinson
Browse files
Options

Disable JspServlet's development mode by default 

This commit switches off the auto-configured JspServlet's
development mode by default. Development mode is then switched on
when DevTools is on the class path.

Closes gh-7039
parent c2d97c97
Hide whitespace changes
Inline Side-by-side
Showing with 89 additions and 36 deletions
spring-boot-devtools/pom.xml
View file @ 570b292d
......@@ -117,6 +117,11 @@
<artifactId>tomcat-embed-core</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.tomcat.embed</groupId>
<artifactId>tomcat-embed-jasper</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.eclipse.jetty.websocket</groupId>
<artifactId>websocket-client</artifactId>
......
spring-boot-devtools/src/main/java/org/springframework/boot/devtools/env/DevToolsPropertyDefaultsPostProcessor.java
View file @ 570b292d
......@@ -52,6 +52,7 @@ public class DevToolsPropertyDefaultsPostProcessor implements EnvironmentPostPro
properties.put("spring.resources.cache-period", "0");
properties.put("spring.template.provider.cache", "false");
properties.put("spring.mvc.log-resolved-exception", "true");
properties.put("server.jsp-servlet.init-parameters.development", "true");
PROPERTIES = Collections.unmodifiableMap(properties);
}
......
spring-boot-devtools/src/test/java/org/springframework/boot/devtools/autoconfigure/LocalDevToolsAutoConfigurationTests.java
View file @ 570b292d
......@@ -21,6 +21,9 @@ import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.apache.catalina.Container;
import org.apache.catalina.core.StandardWrapper;
import org.apache.jasper.EmbeddedServletOptions;
import org.junit.After;
import org.junit.Rule;
import org.junit.Test;
......@@ -30,7 +33,12 @@ import org.thymeleaf.templateresolver.TemplateResolver;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration;
import org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration;
import org.springframework.boot.autoconfigure.web.ResourceProperties;
import org.springframework.boot.autoconfigure.web.ServerProperties;
import org.springframework.boot.context.embedded.EmbeddedWebApplicationContext;
import org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainer;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.devtools.classpath.ClassPathChangedEvent;
import org.springframework.boot.devtools.classpath.ClassPathFileSystemWatcher;
import org.springframework.boot.devtools.filewatch.ChangedFiles;
......@@ -234,6 +242,18 @@ public class LocalDevToolsAutoConfigurationTests {
.containsKey(new File("src/test/java").getAbsoluteFile());
}
@Test
public void devToolsSwitchesJspServletToDevelopmentMode() {
this.context = initializeAndRun(Config.class);
TomcatEmbeddedServletContainer tomcatContainer = (TomcatEmbeddedServletContainer) ((EmbeddedWebApplicationContext) this.context)
.getEmbeddedServletContainer();
Container context = tomcatContainer.getTomcat().getHost().findChildren()[0];
StandardWrapper jspServletWrapper = (StandardWrapper) context.findChild("jsp");
EmbeddedServletOptions options = (EmbeddedServletOptions) ReflectionTestUtils
.getField(jspServletWrapper.getServlet(), "options");
assertThat(options.getDevelopment()).isEqualTo(true);
}
private ConfigurableApplicationContext initializeAndRun(Class<?> config,
String... args) {
return initializeAndRun(config, Collections.<String, Object>emptyMap(), args);
......@@ -244,7 +264,6 @@ public class LocalDevToolsAutoConfigurationTests {
Restarter.initialize(new String[0], false, new MockRestartInitializer(), false);
SpringApplication application = new SpringApplication(config);
application.setDefaultProperties(getDefaultProperties(properties));
application.setWebEnvironment(false);
ConfigurableApplicationContext context = application.run(args);
return context;
}
......@@ -254,18 +273,22 @@ public class LocalDevToolsAutoConfigurationTests {
Map<String, Object> properties = new HashMap<String, Object>();
properties.put("spring.thymeleaf.check-template-location", false);
properties.put("spring.devtools.livereload.port", this.liveReloadPort);
properties.put("server.port", 0);
properties.putAll(specifiedProperties);
return properties;
}
@Configuration
@Import({ LocalDevToolsAutoConfiguration.class, ThymeleafAutoConfiguration.class })
@Import({ EmbeddedServletContainerAutoConfiguration.class,
LocalDevToolsAutoConfiguration.class, ThymeleafAutoConfiguration.class })
@EnableConfigurationProperties(ServerProperties.class)
public static class Config {
}
@Configuration
@Import({ LocalDevToolsAutoConfiguration.class, ThymeleafAutoConfiguration.class })
@Import({ EmbeddedServletContainerAutoConfiguration.class,
LocalDevToolsAutoConfiguration.class, ThymeleafAutoConfiguration.class })
public static class ConfigWithMockLiveReload {
@Bean
......@@ -276,7 +299,8 @@ public class LocalDevToolsAutoConfigurationTests {
}
@Configuration
@Import({ LocalDevToolsAutoConfiguration.class, ResourceProperties.class })
@Import({ EmbeddedServletContainerAutoConfiguration.class,
LocalDevToolsAutoConfiguration.class, ResourceProperties.class })
public static class WebResourcesConfig {
}
......
spring-boot/src/main/java/org/springframework/boot/context/embedded/JspServlet.java
View file @ 570b292d
/*
* Copyright 2012-2015 the original author or authors.
* Copyright 2012-2016 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.
......@@ -36,7 +36,7 @@ public class JspServlet {
private String className = "org.apache.jasper.servlet.JspServlet";
/**
* Init parameters use to configure the JSP servlet.
* Init parameters used to configure the JSP servlet.
*/
private Map<String, String> initParameters = new HashMap<String, String>();
......@@ -46,6 +46,10 @@ public class JspServlet {
*/
private boolean registered = true;
public JspServlet() {
this.initParameters.put("development", "false");
}
public String getClassName() {
return this.className;
}
......
spring-boot/src/test/java/org/springframework/boot/context/embedded/AbstractEmbeddedServletContainerFactoryTests.java
View file @ 570b292d
......@@ -67,8 +67,11 @@ import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.protocol.HttpContext;
import org.apache.http.ssl.SSLContextBuilder;
import org.apache.jasper.EmbeddedServletOptions;
import org.apache.jasper.servlet.JspServlet;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Assume;
import org.junit.BeforeClass;
import org.junit.Rule;
import org.junit.Test;
......@@ -98,6 +101,7 @@ import org.springframework.util.StreamUtils;
import org.springframework.util.concurrent.ListenableFuture;
import static org.assertj.core.api.Assertions.assertThat;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.junit.Assert.fail;
import static org.mockito.BDDMockito.given;
import static org.mockito.Matchers.anyObject;
......@@ -883,6 +887,29 @@ public abstract class AbstractEmbeddedServletContainerFactoryTests {
assertThat(getCharset(Locale.ITALIAN)).isNull();
}
@Test
public void jspServletInitParameters() throws Exception {
Map<String, String> initParameters = new HashMap<String, String>();
initParameters.put("a", "alpha");
AbstractEmbeddedServletContainerFactory factory = getFactory();
factory.getJspServlet().setInitParameters(initParameters);
this.container = factory.getEmbeddedServletContainer();
Assume.assumeThat(getJspServlet(), notNullValue());
JspServlet jspServlet = getJspServlet();
assertThat(jspServlet.getInitParameter("a")).isEqualTo("alpha");
}
@Test
public void jspServletIsNotInDevelopmentModeByDefault() throws Exception {
AbstractEmbeddedServletContainerFactory factory = getFactory();
this.container = factory.getEmbeddedServletContainer();
Assume.assumeThat(getJspServlet(), notNullValue());
JspServlet jspServlet = getJspServlet();
EmbeddedServletOptions options = (EmbeddedServletOptions) ReflectionTestUtils
.getField(jspServlet, "options");
assertThat(options.getDevelopment()).isEqualTo(false);
}
protected abstract void addConnector(int port,
AbstractEmbeddedServletContainerFactory factory);
......@@ -1032,7 +1059,8 @@ public abstract class AbstractEmbeddedServletContainerFactoryTests {
protected abstract AbstractEmbeddedServletContainerFactory getFactory();
protected abstract Object getJspServlet();
protected abstract org.apache.jasper.servlet.JspServlet getJspServlet()
throws Exception;
protected ServletContextInitializer exampleServletRegistration() {
return new ServletRegistrationBean(new ExampleServlet(), "/hello");
......
spring-boot/src/test/java/org/springframework/boot/context/embedded/jetty/JettyEmbeddedServletContainerFactoryTests.java
View file @ 570b292d
......@@ -19,7 +19,6 @@ package org.springframework.boot.context.embedded.jetty;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.concurrent.TimeUnit;
......@@ -29,6 +28,7 @@ import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.jasper.servlet.JspServlet;
import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.ServerConnector;
......@@ -246,16 +246,6 @@ public class JettyEmbeddedServletContainerFactoryTests
testBasicSslWithKeyStore("classpath:test.jks");
}
@Test
public void jspServletInitParameters() {
JettyEmbeddedServletContainerFactory factory = getFactory();
Map<String, String> initParameters = new HashMap<String, String>();
initParameters.put("a", "alpha");
factory.getJspServlet().setInitParameters(initParameters);
this.container = factory.getEmbeddedServletContainer();
assertThat(getJspServlet().getInitParameters()).isEqualTo(initParameters);
}
@Test
public void useForwardHeaders() throws Exception {
JettyEmbeddedServletContainerFactory factory = getFactory();
......@@ -316,10 +306,15 @@ public class JettyEmbeddedServletContainerFactoryTests
}
@Override
protected ServletHolder getJspServlet() {
protected JspServlet getJspServlet() throws Exception {
WebAppContext context = (WebAppContext) ((JettyEmbeddedServletContainer) this.container)
.getServer().getHandler();
return context.getServletHandler().getServlet("jsp");
ServletHolder holder = context.getServletHandler().getServlet("jsp");
if (holder == null) {
return null;
}
holder.start();
return (JspServlet) holder.getServlet();
}
@Override
......
spring-boot/src/test/java/org/springframework/boot/context/embedded/tomcat/TomcatEmbeddedServletContainerFactoryTests.java
View file @ 570b292d
......@@ -20,13 +20,13 @@ import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.servlet.ServletException;
import org.apache.catalina.Container;
import org.apache.catalina.Context;
......@@ -36,11 +36,12 @@ import org.apache.catalina.LifecycleState;
import org.apache.catalina.Service;
import org.apache.catalina.SessionIdGenerator;
import org.apache.catalina.Valve;
import org.apache.catalina.Wrapper;
import org.apache.catalina.connector.Connector;
import org.apache.catalina.core.StandardWrapper;
import org.apache.catalina.startup.Tomcat;
import org.apache.catalina.util.CharsetMapper;
import org.apache.catalina.valves.RemoteIpValve;
import org.apache.jasper.servlet.JspServlet;
import org.apache.tomcat.util.net.SSLHostConfig;
import org.junit.After;
import org.junit.Rule;
......@@ -359,17 +360,6 @@ public class TomcatEmbeddedServletContainerFactoryTests
.addAdditionalTomcatConnectors(connector);
}
@Test
public void jspServletInitParameters() {
Map<String, String> initParameters = new HashMap<String, String>();
initParameters.put("a", "alpha");
TomcatEmbeddedServletContainerFactory factory = getFactory();
factory.getJspServlet().setInitParameters(initParameters);
this.container = factory.getEmbeddedServletContainer();
Wrapper jspServlet = getJspServlet();
assertThat(jspServlet.findInitParameter("a")).isEqualTo("alpha");
}
@Test
public void useForwardHeaders() throws Exception {
TomcatEmbeddedServletContainerFactory factory = getFactory();
......@@ -462,10 +452,15 @@ public class TomcatEmbeddedServletContainerFactoryTests
}
@Override
protected Wrapper getJspServlet() {
protected JspServlet getJspServlet() throws ServletException {
Container context = ((TomcatEmbeddedServletContainer) this.container).getTomcat()
.getHost().findChildren()[0];
return (Wrapper) context.findChild("jsp");
StandardWrapper standardWrapper = (StandardWrapper) context.findChild("jsp");
if (standardWrapper == null) {
return null;
}
standardWrapper.load();
return (JspServlet) standardWrapper.getServlet();
}
@SuppressWarnings("unchecked")
......
spring-boot/src/test/java/org/springframework/boot/context/embedded/undertow/UndertowEmbeddedServletContainerFactoryTests.java
View file @ 570b292d
......@@ -34,6 +34,7 @@ import io.undertow.Undertow.Builder;
import io.undertow.servlet.api.DeploymentInfo;
import io.undertow.servlet.api.DeploymentManager;
import io.undertow.servlet.api.ServletContainer;
import org.apache.jasper.servlet.JspServlet;
import org.junit.Test;
import org.mockito.InOrder;
......@@ -250,7 +251,7 @@ public class UndertowEmbeddedServletContainerFactoryTests
}
@Override
protected Object getJspServlet() {
protected JspServlet getJspServlet() {
return null; // Undertow does not support JSPs
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment