Skip to content

armgit / floci

Public Imported from GitHub
0

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

fix(ec2): honor RunInstances dry run before provisioning (#3599)

luiseterc46b66ffa40ef
diff --git a/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/Ec2RunInstancesDryRunTest.java b/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/Ec2RunInstancesDryRunTest.java
new file mode 100644
index 0000000000..63c4759973
--- /dev/null
+++ b/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/Ec2RunInstancesDryRunTest.java
@@ -0,0 +1,75 @@
+package com.floci.test;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import software.amazon.awssdk.services.ec2.Ec2Client;
+import software.amazon.awssdk.services.ec2.model.Ec2Exception;
+import software.amazon.awssdk.services.ec2.model.Filter;
+import software.amazon.awssdk.services.ec2.model.InstanceType;
+import software.amazon.awssdk.services.ec2.model.ResourceType;
+import software.amazon.awssdk.services.ec2.model.RunInstancesRequest;
+import software.amazon.awssdk.services.ec2.model.RunInstancesResponse;
+import software.amazon.awssdk.services.ec2.model.Tag;
+import software.amazon.awssdk.services.ec2.model.TagSpecification;
+
+import java.util.UUID;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+class Ec2RunInstancesDryRunTest {
+ @Test
+ @DisplayName("Invalid RunInstances counts retain their validation error with DryRun enabled")
+ void invalidDryRunReturnsValidationError() {
+ try (Ec2Client ec2 = TestFixtures.ec2Client()) {
+ Ec2Exception error = assertThrows(Ec2Exception.class, () -> ec2.runInstances(r ->
+ r.imageId("ami-0abcdef1234567890").instanceType(InstanceType.T3_MICRO)
+ .minCount(0).maxCount(1).dryRun(true)));
+ assertThat(error.statusCode()).isEqualTo(400);
+ assertThat(error.awsErrorDetails().errorCode()).isEqualTo("InvalidParameterValue");
+ }
+ }
+
+ @Test
+ @DisplayName("A dry run with a missing subnet returns the launch validation error")
+ void missingSubnetIsValidatedDuringDryRun() {
+ try (Ec2Client ec2 = TestFixtures.ec2Client()) {
+ Ec2Exception error = assertThrows(Ec2Exception.class, () -> ec2.runInstances(r ->
+ r.imageId("ami-0abcdef1234567890").instanceType(InstanceType.T3_MICRO)
+ .minCount(1).maxCount(1).subnetId("subnet-missing").dryRun(true)));
+ assertThat(error.statusCode()).isEqualTo(400);
+ assertThat(error.awsErrorDetails().errorCode()).isEqualTo("InvalidSubnetID.NotFound");
+ }
+ }
+
+ @Test
+ @DisplayName("RunInstances dry run returns DryRunOperation without reserving an instance or client token")
+ void dryRunHasNoLaunchSideEffects() {
+ String marker = UUID.randomUUID().toString();
+ try (Ec2Client ec2 = TestFixtures.ec2Client()) {
+ RunInstancesRequest request = RunInstancesRequest.builder()
+ .imageId("ami-0abcdef1234567890").instanceType(InstanceType.T3_MICRO)
+ .minCount(1).maxCount(1).clientToken(marker)
+ .tagSpecifications(TagSpecification.builder().resourceType(ResourceType.INSTANCE)
+ .tags(Tag.builder().key("DryRunTest").value(marker).build()).build())
+ .build();
+ try {
+ Ec2Exception error = assertThrows(Ec2Exception.class,
+ () -> ec2.runInstances(request.toBuilder().dryRun(true).build()));
+ assertThat(error.statusCode()).isEqualTo(412);
+ assertThat(error.awsErrorDetails().errorCode()).isEqualTo("DryRunOperation");
+ assertThat(ec2.describeInstances(r -> r.filters(Filter.builder()
+ .name("tag:DryRunTest").values(marker).build())).reservations())
+ .flatExtracting(reservation -> reservation.instances()).isEmpty();
+
+ RunInstancesResponse launched = ec2.runInstances(request);
+ assertThat(launched.instances()).hasSize(1);
+ assertThat(launched.instances().get(0).instanceId()).isNotBlank();
+ } finally {
+ ec2.describeInstances(r -> r.filters(Filter.builder().name("tag:DryRunTest").values(marker).build()))
+ .reservations().stream().flatMap(reservation -> reservation.instances().stream())
+ .forEach(instance -> ec2.terminateInstances(r -> r.instanceIds(instance.instanceId())));
+ }
+ }
+ }
+}
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 a70bf59448..749aa15edf 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
@@ -674,8 +674,11 @@ public class Ec2QueryHandler {
private Response handleRunInstances(MultivaluedMap<String, String> p, String region) {
String imageId = p.getFirst("ImageId");
String instanceType = p.getFirst("InstanceType");
- int minCount = Integer.parseInt(p.getOrDefault("MinCount", List.of("1")).get(0));
- int maxCount = Integer.parseInt(p.getOrDefault("MaxCount", List.of("1")).get(0));
+ int minCount = parseRunInstancesCount(p, "MinCount");
+ int maxCount = parseRunInstancesCount(p, "MaxCount");
+ if (maxCount < minCount) {
+ throw new AwsException("InvalidParameterValue", "MaxCount must be greater than or equal to MinCount", 400);
+ }
String keyName = p.getFirst("KeyName");
String subnetId = p.getFirst("SubnetId");
// The launch-time public-IP override arrives either on the primary
@@ -767,7 +770,7 @@ public class Ec2QueryHandler {
Reservation res = service.runInstances(region, imageId, instanceType, minCount, maxCount,
keyName, sgIds, subnetId, clientToken, instanceTags, userData, iamInstanceProfileArn,
associatePublicIp, networkInterfaceId, networkInterfaceDeviceIndex, null, metadataOptions,
- creditSpecificationCpuCredits, userDataEncoded);
+ creditSpecificationCpuCredits, userDataEncoded, Boolean.parseBoolean(p.getFirst("DryRun")));
if (!networkInterfaceTags.isEmpty()) {
List<String> eniIds = new ArrayList<>();
@@ -794,6 +797,22 @@ public class Ec2QueryHandler {
return xmlResponse(xml.build());
}
+ private int parseRunInstancesCount(MultivaluedMap<String, String> p, String name) {
+ String value = p.getFirst(name);
+ if (value == null) {
+ return 1;
+ }
+ try {
+ int count = Integer.parseInt(value);
+ if (count > 0) {
+ return count;
+ }
+ } catch (NumberFormatException ignored) {
+ // Malformed and non-positive counts share the same EC2 validation error.
+ }
+ throw new AwsException("InvalidParameterValue", name + " must be a positive integer", 400);
+ }
+
private LaunchTemplateData resolveRunInstancesLaunchTemplateData(MultivaluedMap<String, String> p, String region) {
String id = p.getFirst("LaunchTemplate.LaunchTemplateId");
String name = p.getFirst("LaunchTemplate.LaunchTemplateName");
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 2682809d8c..b738be134f 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
@@ -2487,6 +2487,21 @@ public class Ec2Service implements ContainerTeardown, ResourceProvider {
int networkInterfaceDeviceIndex, String availabilityZone,
LaunchTemplateData.MetadataOptions metadataOptions,
String creditSpecificationCpuCredits, String encodedUserData) {
+ return runInstances(region, imageId, instanceType, minCount, maxCount, keyName,
+ securityGroupIds, subnetId, clientToken, instanceTags, userData, iamInstanceProfileArn,
+ associatePublicIp, networkInterfaceId, networkInterfaceDeviceIndex, availabilityZone,
+ metadataOptions, creditSpecificationCpuCredits, encodedUserData, false);
+ }
+
+ public Reservation runInstances(String region, String imageId, String instanceType,
+ int minCount, int maxCount, String keyName,
+ List<String> securityGroupIds, String subnetId,
+ String clientToken, List<Tag> instanceTags,
+ String userData, String iamInstanceProfileArn,
+ Boolean associatePublicIp, String networkInterfaceId,
+ int networkInterfaceDeviceIndex, String availabilityZone,
+ LaunchTemplateData.MetadataOptions metadataOptions,
+ String creditSpecificationCpuCredits, String encodedUserData, boolean dryRun) {
if (imageId == null || imageId.isBlank()) {
throw new AwsException("MissingParameter", "The request must contain the parameter ImageId", 400);
}
@@ -2597,6 +2612,9 @@ public class Ec2Service implements ContainerTeardown, ResourceProvider {
dockerImage.cloudInit(), dockerImage.dockerPlatform());
}
}
+ if (dryRun) {
+ throw new AwsException("DryRunOperation", "Request would have succeeded, but DryRun flag is set.", 412);
+ }
for (int i = 0; i < count; i++) {
String instanceId = "i-" + randomHex(17);
String privateIp = suppliedEni != null
diff --git a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2RunInstancesDryRunIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2RunInstancesDryRunIntegrationTest.java
new file mode 100644
index 0000000000..c4bdc3e243
--- /dev/null
+++ b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2RunInstancesDryRunIntegrationTest.java
@@ -0,0 +1,84 @@
+package io.github.hectorvent.floci.services.ec2;
+
+import io.quarkus.test.junit.QuarkusTest;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
+
+import java.util.UUID;
+
+import static io.restassured.RestAssured.given;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.emptyOrNullString;
+
+@QuarkusTest
+class Ec2RunInstancesDryRunIntegrationTest {
+ private static final String AUTH = "AWS4-HMAC-SHA256 Credential=test/20260205/us-east-1/ec2/aws4_request";
+
+ @ParameterizedTest
+ @CsvSource({"true,MinCount,invalid", "false,MinCount,invalid",
+ "true,MinCount,0", "false,MinCount,0", "true,MaxCount,-1", "false,MaxCount,-1",
+ "true,MinCount,2", "false,MinCount,2", "true,UserData,%%%", "false,UserData,%%%",
+ "true,MetadataOptions.HttpTokens,invalid", "false,MetadataOptions.HttpTokens,invalid",
+ "true,CreditSpecification.CpuCredits,invalid", "false,CreditSpecification.CpuCredits,invalid"})
+ void invalidLaunchInputKeepsItsValidationError(boolean dryRun, String parameter, String value) {
+ given().header("Authorization", AUTH).formParam("Action", "RunInstances")
+ .formParam("ImageId", "ami-0abcdef1234567890").formParam("InstanceType", "t3.micro")
+ .formParam("DryRun", dryRun).formParam(parameter, value)
+ .post("/").then().statusCode(400)
+ .body("Response.Errors.Error.Code", equalTo("InvalidParameterValue"));
+ }
+
+ @ParameterizedTest
+ @CsvSource({"true,SubnetId,subnet-missing,InvalidSubnetID.NotFound",
+ "false,SubnetId,subnet-missing,InvalidSubnetID.NotFound",
+ "true,SecurityGroupId.1,sg-missing,InvalidGroup.NotFound",
+ "false,SecurityGroupId.1,sg-missing,InvalidGroup.NotFound",
+ "true,NetworkInterface.1.NetworkInterfaceId,eni-missing,InvalidNetworkInterfaceID.NotFound",
+ "false,NetworkInterface.1.NetworkInterfaceId,eni-missing,InvalidNetworkInterfaceID.NotFound"})
+ void invalidLaunchResourcesKeepTheirValidationError(boolean dryRun, String parameter,
+ String value, String errorCode) {
+ given().header("Authorization", AUTH).formParam("Action", "RunInstances")
+ .formParam("ImageId", "ami-0abcdef1234567890").formParam("InstanceType", "t3.micro")
+ .formParam("DryRun", dryRun).formParam(parameter, value)
+ .post("/").then().statusCode(400)
+ .body("Response.Errors.Error.Code", equalTo(errorCode));
+ }
+
+ @Test
+ void dryRunWithoutAnImageReturnsMissingParameter() {
+ given().header("Authorization", AUTH).formParam("Action", "RunInstances")
+ .formParam("DryRun", true).post("/").then().statusCode(400)
+ .body("Response.Errors.Error.Code", equalTo("MissingParameter"));
+ }
+
+ @Test
+ void dryRunReturnsEc2ErrorWithoutCreatingAnInstanceOrConsumingClientToken() {
+ String token = UUID.randomUUID().toString();
+ given().header("Authorization", AUTH)
+ .formParam("Action", "RunInstances")
+ .formParam("ImageId", "ami-0abcdef1234567890")
+ .formParam("InstanceType", "t3.micro")
+ .formParam("MinCount", "1").formParam("MaxCount", "1")
+ .formParam("ClientToken", token).formParam("DryRun", "true")
+ .formParam("TagSpecification.1.ResourceType", "instance")
+ .formParam("TagSpecification.1.Tag.1.Key", "DryRunTest")
+ .formParam("TagSpecification.1.Tag.1.Value", token)
+ .post("/").then().statusCode(412)
+ .body("Response.Errors.Error.Code", equalTo("DryRunOperation"));
+
+ given().header("Authorization", AUTH).formParam("Action", "DescribeInstances")
+ .formParam("Filter.1.Name", "tag:DryRunTest").formParam("Filter.1.Value.1", token)
+ .post("/").then().statusCode(200)
+ .body("DescribeInstancesResponse.reservationSet", emptyOrNullString());
+
+ String id = given().header("Authorization", AUTH).formParam("Action", "RunInstances")
+ .formParam("ImageId", "ami-0abcdef1234567890")
+ .formParam("InstanceType", "t3.micro")
+ .formParam("ClientToken", token).formParam("DryRun", "false")
+ .post("/").then().statusCode(200)
+ .extract().path("RunInstancesResponse.instancesSet.item.instanceId");
+ given().header("Authorization", AUTH).formParam("Action", "TerminateInstances")
+ .formParam("InstanceId.1", id).post("/").then().statusCode(200);
+ }
+}
diff --git a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2RunInstancesPublicIpParamTest.java b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2RunInstancesPublicIpParamTest.java
index b8417fa482..2885f903d4 100644
--- a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2RunInstancesPublicIpParamTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2RunInstancesPublicIpParamTest.java
@@ -13,6 +13,7 @@ import static org.junit.jupiter.api.Assertions.assertNull;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.anyList;
import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.nullable;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
@@ -59,7 +60,7 @@ class Ec2RunInstancesPublicIpParamTest {
anyInt(), anyInt(), nullable(String.class), anyList(), nullable(String.class),
nullable(String.class), anyList(), nullable(String.class), nullable(String.class),
nullable(Boolean.class), nullable(String.class), anyInt(), nullable(String.class),
- nullable(LaunchTemplateData.MetadataOptions.class), nullable(String.class), nullable(String.class)))
+ nullable(LaunchTemplateData.MetadataOptions.class), nullable(String.class), nullable(String.class), eq(false)))
.thenReturn(new Reservation());
Ec2QueryHandler handler = new Ec2QueryHandler(service, mock(EmulatorConfig.class),
@@ -72,7 +73,7 @@ class Ec2RunInstancesPublicIpParamTest {
anyInt(), anyInt(), nullable(String.class), anyList(), nullable(String.class),
nullable(String.class), anyList(), nullable(String.class), nullable(String.class),
associatePublicIp.capture(), nullable(String.class), anyInt(), nullable(String.class),
- nullable(LaunchTemplateData.MetadataOptions.class), nullable(String.class), nullable(String.class));
+ nullable(LaunchTemplateData.MetadataOptions.class), nullable(String.class), nullable(String.class), eq(false));
if (expected == null) {
assertNull(associatePublicIp.getValue(),
"an absent override must stay null so the subnet default decides");
diff --git a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ServiceTest.java b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ServiceTest.java
index 16abb3ba75..a0527e72dc 100644
--- a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ServiceTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ServiceTest.java
@@ -1377,6 +1377,60 @@ class Ec2ServiceTest {
assertEquals("arm64", compatible.getInstances().getFirst().getArchitecture());
}
+ @Test
+ void dryRunValidatesImagesBeforeReportingSuccess() {
+ Ec2ContainerManager manager = mock(Ec2ContainerManager.class);
+ AmiImageResolver resolver = mock(AmiImageResolver.class);
+ when(resolver.resolveImage("ami-windows"))
+ .thenThrow(new AwsException("UnsupportedOperation", "Unsupported AMI", 400));
+ Ec2Service service = liveService(manager, resolver, new Ec2ImageCatalog());
+ String deregistered = service.registerImage("us-east-1", "dry-run-image", null, null, null,
+ List.of()).getImageId();
+ service.deregisterImage("us-east-1", deregistered, false);
+
+ for (boolean dryRun : List.of(true, false)) {
+ assertEquals("UnsupportedOperation", assertThrows(AwsException.class,
+ () -> service.runInstances("us-east-1", "ami-windows", "t3.micro", 1, 1,
+ null, List.of(), null, null, List.of(), null, null,
+ null, null, 0, null, null, null, null, dryRun)).getErrorCode());
+ assertEquals("InvalidAMIID.Unavailable", assertThrows(AwsException.class,
+ () -> service.runInstances("us-east-1", deregistered, "t3.micro", 1, 1,
+ null, List.of(), null, null, List.of(), null, null,
+ null, null, 0, null, null, null, null, dryRun)).getErrorCode());
+ assertEquals("InvalidParameterValue", assertThrows(AwsException.class,
+ () -> service.runInstances("us-east-1", "ami-ubuntu2404-amd64", "t4g.medium", 1, 1,
+ null, List.of(), null, null, List.of(), null, null,
+ null, null, 0, null, null, null, null, dryRun)).getErrorCode());
+ }
+ assertTrue(service.describeInstances("us-east-1", List.of(), Map.of()).isEmpty());
+ assertTrue(service.describeVolumes("us-east-1", List.of(), Map.of()).isEmpty());
+ verifyNoInteractions(manager);
+ }
+
+ @Test
+ void dryRunValidatesSuppliedEniWithoutAttachingOrProvisioning() {
+ Ec2ContainerManager manager = mock(Ec2ContainerManager.class);
+ Ec2Service service = liveService(manager, mock(AmiImageResolver.class));
+ String subnetId = service.describeSubnets("us-east-1", List.of(), Map.of()).getFirst().getSubnetId();
+ NetworkInterface eni = service.createNetworkInterface("us-east-1", subnetId, null, null,
+ List.of(), List.of(), List.of());
+ for (boolean dryRun : List.of(true, false)) {
+ assertEquals("InvalidParameterCombination", assertThrows(AwsException.class,
+ () -> service.runInstances("us-east-1", "ami-test", "t3.micro", 2, 2,
+ null, List.of(), null, null, List.of(), null, null,
+ null, eni.getNetworkInterfaceId(), 0, null, null, null, null, dryRun)).getErrorCode());
+ }
+ assertEquals("DryRunOperation", assertThrows(AwsException.class,
+ () -> service.runInstances("us-east-1", "ami-test", "t3.micro", 1, 1,
+ null, List.of(), null, null, List.of(), null, null,
+ null, eni.getNetworkInterfaceId(), 0, null, null, null, null, true)).getErrorCode());
+ assertNull(eni.getAttachment());
+ assertEquals("available", eni.getStatus());
+ assertTrue(service.describeInstances("us-east-1", List.of(), Map.of()).isEmpty());
+ assertTrue(service.describeVolumes("us-east-1", List.of(), Map.of()).isEmpty());
+ verifyNoInteractions(manager);
+ }
+
@Test
void runInstancesRejectsUnsupportedImageBeforeCreatingInstance() {
Ec2ContainerManager containerManager = mock(Ec2ContainerManager.class);