Skip to content

armgit / floci

Public Imported from GitHub
0

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

fix(eks): remove the k3s container on DeleteCluster when shutdown retention is on (#4241)

Niels Kootstra6bf1695f2ad5
diff --git a/src/main/java/io/github/hectorvent/floci/services/eks/EksClusterManager.java b/src/main/java/io/github/hectorvent/floci/services/eks/EksClusterManager.java
index f52efb3517..8eac0533e6 100644
--- a/src/main/java/io/github/hectorvent/floci/services/eks/EksClusterManager.java
+++ b/src/main/java/io/github/hectorvent/floci/services/eks/EksClusterManager.java
@@ -576,16 +576,24 @@ public class EksClusterManager {
closeQuietly(logStream);
return;
}
- if (config.services().eks().keepRunningOnShutdown()) {
- closeQuietly(logStream);
- LOG.infov("Leaving k3s container for cluster {0} running", cluster.getName());
- return;
- }
lifecycleManager.stopAndRemove(cluster.getContainerId(), logStream);
ContainerStorageHelper.removeNamedVolume(config, lifecycleManager, clusterResourceName(cluster));
LOG.infov("Stopped k3s container for cluster {0}", cluster.getName());
}
+ /**
+ * Releases Floci's hold on the given cluster (its metadata endpoint and log stream) and leaves
+ * the k3s container running, so a later Floci start can re-latch it through
+ * {@link #restoreCluster}. Used on shutdown when keep-running-on-shutdown is enabled.
+ */
+ public void detachCluster(Cluster cluster) {
+ unregisterMetadataEndpoint(cluster);
+ closeQuietly(clusterLogHandles.remove(clusterResourceName(cluster)));
+ if (cluster.getContainerId() != null) {
+ LOG.infov("Leaving k3s container for cluster {0} running", cluster.getName());
+ }
+ }
+
private static void closeQuietly(Closeable closeable) {
if (closeable != null) {
try {
diff --git a/src/main/java/io/github/hectorvent/floci/services/eks/EksService.java b/src/main/java/io/github/hectorvent/floci/services/eks/EksService.java
index 6b18f07385..b4651212f1 100644
--- a/src/main/java/io/github/hectorvent/floci/services/eks/EksService.java
+++ b/src/main/java/io/github/hectorvent/floci/services/eks/EksService.java
@@ -429,8 +429,13 @@ public class EksService implements TagHandler, ResourceProvider {
public void shutdown() {
poller.shutdownNow();
if (!config.services().eks().mock()) {
+ boolean keepRunning = config.services().eks().keepRunningOnShutdown();
for (Cluster cluster : allClusters()) {
- clusterManager.stopCluster(cluster);
+ if (keepRunning) {
+ clusterManager.detachCluster(cluster);
+ } else {
+ clusterManager.stopCluster(cluster);
+ }
}
}
}
diff --git a/src/test/java/io/github/hectorvent/floci/services/eks/EksClusterManagerTest.java b/src/test/java/io/github/hectorvent/floci/services/eks/EksClusterManagerTest.java
index 91f3334257..e33b51d271 100644
--- a/src/test/java/io/github/hectorvent/floci/services/eks/EksClusterManagerTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/eks/EksClusterManagerTest.java
@@ -1797,8 +1797,13 @@ class EksClusterManagerTest {
assertNull(manager.getLogHandle(cluster));
}
+ /**
+ * Explicit DeleteCluster tears down through {@code stopCluster}. The shutdown retention
+ * option is decided by {@link EksService#shutdown()}, so it must not leave a deleted
+ * cluster's container running.
+ */
@Test
- void logHandleClosedWhenKeepRunningOnShutdownIsTrue() throws Exception {
+ void stopClusterRemovesTheContainerEvenWhenShutdownRetentionIsEnabled() {
when(eks.keepRunningOnShutdown()).thenReturn(true);
Cluster cluster = new Cluster();
@@ -1806,10 +1811,21 @@ class EksClusterManagerTest {
cluster.setLogging(new Logging(List.of(new LogSetup(List.of("api"), true))));
manager.startCluster(cluster);
- assertEquals(mockHandle, manager.getLogHandle(cluster));
-
manager.stopCluster(cluster);
+ verify(lifecycleManager).stopAndRemove("container-id-123456789012345678901234567890", mockHandle);
+ assertNull(manager.getLogHandle(cluster));
+ }
+
+ @Test
+ void detachClusterClosesTheLogStreamAndLeavesTheContainerRunning() throws Exception {
+ Cluster cluster = new Cluster();
+ cluster.setName("prod-cluster");
+ cluster.setLogging(new Logging(List.of(new LogSetup(List.of("api"), true))));
+
+ manager.startCluster(cluster);
+ manager.detachCluster(cluster);
+
verify(mockHandle).close();
verify(lifecycleManager, never()).stopAndRemove(anyString(), any());
assertNull(manager.getLogHandle(cluster));
diff --git a/src/test/java/io/github/hectorvent/floci/services/eks/EksServiceTest.java b/src/test/java/io/github/hectorvent/floci/services/eks/EksServiceTest.java
index 5fa5286f06..090370b885 100644
--- a/src/test/java/io/github/hectorvent/floci/services/eks/EksServiceTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/eks/EksServiceTest.java
@@ -100,10 +100,15 @@ class EksServiceTest {
}
private EmulatorConfig testConfig(boolean mock) {
+ return testConfig(mock, false);
+ }
+
+ private EmulatorConfig testConfig(boolean mock, boolean keepRunningOnShutdown) {
EmulatorConfig.EksServiceConfig eksConfig = proxy(EmulatorConfig.EksServiceConfig.class,
(proxy, method, args) -> switch (method.getName()) {
case "enabled" -> true;
case "mock" -> mock;
+ case "keepRunningOnShutdown" -> keepRunningOnShutdown;
case "apiServerBasePort" -> 6500;
default -> defaultValue(method);
});
@@ -485,6 +490,48 @@ class EksServiceTest {
}
@SuppressWarnings("unchecked")
+ @Test
+ void shutdownLeavesClusterContainersRunningWhenRetentionIsEnabled() {
+ Cluster cluster = activeCluster();
+ EksClusterManager clusterManager = mock(EksClusterManager.class);
+ EksService service = serviceWithCluster(cluster, clusterManager, true);
+
+ service.shutdown();
+
+ verify(clusterManager).detachCluster(cluster);
+ verify(clusterManager, never()).stopCluster(any(Cluster.class));
+ }
+
+ @Test
+ void shutdownStopsClusterContainersWhenRetentionIsDisabled() {
+ Cluster cluster = activeCluster();
+ EksClusterManager clusterManager = mock(EksClusterManager.class);
+ EksService service = serviceWithCluster(cluster, clusterManager, false);
+
+ service.shutdown();
+
+ verify(clusterManager).stopCluster(cluster);
+ verify(clusterManager, never()).detachCluster(any(Cluster.class));
+ }
+
+ private static Cluster activeCluster() {
+ Cluster cluster = new Cluster();
+ cluster.setName("running-cluster");
+ cluster.setStatus(ClusterStatus.ACTIVE);
+ return cluster;
+ }
+
+ private EksService serviceWithCluster(Cluster cluster, EksClusterManager clusterManager,
+ boolean keepRunningOnShutdown) {
+ AccountAwareStorageBackend<Cluster> clusterStore =
+ new AccountAwareStorageBackend<>(new InMemoryStorage<>(), null, "000000000000");
+ clusterStore.putForAccount("000000000000", cluster.getName(), cluster);
+ return new EksService(fixedStorageFactory(clusterStore), testConfig(false, keepRunningOnShutdown),
+ new RegionResolver("us-east-1", "000000000000"), clusterManager, null,
+ new EksOidcService(fixedStorageFactory(new InMemoryStorage<String, ClusterOidcKey>()),
+ new ObjectMapper()), mock(EksAccessEntryService.class));
+ }
+
private StorageFactory fixedStorageFactory(StorageBackend<String, ?> backend) {
return new StorageFactory(null, null) {
@Override