Light, fluffy, and always free - The AWS Local Emulator alternative
fix(ec2): user data logging (#1474)
Preston-Caibb6ee4f69d25
diff --git a/src/main/java/io/github/hectorvent/floci/core/common/docker/ContainerLogStreamer.java b/src/main/java/io/github/hectorvent/floci/core/common/docker/ContainerLogStreamer.javaindex 3e1d5aa973..89bda916ff 100644--- a/src/main/java/io/github/hectorvent/floci/core/common/docker/ContainerLogStreamer.java+++ b/src/main/java/io/github/hectorvent/floci/core/common/docker/ContainerLogStreamer.java@@ -104,6 +104,10 @@ public class ContainerLogStreamer {return LOG_STREAM_DATE_FMT.format(LocalDate.now()) + "/" + suffix;}+ public void streamToCloudWatchLogs(String logGroup, String logStream, String region, String line) {+ forwardToCloudWatchLogs(logGroup, logStream, region, line);+ }+private void forwardToCloudWatchLogs(String logGroup, String logStream, String region, String line) {try {Map<String, Object> event = new HashMap<>();diff --git a/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2ContainerManager.java b/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2ContainerManager.javaindex 4cf1566a88..d4cdfa1657 100644--- a/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2ContainerManager.java+++ b/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2ContainerManager.java@@ -417,21 +417,31 @@ public class Ec2ContainerManager {private void executeUserData(String containerId, String instanceId, String userData, String region) {try {+ String logGroup = "/aws/ec2/" + instanceId;+ String logStream = logStreamer.generateLogStreamName("user-data");+List<String> shellScripts = userDataShellScripts(userData);if (shellScripts.isEmpty()) {LOG.infov("UserData for EC2 instance {0} did not contain executable shellscript parts", instanceId);return;}+ // Execute the script and stream output to CloudWatchfor (int i = 0; i < shellScripts.size(); i++) {- executeUserDataShellScript(containerId, instanceId, shellScripts.get(i), i + 1, shellScripts.size());+ executeUserDataShellScript(+ containerId, instanceId, shellScripts.get(i), i + 1, shellScripts.size(),+ logGroup, logStream, region+ );}} catch (Exception e) {LOG.warnv("UserData execution failed for EC2 instance {0}: {1}", instanceId, e.getMessage());}}- private void executeUserDataShellScript(String containerId, String instanceId, String scriptContent, int partNumber, int partCount) throws Exception {+ private void executeUserDataShellScript(+ String containerId, String instanceId, String scriptContent, int partNumber, int partCount,+ String logGroup, String logStream, String region+ ) throws Exception {byte[] script = scriptContent.getBytes(StandardCharsets.UTF_8);byte[] tar = buildSingleFileTar("user-data.sh", script, 0755);dockerClient.copyArchiveToContainerCmd(containerId)@@ -453,8 +463,12 @@ public class Ec2ContainerManager {dockerClient.execStartCmd(execId).exec(new ResultCallback.Adapter<Frame>() {@Overridepublic void onNext(Frame frame) {- if (frame.getPayload() != null) {- try { output.write(frame.getPayload()); } catch (IOException ignored) {}+ byte[] payload = frame.getPayload();+ if (payload == null) return;+ try { output.write(payload); } catch (IOException ignored) {}+ String line = new String(payload, StandardCharsets.UTF_8).stripTrailing();+ if (!line.isEmpty()) {+ logStreamer.streamToCloudWatchLogs(logGroup, logStream, region, line);}}@Overridediff --git a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ContainerManagerTest.java b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ContainerManagerTest.javaindex 7f4dc2151d..ebe8fa658d 100644--- a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ContainerManagerTest.java+++ b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ContainerManagerTest.java@@ -12,6 +12,8 @@ import com.github.dockerjava.api.command.InspectExecCmd;import com.github.dockerjava.api.command.InspectExecResponse;import com.github.dockerjava.api.model.ContainerNetwork;import com.github.dockerjava.api.model.Frame;+import com.github.dockerjava.api.model.StreamType;+import java.nio.charset.StandardCharsets;import com.github.dockerjava.api.model.NetworkSettings;import io.github.hectorvent.floci.config.EmulatorConfig;import io.github.hectorvent.floci.core.common.docker.ContainerBuilder;@@ -42,6 +44,7 @@ import static org.junit.jupiter.api.Assertions.assertTrue;import static org.mockito.ArgumentMatchers.any;import static org.mockito.ArgumentMatchers.anyInt;import static org.mockito.ArgumentMatchers.anyString;+import static org.mockito.ArgumentMatchers.eq;import static org.mockito.Answers.RETURNS_SELF;import static org.mockito.Mockito.mock;import static org.mockito.Mockito.never;@@ -52,6 +55,10 @@ import static org.mockito.Mockito.withSettings;class Ec2ContainerManagerTest {+ private static final String TEST_USER_DATA_OUTPUT = "test-output";+ private static final String TEST_CONTAINER_ID = "container-1";+ private static final String TEST_LOG_STREAM_NAME = "yyyy/MM/dd/user-data";+@org.junit.jupiter.api.AfterEachvoid resetBridgeIpPolling() {Ec2ContainerManager.containerBridgeIpAttempts = 30;@@ -80,12 +87,12 @@ class Ec2ContainerManagerTest {@Testvoid restoreMetadataRegistrationRegistersRunningPersistedContainer() {ContainerLifecycleManager lifecycleManager = mock(ContainerLifecycleManager.class);- when(lifecycleManager.isContainerRunning("container-1")).thenReturn(true);+ when(lifecycleManager.isContainerRunning(TEST_CONTAINER_ID)).thenReturn(true);DockerClient dockerClient = mock(DockerClient.class);InspectContainerCmd inspect = mock(InspectContainerCmd.class);InspectContainerResponse response = inspectResponse("192.168.215.42");- when(dockerClient.inspectContainerCmd("container-1")).thenReturn(inspect);+ when(dockerClient.inspectContainerCmd(TEST_CONTAINER_ID)).thenReturn(inspect);when(inspect.exec()).thenReturn(response);Ec2MetadataServer metadataServer = mock(Ec2MetadataServer.class);@@ -102,7 +109,7 @@ class Ec2ContainerManagerTest {Instance instance = new Instance();instance.setInstanceId("i-restored");- instance.setDockerContainerId("container-1");+ instance.setDockerContainerId(TEST_CONTAINER_ID);instance.setContainerBridgeIp("192.168.215.7");assertTrue(manager.restoreMetadataRegistration(instance));@@ -175,6 +182,31 @@ class Ec2ContainerManagerTest {assertTrue(Ec2ContainerManager.userDataShellScripts(userData).isEmpty());}+ @Test+ void launchInstanceUserDataStreamToCloudWatch() throws Exception {+ LaunchHarness harness = launchHarness();+ harness.stubSuccessfulExecs(new CountDownLatch(0), new CountDownLatch(0));++ // manually set up container bridge IP+ InspectContainerCmd inspect = mock(InspectContainerCmd.class);+ InspectContainerResponse response = inspectResponse("192.168.215.42");+ when(harness.dockerClient.inspectContainerCmd(TEST_CONTAINER_ID)).thenReturn(inspect);+ when(inspect.exec()).thenReturn(response);++ String instanceId = "i-userdatacloudwatch";+ Instance instance = instance(instanceId);+ instance.setUserData("""+ #!/bin/bash+ echo test+ """);+ harness.manager.launch(instance, "ubuntu:24.04", null, "us-west-2");+ awaitUntil(() -> "running".equals(instance.getState().getName()), Duration.ofSeconds(2));++ verify(harness.logStreamer).streamToCloudWatchLogs(+ any(String.class), any(String.class), eq("us-west-2"), eq(TEST_USER_DATA_OUTPUT)+ );+ }+@Testvoid metadataProxyInstallCommandInstallsLinkLocalProxyDependencies() {String[] command = Ec2ContainerManager.metadataProxyInstallCommand();@@ -252,7 +284,7 @@ class Ec2ContainerManagerTest {InspectContainerCmd inspect = mock(InspectContainerCmd.class);InspectContainerResponse noIp = inspectResponse(null);InspectContainerResponse withIp = inspectResponse("172.18.0.9");- when(harness.dockerClient.inspectContainerCmd("container-1")).thenReturn(inspect);+ when(harness.dockerClient.inspectContainerCmd(TEST_CONTAINER_ID)).thenReturn(inspect);when(inspect.exec()).thenReturn(noIp).thenReturn(withIp);harness.stubSuccessfulExecs(new CountDownLatch(0), new CountDownLatch(0));@@ -261,7 +293,7 @@ class Ec2ContainerManagerTest {harness.manager.launch(instance, "ubuntu:24.04", null, "us-west-2");awaitUntil(() -> "running".equals(instance.getState().getName()), Duration.ofSeconds(2));- assertEquals("container-1", instance.getDockerContainerId());+ assertEquals(TEST_CONTAINER_ID, instance.getDockerContainerId());assertEquals("172.18.0.9", instance.getContainerBridgeIp());assertEquals("172.18.0.9", instance.getPrivateIpAddress());verify(inspect, times(2)).exec();@@ -275,7 +307,7 @@ class Ec2ContainerManagerTest {LaunchHarness harness = launchHarness();InspectContainerCmd inspect = mock(InspectContainerCmd.class);InspectContainerResponse noIp = inspectResponse(null);- when(harness.dockerClient.inspectContainerCmd("container-1")).thenReturn(inspect);+ when(harness.dockerClient.inspectContainerCmd(TEST_CONTAINER_ID)).thenReturn(inspect);when(inspect.exec()).thenReturn(noIp);Instance instance = instance("i-noip");@@ -283,7 +315,7 @@ class Ec2ContainerManagerTest {harness.manager.launch(instance, "ubuntu:24.04", null, "us-west-2");awaitUntil(() -> "terminated".equals(instance.getState().getName()), Duration.ofSeconds(2));- assertEquals("container-1", instance.getDockerContainerId());+ assertEquals(TEST_CONTAINER_ID, instance.getDockerContainerId());verify(harness.metadataServer, never()).registerContainer(anyString(), anyString(), any());}@@ -294,7 +326,7 @@ class Ec2ContainerManagerTest {LaunchHarness harness = launchHarness();InspectContainerCmd inspect = mock(InspectContainerCmd.class);InspectContainerResponse withIp = inspectResponse("172.18.0.10");- when(harness.dockerClient.inspectContainerCmd("container-1")).thenReturn(inspect);+ when(harness.dockerClient.inspectContainerCmd(TEST_CONTAINER_ID)).thenReturn(inspect);when(inspect.exec()).thenReturn(withIp);CountDownLatch userDataStarted = new CountDownLatch(1);CountDownLatch finishUserData = new CountDownLatch(1);@@ -318,8 +350,8 @@ class Ec2ContainerManagerTest {when(builder.build()).thenReturn(new ContainerSpec("ubuntu:24.04"));ContainerLifecycleManager lifecycleManager = mock(ContainerLifecycleManager.class);- when(lifecycleManager.create(any(ContainerSpec.class))).thenReturn("container-1");- when(lifecycleManager.isContainerRunning("container-1")).thenReturn(true);+ when(lifecycleManager.create(any(ContainerSpec.class))).thenReturn(TEST_CONTAINER_ID);+ when(lifecycleManager.isContainerRunning(TEST_CONTAINER_ID)).thenReturn(true);DockerHostResolver dockerHostResolver = mock(DockerHostResolver.class);when(dockerHostResolver.resolve()).thenReturn("floci");@@ -337,17 +369,18 @@ class Ec2ContainerManagerTest {DockerClient dockerClient = mock(DockerClient.class);Ec2MetadataServer metadataServer = mock(Ec2MetadataServer.class);+ ContainerLogStreamer logStreamer = mock(ContainerLogStreamer.class);Ec2ContainerManager manager = new Ec2ContainerManager(containerBuilder,lifecycleManager,- mock(ContainerLogStreamer.class),+ logStreamer,mock(ContainerDetector.class),dockerHostResolver,dockerClient,portAllocator,config,metadataServer);- return new LaunchHarness(manager, dockerClient, metadataServer);+ return new LaunchHarness(manager, dockerClient, metadataServer, logStreamer);}private static Instance instance(String instanceId) {@@ -380,7 +413,8 @@ class Ec2ContainerManagerTest {private record LaunchHarness(Ec2ContainerManager manager,DockerClient dockerClient,- Ec2MetadataServer metadataServer) {+ Ec2MetadataServer metadataServer,+ ContainerLogStreamer logStreamer) {void stubSuccessfulExecs(CountDownLatch userDataStarted, CountDownLatch finishUserData) throws Exception {AtomicReference<String[]> currentCommand = new AtomicReference<>();ExecCreateCmd execCreate = mock(ExecCreateCmd.class, withSettings().defaultAnswer(RETURNS_SELF));@@ -388,7 +422,7 @@ class Ec2ContainerManagerTest {ExecCreateCmdResponse userDataExec = mock(ExecCreateCmdResponse.class);when(metadataExec.getId()).thenReturn("metadata-exec");when(userDataExec.getId()).thenReturn("userdata-exec");- when(dockerClient.execCreateCmd("container-1")).thenReturn(execCreate);+ when(dockerClient.execCreateCmd(TEST_CONTAINER_ID)).thenReturn(execCreate);when(execCreate.withCmd(any(String[].class))).thenAnswer(invocation -> {Object[] args = invocation.getArguments();if (args.length == 1 && args[0] instanceof String[] command) {@@ -414,6 +448,9 @@ class Ec2ContainerManagerTest {ResultCallback<Frame> callback = startInvocation.getArgument(0);if ("userdata-exec".equals(execId)) {userDataStarted.countDown();+ // test docker api frame+ Frame frame = new Frame(StreamType.STDOUT, TEST_USER_DATA_OUTPUT.getBytes(StandardCharsets.UTF_8));+ callback.onNext(frame);finishUserData.await(2, TimeUnit.SECONDS);}callback.onComplete();@@ -429,8 +466,10 @@ class Ec2ContainerManagerTest {when(dockerClient.inspectExecCmd(anyString())).thenReturn(inspectExec);CopyArchiveToContainerCmd copy = mock(CopyArchiveToContainerCmd.class, withSettings().defaultAnswer(RETURNS_SELF));- when(dockerClient.copyArchiveToContainerCmd("container-1")).thenReturn(copy);+ when(dockerClient.copyArchiveToContainerCmd(TEST_CONTAINER_ID)).thenReturn(copy);when(copy.withTarInputStream(any(InputStream.class))).thenReturn(copy);++ when(logStreamer.generateLogStreamName(anyString())).thenReturn(TEST_LOG_STREAM_NAME);}}}