Switching some clone-mode messages to fine logger #55 (comment)

Author: jglick

src/main/java/org/jenkinsci/plugins/workflow/libs/SCMBasedRetriever.java

@@ -50,13 +50,10 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Set;
-import java.util.TreeSet;
 import java.util.concurrent.Callable;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.regex.Pattern;
-import java.util.stream.Collectors;
 import jenkins.model.Jenkins;
 import org.jenkinsci.plugins.workflow.steps.scm.GenericSCMStep;
 import org.jenkinsci.plugins.workflow.steps.scm.SCMStep;
@@ -149,20 +146,18 @@ protected final void doRetrieve(String name, boolean changelog, @NonNull SCM scm
                 for (String content : List.of("src", "vars", "resources")) {
                     FilePath contentDir = subdir.child(content);
                     if (contentDir.isDirectory()) {
-                        listener.getLogger().println("Moving " + content + " to top level");
+                        LOGGER.fine(() -> "Moving " + content + " to top level in " + target);
                         contentDir.renameTo(target.child(content));
                     }
                 }
                 // root itself will be deleted below
             }
-            Set<String> deleted = new TreeSet<>();
             if (!INCLUDE_SRC_TEST_IN_LIBRARIES) {
                 FilePath srcTest = target.child("src/test");
                 if (srcTest.isDirectory()) {
                     listener.getLogger().println("Excluding src/test/ from checkout of " + scm.getKey() + " so that library test code cannot be accessed by Pipelines.");
                     listener.getLogger().println("To remove this log message, move the test code outside of src/. To restore the previous behavior that allowed access to files in src/test/, pass -D" + SCMSourceRetriever.class.getName() + ".INCLUDE_SRC_TEST_IN_LIBRARIES=true to the java command used to start Jenkins.");
                     srcTest.deleteRecursive();
-                    deleted.add("src/test");
                 }
             }
             for (FilePath child : target.list()) {
@@ -178,13 +173,10 @@ protected final void doRetrieve(String name, boolean changelog, @NonNull SCM scm
                     // OK, leave it all
                     break;
                 default:
-                    deleted.add(subdir);
                     child.deleteRecursive();
+                    LOGGER.fine(() -> "Deleted " + child);
                 }
             }
-            if (!deleted.isEmpty()) {
-                listener.getLogger().println("Deleted " + deleted.stream().collect(Collectors.joining(", ")));
-            }
         } else { // !clone
             FilePath dir;
             if (run.getParent() instanceof TopLevelItem) {

src/test/java/org/jenkinsci/plugins/workflow/libs/SCMSourceRetrieverTest.java

@@ -43,6 +43,7 @@
 import java.util.Collections;
 import java.util.Iterator;
 import java.util.List;
+import java.util.logging.Level;
 import jenkins.plugins.git.GitSCMSource;
 import jenkins.plugins.git.GitSampleRepoRule;
 import jenkins.scm.api.SCMHead;
@@ -80,12 +81,15 @@
 import org.jvnet.hudson.test.WithoutJenkins;
 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.arrayContainingInAnyOrder;
+import static org.hamcrest.Matchers.arrayWithSize;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.matchesPattern;
 import static org.hamcrest.Matchers.nullValue;
 import static org.jenkinsci.plugins.workflow.libs.SCMBasedRetriever.PROHIBITED_DOUBLE_DOT;
 import static org.junit.Assume.assumeFalse;
 import org.jvnet.hudson.test.FlagRule;
+import org.jvnet.hudson.test.LoggerRule;
 
 public class SCMSourceRetrieverTest {
 
@@ -94,6 +98,7 @@ public class SCMSourceRetrieverTest {
     @Rule public GitSampleRepoRule sampleRepo = new GitSampleRepoRule();
     @Rule public SubversionSampleRepoRule sampleRepoSvn = new SubversionSampleRepoRule();
     @Rule public FlagRule<Boolean> includeSrcTest = new FlagRule<>(() -> SCMBasedRetriever.INCLUDE_SRC_TEST_IN_LIBRARIES, v -> SCMBasedRetriever.INCLUDE_SRC_TEST_IN_LIBRARIES = v);
+    @Rule public LoggerRule logging = new LoggerRule().record(SCMBasedRetriever.class, Level.FINE);
 
     @Issue("JENKINS-40408")
     @Test public void lease() throws Exception {
@@ -393,10 +398,13 @@ public static class BasicSCMSource extends SCMSource {
         WorkflowRun b = r.buildAndAssertSuccess(p);
         assertFalse(r.jenkins.getWorkspaceFor(p).withSuffix("@libs").isDirectory());
         r.assertLogContains("something special", b);
-        r.assertLogContains("Deleted .git, README.md", b);
         r.assertLogContains("Using shallow clone with depth 1", b);
         r.assertLogContains("Avoid fetching tags", b);
         r.assertLogNotContains("+refs/heads/*:refs/remotes/origin/*", b);
+        File[] libDirs = new File(b.getRootDir(), "libs").listFiles(File::isDirectory);
+        assertThat(libDirs, arrayWithSize(1));
+        String[] entries = libDirs[0].list();
+        assertThat(entries, arrayContainingInAnyOrder("vars"));
     }
 
     @Test public void cloneModeLibraryPath() throws Exception {
@@ -414,8 +422,10 @@ public static class BasicSCMSource extends SCMSource {
         p.setDefinition(new CpsFlowDefinition("@Library('root_sub_path@master') import myecho; myecho()", true));
         WorkflowRun b = r.buildAndAssertSuccess(p);
         r.assertLogContains("something special", b);
-        r.assertLogContains("Moving vars to top level", b);
-        r.assertLogContains("Deleted root", b);
+        File[] libDirs = new File(b.getRootDir(), "libs").listFiles(File::isDirectory);
+        assertThat(libDirs, arrayWithSize(1));
+        String[] entries = libDirs[0].list();
+        assertThat(entries, arrayContainingInAnyOrder("vars"));
     }
 
     @Test public void cloneModeLibraryPathSecurity() throws Exception {