Light, fluffy, and always free - The AWS Local Emulator alternative
feat(rds,docdb): answer DescribeGlobalClusters (#2402)
Michal Schreiber29b0d600c6a1
diff --git a/compatibility-tests/sdk-test-awscli/test/rds.bats b/compatibility-tests/sdk-test-awscli/test/rds.batsindex e616410c9e..f1993b0349 100644--- a/compatibility-tests/sdk-test-awscli/test/rds.bats+++ b/compatibility-tests/sdk-test-awscli/test/rds.bats@@ -127,3 +127,21 @@ teardown() {[ "$(json_get "$output" '.RotationEnabled')" = "true" ][ "$(json_get "$output" '.RotationRules.AutomaticallyAfterDays')" = "7" ]}++@test "RDS: describe global clusters returns an empty list" {+ run aws_cmd rds describe-global-clusters+ assert_success+ [ "$(json_get "$output" '.GlobalClusters | length')" = "0" ]+}++@test "DocDB: describe global clusters answers the read every cluster read makes" {+ # DocumentDB signs with the rds scope, so this is the same handler the CLI reaches+ # for either service. Without an answer here a created cluster cannot be read back.+ run aws_cmd docdb describe-global-clusters+ assert_success+ [ "$(json_get "$output" '.GlobalClusters | length')" = "0" ]++ run aws_cmd docdb describe-global-clusters --global-cluster-identifier "bats-absent-gc"+ assert_failure+ assert_output --partial "GlobalClusterNotFoundFault"+}diff --git a/docs/services/docdb.md b/docs/services/docdb.mdindex f3ed2fff1d..f69ce865ce 100644--- a/docs/services/docdb.md+++ b/docs/services/docdb.md@@ -22,6 +22,7 @@ The management API shares the RDS Query endpoint (`POST /` with an `Action=` par| `CreateDBCluster` | Create a DocumentDB cluster and start a MongoDB container || `DescribeDBClusters` | List clusters and their connection details || `DescribeDBClusterSnapshots` | - |+| `DescribeGlobalClusters` | List global clusters — always empty, as none are modeled || `DeleteDBCluster` | Stop and remove a cluster (must have no instances) || `ModifyDBCluster` | Update engine version or IAM auth setting || `CreateDBInstance` | Add an instance to a cluster |diff --git a/docs/services/rds.md b/docs/services/rds.mdindex 1ec323a791..700042e775 100644--- a/docs/services/rds.md+++ b/docs/services/rds.md@@ -52,6 +52,7 @@ RDS Data API (`rds-data`) is documented separately because it uses REST JSON rou| `ModifyDBProxyTargetGroup` | Update target-group connection-pool configuration || `DescribeDBProxyTargets` | List a proxy target group's registered targets || `DescribeDBClusterSnapshots` | - |+| `DescribeGlobalClusters` | List global clusters — always empty, as none are modeled || `AddTagsToResource` | Add tags to a DB resource || `ListTagsForResource` | List tags for a DB resource || `RemoveTagsFromResource` | Remove tags from a DB resource |diff --git a/src/main/java/io/github/hectorvent/floci/core/common/AwsQueryController.java b/src/main/java/io/github/hectorvent/floci/core/common/AwsQueryController.javaindex a0ce0adedd..249a85be75 100644--- a/src/main/java/io/github/hectorvent/floci/core/common/AwsQueryController.java+++ b/src/main/java/io/github/hectorvent/floci/core/common/AwsQueryController.java@@ -367,11 +367,17 @@ public class AwsQueryController {"CreateDBSubnetGroup", "DescribeDBSubnetGroups", "ModifyDBSubnetGroup", "DeleteDBSubnetGroup","AddTagsToResource", "ListTagsForResource", "RemoveTagsFromResource","CreateDBCluster", "DescribeDBClusters", "DeleteDBCluster", "ModifyDBCluster",+ "DescribeGlobalClusters","CreateDBParameterGroup", "DescribeDBParameterGroups","DeleteDBParameterGroup", "ModifyDBParameterGroup", "DescribeDBParameters","DescribeDBProxies", "CreateDBProxy", "ModifyDBProxy", "DeleteDBProxy","RegisterDBProxyTargets", "DeregisterDBProxyTargets",- "DescribeDBProxyTargetGroups", "ModifyDBProxyTargetGroup", "DescribeDBProxyTargets"+ "DescribeDBProxyTargetGroups", "ModifyDBProxyTargetGroup", "DescribeDBProxyTargets",+ "CreateDBClusterParameterGroup", "DescribeDBClusterParameterGroups",+ "ModifyDBClusterParameterGroup", "DeleteDBClusterParameterGroup",+ "DescribeDBClusterParameters",+ "CreateOptionGroup", "DescribeOptionGroups", "ModifyOptionGroup", "DeleteOptionGroup",+ "DescribeDBSnapshots", "DescribeDBClusterSnapshots");private static final Set<String> CLOUDFORMATION_ACTIONS = Set.of(diff --git a/src/main/java/io/github/hectorvent/floci/services/docdb/DocDbQueryHandler.java b/src/main/java/io/github/hectorvent/floci/services/docdb/DocDbQueryHandler.javaindex 85e936c5ea..5abb814e32 100644--- a/src/main/java/io/github/hectorvent/floci/services/docdb/DocDbQueryHandler.java+++ b/src/main/java/io/github/hectorvent/floci/services/docdb/DocDbQueryHandler.java@@ -36,6 +36,7 @@ public class DocDbQueryHandler {case "CreateDBCluster" -> handleCreateDbCluster(params);case "DescribeDBClusters" -> handleDescribeDbClusters(params);case "DescribeDBClusterSnapshots" -> handleDescribeDbClusterSnapshots(params);+ case "DescribeGlobalClusters" -> handleDescribeGlobalClusters(params);case "DeleteDBCluster" -> handleDeleteDbCluster(params);case "ModifyDBCluster" -> handleModifyDbCluster(params);case "CreateDBInstance" -> handleCreateDbInstance(params);@@ -98,6 +99,42 @@ public class DocDbQueryHandler {return Response.ok(AwsQueryResponse.envelope("DescribeDBClusters", AwsNamespaces.RDS, xml.build())).build();}+ private Response handleDescribeGlobalClusters(MultivaluedMap<String, String> params) {+ // Global clusters are not modeled; an empty list is what completes the provider's read.+ // Real SDKs sign DocumentDB with the "rds" scope and land on RdsQueryHandler instead;+ // this serves the "docdb" scope Floci also accepts, and must answer the same way.+ // MaxRecords is rejected before the identifier is looked up, and a marker after it —+ // the order a live account applies them in.+ String maxRecords = params.getFirst("MaxRecords");+ if (maxRecords != null && !maxRecords.isBlank()) {+ int max = -1;+ try {+ max = Integer.parseInt(maxRecords.trim());+ } catch (NumberFormatException e) {+ LOG.debugv("Non-numeric MaxRecords {0} on DescribeGlobalClusters", maxRecords);+ }+ if (max < 20 || max > 100) {+ throw new AwsException("InvalidParameterValue",+ "Invalid value " + maxRecords + " for MaxRecords. Must be between 20 and 100", 400);+ }+ }+ String identifier = params.getFirst("GlobalClusterIdentifier");+ if (identifier != null && !identifier.isBlank()) {+ // Naming one is a different question from listing none, and AWS errors on it.+ throw new AwsException("GlobalClusterNotFoundFault",+ "Global cluster '" + identifier + "' not found", 404);+ }+ // No page is ever handed out, so any marker a caller presents came from somewhere else.+ String marker = params.getFirst("Marker");+ if (marker != null && !marker.isBlank()) {+ throw new AwsException("InvalidParameterValue", "The request token is invalid.", 400);+ }+ // Filters are not validated: the answer is empty for every name AWS accepts, and a partial+ // list of accepted names would reject filters a live account allows.+ XmlBuilder xml = new XmlBuilder().start("GlobalClusters").end("GlobalClusters");+ return Response.ok(AwsQueryResponse.envelope("DescribeGlobalClusters", AwsNamespaces.RDS, xml.build())).build();+ }+private Response handleDescribeDbClusterSnapshots(MultivaluedMap<String, String> params) {// Snapshots are not modeled by the emulator; return the wire-accurate empty result// the DocDB/RDS Query API uses (empty <DBClusterSnapshots/>, no <Marker>) so SDKdiff --git a/src/main/java/io/github/hectorvent/floci/services/rds/RdsQueryHandler.java b/src/main/java/io/github/hectorvent/floci/services/rds/RdsQueryHandler.javaindex 0b2625d7f4..05d5969806 100644--- a/src/main/java/io/github/hectorvent/floci/services/rds/RdsQueryHandler.java+++ b/src/main/java/io/github/hectorvent/floci/services/rds/RdsQueryHandler.java@@ -95,6 +95,7 @@ public class RdsQueryHandler {case "ModifyDBProxyTargetGroup" -> handleModifyDbProxyTargetGroup(params, region);case "DescribeDBProxyTargets" -> handleDescribeDbProxyTargets(params, region);case "DescribeDBClusterSnapshots" -> handleDescribeDbClusterSnapshots(params);+ case "DescribeGlobalClusters" -> handleDescribeGlobalClusters(params);case "AddTagsToResource" -> handleAddTagsToResource(params, region);case "ListTagsForResource" -> handleListTagsForResource(params, region);case "RemoveTagsFromResource" -> handleRemoveTagsFromResource(params, region);@@ -1096,6 +1097,41 @@ public class RdsQueryHandler {return xml.build();}+ private Response handleDescribeGlobalClusters(MultivaluedMap<String, String> params) {+ // Global clusters are not modeled. Both providers read this on every cluster read, and+ // DocumentDB signs with the "rds" scope, so this handler answers for either service.+ // MaxRecords is rejected before the identifier is looked up, and a marker after it —+ // the order a live account applies them in.+ String maxRecords = params.getFirst("MaxRecords");+ if (maxRecords != null && !maxRecords.isBlank()) {+ int max = -1;+ try {+ max = Integer.parseInt(maxRecords.trim());+ } catch (NumberFormatException e) {+ LOG.debugv("Non-numeric MaxRecords {0} on DescribeGlobalClusters", maxRecords);+ }+ if (max < 20 || max > 100) {+ throw new AwsException("InvalidParameterValue",+ "Invalid value " + maxRecords + " for MaxRecords. Must be between 20 and 100", 400);+ }+ }+ String identifier = params.getFirst("GlobalClusterIdentifier");+ if (identifier != null && !identifier.isBlank()) {+ // Naming one is a different question from listing none, and AWS errors on it.+ throw new AwsException("GlobalClusterNotFoundFault",+ "Global cluster '" + identifier + "' not found", 404);+ }+ // No page is ever handed out, so any marker a caller presents came from somewhere else.+ String marker = params.getFirst("Marker");+ if (marker != null && !marker.isBlank()) {+ throw new AwsException("InvalidParameterValue", "The request token is invalid.", 400);+ }+ // Filters are not validated: the answer is empty for every name AWS accepts, and a partial+ // list of accepted names would reject filters a live account allows.+ String result = new XmlBuilder().start("GlobalClusters").end("GlobalClusters").build();+ return Response.ok(AwsQueryResponse.envelope("DescribeGlobalClusters", AwsNamespaces.RDS, result)).build();+ }+private Response handleDescribeDbClusterSnapshots(MultivaluedMap<String, String> params) {// DB cluster snapshots are not modeled; return the RDS Query API's wire-accurate// empty result (empty <DBClusterSnapshots> wrapper, no <Marker>) so SDK clientsdiff --git a/src/test/java/io/github/hectorvent/floci/core/common/AwsQueryControllerIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/core/common/AwsQueryControllerIntegrationTest.javaindex c3cea450a5..958cd309fd 100644--- a/src/test/java/io/github/hectorvent/floci/core/common/AwsQueryControllerIntegrationTest.java+++ b/src/test/java/io/github/hectorvent/floci/core/common/AwsQueryControllerIntegrationTest.java@@ -2,10 +2,14 @@ package io.github.hectorvent.floci.core.common;import io.quarkus.test.junit.QuarkusTest;import org.junit.jupiter.api.Test;+import org.junit.jupiter.params.ParameterizedTest;+import org.junit.jupiter.params.provider.ValueSource;import static io.restassured.RestAssured.given;+import static org.hamcrest.Matchers.containsString;import static org.hamcrest.Matchers.equalTo;import static org.hamcrest.Matchers.greaterThan;+import static org.hamcrest.Matchers.not;@QuarkusTestclass AwsQueryControllerIntegrationTest {@@ -23,6 +27,43 @@ class AwsQueryControllerIntegrationTest {.body("ErrorResponse.Error.Message", equalTo("The request must contain the parameter Action"));}+ @Test+ void globalClusterActionFallbackWithoutAuthorizationHeader() {+ // Without a credential scope the service is inferred from the action. An action the RDS+ // handler serves but the inference list does not name is dispatched to SQS, which answers+ // UnsupportedOperation for it.+ given()+ .contentType("application/x-www-form-urlencoded")+ .formParam("Action", "DescribeGlobalClusters")+ .when()+ .post("/")+ .then()+ .statusCode(200)+ .contentType("application/xml")+ .body("DescribeGlobalClustersResponse.DescribeGlobalClustersResult.GlobalClusters",+ equalTo(""));+ }++ @ParameterizedTest+ @ValueSource(strings = {"DescribeDBClusterSnapshots", "DescribeDBSnapshots",+ "DescribeDBClusterParameterGroups", "DescribeDBClusterParameters", "DescribeOptionGroups",+ "CreateDBClusterParameterGroup", "ModifyDBClusterParameterGroup",+ "DeleteDBClusterParameterGroup", "CreateOptionGroup", "ModifyOptionGroup",+ "DeleteOptionGroup"})+ void everyRdsActionIsInferredWithoutAnAuthorizationHeader(String action) {+ // Whatever each answers — a result or a validation error for the parameters left out here —+ // RDS has to be the one answering. An action the handler serves but the inference list does+ // not name is dispatched to SQS instead.+ given()+ .contentType("application/x-www-form-urlencoded")+ .formParam("Action", action)+ .when()+ .post("/")+ .then()+ .body(not(containsString("sqs.amazonaws.com")))+ .body(not(containsString("is not supported by SQS")));+ }+@Testvoid ec2ActionFallbackWithoutAuthorizationHeader() {given()diff --git a/src/test/java/io/github/hectorvent/floci/services/docdb/DocDbGlobalClusterIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/docdb/DocDbGlobalClusterIntegrationTest.javanew file mode 100644index 0000000000..d494402324--- /dev/null+++ b/src/test/java/io/github/hectorvent/floci/services/docdb/DocDbGlobalClusterIntegrationTest.java@@ -0,0 +1,110 @@+package io.github.hectorvent.floci.services.docdb;++import io.quarkus.test.junit.QuarkusTest;+import org.junit.jupiter.api.MethodOrderer;+import org.junit.jupiter.api.Order;+import org.junit.jupiter.api.Test;+import org.junit.jupiter.api.TestMethodOrder;++import static io.restassured.RestAssured.given;+import static io.restassured.http.ContentType.URLENC;+import static org.hamcrest.Matchers.containsString;++/**+ * DescribeGlobalClusters on the path the DocumentDB SDK actually takes.+ *+ * <p>DocumentDB's signing name is {@code rds}, and this action carries no engine or cluster+ * identifier to route on, so the request reaches the RDS handler however the caller thinks of it.+ * The provider reads it as part of every {@code aws_docdb_cluster} read: without an answer the+ * cluster is created and then cannot be read back, which fails the apply after the fact.+ */+@QuarkusTest+@TestMethodOrder(MethodOrderer.OrderAnnotation.class)+class DocDbGlobalClusterIntegrationTest {++ private static final String CLUSTER_ID = "gc-read-back-cluster";++ /** What the DocumentDB SDK signs with. */+ private static final String RDS_SCOPE =+ "AWS4-HMAC-SHA256 Credential=test/20260615/us-east-1/rds/aws4_request, "+ + "SignedHeaders=content-type;host, Signature=test";+ /** The scope floci also accepts for DocumentDB. */+ private static final String DOCDB_SCOPE =+ "AWS4-HMAC-SHA256 Credential=test/20260615/us-east-1/docdb/aws4_request, "+ + "SignedHeaders=content-type;host, Signature=test";++ private static io.restassured.specification.RequestSpecification query(String scope, String action) {+ return given().header("Authorization", scope)+ .contentType(URLENC)+ .formParam("Action", action)+ .formParam("Version", "2014-10-31");+ }++ @Test+ @Order(1)+ void createTheClusterTheProviderWouldCreate() {+ query(RDS_SCOPE, "CreateDBCluster")+ .formParam("DBClusterIdentifier", CLUSTER_ID)+ .formParam("Engine", "docdb")+ .formParam("MasterUsername", "docdbadmin")+ .formParam("MasterUserPassword", "secret99password")+ .when().post("/")+ .then()+ .statusCode(200)+ .body(containsString(CLUSTER_ID));+ }++ @Test+ @Order(2)+ void theReadThatFollowsTheCreateReportsNoGlobalClusters() {+ // No engine or cluster id on this request, so it lands on the RDS handler — the same+ // place the provider's call lands.+ query(RDS_SCOPE, "DescribeGlobalClusters")+ .when().post("/")+ .then()+ .statusCode(200)+ .body(containsString("<GlobalClusters></GlobalClusters>"))+ .body(containsString("rds.amazonaws.com/doc/2014-10-31"));+ }++ @Test+ @Order(2)+ void theDocDbScopeAnswersTheSameWay() {+ query(DOCDB_SCOPE, "DescribeGlobalClusters")+ .when().post("/")+ .then()+ .statusCode(200)+ .body(containsString("<GlobalClusters></GlobalClusters>"));++ query(DOCDB_SCOPE, "DescribeGlobalClusters")+ .formParam("GlobalClusterIdentifier", "no-such-gc")+ .when().post("/")+ .then()+ .statusCode(404)+ .body(containsString("GlobalClusterNotFoundFault"))+ .body(containsString("Global cluster 'no-such-gc' not found"));+ }++ @Test+ @Order(3)+ void theClusterIsStillReadableAfterwards() {+ query(RDS_SCOPE, "DescribeDBClusters")+ .formParam("DBClusterIdentifier", CLUSTER_ID)+ .when().post("/")+ .then()+ .statusCode(200)+ .body(containsString(CLUSTER_ID))+ .body(containsString("docdb"));+ }++ @Test+ @Order(4)+ void cleanUp() {+ query(RDS_SCOPE, "DeleteDBCluster")+ .formParam("DBClusterIdentifier", CLUSTER_ID)+ .formParam("SkipFinalSnapshot", "true")+ .when().post("/")+ .then()+ .statusCode(200);+ }+}diff --git a/src/test/java/io/github/hectorvent/floci/services/rds/RdsQueryHandlerTest.java b/src/test/java/io/github/hectorvent/floci/services/rds/RdsQueryHandlerTest.javaindex b9d73e8c55..bac054a2af 100644--- a/src/test/java/io/github/hectorvent/floci/services/rds/RdsQueryHandlerTest.java+++ b/src/test/java/io/github/hectorvent/floci/services/rds/RdsQueryHandlerTest.java@@ -907,6 +907,108 @@ class RdsQueryHandlerTest {assertFalse(body.contains("<Marker>"));}+ // ─────────────────────────── Global clusters ───────────────────────────────++ @Test+ void describeGlobalClusters_returnsEmptyListWith200() {+ // The RDS and DocumentDB providers both read this on every cluster read, and DocumentDB+ // signs with the "rds" scope, so this handler answers for both. A live account with no+ // global clusters answers with an empty list, not an error.+ Response response = handler.handle("DescribeGlobalClusters", params());++ String body = (String) response.getEntity();+ assertEquals(200, response.getStatus());+ assertTrue(body.contains("<DescribeGlobalClustersResult>"));+ assertTrue(body.contains("<GlobalClusters></GlobalClusters>"));+ assertTrue(body.contains("rds.amazonaws.com/doc/2014-10-31"));+ }++ @Test+ void describeGlobalClusters_unknownIdentifierIsNotFound() {+ // Naming one that does not exist is a different question from listing none, and AWS+ // answers it with GlobalClusterNotFoundFault rather than an empty list.+ MultivaluedMap<String, String> params = params();+ params.putSingle("GlobalClusterIdentifier", "no-such-gc");++ Response response = handler.handle("DescribeGlobalClusters", params);++ String body = (String) response.getEntity();+ assertEquals(404, response.getStatus());+ assertTrue(body.contains("<Code>GlobalClusterNotFoundFault</Code>"));+ assertTrue(body.contains("Global cluster 'no-such-gc' not found"));+ }++ @Test+ void describeGlobalClusters_blankIdentifierListsRatherThanFailing() {+ // An empty form field is the SDK omitting the filter, not a request for a cluster named "".+ MultivaluedMap<String, String> params = params();+ params.putSingle("GlobalClusterIdentifier", "");++ Response response = handler.handle("DescribeGlobalClusters", params);++ assertEquals(200, response.getStatus());+ assertTrue(((String) response.getEntity()).contains("<GlobalClusters></GlobalClusters>"));+ }++ @Test+ void describeGlobalClusters_rejectsMaxRecordsOutsideTheAllowedRange() {+ // A live account rejects this before it looks the identifier up, so an empty model is no+ // reason to accept a value AWS refuses.+ for (String value : new String[]{"5", "101", "abc"}) {+ MultivaluedMap<String, String> params = params();+ params.putSingle("MaxRecords", value);+ params.putSingle("GlobalClusterIdentifier", "no-such-gc");++ Response response = handler.handle("DescribeGlobalClusters", params);++ assertEquals(400, response.getStatus(), "MaxRecords=" + value);+ String body = (String) response.getEntity();+ assertTrue(body.contains("Invalid value " + value + " for MaxRecords"), body);+ }+ }++ @Test+ void describeGlobalClusters_acceptsMaxRecordsInsideTheAllowedRange() {+ MultivaluedMap<String, String> params = params();+ params.putSingle("MaxRecords", "20");++ Response response = handler.handle("DescribeGlobalClusters", params);++ assertEquals(200, response.getStatus());+ }++ @Test+ void describeGlobalClusters_rejectsAMarkerItNeverIssued() {+ // No page is ever handed out, so a marker cannot have come from here. AWS checks this+ // after the identifier, which is why the not-found wins when both are present.+ MultivaluedMap<String, String> params = params();+ params.putSingle("Marker", "bogus");++ Response response = handler.handle("DescribeGlobalClusters", params);++ assertEquals(400, response.getStatus());+ assertTrue(((String) response.getEntity()).contains("The request token is invalid."));++ params.putSingle("GlobalClusterIdentifier", "no-such-gc");+ Response withBoth = handler.handle("DescribeGlobalClusters", params);+ assertEquals(404, withBoth.getStatus());+ assertTrue(((String) withBoth.getEntity()).contains("GlobalClusterNotFoundFault"));+ }++ @Test+ void describeGlobalClusters_acceptsFiltersWithoutValidatingThem() {+ // Every filter name AWS accepts answers empty here, and Floci carries no list of the+ // accepted names — rejecting one would refuse a filter a live account allows.+ MultivaluedMap<String, String> params = params();+ params.putSingle("Filters.Filter.1.Name", "db-cluster-id");+ params.putSingle("Filters.Filter.1.Values.Value.1", "anything");++ Response response = handler.handle("DescribeGlobalClusters", params);++ assertEquals(200, response.getStatus());+ assertTrue(((String) response.getEntity()).contains("<GlobalClusters></GlobalClusters>"));+ }+// ──────────────────────────── DBProxy wire shapes ──────────────────────────@Test