Skip to content

armgit / floci

Public Imported from GitHub
0

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

fix(ec2): preserve original Spot instance user data (#5468)

David Phillipsb86268e4592c
diff --git a/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/Ec2Tests.java b/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/Ec2Tests.java
index 913c63fb54..facb3e1577 100644
--- a/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/Ec2Tests.java
+++ b/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/Ec2Tests.java
@@ -39,6 +39,32 @@ class Ec2Tests {
keyName = "sdk-test-key";
}
+ @Test
+ @Order(-1)
+ void spotRequestsPreserveOriginalUserData() {
+ String encoded = "/w";
+ SpotInstanceRequest request = ec2.requestSpotInstances(RequestSpotInstancesRequest.builder()
+ .instanceCount(1)
+ .launchSpecification(RequestSpotLaunchSpecification.builder()
+ .imageId("ami-0abcdef1234567890")
+ .instanceType(InstanceType.T3_MICRO)
+ .userData(encoded).build())
+ .build()).spotInstanceRequests().get(0);
+ try {
+ assertThat(request.launchSpecification().userData()).isEqualTo(encoded);
+ assertThat(ec2.describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest.builder()
+ .spotInstanceRequestIds(request.spotInstanceRequestId()).build())
+ .spotInstanceRequests().get(0).launchSpecification().userData()).isEqualTo(encoded);
+ assertThat(ec2.describeInstanceAttribute(DescribeInstanceAttributeRequest.builder()
+ .instanceId(request.instanceId()).attribute(InstanceAttributeName.USER_DATA).build())
+ .userData().value()).isEqualTo(encoded);
+ } finally {
+ ec2.terminateInstances(TerminateInstancesRequest.builder().instanceIds(request.instanceId()).build());
+ ec2.cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest.builder()
+ .spotInstanceRequestIds(request.spotInstanceRequestId()).build());
+ }
+ }
+
@Test
@Order(0)
@DisplayName("DescribeVpnGateways - empty when none exist")
diff --git a/docs/services/ec2.md b/docs/services/ec2.md
index 0f4a78d3d3..4815ce9423 100644
--- a/docs/services/ec2.md
+++ b/docs/services/ec2.md
@@ -782,6 +782,13 @@ Validation matches AWS behavior:
| CancelSpotInstanceRequests | Cancels the named spot instance requests, returning each id with its new state. |
| DescribeSpotPriceHistory | Returns synthetic spot price history for known instance types across modeled availability zones. |
+`RequestSpotInstances` preserves the original base64 user data in the Spot request
+and launched instance. Binary and gzip payloads remain intact when described or
+retrieved through IMDS; script execution uses the same bounded decoder as
+`RunInstances`. Invalid base64, oversized payloads and malformed gzip return
+`InvalidParameterValue` before launch. Older stored Spot requests without the
+original encoding return base64 derived from their saved UTF-8 text.
+
Spot prices returned by `DescribeSpotPriceHistory` are synthetic and derived deterministically from instance type specifications: `((vcpu * 0.0016) + (memoryGiB * 0.0012)) * (1.0 + (azOffset * 0.03))`, formatted to six decimal places. They bear no relation to real AWS spot prices and are intended for testing cost-aware schedulers rather than spend estimation. Supported filters are `availability-zone`, `availability-zone-id`, `instance-type`, `product-description`, `spot-price`, and `timestamp`. Pagination is supported via `MaxResults` and `NextToken`.
### VPN Gateways
diff --git a/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2QueryHandler.java b/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2QueryHandler.java
index 994bc91c34..67f7f3fa7f 100644
--- a/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2QueryHandler.java
+++ b/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2QueryHandler.java
@@ -6249,10 +6249,10 @@ public class Ec2QueryHandler {
String subnetId = p.getFirst("LaunchSpecification.SubnetId");
List<String> securityGroupIds = getList(p, "LaunchSpecification.SecurityGroupId");
String userDataEncoded = p.getFirst("LaunchSpecification.UserData");
- String userData = null;
- if (userDataEncoded != null && !userDataEncoded.isBlank()) {
- userData = new String(Base64.getDecoder().decode(userDataEncoded), StandardCharsets.UTF_8);
+ if (userDataEncoded != null && !userDataEncoded.isEmpty() && userDataEncoded.isBlank()) {
+ userDataEncoded = null;
}
+ String userData = Ec2UserDataDecoder.decode(userDataEncoded);
String iamInstanceProfileArn = p.getFirst("LaunchSpecification.IamInstanceProfile.Arn");
// Parse TagSpecifications
@@ -6280,7 +6280,7 @@ public class Ec2QueryHandler {
List<SpotInstanceRequest> requests = service.requestSpotInstances(region, spotPrice, instanceCount,
type, productDescription, imageId, instanceType, keyName, subnetId, securityGroupIds, userData, iamInstanceProfileArn,
- spotRequestTags, instanceTags);
+ spotRequestTags, instanceTags, userDataEncoded);
XmlBuilder xml = new XmlBuilder()
.start("RequestSpotInstancesResponse", AwsNamespaces.EC2)
@@ -6426,8 +6426,9 @@ public class Ec2QueryHandler {
}
xml.end("groupSet");
- if (spec.getUserData() != null) {
- String encodedUserData = Base64.getEncoder().encodeToString(spec.getUserData().getBytes(StandardCharsets.UTF_8));
+ if (spec.getEncodedUserData() != null || spec.getUserData() != null) {
+ String encodedUserData = spec.getEncodedUserData() != null ? spec.getEncodedUserData()
+ : Base64.getEncoder().encodeToString(spec.getUserData().getBytes(StandardCharsets.UTF_8));
xml.elem("userData", encodedUserData);
}
if (spec.getIamInstanceProfileArn() != null) {
diff --git a/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2Service.java b/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2Service.java
index bd1cbcda9e..ae4960e6ba 100644
--- a/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2Service.java
+++ b/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2Service.java
@@ -10635,11 +10635,19 @@ public class Ec2Service implements ContainerTeardown, ResourceProvider, Resettab
.findFirst();
}
+ /**
+ * Launches Spot instances with separately retained execution text and API encoding.
+ *
+ * @param userData decoded execution text, including decompressed text for gzip payloads
+ * @param encodedUserData original validated base64 payload corresponding to {@code userData};
+ * it takes precedence in descriptions and IMDS byte retrieval. Null
+ * retains the legacy UTF-8 text fallback; empty represents zero bytes.
+ */
public List<SpotInstanceRequest> requestSpotInstances(String region, String spotPrice, Integer instanceCount,
String type, String productDescription, String imageId, String instanceType,
String keyName, String subnetId, List<String> securityGroupIds,
String userData, String iamInstanceProfileArn,
- List<Tag> spotRequestTags, List<Tag> instanceTags) {
+ List<Tag> spotRequestTags, List<Tag> instanceTags, String encodedUserData) {
ensureDefaultResources(region);
int count = instanceCount != null ? instanceCount : 1;
@@ -10651,7 +10659,10 @@ public class Ec2Service implements ContainerTeardown, ResourceProvider, Resettab
String spotRequestId = "sir-" + randomHex(8);
Reservation reservation = runInstances(region, imageId, instanceType, 1, 1, keyName,
- securityGroupIds, subnetId, null, instanceTags, userData, iamInstanceProfileArn);
+ securityGroupIds, subnetId, null, instanceTags, userData, iamInstanceProfileArn,
+ /* associatePublicIp */ null, /* networkInterfaceId */ null,
+ /* networkInterfaceDeviceIndex */ 0, /* availabilityZone */ null,
+ /* metadataOptions */ null, /* creditSpecificationCpuCredits */ null, encodedUserData);
Instance launchedInstance = reservation.getInstances().get(0);
@@ -10661,6 +10672,7 @@ public class Ec2Service implements ContainerTeardown, ResourceProvider, Resettab
spec.setKeyName(launchedInstance.getKeyName());
spec.setSubnetId(launchedInstance.getSubnetId());
spec.setUserData(userData);
+ spec.setEncodedUserData(encodedUserData);
spec.setIamInstanceProfileArn(iamInstanceProfileArn);
if (launchedInstance.getSecurityGroups() != null) {
diff --git a/src/main/java/io/github/hectorvent/floci/services/ec2/model/LaunchSpecification.java b/src/main/java/io/github/hectorvent/floci/services/ec2/model/LaunchSpecification.java
index 71baafc311..2e608fdbd1 100644
--- a/src/main/java/io/github/hectorvent/floci/services/ec2/model/LaunchSpecification.java
+++ b/src/main/java/io/github/hectorvent/floci/services/ec2/model/LaunchSpecification.java
@@ -16,6 +16,7 @@ public class LaunchSpecification {
private String subnetId;
private List<GroupIdentifier> securityGroups = new ArrayList<>();
private String userData;
+ private String encodedUserData;
private String iamInstanceProfileArn;
public LaunchSpecification() {}
@@ -68,6 +69,14 @@ public class LaunchSpecification {
this.userData = userData;
}
+ public String getEncodedUserData() {
+ return encodedUserData;
+ }
+
+ public void setEncodedUserData(String encodedUserData) {
+ this.encodedUserData = encodedUserData;
+ }
+
public String getIamInstanceProfileArn() {
return iamInstanceProfileArn;
}
diff --git a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2UserDataAttributeIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2UserDataAttributeIntegrationTest.java
index a2da4a7833..b57cb424de 100644
--- a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2UserDataAttributeIntegrationTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2UserDataAttributeIntegrationTest.java
@@ -1,12 +1,21 @@
package io.github.hectorvent.floci.services.ec2;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.github.hectorvent.floci.services.ec2.model.LaunchSpecification;
import io.quarkus.test.junit.QuarkusTest;
+import io.restassured.response.Response;
+import io.restassured.specification.RequestSpecification;
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 java.util.Base64;
+
import static io.restassured.RestAssured.given;
import static org.hamcrest.Matchers.equalTo;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
@QuarkusTest
class Ec2UserDataAttributeIntegrationTest {
@@ -76,6 +85,109 @@ class Ec2UserDataAttributeIntegrationTest {
}
}
+ @ParameterizedTest
+ @NullSource
+ @ValueSource(strings = {"YQ==", "YQ", "/w", "H4sIAAAAAAAC/1NW1E/KzNMvzuBKTc7IV8hIzcnJ5wIAedQ/FxUAAAA=", ""})
+ void spotLaunchPreservesOriginalUserData(String encoded) {
+ Response response = requestSpotInstance(encoded);
+ String id = response.path("RequestSpotInstancesResponse.spotInstanceRequestSet.item.instanceId");
+ String requestId = response.path("RequestSpotInstancesResponse.spotInstanceRequestSet.item.spotInstanceRequestId");
+ try {
+ String spec = "RequestSpotInstancesResponse.spotInstanceRequestSet.item.launchSpecification.userData";
+ if (encoded == null) {
+ response.then().body(spec + ".size()", equalTo(0));
+ } else {
+ response.then().body(spec + ".text()", equalTo(encoded));
+ }
+ given().header("Authorization", AUTH).formParam("Action", "DescribeSpotInstanceRequests")
+ .formParam("SpotInstanceRequestId.1", requestId).post("/").then().statusCode(200)
+ .body("DescribeSpotInstanceRequestsResponse.spotInstanceRequestSet.item.launchSpecification.userData.text()",
+ equalTo(encoded == null ? "" : encoded));
+ given().header("Authorization", AUTH).formParam("Action", "DescribeInstanceAttribute")
+ .formParam("InstanceId", id).formParam("Attribute", "userData")
+ .post("/").then().statusCode(200)
+ .body("DescribeInstanceAttributeResponse.userData.value.text()", equalTo(encoded == null ? "" : encoded));
+ } finally {
+ terminateAndCancelSpotRequest(id, requestId);
+ }
+ }
+
+ @ParameterizedTest
+ @ValueSource(strings = {" ", " \t\r\n"})
+ void spotLaunchTreatsWhitespaceUserDataAsAbsent(String encoded) {
+ Response response = requestSpotInstance(encoded);
+ String id = response.path("RequestSpotInstancesResponse.spotInstanceRequestSet.item.instanceId");
+ String requestId = response.path("RequestSpotInstancesResponse.spotInstanceRequestSet.item.spotInstanceRequestId");
+ try {
+ response.then().body("RequestSpotInstancesResponse.spotInstanceRequestSet.item.launchSpecification.userData.size()",
+ equalTo(0));
+ given().header("Authorization", AUTH).formParam("Action", "DescribeSpotInstanceRequests")
+ .formParam("SpotInstanceRequestId.1", requestId).post("/").then().statusCode(200)
+ .body("DescribeSpotInstanceRequestsResponse.spotInstanceRequestSet.item.launchSpecification.userData.size()",
+ equalTo(0));
+ given().header("Authorization", AUTH).formParam("Action", "DescribeInstanceAttribute")
+ .formParam("InstanceId", id).formParam("Attribute", "userData")
+ .post("/").then().statusCode(200)
+ .body("DescribeInstanceAttributeResponse.userData.value.size()", equalTo(0));
+ } finally {
+ terminateAndCancelSpotRequest(id, requestId);
+ }
+ }
+
+ @Test
+ void spotLaunchRejectsInvalidEncodedUserDataBeforeCreatingRequests() {
+ for (String encoded : new String[]{"not-base64!", "H4sI", Base64.getEncoder().encodeToString(new byte[16385])}) {
+ int before = given().header("Authorization", AUTH).formParam("Action", "DescribeSpotInstanceRequests")
+ .post("/").then().statusCode(200).extract()
+ .path("DescribeSpotInstanceRequestsResponse.spotInstanceRequestSet.item.size()");
+ given().header("Authorization", AUTH).formParam("Action", "RequestSpotInstances")
+ .formParam("LaunchSpecification.ImageId", "ami-0abcdef1234567890")
+ .formParam("LaunchSpecification.InstanceType", "t3.micro")
+ .formParam("LaunchSpecification.UserData", encoded)
+ .post("/").then().statusCode(400)
+ .body("Response.Errors.Error.Code", equalTo("InvalidParameterValue"));
+ given().header("Authorization", AUTH).formParam("Action", "DescribeSpotInstanceRequests")
+ .post("/").then().statusCode(200)
+ .body("DescribeSpotInstanceRequestsResponse.spotInstanceRequestSet.item.size()", equalTo(before));
+ }
+ }
+
+ @Test
+ void spotLaunchSpecificationKeepsEncodingAcrossStoredJson() throws Exception {
+ ObjectMapper mapper = new ObjectMapper();
+ LaunchSpecification spec = new LaunchSpecification();
+ spec.setUserData("execution text");
+ spec.setEncodedUserData("/w");
+ LaunchSpecification restored = mapper.readValue(mapper.writeValueAsBytes(spec), LaunchSpecification.class);
+ assertEquals("/w", restored.getEncodedUserData());
+ assertEquals("execution text", restored.getUserData());
+ LaunchSpecification legacy = mapper.readValue("{\"userData\":\"legacy text\"}", LaunchSpecification.class);
+ assertNull(legacy.getEncodedUserData());
+ assertEquals("legacy text", legacy.getUserData());
+ }
+
+ private Response requestSpotInstance(String encoded) {
+ RequestSpecification request = given().header("Authorization", AUTH)
+ .formParam("Action", "RequestSpotInstances")
+ .formParam("LaunchSpecification.ImageId", "ami-0abcdef1234567890")
+ .formParam("LaunchSpecification.InstanceType", "t3.micro");
+ if (encoded != null) {
+ request.formParam("LaunchSpecification.UserData", encoded);
+ }
+ Response response = request.post("/");
+ response.then().statusCode(200);
+ return response;
+ }
+
+ private void terminateAndCancelSpotRequest(String id, String requestId) {
+ try {
+ terminate(id);
+ } finally {
+ given().header("Authorization", AUTH).formParam("Action", "CancelSpotInstanceRequests")
+ .formParam("SpotInstanceRequestId.1", requestId).post("/").then().statusCode(200);
+ }
+ }
+
private void terminate(String id) {
given().header("Authorization", AUTH).formParam("Action", "TerminateInstances")
.formParam("InstanceId.1", id).post("/").then().statusCode(200);