Deprecate legacy properties, README fixes.

afranken · afranken · commit 71a910dbc940 · 2025-06-23T15:33:49.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -123,6 +123,7 @@ 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
@@ -164,11 +165,15 @@ Version 4.x is JDK17 LTS bytecode compatible, with Docker and JUnit / direct Jav
 * Refactorings
   * Add JSpecify annotations to S3Mock code
   * Migrate unit tests in "testsupport" modules to Kotlin
+  * Deprecation of legacy-style Spring properties in favor of current environment variables.
+  * Various fixes and clarifications in README.md
 * Version updates (deliverable dependencies)
   * Bump alpine from 3.21.3 to 3.22.0 in /docker
   * Bump aws.version from 1.12.783 to 1.12.785
-  * Bump testcontainers.version from 1.21.0 to 1.21.1
+  * Bump spring-boot.version from 3.5.0 to 3.5.3
+  * Bump testcontainers.version from 1.21.0 to 1.21.2
 * Version updates (build dependencies)
+  * Bump org.xmlunit:xmlunit-assertj3 from 2.10.2 to 2.10.3
   * Bump org.codehaus.mojo:exec-maven-plugin from 3.5.0 to 3.5.1
   * Bump org.apache.maven.plugins:maven-clean-plugin from 3.4.1 to 3.5.0
   * Bump com.puppycrawl.tools:checkstyle from 10.24.0 to 10.25.0
