Added an option to collect init script logs.

Author: zendesk-abhijeet

src/main/java/hudson/plugins/ec2/SlaveTemplate.java

@@ -254,6 +254,8 @@ public class SlaveTemplate implements Describable<SlaveTemplate> {
 
     private Boolean enclaveEnabled;
 
+    private boolean collectInitScriptLogs;
+
     private transient /* almost final */ Set<LabelAtom> labelSet;
 
     private transient /* almost final */ Set<String> securityGroupSet;
@@ -343,7 +345,8 @@ public SlaveTemplate(
             Boolean metadataTokensRequired,
             Integer metadataHopsLimit,
             Boolean metadataSupported,
-            Boolean enclaveEnabled) {
+            Boolean enclaveEnabled,
+            boolean collectInitScriptLogs) {
 
         if (StringUtils.isNotBlank(remoteAdmin) || StringUtils.isNotBlank(jvmopts) || StringUtils.isNotBlank(tmpDir)) {
             LOGGER.log(
@@ -434,6 +437,7 @@ public SlaveTemplate(
                 metadataHopsLimit != null ? metadataHopsLimit : EC2AbstractSlave.DEFAULT_METADATA_HOPS_LIMIT;
         this.enclaveEnabled = enclaveEnabled != null ? enclaveEnabled : EC2AbstractSlave.DEFAULT_ENCLAVE_ENABLED;
         this.associateIPStrategy = associateIPStrategy != null ? associateIPStrategy : AssociateIPStrategy.DEFAULT;
+        this.collectInitScriptLogs = collectInitScriptLogs;
 
         readResolve(); // initialize
     }
@@ -530,7 +534,8 @@ public SlaveTemplate(
                 metadataTokensRequired,
                 metadataHopsLimit,
                 metadataSupported,
-                enclaveEnabled);
+                enclaveEnabled,
+                false);
     }
 
     @Deprecated
@@ -609,7 +614,7 @@ public SlaveTemplate(
                 deleteRootOnTermination,
                 useEphemeralDevices,
                 launchTimeoutStr,
-                associatePublicIp,
+                AssociateIPStrategy.backwardsCompatible(associatePublicIp),
                 customDeviceMapping,
                 connectBySSHProcess,
                 monitoring,
@@ -624,7 +629,8 @@ public SlaveTemplate(
                 metadataTokensRequired,
                 metadataHopsLimit,
                 metadataSupported,
-                EC2AbstractSlave.DEFAULT_ENCLAVE_ENABLED);
+                EC2AbstractSlave.DEFAULT_ENCLAVE_ENABLED,
+                false);
     }
 
     @Deprecated
@@ -703,7 +709,7 @@ public SlaveTemplate(
                 deleteRootOnTermination,
                 useEphemeralDevices,
                 launchTimeoutStr,
-                associatePublicIp,
+                AssociateIPStrategy.backwardsCompatible(associatePublicIp),
                 customDeviceMapping,
                 connectBySSHProcess,
                 monitoring,
@@ -718,7 +724,8 @@ public SlaveTemplate(
                 metadataTokensRequired,
                 metadataHopsLimit,
                 EC2AbstractSlave.DEFAULT_METADATA_SUPPORTED,
-                EC2AbstractSlave.DEFAULT_ENCLAVE_ENABLED);
+                EC2AbstractSlave.DEFAULT_ENCLAVE_ENABLED,
+                false);
     }
 
     @Deprecated
@@ -792,7 +799,7 @@ public SlaveTemplate(
                 deleteRootOnTermination,
                 useEphemeralDevices,
                 launchTimeoutStr,
-                associatePublicIp,
+                AssociateIPStrategy.backwardsCompatible(associatePublicIp),
                 customDeviceMapping,
                 connectBySSHProcess,
                 monitoring,
@@ -807,7 +814,8 @@ public SlaveTemplate(
                 EC2AbstractSlave.DEFAULT_METADATA_TOKENS_REQUIRED,
                 EC2AbstractSlave.DEFAULT_METADATA_HOPS_LIMIT,
                 EC2AbstractSlave.DEFAULT_METADATA_SUPPORTED,
-                EC2AbstractSlave.DEFAULT_ENCLAVE_ENABLED);
+                EC2AbstractSlave.DEFAULT_ENCLAVE_ENABLED,
+                false);
     }
 
     @Deprecated
@@ -2074,6 +2082,15 @@ public Boolean getEnclaveEnabled() {
         return enclaveEnabled;
     }
 
