Remove legacy properties.

Author: afranken

CHANGELOG.md

@@ -129,15 +129,9 @@ Running S3Mock in unit tests is still supported by using [TestContainers](https:
 * Features and fixes
   * TBD
 * Refactorings
-  * Removal of legacy-style Spring properties in favor of current environment variables.
-  * AWS has deprecated SDK for Java v1, and will remove support EOY 2025.
-    * S3Mock will remove bundled support for Java SDK v1 in late 2025.
-  * JUnit 4.x deprecation
-    * S3Mock will remove bundled support for JUnit 4.x in late 2025.
   * Looking to Remove unit test modules. This enables
     * Refactoring S3Mock to a "standard" Spring Boot application.
     * Removal of workarounds to use `S3MockApplication#start` from a static context
-    * Removal of properties workarounds
   * Migration to `Kotlin` - the IntegrationTests and unit tests were migrated already.
 * Version updates
   * TBD
@@ -151,27 +145,14 @@ Running S3Mock in unit tests is still supported by using [TestContainers](https:
     * Remove Java SDK v1.
   * JUnit 4.x deprecation
     * Remove JUnit 4.x support.
+  * Remove legacy properties for S3Mock configuration.
 * Version updates
   * Bump Spring Boot version to 4.x
   * Bump Spring Framework version to 7.x
   * Bump java version from 17 to 25
     * S3Mock will use the baseline Spring chooses to support.
     * The Docker container will run Java 25 LTS.
 
-## 5.0.0 - PLANNED
-
-* Features and fixes
-  * TBD
-* Refactorings
-  * AWS has deprecated SDK for Java v1, and will remove support EOY 2025.
-    * Remove Java v1.
-  * JUnit 4.x deprecation
-    * Remove JUnit 4.x support.
-* Version updates
-  * Bump Spring Boot version to 4.x
-  * Bump Spring Framework version to 7.x
-  * Bump java version from 17 to 25
-
 # CURRENT - 4.x - THIS VERSION IS UNDER ACTIVE DEVELOPMENT
 Version 4.x is JDK17 LTS bytecode compatible, with Docker and JUnit / direct Java integration.
 

README.md

@@ -63,6 +63,7 @@
   * [Contributing](#contributing)
   * [Licensing](#licensing)
   * [Powered by](#powered-by)
+  * [Star History](#star-history)
 <!-- TOC -->
 
 ## S3Mock
@@ -300,7 +301,6 @@ curl --insecure --request GET https://localhost:9191/my-test-bucket/my-file -O
 The mock can be configured with the following environment variables:
 
 - `COM_ADOBE_TESTING_S3MOCK_STORE_VALID_KMS_KEYS`: list of KMS Key-Refs that are to be treated as *valid*.
-  - Legacy name: `validKmsKeys`
   - Default: none
   - KMS keys must be configured as valid ARNs in the format of "`arn:aws:kms:region:acct-id:key/key-id`", for example "
     `arn:aws:kms:us-east-1:1234567890:key/valid-test-key-id`"
@@ -310,20 +310,16 @@ The mock can be configured with the following environment variables:
   - *S3Mock does not implement KMS encryption*, if a key ID is passed in a request, S3Mock will just validate if a given
     Key was configured during startup and reject the request if the given Key was not configured.
 - `COM_ADOBE_TESTING_S3MOCK_STORE_INITIAL_BUCKETS`: list of names for buckets that will be available initially.
-  - Legacy name: `initialBuckets`
   - Default: none
   - The list must be comma separated names like `bucketa, bucketb`
 - `COM_ADOBE_TESTING_S3MOCK_STORE_REGION`: the region the S3Mock is supposed to mock.
-  - Legacy name: `COM_ADOBE_TESTING_S3MOCK_REGION`
-  - Example: `eu-west-1`
   - Default: `us-east-1`
+  - Value must be a valid AWS region identifier like `eu-west-1`
 - `COM_ADOBE_TESTING_S3MOCK_STORE_ROOT`: the base directory to place the temporary files exposed by the mock. If S3Mock is started in Docker, a volume
   must be mounted as the `root` directory, see examples below.
-  - Legacy name: `root`
   - Default: Java temp directory
 - `COM_ADOBE_TESTING_S3MOCK_STORE_RETAIN_FILES_ON_EXIT`: set to `true` to let S3Mock keep all files that were created during its lifetime. Default is
   `false`, all files are removed if S3Mock shuts down.
-  - Legacy name: `retainFilesOnExit`
   - Default: false
 - `debug`: set to `true` to
   enable [Spring Boot's debug output](https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.logging.console-output).

integration-tests/pom.xml

@@ -192,9 +192,9 @@
                     <time>30000</time>
                   </wait>
                   <env>
-                    <COM_ADOBE_TESTING_S3MOCK_DOMAIN_VALID_KMS_KEYS>arn:aws:kms:us-east-1:1234567890:key/valid-test-key-id</COM_ADOBE_TESTING_S3MOCK_DOMAIN_VALID_KMS_KEYS>
-                    <COM_ADOBE_TESTING_S3MOCK_DOMAIN_INITIAL_BUCKETS>bucket-a, bucket-b</COM_ADOBE_TESTING_S3MOCK_DOMAIN_INITIAL_BUCKETS>
-                    <COM_ADOBE_TESTING_S3MOCK_REGION>eu-west-1</COM_ADOBE_TESTING_S3MOCK_REGION>
+                    <COM_ADOBE_TESTING_S3MOCK_STORE_VALID_KMS_KEYS>arn:aws:kms:us-east-1:1234567890:key/valid-test-key-id</COM_ADOBE_TESTING_S3MOCK_STORE_VALID_KMS_KEYS>
+                    <COM_ADOBE_TESTING_S3MOCK_STORE_INITIAL_BUCKETS>bucket-a, bucket-b</COM_ADOBE_TESTING_S3MOCK_STORE_INITIAL_BUCKETS>
+                    <COM_ADOBE_TESTING_S3MOCK_STORE_REGION>eu-west-1</COM_ADOBE_TESTING_S3MOCK_STORE_REGION>
                   </env>
                   <memory>256000000</memory>
                 </run>

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

@@ -58,18 +58,6 @@ public class S3MockApplication {
   public static final String DEFAULT_SERVER_SSL_KEY_ALIAS = "selfsigned";
   public static final String DEFAULT_SERVER_SSL_KEY_PASSWORD = "password";
 
-  /**
-   * Property name for passing a comma-separated list of buckets that are to be created at startup.
-   */
-  public static final String PROP_INITIAL_BUCKETS = "com.adobe.testing.s3mock.store.initialBuckets";
-  private static final String LEGACY_PROP_INITIAL_BUCKETS = "initialBuckets";
-
-  /**
-   * Property name for passing a root directory to use. If omitted a default temp-dir will be used.
-   */
-  public static final String PROP_ROOT_DIRECTORY = "com.adobe.testing.s3mock.store.root";
-  private static final String LEGACY_PROP_ROOT_DIRECTORY = "root";
-
   /**
    * Property name for passing the HTTPS port to use. Defaults to {@value DEFAULT_HTTPS_PORT}. If
    * set to {@value RANDOM_PORT}, a random port will be chosen.
@@ -106,11 +94,6 @@ public class S3MockApplication {
    */
   public static final String SERVER_SSL_KEY_PASSWORD = "server.ssl.key-password";
 
-  /**
-   * Property name for using either HTTPS or HTTP connections.
-   */
-  public static final String PROP_SECURE_CONNECTION = "secureConnection";
-
   /**
    * Property name for enabling the silent mode with logging set at WARN and without banner.
    */
@@ -178,68 +161,14 @@ public static S3MockApplication start(final Map<String, Object> properties,
 
     final var ctx =
         new SpringApplicationBuilder(S3MockApplication.class)
-            .properties(translateLegacyProperties(defaults))
-            .properties(translateLegacyProperties(properties))
+            .properties(defaults)
+            .properties(properties)
             .bannerMode(bannerMode)
             .run(args);
 
     return ctx.getBean(S3MockApplication.class);
   }
 
-  /**
-   * Hack to still support startup of S3Mock from Java, e.g. in a (J)Unit-Test using one of the
-   * Unit test integration modules.
-   * -----------
-   * TODO: Remove ASAP as this breaks Spring's Externalized Configuration
-   * https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config
-   * -----------
-   * S3Mock is using @Configuration / @ConfigurationProperties for each package.
-   * Before this was implemented, all properties were exposed without a package.
-   * Translation of these properties should be done in "application.properties" as is standard with
-   * Spring (Boot) applications. However, if S3Mock is used directly in a unit test from within a
-   * Spring application, S3Mock reads the "application.properties" of the tested application instead
-   * of its own "application.properties".
-   * This is equivalent to:
-   * com.adobe.testing.s3mock.httpPort=${http.port:}
-   * com.adobe.testing.s3mock.domain.initialBuckets=${initialBuckets:}
-   * com.adobe.testing.s3mock.domain.retainFilesOnExit=${retainFilesOnExit:}
-   * com.adobe.testing.s3mock.domain.root=${root:}
-   * com.adobe.testing.s3mock.domain.validKmsKeys=${validKmsKeys:}
-   */
-  private static Map<String, Object> translateLegacyProperties(Map<String, Object> properties) {
-    // make incoming map mutable
-    var translated = new HashMap<>(properties);
-    translateLegacyProperty(translated, PROP_ROOT_DIRECTORY, LEGACY_PROP_ROOT_DIRECTORY);
-    translateLegacyProperty(translated, PROP_INITIAL_BUCKETS, LEGACY_PROP_INITIAL_BUCKETS);
-    translateLegacyProperty(translated,
-        "com.adobe.testing.s3mock.store.retainFilesOnExit", "retainFilesOnExit");
-    translateLegacyProperty(translated,
-        "com.adobe.testing.s3mock.store.validKmsKeys", "validKmsKeys");
-    translateLegacyProperty(translated,
-        "com.adobe.testing.s3mock.httpPort", "http.port");
-    return translated;
-  }
-
-  private static void translateLegacyProperty(Map<String, Object> properties, String propertyName,
-      String legacyPropertyName) {
-    if (!properties.containsKey(propertyName)) {
-      // start by looking at incoming properties
-      if (properties.containsKey(legacyPropertyName)) {
-        properties.put(propertyName, properties.get(legacyPropertyName));
-      }
-      // these may be overwritten by system properties
-      var legacySystemProperty = System.getProperty(legacyPropertyName);
-      if (legacySystemProperty != null) {
-        properties.put(propertyName, legacySystemProperty);
-      }
-      // highest precedence to environment variables.
-      var legacyEnvironmentProperty = System.getenv(legacyPropertyName);
-      if (legacyEnvironmentProperty != null) {
-        properties.put(propertyName, legacyEnvironmentProperty);
-      }
-    }
-  }
-
   /**
    * Stops the server.
    */

server/src/main/java/com/adobe/testing/s3mock/store/LegacyStoreProperties.java

@@ -39,7 +39,7 @@
 import software.amazon.awssdk.regions.Region;
 
 @Configuration
-@EnableConfigurationProperties({StoreProperties.class, LegacyStoreProperties.class})
+@EnableConfigurationProperties(StoreProperties.class)
 public class StoreConfiguration {
 
   private static final Logger LOG = LoggerFactory.getLogger(StoreConfiguration.class);
@@ -63,11 +63,10 @@ ObjectStore objectStore(
   @Bean
   BucketStore bucketStore(
       StoreProperties properties,
-      LegacyStoreProperties legacyProperties,
       File rootFolder,
       List<String> bucketNames,
       ObjectMapper objectMapper,
-      @Nullable @Value("${com.adobe.testing.s3mock.region}") Region region) {
+      @Nullable @Value("${com.adobe.testing.s3mock.store.region}") Region region) {
     Region mockRegion = region == null ? properties.region() : region;
 
     var bucketStore = new BucketStore(rootFolder, S3_OBJECT_DATE_FORMAT, mockRegion.id(), objectMapper);
@@ -76,9 +75,7 @@ BucketStore bucketStore(
 
     // load initialBuckets if not part of existing buckets
     List<String> initialBuckets = List.of();
-    if (!legacyProperties.initialBuckets().isEmpty()) {
-      initialBuckets = legacyProperties.initialBuckets();
-    } else if (!properties.initialBuckets().isEmpty()) {
+    if (!properties.initialBuckets().isEmpty()) {
       initialBuckets = properties.initialBuckets();
     }
 
@@ -135,26 +132,22 @@ MultipartStore multipartStore(
 
   @Bean
   KmsKeyStore kmsKeyStore(
-      StoreProperties properties,
-      LegacyStoreProperties legacyProperties) {
+      StoreProperties properties
+  ) {
     if (!properties.validKmsKeys().isEmpty()) {
       return new KmsKeyStore(properties.validKmsKeys());
-    } else if (!legacyProperties.validKmsKeys().isEmpty()) {
-      return new KmsKeyStore(legacyProperties.validKmsKeys());
     }
 
     return new KmsKeyStore(new HashSet<>());
   }
 
   @Bean
   File rootFolder(
-      StoreProperties properties,
-      LegacyStoreProperties legacyProperties) {
+      StoreProperties properties
+  ) {
     File root;
     String rootPath = null;
-    if (legacyProperties.root() != null && !legacyProperties.root().isEmpty()) {
-      rootPath = legacyProperties.root();
-    } else if (properties.root() != null && !properties.root().isEmpty()) {
+    if (properties.root() != null && !properties.root().isEmpty()) {
       rootPath = properties.root();
     }
 
@@ -192,9 +185,9 @@ File rootFolder(
   @Bean
   StoreCleaner storeCleaner(
       File rootFolder,
-      StoreProperties properties,
-      LegacyStoreProperties legacyProperties) {
-    if (legacyProperties.retainFilesOnExit() || properties.retainFilesOnExit()) {
+      StoreProperties properties
+  ) {
+    if (properties.retainFilesOnExit()) {
       return new StoreCleaner(rootFolder, true);
     } else {
       return new StoreCleaner(rootFolder, false);

server/src/main/java/com/adobe/testing/s3mock/store/StoreConfiguration.java

@@ -22,11 +22,13 @@ logging.level.org.springframework.web.servlet.mvc.method.annotation.ExceptionHan
 # deactivate JMX to save resources and startup time
 spring.jmx.enabled=false
 
-com.adobe.testing.s3mock.region=us-east-1
+com.adobe.testing.s3mock.store.region=us-east-1
 
 # allow S3Mock to consume larger payloads
 server.tomcat.max-swallow-size=10MB
 
 management.endpoints.web.discovery.enabled=false
 
 spring.main.lazy-initialization=true
+
+com.adobe.testing.s3mock.httpPort=${http.port:}

server/src/main/resources/application.properties

@@ -79,7 +79,7 @@ import java.nio.file.Path
 import java.time.Instant
 
 @MockitoBean(types = [KmsKeyStore::class, ObjectService::class, MultipartService::class, ObjectController::class, MultipartController::class])
-@WebMvcTest(properties = ["com.adobe.testing.s3mock.region=us-east-1"])
+@WebMvcTest(properties = ["com.adobe.testing.s3mock.store.region=us-east-1"])
 internal class BucketControllerTest : BaseControllerTest() {
   @MockitoBean
   private lateinit var bucketService: BucketService

server/src/test/kotlin/com/adobe/testing/s3mock/BucketControllerTest.kt

@@ -82,7 +82,7 @@ import java.time.Instant
 import java.util.UUID
 
 @MockitoBean(types = [KmsKeyStore::class, MultipartService::class, BucketController::class, MultipartController::class])
-@WebMvcTest(properties = ["com.adobe.testing.s3mock.region=us-east-1"])
+@WebMvcTest(properties = ["com.adobe.testing.s3mock.store.region=us-east-1"])
 internal class ObjectControllerTest : BaseControllerTest() {
   @MockitoBean
   private lateinit var objectService: ObjectService

server/src/test/kotlin/com/adobe/testing/s3mock/ObjectControllerTest.kt

@@ -36,11 +36,9 @@ internal class StoreConfigurationTest {
     val initialBucketName = "initialBucketName"
 
     val properties = StoreProperties(false, null, setOf(), listOf(initialBucketName), Region.EU_CENTRAL_1)
-    val legacyStoreProperties = LegacyStoreProperties(false, null, setOf(), listOf())
     val iut = StoreConfiguration()
     val bucketStore = iut.bucketStore(
       properties,
-      legacyStoreProperties,
       tempDir.toFile(),
       listOf(),
       OBJECT_MAPPER,
@@ -83,12 +81,10 @@ internal class StoreConfigurationTest {
     val initialBucketName = "initialBucketName"
 
     val properties = StoreProperties(false, null, setOf(), listOf(initialBucketName), Region.EU_CENTRAL_1)
-    val legacyStoreProperties = LegacyStoreProperties(false, null, setOf(), listOf())
     val iut = StoreConfiguration()
     val bucketStore =
       iut.bucketStore(
         properties,
-        legacyStoreProperties,
         tempDir.toFile(),
         listOf(existingBucketName),
         OBJECT_MAPPER,