Merge pull request #835 from jenkinsci/welandaz/debug-logging

Add tracing messages for build scan parsing

Author: wolfs

plugin/src/main/java/hudson/plugins/gradle/AbstractGradleLogProcessor.java

@@ -6,9 +6,13 @@
 import java.io.OutputStream;
 import java.nio.ByteBuffer;
 import java.nio.charset.Charset;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 public abstract class AbstractGradleLogProcessor extends LineTransformationOutputStream {
 
+    private static final Logger LOGGER = Logger.getLogger(AbstractGradleLogProcessor.class.getName());
+
     // Don't parse too long lines
     private static final int DEFAULT_MAX_LINE_LENGTH = 500;
 
@@ -31,6 +35,8 @@ protected final void eol(byte[] bytes, int length) throws IOException {
         if (length < maxLineLength) {
             String line = charset.decode(ByteBuffer.wrap(bytes, 0, length)).toString();
             processLogLine(line);
+        } else {
+            LOGGER.fine(() -> "Skipping log line of length " + length + " (max: " + maxLineLength + ")");
         }
 
         out.write(bytes, 0, length);

plugin/src/main/java/hudson/plugins/gradle/BuildScanLogScanner.java

@@ -1,11 +1,15 @@
 package hudson.plugins.gradle;
 
 import java.util.function.Consumer;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 public class BuildScanLogScanner {
 
+    private static final Logger LOGGER = Logger.getLogger(BuildScanLogScanner.class.getName());
+
     private static final Pattern BUILD_SCAN_PATTERN = Pattern.compile("Publishing (Build Scan|build scan|build information)(?: to Develocity)?\\.\\.\\.");
     private static final Pattern URL_PATTERN = Pattern.compile(".*(?:\\[INFO] )?(https?://.*/s/.*)");
     private static final int LINES_TO_SCAN = 1000;
@@ -19,14 +23,19 @@ public BuildScanLogScanner(BuildScanPublishedListener listener) {
     }
 
     public void scanLine(String line) {
-        if (linesSinceBuildScanPublishingMessage < LINES_TO_SCAN) {
+      LOGGER.log(Level.FINE, "Scanning line: {0}", line);
+
+      if (linesSinceBuildScanPublishingMessage < LINES_TO_SCAN) {
             linesSinceBuildScanPublishingMessage++;
+            LOGGER.log(Level.FINE, "Within scan window, lines since publishing message: {0}", linesSinceBuildScanPublishingMessage);
             tryFindBuildScanUrl(line, url -> {
+                LOGGER.log(Level.FINE, "Found build scan URL: {0}", url);
                 linesSinceBuildScanPublishingMessage = Integer.MAX_VALUE;
                 listener.onBuildScanPublished(url);
             });
         }
         if (BUILD_SCAN_PATTERN.matcher(line).find()) {
+            LOGGER.log(Level.FINE, "Detected build scan publishing message: {0}", line);
             linesSinceBuildScanPublishingMessage = 0;
         }
 

plugin/src/main/java/hudson/plugins/gradle/GradleTaskListenerDecorator.java

@@ -5,7 +5,6 @@
 import javax.annotation.Nonnull;
 import java.io.OutputStream;
 import java.nio.charset.StandardCharsets;
-import java.util.Collection;
 import java.util.List;
 
 public class GradleTaskListenerDecorator extends TaskListenerDecorator implements BuildScansAware {

plugin/src/main/java/hudson/plugins/gradle/SimpleBuildScanPublishedListener.java

@@ -5,14 +5,18 @@
 import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.logging.Logger;
 
 public final class SimpleBuildScanPublishedListener
     implements BuildScanPublishedListener, BuildScansAware, Serializable {
 
+    private static final Logger LOGGER = Logger.getLogger(SimpleBuildScanPublishedListener.class.getName());
+
     private final List<String> buildScans = new ArrayList<>();
 
     @Override
     public void onBuildScanPublished(String scanUrl) {
+        LOGGER.fine(() -> "Build scan has been published: " + scanUrl);
         buildScans.add(scanUrl);
     }
 

plugin/src/main/java/hudson/plugins/gradle/WithGradleExecution.java

@@ -14,15 +14,20 @@
 import java.io.UncheckedIOException;
 import java.util.Collections;
 import java.util.List;
+import java.util.logging.Logger;
 
 public class WithGradleExecution extends StepExecution {
 
+    private static final Logger LOGGER = Logger.getLogger(WithGradleExecution.class.getName());
+
     WithGradleExecution(StepContext context) {
         super(context);
     }
 
     @Override
     public boolean start() throws IOException, InterruptedException {
+        LOGGER.fine("Starting withGradle execution");
+
         GradleTaskListenerDecorator gradleTaskListenerDecorator = new GradleTaskListenerDecorator();
 
         getContext()
@@ -59,9 +64,12 @@ private List<String> extractBuildScans(StepContext context) {
             try {
                 List<String> buildScans = this.buildScans.getBuildScans();
                 if (buildScans.isEmpty()) {
+                    LOGGER.fine("No build scans found");
                     return Collections.emptyList();
                 }
 
+                LOGGER.fine(() -> "Found " + buildScans.size() + " build scan(s) in " + buildScans);
+
                 FlowNode flowNode = context.get(FlowNode.class);
                 flowNode.getParents().stream().findFirst().ifPresent(parent -> {
                     BuildScanFlowAction nodeBuildScanAction = new BuildScanFlowAction(parent);

plugin/src/main/java/hudson/plugins/gradle/injection/MavenBuildScanInjection.java

@@ -4,7 +4,6 @@
 import hudson.model.Node;
 import jenkins.model.Jenkins;
 
-import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;