diff --git a/README.md b/README.md
diff --git a/server/src/main/java/com/adobe/testing/s3mock/BucketController.java b/server/src/main/java/com/adobe/testing/s3mock/BucketController.java
@@ -76,11 +76,9 @@
 @RequestMapping("${com.adobe.testing.s3mock.contextPath:}")
 public class BucketController {
   private final BucketService bucketService;
-  private final Region region;
 
-  public BucketController(BucketService bucketService, Region region) {
+  public BucketController(BucketService bucketService) {
     this.bucketService = bucketService;
-    this.region = region;
   }
 
   //================================================================================================
@@ -376,8 +374,9 @@ public ResponseEntity<LocationConstraint> getBucketLocation(@PathVariable String
 
   /**
    * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">API Reference</a>.
-   * @deprecated Long since replaced by listObjectsV2
+   *
    * @see #listObjectsV2
+   * @deprecated Long since replaced by listObjectsV2
    */
   @GetMapping(
       value = {
@@ -486,12 +485,12 @@ public ResponseEntity<ListVersionsResult> listObjectVersions(
     return ResponseEntity.ok(listVersionsResult);
   }
 
+  @Nullable
   private String regionFrom(@Nullable CreateBucketConfiguration createBucketRequest) {
-    if (createBucketRequest != null
-            && createBucketRequest.locationConstraint() != null
-            && createBucketRequest.locationConstraint().region() != null) {
-      return createBucketRequest.locationConstraint().region().toString();
+    if (createBucketRequest != null) {
+      return createBucketRequest.regionFrom();
+    } else {
+      return null;
     }
-    return this.region.toString();
   }
 }
diff --git a/server/src/main/java/com/adobe/testing/s3mock/S3MockConfiguration.java b/server/src/main/java/com/adobe/testing/s3mock/S3MockConfiguration.java
@@ -20,7 +20,6 @@
 import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR;
 
 import com.adobe.testing.s3mock.dto.ErrorResponse;
-import com.adobe.testing.s3mock.dto.Region;
 import com.adobe.testing.s3mock.service.BucketService;
 import com.adobe.testing.s3mock.service.MultipartService;
 import com.adobe.testing.s3mock.service.ObjectService;
@@ -159,8 +158,8 @@ ObjectController fileStoreController(ObjectService objectService, BucketService
   }
 
   @Bean
-  BucketController bucketController(BucketService bucketService, S3MockProperties properties) {
-    return new BucketController(bucketService, properties.region());
+  BucketController bucketController(BucketService bucketService) {
+    return new BucketController(bucketService);
   }
 
   @Bean
diff --git a/server/src/main/java/com/adobe/testing/s3mock/S3MockProperties.java b/server/src/main/java/com/adobe/testing/s3mock/S3MockProperties.java
@@ -32,11 +32,7 @@ public record S3MockProperties(
     // For example if set to `s3-mock` all endpoints will be available at
     // `http://host:port/s3-mock` instead of `http://host:port/`
     @DefaultValue("")
-    String contextPath,
-
-    // Region is S3Mock is supposed to mock.
-    // Must be an official AWS region string like "us-east-1"
-    Region region
+    String contextPath
 ) {
 
 }
diff --git a/server/src/main/java/com/adobe/testing/s3mock/dto/CreateBucketConfiguration.java b/server/src/main/java/com/adobe/testing/s3mock/dto/CreateBucketConfiguration.java
@@ -48,4 +48,12 @@ public CreateBucketConfiguration(BucketInfo bucket,
        LocationConstraint locationConstraint) {
     this(bucket, location, locationConstraint, null);
   }
+
+  public String regionFrom() {
+    if (this.locationConstraint() != null
+        && this.locationConstraint().region() != null) {
+      return this.locationConstraint().region().toString();
+    }
+    return null;
+  }
 }
diff --git a/server/src/main/java/com/adobe/testing/s3mock/service/BucketService.java b/server/src/main/java/com/adobe/testing/s3mock/service/BucketService.java
@@ -147,7 +147,7 @@ public Bucket createBucket(
       String bucketName,
       boolean objectLockEnabled,
       ObjectOwnership objectOwnership,
-      String bucketRegion,
+      @Nullable String bucketRegion,
       @Nullable BucketInfo bucketInfo,
       @Nullable LocationInfo locationInfo) {
     return Bucket.from(
diff --git a/server/src/main/java/com/adobe/testing/s3mock/store/BucketMetadata.java b/server/src/main/java/com/adobe/testing/s3mock/store/BucketMetadata.java
@@ -104,7 +104,8 @@ public BucketMetadata withObjectLockConfiguration(
   }
 
   public BucketMetadata withBucketLifecycleConfiguration(
-      BucketLifecycleConfiguration bucketLifecycleConfiguration) {
+      @Nullable BucketLifecycleConfiguration bucketLifecycleConfiguration
+  ) {
     return new BucketMetadata(name(),
         creationDate(),
         versioningConfiguration(),
diff --git a/server/src/main/java/com/adobe/testing/s3mock/store/BucketStore.java b/server/src/main/java/com/adobe/testing/s3mock/store/BucketStore.java
@@ -56,13 +56,17 @@ public class BucketStore {
   private final Map<String, Object> lockStore = new ConcurrentHashMap<>();
   private final File rootFolder;
   private final DateTimeFormatter s3ObjectDateFormat;
+  private final String region;
   private final ObjectMapper objectMapper;
 
-  public BucketStore(File rootFolder,
+  public BucketStore(
+      File rootFolder,
       DateTimeFormatter s3ObjectDateFormat,
+      String region,
       ObjectMapper objectMapper) {
     this.rootFolder = rootFolder;
     this.s3ObjectDateFormat = s3ObjectDateFormat;
+    this.region = region;
     this.objectMapper = objectMapper;
   }
 
@@ -136,7 +140,7 @@ public BucketMetadata createBucket(
       String bucketName,
       boolean objectLockEnabled,
       ObjectOwnership objectOwnership,
-      String bucketRegion,
+      @Nullable String bucketRegion,
       @Nullable BucketInfo bucketInfo,
       @Nullable LocationInfo locationInfo) {
     if (doesBucketExist(bucketName)) {
@@ -145,6 +149,7 @@ public BucketMetadata createBucket(
     lockStore.putIfAbsent(bucketName, new Object());
     synchronized (lockStore.get(bucketName)) {
       var bucketFolder = createBucketFolder(bucketName);
+      var region = bucketRegion == null ? this.region : bucketRegion;
 
       var newBucketMetadata = new BucketMetadata(
           bucketName,
@@ -155,7 +160,7 @@ public BucketMetadata createBucket(
           null,
           objectOwnership,
           bucketFolder.toPath(),
-          bucketRegion,
+          region,
           bucketInfo,
           locationInfo
       );
diff --git a/server/src/main/java/com/adobe/testing/s3mock/store/LegacyStoreProperties.java b/server/src/main/java/com/adobe/testing/s3mock/store/LegacyStoreProperties.java
@@ -0,0 +1,40 @@
+/*
+ *  Copyright 2017-2025 Adobe.
+ *
+ *  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 com.adobe.testing.s3mock.store;
+
+import java.util.List;
+import java.util.Set;
+import org.jspecify.annotations.Nullable;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.bind.DefaultValue;
+
+@Deprecated(forRemoval = true, since = "4.5.0")
+@ConfigurationProperties("com.adobe.testing.s3mock.domain")
+public record LegacyStoreProperties(
+    // True if files should be retained when S3Mock exits gracefully.
+    // False to let S3Mock delete all files when S3Mock exits gracefully.
+    boolean retainFilesOnExit,
+    // The root directory to use. If omitted a default temp-dir will be used.
+    @Nullable String root,
+    @DefaultValue
+    Set<String> validKmsKeys,
+    // A comma separated list of buckets that are to be created at startup.
+    @DefaultValue
+    List<String> initialBuckets
+) {
+
+}
diff --git a/server/src/main/java/com/adobe/testing/s3mock/store/StoreConfiguration.java b/server/src/main/java/com/adobe/testing/s3mock/store/StoreConfiguration.java
@@ -26,8 +26,10 @@
 import java.time.ZoneId;
 import java.time.format.DateTimeFormatter;
 import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
 import org.apache.commons.io.FileUtils;
+import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Value;
@@ -37,7 +39,7 @@
 import software.amazon.awssdk.regions.Region;
 
 @Configuration
-@EnableConfigurationProperties(StoreProperties.class)
+@EnableConfigurationProperties({StoreProperties.class, LegacyStoreProperties.class})
 public class StoreConfiguration {
 
   private static final Logger LOG = LoggerFactory.getLogger(StoreConfiguration.class);
@@ -47,7 +49,6 @@ public class StoreConfiguration {
 
   @Bean
   ObjectStore objectStore(
-      StoreProperties properties,
       List<String> bucketNames,
       BucketStore bucketStore,
       ObjectMapper objectMapper) {
@@ -62,18 +63,28 @@ ObjectStore objectStore(
   }
 
   @Bean
-  BucketStore bucketStore(StoreProperties properties,
-                          File rootFolder,
-                          List<String> bucketNames,
-                          ObjectMapper objectMapper,
-                          @Value("com.adobe.testing.s3mock.region") Region region) {
-    var bucketStore = new BucketStore(rootFolder, S3_OBJECT_DATE_FORMAT, objectMapper);
+  BucketStore bucketStore(
+      StoreProperties properties,
+      LegacyStoreProperties legacyProperties,
+      File rootFolder,
+      List<String> bucketNames,
+      ObjectMapper objectMapper,
+      @Nullable @Value("${com.adobe.testing.s3mock.region}") Region region) {
+    Region mockRegion = region == null ? properties.region() : region;
+
+    var bucketStore = new BucketStore(rootFolder, S3_OBJECT_DATE_FORMAT, mockRegion.id(), objectMapper);
     //load existing buckets first
     bucketStore.loadBuckets(bucketNames);
 
     //load initialBuckets if not part of existing buckets
-    properties
-        .initialBuckets()
+    List<String> initialBuckets = List.of();
+    if (!legacyProperties.initialBuckets().isEmpty()) {
+      initialBuckets = legacyProperties.initialBuckets();
+    } else if (!properties.initialBuckets().isEmpty()) {
+      initialBuckets = properties.initialBuckets();
+    }
+
+    initialBuckets
         .stream()
         .filter(name -> {
           boolean partOfExistingBuckets = bucketNames.contains(name);
@@ -118,21 +129,38 @@ List<String> bucketNames(File rootFolder) {
   }
 
   @Bean
-  MultipartStore multipartStore(StoreProperties properties,
+  MultipartStore multipartStore(
       ObjectStore objectStore,
       ObjectMapper objectMapper) {
     return new MultipartStore(objectStore, objectMapper);
   }
 
   @Bean
-  KmsKeyStore kmsKeyStore(StoreProperties properties) {
-    return new KmsKeyStore(properties.validKmsKeys());
+  KmsKeyStore kmsKeyStore(
+      StoreProperties properties,
+      LegacyStoreProperties legacyProperties) {
+    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) {
+  File rootFolder(
+      StoreProperties properties,
+      LegacyStoreProperties legacyProperties) {
     File root;
-    var createTempDir = properties.root() == null || properties.root().isEmpty();
+    String rootPath = null;
+    if (legacyProperties.root() != null && !legacyProperties.root().isEmpty()) {
+      rootPath = legacyProperties.root();
+    } else if (properties.root() != null && !properties.root().isEmpty()) {
+      rootPath = properties.root();
+    }
+
+    var createTempDir = rootPath == null;
 
     if (createTempDir) {
       var baseTempDir = FileUtils.getTempDirectory().toPath();
@@ -146,7 +174,7 @@ File rootFolder(StoreProperties properties) {
       LOG.info("Successfully created \"{}\" as root folder. Will retain files on exit: {}",
           root.getAbsolutePath(), properties.retainFilesOnExit());
     } else {
-      root = new File(properties.root());
+      root = new File(rootPath);
 
       if (root.exists()) {
         LOG.info("Using existing folder \"{}\" as root folder. Will retain files on exit: {}",
@@ -164,7 +192,14 @@ File rootFolder(StoreProperties properties) {
   }
 
   @Bean
-  StoreCleaner storeCleaner(File rootFolder, StoreProperties storeProperties) {
-    return new StoreCleaner(rootFolder, storeProperties.retainFilesOnExit());
+  StoreCleaner storeCleaner(
+      File rootFolder,
+      StoreProperties properties,
+      LegacyStoreProperties legacyProperties) {
+    if (legacyProperties.retainFilesOnExit() || properties.retainFilesOnExit()) {
+      return new StoreCleaner(rootFolder, true);
+    } else {
+      return new StoreCleaner(rootFolder, false);
+    }
   }
 }
diff --git a/server/src/main/java/com/adobe/testing/s3mock/store/StoreProperties.java b/server/src/main/java/com/adobe/testing/s3mock/store/StoreProperties.java
@@ -21,8 +21,9 @@
 import org.jspecify.annotations.Nullable;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.bind.DefaultValue;
+import software.amazon.awssdk.regions.Region;
 
-@ConfigurationProperties("com.adobe.testing.s3mock.domain") //TODO: wrong package.
+@ConfigurationProperties("com.adobe.testing.s3mock.store")
 public record StoreProperties(
     // True if files should be retained when S3Mock exits gracefully.
     // False to let S3Mock delete all files when S3Mock exits gracefully.
@@ -33,7 +34,11 @@ public record StoreProperties(
     Set<String> validKmsKeys,
     // A comma separated list of buckets that are to be created at startup.
     @DefaultValue
-    List<String> initialBuckets
+    List<String> initialBuckets,
+    // Region is S3Mock is supposed to mock.
+    // Must be an official AWS region string like "us-east-1"
+    @DefaultValue("us-east-1")
+    Region region
 ) {
 
 }
diff --git a/server/src/test/kotlin/com/adobe/testing/s3mock/BucketControllerTest.kt b/server/src/test/kotlin/com/adobe/testing/s3mock/BucketControllerTest.kt
@@ -158,7 +158,7 @@ internal class BucketControllerTest : BaseControllerTest() {
     )
     assertThat(response.statusCode).isEqualTo(HttpStatus.OK)
     assertThat(response.headers.location).isEqualTo(URI.create("/${TEST_BUCKET_NAME}"))
-    verify(bucketService).createBucket(TEST_BUCKET_NAME, false, BUCKET_OWNER_ENFORCED, BUCKET_REGION, null, null)
+    verify(bucketService).createBucket(TEST_BUCKET_NAME, false, BUCKET_OWNER_ENFORCED, null, null, null)
   }
 
   @Test
@@ -188,7 +188,7 @@ internal class BucketControllerTest : BaseControllerTest() {
 
   @Test
   fun `PUT bucket returns InternalServerError if bucket can't be persisted`() {
-    whenever(bucketService.createBucket(TEST_BUCKET_NAME, false, BUCKET_OWNER_ENFORCED, BUCKET_REGION, null, null))
+    whenever(bucketService.createBucket(TEST_BUCKET_NAME, false, BUCKET_OWNER_ENFORCED, null, null, null))
       .thenThrow(IllegalStateException("THIS IS EXPECTED"))
 
     val headers = HttpHeaders().apply {
diff --git a/server/src/test/kotlin/com/adobe/testing/s3mock/store/StoreConfigurationTest.kt b/server/src/test/kotlin/com/adobe/testing/s3mock/store/StoreConfigurationTest.kt
diff --git a/server/src/test/kotlin/com/adobe/testing/s3mock/store/StoresWithExistingFileRootTest.kt b/server/src/test/kotlin/com/adobe/testing/s3mock/store/StoresWithExistingFileRootTest.kt

Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,12 @@ public CreateBucketConfiguration(BucketInfo bucket,`
`48`	`48`	`LocationConstraint locationConstraint) {`
`49`	`49`	`this(bucket, location, locationConstraint, null);`
`50`	`50`	`}`
	`51`	`+`
	`52`	`+ public String regionFrom() {`
	`53`	`+ if (this.locationConstraint() != null`
	`54`	`+ && this.locationConstraint().region() != null) {`
	`55`	`+ return this.locationConstraint().region().toString();`
	`56`	`+ }`
	`57`	`+ return null;`
	`58`	`+ }`
`51`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,8 @@ public BucketMetadata withObjectLockConfiguration(`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`public BucketMetadata withBucketLifecycleConfiguration(`
`107`		`- BucketLifecycleConfiguration bucketLifecycleConfiguration) {`
	`107`	`+ @Nullable BucketLifecycleConfiguration bucketLifecycleConfiguration`
	`108`	`+ ) {`
`108`	`109`	`return new BucketMetadata(name(),`
`109`	`110`	`creationDate(),`
`110`	`111`	`versioningConfiguration(),`