Merge pull request #140 from jglick/cacheRootDir

Allow `$JENKINS_HOME/global-libraries-cache/` to be overridden

Author: jglick

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

@@ -239,7 +239,7 @@ static List<URL> retrieve(@NonNull LibraryRecord record, @NonNull LibraryRetriev
                       boolean retrieve = false;
                       switch (getCacheStatus(cachingConfiguration, versionCacheDir)) {
                           case VALID:
-                              listener.getLogger().println("Library " + libraryLogString + " is cached. Copying from home.");
+                              listener.getLogger().println("Library " + libraryLogString + " is cached. Copying from cache.");
                               break;
                           case EMPTY:
                               listener.getLogger().println("Library " + libraryLogString + " should have been cached but is empty, re-caching.");
@@ -285,7 +285,7 @@ static List<URL> retrieve(@NonNull LibraryRecord record, @NonNull LibraryRetriev
                         retrieveLock.writeLock().unlock();
                     }
                 } else {
-                    listener.getLogger().println("Library " + libraryLogString + " is cached. Copying from home.");
+                    listener.getLogger().println("Library " + libraryLogString + " is cached. Copying from cache.");
                 }
 
                 lastReadFile.touch(System.currentTimeMillis());

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

@@ -2,11 +2,12 @@
 
 import hudson.Extension;
 import hudson.FilePath;
-import hudson.RestrictedSince;
 import hudson.model.AbstractDescribableImpl;
 import hudson.model.Descriptor;
 import hudson.util.FormValidation;
+import java.io.File;
 import jenkins.model.Jenkins;
+import jenkins.util.SystemProperties;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -36,7 +37,7 @@ public final class LibraryCachingConfiguration extends AbstractDescribableImpl<L
     private String includedVersionsStr;
 
     private static final String VERSIONS_SEPARATOR = " ";
-    public static final String GLOBAL_LIBRARIES_DIR = "global-libraries-cache";
+    private static final String GLOBAL_LIBRARIES_DIR = "global-libraries-cache";
     public static final String LAST_READ_FILE = "last_read";
 
     @DataBoundConstructor public LibraryCachingConfiguration(int refreshTimeMinutes, String excludedVersionsStr) {
@@ -134,8 +135,9 @@ public Boolean isIncluded(String version) {
     }
 
     public static FilePath getGlobalLibrariesCacheDir() {
-        Jenkins jenkins = Jenkins.get();
-        return new FilePath(jenkins.getRootPath(), LibraryCachingConfiguration.GLOBAL_LIBRARIES_DIR);
+        String cacheRootDirOverride = SystemProperties.getString(LibraryCachingConfiguration.class.getName() + ".cacheRootDir");
+        File cacheRootDir = cacheRootDirOverride != null ? new File(cacheRootDirOverride) : new File(Jenkins.get().getRootDir(), GLOBAL_LIBRARIES_DIR);
+        return new FilePath(cacheRootDir);
     }
 
     @Extension public static class DescriptorImpl extends Descriptor<LibraryCachingConfiguration> {

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

@@ -505,7 +505,7 @@ public void parallelBuildsDontInterfereWithExpiredCache() throws Throwable {
             r.assertLogContains("global library root", b);
             // Second build should succeed and cache the global library at the root level
             b = r.assertBuildStatus(Result.SUCCESS, p.scheduleBuild2(0));
-            r.assertLogContains("Library global@master is cached. Copying from home.", b);
+            r.assertLogContains("Library global@master is cached. Copying from cache.", b);
             r.assertLogContains("global library root", b);
             // Simulate an error which leaves the cache directory empty
             FilePath globalCacheDir = LibraryCachingConfiguration.getGlobalLibrariesCacheDir();
@@ -523,7 +523,7 @@ public void parallelBuildsDontInterfereWithExpiredCache() throws Throwable {
             r.assertLogContains("global library root", b);
             // Third build should succeed and cache the global library at the root level again
             b = r.assertBuildStatus(Result.SUCCESS, p.scheduleBuild2(0));
-            r.assertLogContains("Library global@master is cached. Copying from home.", b);
+            r.assertLogContains("Library global@master is cached. Copying from cache.", b);
             r.assertLogContains("global library root", b);
         }
         // Change the library path to lib1 - build should succeed and cache the global library at the lib1 level

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

@@ -83,7 +83,7 @@ public class ResourceStepTest {
 
         WorkflowRun secondBuild = r.buildAndAssertSuccess(p);
         r.assertLogContains("got fixed contents", secondBuild);
-        r.assertLogContains("Library stuff@master is cached. Copying from home.", secondBuild);
+        r.assertLogContains("Library stuff@master is cached. Copying from cache.", secondBuild);
         r.assertLogNotContains("git", secondBuild); // git is not called
     }
 
@@ -127,7 +127,7 @@ public class ResourceStepTest {
         modifyCacheTimestamp("stuff", "master", System.currentTimeMillis() - 60000 * 55); // 55 minutes have passed, still cached
         WorkflowRun secondBuild = r.buildAndAssertSuccess(p);
         r.assertLogContains("got fixed contents", secondBuild);
-        r.assertLogContains("Library stuff@master is cached. Copying from home.", secondBuild);
+        r.assertLogContains("Library stuff@master is cached. Copying from cache.", secondBuild);
         r.assertLogNotContains("git", secondBuild); // git is not called
 
         modifyCacheTimestamp("stuff", "master", System.currentTimeMillis() - 60000 * 61); // 61 minutes have passed, due for a refresh