Adding rolled custom logs in support bundle

src/main/java/com/cloudbees/jenkins/support/impl/CustomLogs.java

@@ -44,7 +44,7 @@
 
     private static final Logger LOGGER = Logger.getLogger(CustomLogs.class.getName());
     private static final int MAX_ROTATE_LOGS = Integer.getInteger(CustomLogs.class.getName() + ".MAX_ROTATE_LOGS", 9);
-    private static final File customLogs = new File(SafeTimerTask.getLogsRoot(), "custom");
+    private final File customLogs = new File(SafeTimerTask.getLogsRoot(), "custom");
     private final List<LogRecorder> logRecorders = Jenkins.get().getLog().getRecorders();
 
     @NonNull
@@ -95,13 +95,38 @@
                     }
                 });
             }
+
+            // Add rotated log files
+            File[] rotatedLogFiles =
+                    customLogs.listFiles((dir, filename) -> filename.matches(name + "[.]log[.][0-9]+"));
+            if (rotatedLogFiles == null) {
+                LOGGER.fine("No rotated logs found for : " + name);
+                return;
+            }
+
+            for (File rotatedLogFile : rotatedLogFiles) {
+                String rotatedEntryName = "nodes/master/logs/custom/{0}.log.";
+
+                try {
+                    // Fetch the rotations number of the log
+                    // eg. custom.log.2 , the rotation number is 2
+                    String[] logNameParts = rotatedLogFile.getName().split("\\.");
+                    String logRotationNumber = logNameParts[logNameParts.length - 1];
+
+                    result.add(
+                            new FileContent(rotatedEntryName + logRotationNumber, new String[] {name}, rotatedLogFile));
+                } catch (Exception e) {
+                    LOGGER.log(Level.WARNING, "Error while adding rotated log files for " + name, e);
+                }
+            }
         }
     }
 
     private static final class LogFile {
         private final RewindableRotatingFileOutputStream stream;
         private final Handler handler;
         private int count;
+        private final File customLogs = new File(SafeTimerTask.getLogsRoot(), "custom");
 
         @SuppressFBWarnings(
                 value = "RV_RETURN_VALUE_IGNORED_BAD_PRACTICE",

src/test/java/com/cloudbees/jenkins/support/impl/CustomLogsTest.java

@@ -4,6 +4,7 @@
 package com.cloudbees.jenkins.support.impl;
 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
@@ -14,10 +15,17 @@
 import hudson.ExtensionList;
 import hudson.logging.LogRecorder;
 import hudson.security.Permission;
+import hudson.triggers.SafeTimerTask;
+import java.io.File;
 import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.nio.file.StandardOpenOption;
 import java.util.Collections;
+import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
+import java.util.TreeMap;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import jenkins.model.Jenkins;
@@ -70,4 +78,73 @@ public void addContents(@NonNull Container container) {
         assertFalse("Should write CustomLogsTest FINE logs", customLogs.isEmpty());
         assertThat(customLogs, Matchers.containsString("Testing custom log recorders"));
     }
+
+    @Test
+    public void testCustomLogRotation() throws IOException {
+        LogRecorder test1LogRecorder = new LogRecorder("test1");
+        j.getInstance().getLog().getRecorders().add(test1LogRecorder);
+
+        LogRecorder test2LogRecorder = new LogRecorder("second.test2");
+        j.getInstance().getLog().getRecorders().add(test2LogRecorder);
+
+        LogRecorder nonRotatedCustomLog = new LogRecorder("nonRotatedCustomLog");
+        j.getInstance().getLog().getRecorders().add(nonRotatedCustomLog);
+
+        // Create dummy log files
+        File customLogsDir = new File(SafeTimerTask.getLogsRoot(), "custom");
+        customLogsDir.mkdirs();
+
+        // Create dummy log for test1 log recorder
+        Files.write(Paths.get(customLogsDir.getPath(), "test1.log"), "test1 one".getBytes(), StandardOpenOption.CREATE);
+        Files.write(
+                Paths.get(customLogsDir.getPath(), "test1.log.1"), "test1 two".getBytes(), StandardOpenOption.CREATE);
+        Files.write(
+                Paths.get(customLogsDir.getPath(), "test1.log.2"), "test1 three".getBytes(), StandardOpenOption.CREATE);
+
+        // Create dummy log for second.test2 log recorder
+        Files.write(
+                Paths.get(customLogsDir.getPath(), "second.test2.log"),
+                "second.test2 one".getBytes(),
+                StandardOpenOption.CREATE);
+        Files.write(
+                Paths.get(customLogsDir.getPath(), "second.test2.log.1"),
+                "second.test2 two".getBytes(),
+                StandardOpenOption.CREATE);
+        Files.write(
+                Paths.get(customLogsDir.getPath(), "second.test2.log.2"),
+                "second.test2 three".getBytes(),
+                StandardOpenOption.CREATE);
+
+        // Create dummy log for nonRotatedCustomLog
+        Files.write(
+                Paths.get(customLogsDir.getPath(), "nonRotatedCustomLog.log"),
+                "nonRotatedCustomLog one".getBytes(),
+                StandardOpenOption.CREATE);
+
+        // Invoke the component and get the result map
+        Map<String, String> resultMap = SupportTestUtils.invokeComponentToMap(
+                Objects.requireNonNull(ExtensionList.lookup(Component.class).get(CustomLogs.class)));
+
+        // Create the expected map
+        Map<String, String> expectedMap = new TreeMap<>();
+        expectedMap.put("nodes/master/logs/custom/test1.log", "test1 one");
+        expectedMap.put("nodes/master/logs/custom/test1.log.1", "test1 two");
+        expectedMap.put("nodes/master/logs/custom/test1.log.2", "test1 three");
+        expectedMap.put("nodes/master/logs/custom/second.test2.log", "second.test2 one");
+        expectedMap.put("nodes/master/logs/custom/second.test2.log.1", "second.test2 two");
+        expectedMap.put("nodes/master/logs/custom/second.test2.log.2", "second.test2 three");
+        expectedMap.put("nodes/master/logs/custom/nonRotatedCustomLog.log", "nonRotatedCustomLog one");
+
+        // Assert the result map
+        assertEquals(expectedMap, resultMap);
+
+        // Cleanup all the dummy files
+        Files.deleteIfExists(Paths.get(customLogsDir.getPath(), "test1.log"));
+        Files.deleteIfExists(Paths.get(customLogsDir.getPath(), "test1.log.1"));
+        Files.deleteIfExists(Paths.get(customLogsDir.getPath(), "test1.log.2"));
+        Files.deleteIfExists(Paths.get(customLogsDir.getPath(), "second.test2.log"));
+        Files.deleteIfExists(Paths.get(customLogsDir.getPath(), "second.test2.log.1"));
+        Files.deleteIfExists(Paths.get(customLogsDir.getPath(), "second.test2.log.2"));
+        Files.deleteIfExists(Paths.get(customLogsDir.getPath(), "nonRotatedCustomLog.log"));
+    }
 }