+    public boolean getCollectInitScriptLogs() {
+        return collectInitScriptLogs;
+    }
+
+    @DataBoundSetter
+    public void setCollectInitScriptLogs(boolean collectInitScriptLogs) {
+        this.collectInitScriptLogs = collectInitScriptLogs;
+    }
+
     public DescribableList<NodeProperty<?>, NodePropertyDescriptor> getNodeProperties() {
         return Objects.requireNonNull(nodeProperties);
     }

src/main/java/hudson/plugins/ec2/ssh/EC2SSHLauncher.java

@@ -155,34 +155,110 @@ public void onClosed(Channel channel, IOException cause) {
         computer.setChannel(invertedOut, invertedIn, logger, channelListener);
     }
 
+    protected boolean executeRemote(ClientSession session, String command, OutputStream logger) {
+        return executeRemote(session, command, logger, false, null);
+    }
+
+    // Add overloaded method with collectOutput parameter
+    protected boolean executeRemote(
+            ClientSession session, String command, OutputStream logger, boolean collectOutput, TaskListener listener) {
+        try {
+            if (collectOutput && listener != null) {
+                // Execute with output capture
+                ChannelExec channelExec = session.createExecChannel(command);
+                java.io.ByteArrayOutputStream stdout = new java.io.ByteArrayOutputStream();
+                java.io.ByteArrayOutputStream stderr = new java.io.ByteArrayOutputStream();
+
+                // Send to both the original logger and our capture streams
+                java.io.OutputStream combinedOut = new java.io.OutputStream() {
+                    @Override
+                    public void write(int b) throws IOException {
+                        logger.write(b);
+                        stdout.write(b);
+                    }
+
+                    @Override
+                    public void write(byte[] b, int off, int len) throws IOException {
+                        logger.write(b, off, len);
+                        stdout.write(b, off, len);
+                    }
+                };
+
+                java.io.OutputStream combinedErr = new java.io.OutputStream() {
+                    @Override
+                    public void write(int b) throws IOException {
+                        logger.write(b);
+                        stderr.write(b);
+                    }
+
+                    @Override
+                    public void write(byte[] b, int off, int len) throws IOException {
+                        logger.write(b, off, len);
+                        stderr.write(b, off, len);
+                    }
+                };
+
+                channelExec.setOut(combinedOut);
+                channelExec.setErr(combinedErr);
+                channelExec.open();
+                channelExec.waitFor(java.util.EnumSet.of(org.apache.sshd.client.channel.ClientChannelEvent.CLOSED), 0);
+
+                // Log the captured output to Logger
+                String stdoutStr = stdout.toString(java.nio.charset.StandardCharsets.UTF_8);
+                String stderrStr = stderr.toString(java.nio.charset.StandardCharsets.UTF_8);
+
+                if (!stdoutStr.trim().isEmpty()) {
+                    // Replace all line breaks with "||" so that it appears as a single line in the logs
+                    LOGGER.info("Init script STDOUT for command '" + command + "': "
+                            + stdoutStr.replaceAll("\\r\\n|\\r|\\n", "||"));
+                }
+                if (!stderrStr.trim().isEmpty()) {
+                    // Replace all line breaks with "||" so that it appears as a single line in the logs
+                    LOGGER.warning("Init script STDERR for command '" + command + "': "
+                            + stderrStr.replaceAll("\\r\\n|\\r|\\n", "||"));
+                }
+
+                return channelExec.getExitStatus() == 0;
+            } else {
+                // Use existing implementation
+                session.executeRemoteCommand(command, logger, logger, null);
+                return true;
+            }
+        } catch (IOException e) {
+            LOGGER.log(Level.FINE, "Failed to execute remote command: " + command, e);
+            return false;
+        }
+    }
+
     protected boolean executeRemote(
             EC2Computer computer,
             ClientSession clientSession,
             String checkCommand,
             String command,
             PrintStream logger,
             TaskListener listener) {
+        return executeRemote(computer, clientSession, checkCommand, command, logger, listener, false);
+    }
+
+    protected boolean executeRemote(
+            EC2Computer computer,
+            ClientSession clientSession,
+            String checkCommand,
+            String command,
+            PrintStream logger,
+            TaskListener listener,
+            boolean collectOutput) {
         logInfo(computer, listener, "Verifying: " + checkCommand);
-        if (!executeRemote(clientSession, checkCommand, logger)) {
+        if (!executeRemote(clientSession, checkCommand, logger, collectOutput, listener)) {
             logInfo(computer, listener, "Installing: " + command);
-            if (!executeRemote(clientSession, command, logger)) {
+            if (!executeRemote(clientSession, command, logger, collectOutput, listener)) {
                 logWarning(computer, listener, "Failed to install: " + command);
                 return false;
             }
         }
         return true;
     }
 
-    protected boolean executeRemote(ClientSession session, String command, OutputStream logger) {
-        try {
-            session.executeRemoteCommand(command, logger, logger, null);
-            return true;
-        } catch (IOException e) {
-            LOGGER.log(Level.FINE, "Failed to execute remote command: " + command, e);
-            return false;
-        }
-    }
-
     protected File createIdentityKeyFile(EC2Computer computer) throws IOException {
         EC2PrivateKey ec2PrivateKey = computer.getCloud().resolvePrivateKey();
         String privateKey = "";

src/main/java/hudson/plugins/ec2/ssh/EC2UnixLauncher.java

@@ -181,8 +181,12 @@ protected void launchScript(EC2Computer computer, TaskListener listener)
 
                         logInfo(computer, listener, "Executing init script");
                         String initCommand = buildUpCommand(computer, tmpDir + "/init.sh");
+
+                        // Check if collectInitScriptLogs flag is set
+                        boolean collectInitScriptLogs = template.getCollectInitScriptLogs();
+
                         // Set the flag only when init script executed successfully.
-                        if (executeRemote(clientSession, initCommand, logger)) {
+                        if (executeRemote(clientSession, initCommand, logger, collectInitScriptLogs, listener)) {
                             log(
                                     Level.FINE,
                                     computer,

src/main/resources/hudson/plugins/ec2/SlaveTemplate/config.jelly

@@ -251,6 +251,10 @@ THE SOFTWARE.
       <f:checkbox default="false"/>
     </f:entry>
 
+    <f:entry title="${%Collect Init Script Logs}" field="collectInitScriptLogs">
+      <f:checkbox />
+    </f:entry>
+
   </f:advanced>
 
   <f:entry title="">

src/main/resources/hudson/plugins/ec2/SlaveTemplate/help-collectInitScriptLogs.html

@@ -0,0 +1,6 @@
+<div>
+    When checked, the output (stdout and stderr) from the init script execution will be collected and displayed in the Jenkins build logs.
+    This can be useful for debugging init script issues, but may increase log verbosity.
+    <br/><br/>
+    <strong>Note:</strong> This only affects the logging of init script output. The init script will still execute regardless of this setting.
+</div>

src/test/java/hudson/plugins/ec2/ConfigurationAsCodeTest.java

@@ -415,4 +415,37 @@ void testWindowsSSHConfigAsCodeWithAltEndpointAndJavaPathExport(JenkinsConfigure
         String expected = Util.toStringFromYamlFile(this, "WindowsSSHDataExport-withAltEndpointAndJavaPath.yml");
         assertEquals(expected, exported);
     }
+
+    @Test
+    @ConfiguredWithCode("UnixDataWithCollectInitScriptLogs.yml")
+    void testUnixDataWithInitLogs(JenkinsConfiguredWithCodeRule j) throws Exception {
+        ConfiguratorRegistry registry = ConfiguratorRegistry.get();
+        ConfigurationContext context = new ConfigurationContext(registry);
+        CNode clouds = Util.getJenkinsRoot(context).get("clouds");
+        String exported = Util.toYamlString(clouds);
+        String expected = Util.toStringFromYamlFile(this, "UnixDataExportWithCollectInitScriptLogs.yml");
+        assertEquals(expected, exported);
+    }
+
+    @Test
+    @ConfiguredWithCode("MacDataWithCollectInitScriptLogs.yml")
+    void testMacDataWithInitLogs(JenkinsConfiguredWithCodeRule j) throws Exception {
+        ConfiguratorRegistry registry = ConfiguratorRegistry.get();
+        ConfigurationContext context = new ConfigurationContext(registry);
+        CNode clouds = Util.getJenkinsRoot(context).get("clouds");
+        String exported = Util.toYamlString(clouds);
+        String expected = Util.toStringFromYamlFile(this, "MacDataExportWithCollectInitScriptLogs.yml");
+        assertEquals(expected, exported);
+    }
+
+    @Test
+    @ConfiguredWithCode("WindowsSSHDataWithCollectInitScriptLogs.yml")
+    void testWindowsDataWithInitLogs(JenkinsConfiguredWithCodeRule j) throws Exception {
+        ConfiguratorRegistry registry = ConfiguratorRegistry.get();
+        ConfigurationContext context = new ConfigurationContext(registry);
+        CNode clouds = Util.getJenkinsRoot(context).get("clouds");
+        String exported = Util.toYamlString(clouds);
+        String expected = Util.toStringFromYamlFile(this, "WindowsSSHDataExportWithCollectInitScriptLogs.yml");
+        assertEquals(expected, exported);
+    }
 }