Merge pull request #2137 from matdue/switch-to-tomcat

Use Tomcat instead of Jetty

Author: afranken

integration-tests/src/test/kotlin/com/adobe/testing/s3mock/its/PlainHttpIT.kt

@@ -100,7 +100,7 @@ internal class PlainHttpIT : S3TestBase() {
   fun putHeadObject_withUserMetadata(testInfo: TestInfo) {
     val targetBucket = givenBucketV2(testInfo)
     val byteArray = UUID.randomUUID().toString().toByteArray()
-    val amzMetaHeaderKey = "X-Amz-Meta-My-Key"
+    val amzMetaHeaderKey = "x-amz-meta-my-key"
     val amzMetaHeaderValue = "MY_DATA"
     val putObject = HttpPut("/$targetBucket/testObjectName").apply {
       this.entity = ByteArrayEntity(byteArray)

pom.xml

@@ -128,7 +128,7 @@
     <!-- Run Docker build by default -->
     <skipDocker>false</skipDocker>
     <sortpom-maven-plugin.version>4.0.0</sortpom-maven-plugin.version>
-    <spring-boot.version>3.3.3</spring-boot.version>
+    <spring-boot.version>3.3.5</spring-boot.version>
     <testcontainers.version>1.20.4</testcontainers.version>
     <testng.version>7.10.2</testng.version>
     <xmlunit-assertj3.version>2.10.0</xmlunit-assertj3.version>

server/pom.xml

@@ -110,11 +110,6 @@
       <artifactId>spring-boot-devtools</artifactId>
       <optional>true</optional>
     </dependency>
-    <!-- Use Jetty instead of tomcat -->
-    <dependency>
-      <groupId>org.springframework.boot</groupId>
-      <artifactId>spring-boot-starter-jetty</artifactId>
-    </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-test</artifactId>
@@ -123,12 +118,6 @@
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
-      <exclusions>
-        <exclusion>
-          <groupId>org.springframework.boot</groupId>
-          <artifactId>spring-boot-starter-tomcat</artifactId>
-        </exclusion>
-      </exclusions>
     </dependency>
     <dependency>
       <groupId>org.xmlunit</groupId>

server/src/main/java/com/adobe/testing/s3mock/S3MockApplication.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2017-2023 Adobe.
+ *  Copyright 2017-2024 Adobe.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -283,7 +283,7 @@ public int getPort() {
    */
   @Deprecated(since = "2.12.2", forRemoval = true)
   public int getHttpPort() {
-    return config.getHttpServerConnector().getLocalPort();
+    return config.getHttpConnector().getLocalPort();
   }
 
   /**

server/src/main/java/com/adobe/testing/s3mock/S3MockConfiguration.java

@@ -31,18 +31,12 @@
 import jakarta.servlet.Filter;
 import jakarta.servlet.http.HttpServletRequest;
 import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Objects;
-import org.eclipse.jetty.http.UriCompliance;
-import org.eclipse.jetty.server.Connector;
-import org.eclipse.jetty.server.HttpConnectionFactory;
-import org.eclipse.jetty.server.SecureRequestCustomizer;
-import org.eclipse.jetty.server.Server;
-import org.eclipse.jetty.server.ServerConnector;
+import org.apache.catalina.connector.Connector;
+import org.apache.tomcat.util.buf.EncodedSolidusHandling;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.boot.web.embedded.jetty.JettyServletWebServerFactory;
+import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
 import org.springframework.boot.web.servlet.filter.OrderedFormContentFilter;
 import org.springframework.boot.web.servlet.server.ServletWebServerFactory;
 import org.springframework.context.annotation.Bean;
@@ -63,7 +57,7 @@
 @Configuration
 @EnableConfigurationProperties(S3MockProperties.class)
 public class S3MockConfiguration implements WebMvcConfigurer {
-  private ServerConnector httpServerConnector;
+  private Connector httpConnector;
 
   /**
    * Create a ServletWebServerFactory bean reconfigured for an additional HTTP port.
@@ -72,37 +66,24 @@ public class S3MockConfiguration implements WebMvcConfigurer {
    */
   @Bean
   ServletWebServerFactory webServerFactory(S3MockProperties properties) {
-    var factory = new JettyServletWebServerFactory();
-    factory.addServerCustomizers(
-        server -> server.addConnector(createHttpConnector(server, properties.httpPort())),
-        server -> Arrays.stream(server.getConnectors())
-            .filter(ServerConnector.class::isInstance)
-            .forEach(
-                connector -> connector.getConnectionFactories()
-                    .stream()
-                    .filter(HttpConnectionFactory.class::isInstance)
-                    .map(cf -> (HttpConnectionFactory) cf)
-                    .map(HttpConnectionFactory::getHttpConfiguration)
-                    .map(hc -> {
-                      //disable UriCompliance checks. S3 allows object keys that do not conform to
-                      //URI specs as defined here: https://datatracker.ietf.org/doc/html/rfc3986
-                      hc.setUriCompliance(UriCompliance.UNSAFE);
-                      return hc.getCustomizer(SecureRequestCustomizer.class);
-                    })
-                    .filter(Objects::nonNull)
-                    .forEach(customizer -> customizer.setSniHostCheck(false))
-            ));
+    var factory = new TomcatServletWebServerFactory();
+    factory.addAdditionalTomcatConnectors(createHttpConnector(properties.httpPort()));
+    factory.addConnectorCustomizers(connector -> {
+      // Allow encoded slashes in URL
+      connector.setEncodedSolidusHandling(EncodedSolidusHandling.DECODE.getValue());
+      connector.setAllowBackslash(true);
+    });
     return factory;
   }
 
-  private Connector createHttpConnector(final Server server, int httpPort) {
-    httpServerConnector = new ServerConnector(server);
-    httpServerConnector.setPort(httpPort);
-    return httpServerConnector;
+  private Connector createHttpConnector(int httpPort) {
+    httpConnector = new Connector();
+    httpConnector.setPort(httpPort);
+    return httpConnector;
   }
 
-  ServerConnector getHttpServerConnector() {
-    return httpServerConnector;
+  Connector getHttpConnector() {
+    return httpConnector;
   }
 
   @Bean

server/src/main/resources/application.properties

@@ -1,5 +1,5 @@
 #
-#  Copyright 2017-2022 Adobe.
+#  Copyright 2017-2024 Adobe.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -15,10 +15,9 @@
 #
 
 # server.ssl.* are moved to S3MockApplication#start so users can override them
-# The values in application.properties can't be overriden by SpringApplicationBuilder#properties
+# The values in application.properties can't be overridden by SpringApplicationBuilder#properties
 
 logging.level.org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver=ERROR
-logging.level.org.eclipse.jetty.util.ssl.SslContextFactory.config=ERROR
 
 # deactivate JMX to save resources and startup time
 spring.jmx.enabled=false