Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

fix(s3): include bucket regions in parameterized listings (#6315)

Aniket Shukla95387d190698
diff --git a/docs/services/s3.md b/docs/services/s3.md
index e7887c3110..9f834c2c13 100644
--- a/docs/services/s3.md
+++ b/docs/services/s3.md
@@ -35,6 +35,11 @@
**Replication** is configuration-only: the replication configuration is stored on the bucket and round-trips through `GetBucketReplication`, but no objects are actually replicated.
+`ListBuckets` includes each bucket's `BucketRegion` when `bucket-region`, `continuation-token`,
+`max-buckets`, or `prefix` is present. It uses the stored bucket region, falling back to the
+configured default region. Bare requests omit the field. ListBuckets filtering and pagination
+are not implemented; supplying these parameters does not limit the returned bucket list.
+
## Event Notifications
Browser and presigned POST uploads emit `s3:ObjectCreated:Post`, matching AWS S3. They do not emit
diff --git a/pom.xml b/pom.xml
index 629ace1100..6dfbb29038 100644
--- a/pom.xml
+++ b/pom.xml
@@ -354,6 +354,12 @@
<version>${aws.sdk.version}</version>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>software.amazon.awssdk</groupId>
+ <artifactId>s3</artifactId>
+ <version>${aws.sdk.version}</version>
+ <scope>test</scope>
+ </dependency>
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>elasticache</artifactId>
diff --git a/src/main/java/io/github/hectorvent/floci/services/s3/S3Controller.java b/src/main/java/io/github/hectorvent/floci/services/s3/S3Controller.java
index 7768b79177..9074809966 100644
--- a/src/main/java/io/github/hectorvent/floci/services/s3/S3Controller.java
+++ b/src/main/java/io/github/hectorvent/floci/services/s3/S3Controller.java
@@ -244,6 +244,8 @@ public class S3Controller {
return Response.ok(uiPages.landingHtml(), MediaType.TEXT_HTML).build();
}
try {
+ boolean includeRegion = List.of("bucket-region", "continuation-token", "max-buckets", "prefix")
+ .stream().anyMatch(queryParams::containsKey);
List<Bucket> buckets = s3Service.listBuckets();
XmlBuilder xml = new XmlBuilder()
.raw("<?xml version=\"1.0\" encoding=\"UTF-8\"?>")
@@ -256,8 +258,12 @@ public class S3Controller {
for (Bucket b : buckets) {
xml.start("Bucket")
.elem("Name", b.getName())
- .elem("CreationDate", ISO_FORMAT.format(b.getCreationDate()))
- .end("Bucket");
+ .elem("CreationDate", ISO_FORMAT.format(b.getCreationDate()));
+ if (includeRegion) {
+ String region = b.getRegion();
+ xml.elem("BucketRegion", region == null || region.isBlank() ? regionResolver.getDefaultRegion() : region);
+ }
+ xml.end("Bucket");
}
xml.end("Buckets").end("ListAllMyBucketsResult");
return Response.ok(xml.build()).type(MediaType.APPLICATION_XML).build();
diff --git a/src/test/java/io/github/hectorvent/floci/services/s3/S3ListBucketsRegionIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/s3/S3ListBucketsRegionIntegrationTest.java
new file mode 100644
index 0000000000..2fa1e280b8
--- /dev/null
+++ b/src/test/java/io/github/hectorvent/floci/services/s3/S3ListBucketsRegionIntegrationTest.java
@@ -0,0 +1,115 @@
+package io.github.hectorvent.floci.services.s3;
+
+import io.quarkus.test.junit.QuarkusTest;
+import io.restassured.RestAssured;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.NullSource;
+import org.junit.jupiter.params.provider.ValueSource;
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.s3.S3Client;
+import software.amazon.awssdk.services.s3.model.Bucket;
+import software.amazon.awssdk.services.s3.model.ListBucketsResponse;
+
+import java.net.URI;
+import java.util.Map;
+import java.util.UUID;
+
+import static io.restassured.RestAssured.given;
+import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.not;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+@QuarkusTest
+class S3ListBucketsRegionIntegrationTest {
+
+ @Inject
+ S3Service service;
+
+ @ParameterizedTest
+ @NullSource
+ @ValueSource(strings = {"", " "})
+ void legacyBucketsWithoutARecordedRegionUseTheConfiguredDefault(String storedRegion) {
+ String bucket = "s3-region-legacy-6241-" + UUID.randomUUID();
+ service.createBucket(bucket, storedRegion);
+ try {
+ given().queryParam("max-buckets", "1000").get("/").then().statusCode(200)
+ .body("ListAllMyBucketsResult.Buckets.Bucket.find { it.Name == '" + bucket + "' }.BucketRegion",
+ equalTo("us-east-1"));
+ } finally {
+ service.deleteBucket(bucket);
+ }
+ }
+
+ @ParameterizedTest
+ @ValueSource(strings = {"max-buckets", "prefix", "continuation-token", "bucket-region", "none"})
+ void sdkReadsBucketRegionsOnlyWhenAListParameterIsPresent(String parameter) {
+ String prefix = "s3-region-6241-" + UUID.randomUUID();
+ String defaultBucket = prefix + "-us";
+ String explicitBucket = prefix + "-eu";
+ try (S3Client client = client()) {
+ client.createBucket(request -> request.bucket(defaultBucket));
+ try {
+ client.createBucket(request -> request.bucket(explicitBucket)
+ .createBucketConfiguration(configuration -> configuration.locationConstraint("eu-central-1")));
+ try {
+ ListBucketsResponse response = switch (parameter) {
+ case "max-buckets" -> client.listBuckets(request -> request.maxBuckets(1000));
+ case "prefix" -> client.listBuckets(request -> request.prefix(prefix));
+ case "continuation-token" -> client.listBuckets(request -> request.continuationToken(""));
+ case "bucket-region" -> client.listBuckets(request -> request.bucketRegion("us-east-1"));
+ case "none" -> client.listBuckets();
+ default -> throw new IllegalArgumentException(parameter);
+ };
+ Map<String, String> expected = "bucket-region".equals(parameter)
+ ? Map.of(defaultBucket, "us-east-1")
+ : Map.of(defaultBucket, "us-east-1", explicitBucket, "eu-central-1");
+ for (Map.Entry<String, String> entry : expected.entrySet()) {
+ Bucket bucket = response.buckets().stream().filter(value -> entry.getKey().equals(value.name()))
+ .findFirst().orElseThrow();
+ if ("none".equals(parameter)) {
+ assertNull(bucket.bucketRegion());
+ } else {
+ assertEquals(entry.getValue(), bucket.bucketRegion());
+ }
+ assertNull(bucket.bucketArn());
+ }
+ } finally {
+ client.deleteBucket(request -> request.bucket(explicitBucket));
+ }
+ } finally {
+ client.deleteBucket(request -> request.bucket(defaultBucket));
+ }
+ }
+ }
+
+ @Test
+ void unrelatedQueryParametersDoNotAddRegionOrDirectoryBucketArn() {
+ String bucket = "s3-region-control-6241-" + UUID.randomUUID();
+ given().put("/" + bucket).then().statusCode(200);
+ try {
+ given().queryParam("unrelated", "1").get("/").then().statusCode(200)
+ .body(containsString("<Name>" + bucket + "</Name>"))
+ .body(not(containsString("<BucketRegion>")))
+ .body(not(containsString("<BucketArn>")));
+ } finally {
+ given().delete("/" + bucket).then().statusCode(204);
+ }
+ }
+
+ private static S3Client client() {
+ return S3Client.builder()
+ .endpointOverride(URI.create("http://localhost:" + RestAssured.port))
+ .httpClientBuilder(UrlConnectionHttpClient.builder())
+ .forcePathStyle(true)
+ .region(Region.US_EAST_1)
+ .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create("741624100001", "test")))
+ .build();
+ }
+}