Skip to content

armgit / floci

Public Imported from GitHub
0

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

feat(ec2): added attach and detach volume support (#1787)

Preston-Cai2c743299ec35
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.java
index 1efe93825d..509846f5cf 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
@@ -170,7 +170,7 @@ public class AwsQueryController {
"ModifyLaunchTemplate", "DeleteLaunchTemplate",
"DescribeNetworkInterfaces",
"CreateFlowLogs", "DescribeFlowLogs", "DeleteFlowLogs",
- "CreateVolume", "DescribeVolumes", "DeleteVolume"
+ "CreateVolume", "DescribeVolumes", "DeleteVolume", "AttachVolume", "DetachVolume"
);
private final CloudFormationQueryHandler cloudFormationQueryHandler;
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 03ecb3ab78..268604a1d7 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
@@ -158,6 +158,8 @@ public class Ec2QueryHandler {
case "CreateVolume" -> handleCreateVolume(params, region);
case "DescribeVolumes" -> handleDescribeVolumes(params, region);
case "DeleteVolume" -> handleDeleteVolume(params, region);
+ case "AttachVolume" -> handleAttachVolume(params, region);
+ case "DetachVolume" -> handleDetachVolume(params, region);
// Spot Instances
case "RequestSpotInstances" -> handleRequestSpotInstances(params, region);
case "DescribeSpotInstanceRequests" -> handleDescribeSpotInstanceRequests(params, region);
@@ -2587,6 +2589,39 @@ public class Ec2QueryHandler {
return booleanResponse("DeleteVolume");
}
+ private Response handleAttachVolume(MultivaluedMap<String, String> p, String region) {
+ String volumeId = p.getFirst("VolumeId");
+ String instanceId = p.getFirst("InstanceId");
+ String device = p.getFirst("Device");
+ VolumeAttachment attachment = service.attachVolume(region, volumeId, instanceId, device);
+ return volumeAttachmentResponse("AttachVolume", attachment, "attaching");
+ }
+
+ private Response handleDetachVolume(MultivaluedMap<String, String> p, String region) {
+ String volumeId = p.getFirst("VolumeId");
+ String instanceId = p.getFirst("InstanceId");
+ String device = p.getFirst("Device");
+ boolean force = "true".equalsIgnoreCase(p.getFirst("Force"));
+ VolumeAttachment attachment = service.detachVolume(region, volumeId, instanceId, device, force);
+ return volumeAttachmentResponse("DetachVolume", attachment, "detaching");
+ }
+
+ private Response volumeAttachmentResponse(String action, VolumeAttachment attachment, String status) {
+ XmlBuilder xml = new XmlBuilder()
+ .start(action + "Response", AwsNamespaces.EC2)
+ .elem("requestId", UUID.randomUUID().toString())
+ .elem("volumeId", attachment.getVolumeId())
+ .elem("instanceId", attachment.getInstanceId())
+ .elem("device", attachment.getDevice())
+ .elem("status", status)
+ .elem("deleteOnTermination", String.valueOf(attachment.isDeleteOnTermination()));
+ if (attachment.getAttachTime() != null) {
+ xml.elem("attachTime", ISO_FMT.format(attachment.getAttachTime()));
+ }
+ xml.end(action + "Response");
+ return xmlResponse(xml.build());
+ }
+
private String volumeXml(Volume vol) {
XmlBuilder xml = new XmlBuilder()
.elem("volumeId", vol.getVolumeId())
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 b3066bf5dd..94ae3468d2 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
@@ -2918,6 +2918,95 @@ public class Ec2Service implements ContainerTeardown {
volumes.delete(key(region, volumeId));
}
+ public VolumeAttachment attachVolume(String region, String volumeId, String instanceId, String device) {
+ ensureDefaultResources(region);
+ if (volumeId == null || volumeId.isEmpty()) {
+ throw new AwsException("MissingParameter",
+ "The parameter VolumeId is missing", 400);
+ }
+ if (instanceId == null || instanceId.isEmpty()) {
+ throw new AwsException("MissingParameter",
+ "The parameter InstanceId is missing", 400);
+ }
+ if (device == null || device.isEmpty()) {
+ throw new AwsException("MissingParameter",
+ "The parameter Device is missing", 400);
+ }
+ Volume volume = getRequiredVolume(region, volumeId);
+ Instance inst = getRequiredInstance(region, instanceId);
+ if (!List.of("running", "stopped").contains(inst.getState().getName())) {
+ throw new AwsException("IncorrectInstanceState",
+ "The instance '" + inst.getInstanceId() + "' is not in a state from which it can be attached", 400);
+ }
+ if (!inst.getPlacement().getAvailabilityZone().equals(volume.getAvailabilityZone())) {
+ throw new AwsException(
+ "InvalidParameterValue",
+ "The volume '" + volume.getVolumeId() +
+ "' and instance '" + inst.getInstanceId() +
+ "' must be in the same Availability Zone", 400);
+ }
+ if (!"available".equals(volume.getState())) {
+ throw new AwsException("VolumeInUse",
+ "Volume '" + volumeId + "' is already attached", 400);
+ }
+
+ VolumeAttachment attachment = new VolumeAttachment();
+ attachment.setVolumeId(volumeId);
+ attachment.setInstanceId(instanceId);
+ attachment.setDevice(device);
+ attachment.setState("attached");
+ attachment.setAttachTime(Instant.now());
+ attachment.setDeleteOnTermination(false); // Default for attached volumes
+
+ volume.getAttachments().add(attachment);
+ volume.setState("in-use");
+ volumes.put(key(region, volumeId), volume);
+ return attachment;
+ }
+
+ public VolumeAttachment detachVolume(String region, String volumeId, String instanceId, String device, boolean force) {
+ if (volumeId == null || volumeId.isEmpty()) {
+ throw new AwsException("MissingParameter", "The parameter VolumeId is missing", 400);
+ }
+ ensureDefaultResources(region);
+ Volume volume = getRequiredVolume(region, volumeId);
+
+ if ("available".equals(volume.getState()) || volume.getAttachments().isEmpty()) {
+ throw new AwsException("InvalidVolume.NotAttached",
+ "Volume '" + volumeId + "' is not attached", 400);
+ }
+ VolumeAttachment target = volume.getAttachments().getFirst();
+ if (instanceId != null && !target.getInstanceId().equals(instanceId)) {
+ throw new AwsException("InvalidAttachment.NotFound",
+ "Volume '" + volumeId + "' is not attached to instance '" + instanceId + "'", 400);
+ }
+ if (device != null && !target.getDevice().equals(device)) {
+ throw new AwsException("InvalidAttachment.NotFound",
+ "Volume '" + volumeId + "' is not attached with device '" + device + "'", 400);
+ }
+ Instance inst = getRequiredInstance(region, target.getInstanceId());
+ if (!inst.getState().getName().equals("stopped") && target.getDevice().equals(inst.getRootDeviceName())) {
+ throw new AwsException("OperationNotPermitted",
+ "The root volume of an instance cannot be detached while the instance is running", 400);
+ }
+ if (!force && target.getDevice().equals(inst.getRootDeviceName())) {
+ throw new AwsException("InvalidParameterCombination",
+ "Device " + inst.getRootDeviceName() + " has the root partition on it. Detaching it will damage the " +
+ "filesystem/partition tables. To force detachment, use the force parameter", 400);
+ }
+ target.setState("detached");
+ volume.getAttachments().clear();
+ volume.setState("available");
+ volumes.put(key(region, volumeId), volume);
+ return target;
+ }
+
+ private Volume getRequiredVolume(String region, String volumeId) {
+ return volumes.get(key(region, volumeId)).orElseThrow(() ->
+ new AwsException("InvalidVolume.NotFound", "The volume '" + volumeId + "' does not exist", 400)
+ );
+ }
+
// ─── Network Interfaces ─────────────────────────────────────────────────────
public NetworkInterfaceListResult describeNetworkInterfaces(String region, List<String> networkInterfaceIds,
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 eed059623a..e5bd7be78b 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
@@ -18,6 +18,9 @@ import io.github.hectorvent.floci.services.ec2.model.SecurityGroup;
import io.github.hectorvent.floci.services.ec2.model.Snapshot;
import io.github.hectorvent.floci.services.ec2.model.Tag;
import io.github.hectorvent.floci.services.ec2.model.VpcEndpoint;
+import io.github.hectorvent.floci.services.ec2.model.Volume;
+import io.github.hectorvent.floci.services.ec2.model.VolumeAttachment;
+import io.github.hectorvent.floci.services.ec2.model.InstanceState;
import org.junit.jupiter.api.Test;
import java.util.List;
@@ -391,6 +394,143 @@ class Ec2ServiceTest {
return mapping;
}
+ @Test
+ void attachVolumeMarksVolumeInUseWithAttachmentDetails() {
+ Ec2Service service = new Ec2Service(mockConfig(true), mock(Ec2ContainerManager.class),
+ mock(Ec2PortForwardManager.class), mock(AmiImageResolver.class), mock(Ec2ImageCatalog.class),
+ new Ec2InstanceTypeCatalog(), new InMemoryStorageFactory());
+ Reservation reservation = service.runInstances("us-east-1", "ami-1234567890abcdef0", "t3.micro",
+ 1, 1, null, List.of(), null, null, List.of(), null, null);
+ Instance inst = reservation.getInstances().getFirst();
+ inst.setState(InstanceState.running());
+ String instanceId = inst.getInstanceId();
+ String instanceAz = inst.getPlacement().getAvailabilityZone();
+ Volume volume = service.createVolume("us-east-1", instanceAz, "gp3", 8,
+ false, 0, null, null, List.of());
+ VolumeAttachment response = service.attachVolume("us-east-1", volume.getVolumeId(), instanceId, "/dev/sdf");
+
+ assertEquals(volume.getVolumeId(), response.getVolumeId());
+ assertEquals(instanceId, response.getInstanceId());
+ assertEquals("/dev/sdf", response.getDevice());
+ assertEquals("attached", response.getState());
+ assertFalse(response.isDeleteOnTermination());
+ Volume attached = service.describeVolumes("us-east-1", List.of(volume.getVolumeId()), Map.of()).getFirst();
+ assertEquals("in-use", attached.getState());
+ assertEquals(1, attached.getAttachments().size());
+ assertEquals(instanceId, attached.getAttachments().getFirst().getInstanceId());
+ assertEquals("/dev/sdf", attached.getAttachments().getFirst().getDevice());
+ assertEquals("attached", attached.getAttachments().getFirst().getState());
+ assertFalse(attached.getAttachments().getFirst().isDeleteOnTermination());
+ }
+
+ @Test
+ void attachVolumeThrowsWithDifferentAZ() {
+ Ec2Service service = new Ec2Service(mockConfig(true), mock(Ec2ContainerManager.class),
+ mock(Ec2PortForwardManager.class), mock(AmiImageResolver.class), mock(Ec2ImageCatalog.class),
+ new Ec2InstanceTypeCatalog(), new InMemoryStorageFactory());
+ Reservation reservation = service.runInstances("us-east-1", "ami-1234567890abcdef0", "t3.micro",
+ 1, 1, null, List.of(), null, null, List.of(), null, null);
+ Instance inst = reservation.getInstances().getFirst();
+ inst.setState(InstanceState.running());
+ String instanceAz = inst.getPlacement().getAvailabilityZone();
+ String volumeAz = List.of("us-east-1a", "us-east-1b", "us-east-1c").stream()
+ .filter(az -> !az.equals(instanceAz))
+ .findFirst()
+ .orElseThrow();
+ Volume volume = service.createVolume("us-east-1", volumeAz, "gp3", 8,
+ false, 0, null, null, List.of());
+
+ AwsException error = assertThrows(AwsException.class, () ->
+ service.attachVolume("us-east-1", volume.getVolumeId(), inst.getInstanceId(), "/dev/sdf"));
+ assertEquals("InvalidParameterValue", error.getErrorCode());
+ }
+
+ @Test
+ void attachVolumeThrowsWithIncorrectInstanceState() {
+ Ec2Service service = new Ec2Service(mockConfig(true), mock(Ec2ContainerManager.class),
+ mock(Ec2PortForwardManager.class), mock(AmiImageResolver.class), mock(Ec2ImageCatalog.class),
+ new Ec2InstanceTypeCatalog(), new InMemoryStorageFactory());
+ Reservation reservation = service.runInstances("us-east-1", "ami-1234567890abcdef0", "t3.micro",
+ 1, 1, null, List.of(), null, null, List.of(), null, null);
+ Instance inst = reservation.getInstances().getFirst();
+ inst.setState(InstanceState.pending());
+ String az = inst.getPlacement().getAvailabilityZone();
+ Volume volume = service.createVolume("us-east-1", az, "gp3", 8,
+ false, 0, null, null, List.of());
+ AwsException error = assertThrows(AwsException.class, () ->
+ service.attachVolume("us-east-1", volume.getVolumeId(), inst.getInstanceId(), "/dev/sdf"));
+ assertEquals("IncorrectInstanceState", error.getErrorCode());
+ }
+
+ @Test
+ void detachVolumeMarksVolumeAvailableAndClearsAttachment() {
+ Ec2Service service = new Ec2Service(mockConfig(true), mock(Ec2ContainerManager.class),
+ mock(Ec2PortForwardManager.class), mock(AmiImageResolver.class), mock(Ec2ImageCatalog.class),
+ new Ec2InstanceTypeCatalog(), new InMemoryStorageFactory());
+ Reservation reservation = service.runInstances("us-east-1", "ami-1234567890abcdef0", "t3.micro",
+ 1, 1, null, List.of(), null, null, List.of(), null, null);
+ Instance inst = reservation.getInstances().getFirst();
+ inst.setState(InstanceState.running());
+ String instanceId = inst.getInstanceId();
+ String instanceAz = inst.getPlacement().getAvailabilityZone();
+ Volume volume = service.createVolume("us-east-1", instanceAz, "gp3", 8,
+ false, 0, null, null, List.of());
+ service.attachVolume("us-east-1", volume.getVolumeId(), instanceId, "/dev/sdf");
+
+ VolumeAttachment response = service.detachVolume("us-east-1", volume.getVolumeId(), instanceId, "/dev/sdf", false);
+
+ assertEquals(volume.getVolumeId(), response.getVolumeId());
+ assertEquals(instanceId, response.getInstanceId());
+ assertEquals("/dev/sdf", response.getDevice());
+ assertEquals("detached", response.getState());
+ assertFalse(response.isDeleteOnTermination());
+ Volume detached = service.describeVolumes("us-east-1", List.of(volume.getVolumeId()), Map.of()).getFirst();
+ assertEquals("available", detached.getState());
+ assertTrue(detached.getAttachments().isEmpty());
+ }
+
+ @Test
+ void detachRootVolumeRequiresForceAndStopped() {
+ Ec2Service service = new Ec2Service(mockConfig(true), mock(Ec2ContainerManager.class),
+ mock(Ec2PortForwardManager.class), mock(AmiImageResolver.class), mock(Ec2ImageCatalog.class),
+ new Ec2InstanceTypeCatalog(), new InMemoryStorageFactory());
+ Reservation reservation = service.runInstances("us-east-1", "ami-1234567890abcdef0", "t3.micro",
+ 1, 1, null, List.of(), null, null, List.of(), null, null);
+ Instance inst = reservation.getInstances().getFirst();
+ String instanceId = inst.getInstanceId();
+ String rootVolumeId = inst.getRootVolumeId();
+ String rootDeviceName = inst.getRootDeviceName();
+
+ // forced but not stopped
+ inst.setState(InstanceState.running());
+ AwsException error = assertThrows(AwsException.class,
+ () -> service.detachVolume("us-east-1", rootVolumeId, instanceId, rootDeviceName, true));
+ assertEquals("OperationNotPermitted", error.getErrorCode());
+ AwsException errorWithoutInstanceId = assertThrows(AwsException.class,
+ () -> service.detachVolume("us-east-1", rootVolumeId, null, null, true));
+ assertEquals("OperationNotPermitted", errorWithoutInstanceId.getErrorCode());
+
+ // stopped but not forced
+ inst.setState(InstanceState.stopped());
+ error = assertThrows(AwsException.class,
+ () -> service.detachVolume("us-east-1", rootVolumeId, instanceId, rootDeviceName, false));
+ assertEquals("InvalidParameterCombination", error.getErrorCode());
+ errorWithoutInstanceId = assertThrows(AwsException.class,
+ () -> service.detachVolume("us-east-1", rootVolumeId, null, null, false));
+ assertEquals("InvalidParameterCombination", errorWithoutInstanceId.getErrorCode());
+
+ // success
+ VolumeAttachment response = service.detachVolume("us-east-1", rootVolumeId, instanceId, rootDeviceName, true);
+ assertEquals(rootVolumeId, response.getVolumeId());
+ assertEquals(instanceId, response.getInstanceId());
+ assertEquals(rootDeviceName, response.getDevice());
+ assertEquals("detached", response.getState());
+ assertTrue(response.isDeleteOnTermination());
+
+ Volume detached = service.describeVolumes("us-east-1", List.of(rootVolumeId), Map.of()).getFirst();
+ assertEquals("available", detached.getState());
+ }
+
private static EmulatorConfig mockConfig(boolean ec2Mock) {
EmulatorConfig config = mock(EmulatorConfig.class);
EmulatorConfig.ServicesConfig services = mock(EmulatorConfig.ServicesConfig.class);