From 37ae78ea73e043dbe8b605c586e3cc845a9d2240 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Fri, 18 Oct 2024 10:53:33 -0700 Subject: [PATCH] Add Tomacat 11 Smoke Test Closes gh-42730 --- .../build.gradle | 21 ++++ .../tomcat/SampleTomcat11Application.java | 54 ++++++++ .../tomcat/service/HelloWorldService.java | 32 +++++ .../tomcat/service/HttpHeaderService.java | 43 +++++++ .../tomcat/util/RandomStringUtil.java | 33 +++++ .../tomcat/web/SampleController.java | 53 ++++++++ .../src/main/resources/application.properties | 5 + ...igurationSampleTomcatApplicationTests.java | 72 +++++++++++ .../SampleTomcat11ApplicationTests.java | 116 ++++++++++++++++++ 9 files changed, 429 insertions(+) create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/build.gradle create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/SampleTomcat11Application.java create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/service/HelloWorldService.java create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/service/HttpHeaderService.java create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/util/RandomStringUtil.java create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/web/SampleController.java create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/resources/application.properties create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/test/java/smoketest/tomcat/NonAutoConfigurationSampleTomcatApplicationTests.java create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/test/java/smoketest/tomcat/SampleTomcat11ApplicationTests.java diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/build.gradle b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/build.gradle new file mode 100644 index 0000000000..601263a0a9 --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/build.gradle @@ -0,0 +1,21 @@ +plugins { + id "java" +} + +description = "Spring Boot Tomcat 11 smoke test" + +configurations.all { + resolutionStrategy.eachDependency { + if (it.requested.group == 'org.apache.tomcat' || it.requested.group == 'org.apache.tomcat.embed') { + it.useVersion '11.0.0' + } + } +} + +dependencies { + implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter")) + implementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-tomcat")) + implementation("org.springframework:spring-webmvc") + + testImplementation(project(":spring-boot-project:spring-boot-starters:spring-boot-starter-test")) +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/SampleTomcat11Application.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/SampleTomcat11Application.java new file mode 100644 index 0000000000..d92a9d371f --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/SampleTomcat11Application.java @@ -0,0 +1,54 @@ +/* + * Copyright 2012-2024 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 + * + * https://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 smoketest.tomcat; + +import jakarta.servlet.ServletContextEvent; +import jakarta.servlet.ServletContextListener; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.annotation.Bean; + +@SpringBootApplication +public class SampleTomcat11Application { + + private static final Log logger = LogFactory.getLog(SampleTomcat11Application.class); + + @Bean + protected ServletContextListener listener() { + return new ServletContextListener() { + + @Override + public void contextInitialized(ServletContextEvent sce) { + logger.info("ServletContext initialized"); + } + + @Override + public void contextDestroyed(ServletContextEvent sce) { + logger.info("ServletContext destroyed"); + } + + }; + } + + public static void main(String[] args) { + SpringApplication.run(SampleTomcat11Application.class, args); + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/service/HelloWorldService.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/service/HelloWorldService.java new file mode 100644 index 0000000000..ad2ccc4d32 --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/service/HelloWorldService.java @@ -0,0 +1,32 @@ +/* + * Copyright 2012-2024 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 + * + * https://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 smoketest.tomcat.service; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; + +@Component +public class HelloWorldService { + + @Value("${test.name:World}") + private String name; + + public String getHelloMessage() { + return "Hello " + this.name; + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/service/HttpHeaderService.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/service/HttpHeaderService.java new file mode 100644 index 0000000000..9b93d4216b --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/service/HttpHeaderService.java @@ -0,0 +1,43 @@ +/* + * Copyright 2012-2024 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 + * + * https://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 smoketest.tomcat.service; + +import smoketest.tomcat.util.RandomStringUtil; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; + +@Component +public class HttpHeaderService { + + @Value("${server.tomcat.max-http-response-header-size}") + private int maxHttpResponseHeaderSize; + + /** + * Generates random data. The data is: + *
    + *
  1. is longer than configured + * server.tomcat.max-http-response-header-size
    2. + *
  2. is url encoded by base 64 encode the random value
    3. + *
+ * @return a base64 encoded string of random bytes + */ + public String getHeaderValue() { + return RandomStringUtil.getRandomBase64EncodedString(this.maxHttpResponseHeaderSize + 1); + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/util/RandomStringUtil.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/util/RandomStringUtil.java new file mode 100644 index 0000000000..2aa56e9023 --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/util/RandomStringUtil.java @@ -0,0 +1,33 @@ +/* + * Copyright 2012-2024 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 + * + * https://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 smoketest.tomcat.util; + +import java.util.Base64; +import java.util.Random; + +public final class RandomStringUtil { + + private RandomStringUtil() { + } + + public static String getRandomBase64EncodedString(int length) { + byte[] responseHeader = new byte[length]; + new Random().nextBytes(responseHeader); + return Base64.getEncoder().encodeToString(responseHeader); + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/web/SampleController.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/web/SampleController.java new file mode 100644 index 0000000000..2651397bcd --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/java/smoketest/tomcat/web/SampleController.java @@ -0,0 +1,53 @@ +/* + * Copyright 2012-2024 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 + * + * https://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 smoketest.tomcat.web; + +import jakarta.servlet.http.HttpServletResponse; +import smoketest.tomcat.service.HelloWorldService; +import smoketest.tomcat.service.HttpHeaderService; + +import org.springframework.stereotype.Controller; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.ResponseBody; + +@Controller +public class SampleController { + + private final HelloWorldService helloWorldService; + + private final HttpHeaderService httpHeaderService; + + public SampleController(HelloWorldService helloWorldService, HttpHeaderService httpHeaderService) { + this.helloWorldService = helloWorldService; + this.httpHeaderService = httpHeaderService; + } + + @GetMapping("/") + @ResponseBody + public String helloWorld() { + return this.helloWorldService.getHelloMessage(); + } + + @GetMapping("/max-http-response-header") + @ResponseBody + public String maxHttpResponseHeader(HttpServletResponse response) { + String headerValue = this.httpHeaderService.getHeaderValue(); + response.addHeader("x-max-header", headerValue); + return this.helloWorldService.getHelloMessage(); + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/resources/application.properties b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/resources/application.properties new file mode 100644 index 0000000000..2a19059833 --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/main/resources/application.properties @@ -0,0 +1,5 @@ +server.compression.enabled: true +server.compression.min-response-size: 1 +server.max-http-request-header-size=1000 +server.tomcat.connection-timeout=5s +server.tomcat.max-http-response-header-size=1000 diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/test/java/smoketest/tomcat/NonAutoConfigurationSampleTomcatApplicationTests.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/test/java/smoketest/tomcat/NonAutoConfigurationSampleTomcatApplicationTests.java new file mode 100644 index 0000000000..50d5e693c7 --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/test/java/smoketest/tomcat/NonAutoConfigurationSampleTomcatApplicationTests.java @@ -0,0 +1,72 @@ +/* + * Copyright 2012-2024 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 + * + * https://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 smoketest.tomcat; + +import org.junit.jupiter.api.Test; +import smoketest.tomcat.service.HelloWorldService; +import smoketest.tomcat.web.SampleController; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration; +import org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration; +import org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration; +import org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration; +import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; +import org.springframework.boot.test.web.client.TestRestTemplate; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Import; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Basic integration tests for demo application. + * + * @author Dave Syer + */ +@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) +class NonAutoConfigurationSampleTomcatApplicationTests { + + @Autowired + private TestRestTemplate restTemplate; + + @Test + void testHome() { + ResponseEntity entity = this.restTemplate.getForEntity("/", String.class); + assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK); + assertThat(entity.getBody()).isEqualTo("Hello World"); + } + + @Configuration(proxyBeanMethods = false) + @Import({ ServletWebServerFactoryAutoConfiguration.class, DispatcherServletAutoConfiguration.class, + WebMvcAutoConfiguration.class, HttpMessageConvertersAutoConfiguration.class, + PropertyPlaceholderAutoConfiguration.class }) + @ComponentScan(basePackageClasses = { SampleController.class, HelloWorldService.class }) + public static class NonAutoConfigurationSampleTomcatApplication { + + public static void main(String[] args) { + SpringApplication.run(SampleTomcat11Application.class, args); + } + + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/test/java/smoketest/tomcat/SampleTomcat11ApplicationTests.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/test/java/smoketest/tomcat/SampleTomcat11ApplicationTests.java new file mode 100644 index 0000000000..f9d660878c --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-tomcat11/src/test/java/smoketest/tomcat/SampleTomcat11ApplicationTests.java @@ -0,0 +1,116 @@ +/* + * Copyright 2012-2024 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 + * + * https://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 smoketest.tomcat; + +import java.io.ByteArrayInputStream; +import java.nio.charset.StandardCharsets; +import java.util.zip.GZIPInputStream; + +import org.apache.coyote.AbstractProtocol; +import org.apache.coyote.ProtocolHandler; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import smoketest.tomcat.util.RandomStringUtil; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; +import org.springframework.boot.test.system.CapturedOutput; +import org.springframework.boot.test.system.OutputCaptureExtension; +import org.springframework.boot.test.web.client.TestRestTemplate; +import org.springframework.boot.web.embedded.tomcat.TomcatWebServer; +import org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext; +import org.springframework.context.ApplicationContext; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.util.StreamUtils; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Basic integration tests for demo application. + * + * @author Dave Syer + * @author Andy Wilkinson + * @author Florian Storz + * @author Michael Weidmann + */ +@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) +@ExtendWith(OutputCaptureExtension.class) +class SampleTomcat11ApplicationTests { + + @Autowired + private TestRestTemplate restTemplate; + + @Autowired + private ApplicationContext applicationContext; + + @Value("${server.max-http-request-header-size}") + private int maxHttpRequestHeaderSize; + + @Test + void testHome() { + ResponseEntity entity = this.restTemplate.getForEntity("/", String.class); + assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK); + assertThat(entity.getBody()).isEqualTo("Hello World"); + } + + @Test + void testCompression() throws Exception { + HttpHeaders requestHeaders = new HttpHeaders(); + requestHeaders.set("Accept-Encoding", "gzip"); + HttpEntity requestEntity = new HttpEntity<>(requestHeaders); + ResponseEntity entity = this.restTemplate.exchange("/", HttpMethod.GET, requestEntity, byte[].class); + assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK); + try (GZIPInputStream inflater = new GZIPInputStream(new ByteArrayInputStream(entity.getBody()))) { + assertThat(StreamUtils.copyToString(inflater, StandardCharsets.UTF_8)).isEqualTo("Hello World"); + } + } + + @Test + void testTimeout() { + ServletWebServerApplicationContext context = (ServletWebServerApplicationContext) this.applicationContext; + TomcatWebServer embeddedServletContainer = (TomcatWebServer) context.getWebServer(); + ProtocolHandler protocolHandler = embeddedServletContainer.getTomcat().getConnector().getProtocolHandler(); + int timeout = ((AbstractProtocol) protocolHandler).getConnectionTimeout(); + assertThat(timeout).isEqualTo(5000); + } + + @Test + void testMaxHttpResponseHeaderSize(CapturedOutput output) { + ResponseEntity entity = this.restTemplate.getForEntity("/max-http-response-header", String.class); + assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.INTERNAL_SERVER_ERROR); + assertThat(output).contains( + "threw exception [Request processing failed: org.apache.coyote.http11.HeadersTooLargeException: An attempt was made to write more data to the response headers than there was room available in the buffer. Increase maxHttpHeaderSize on the connector or write less data into the response headers.]"); + } + + @Test + void testMaxHttpRequestHeaderSize(CapturedOutput output) { + String headerValue = RandomStringUtil.getRandomBase64EncodedString(this.maxHttpRequestHeaderSize + 1); + HttpHeaders headers = new HttpHeaders(); + headers.add("x-max-request-header", headerValue); + HttpEntity httpEntity = new HttpEntity<>(headers); + ResponseEntity entity = this.restTemplate.exchange("/", HttpMethod.GET, httpEntity, String.class); + assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.BAD_REQUEST); + assertThat(output).contains("java.lang.IllegalArgumentException: Request header is too large"); + } + +}