convert library cache exclude to substring search (#147)

Author: JeffCobble

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

@@ -14,6 +14,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import org.apache.commons.lang.StringUtils;
 
 public final class LibraryCachingConfiguration extends AbstractDescribableImpl<LibraryCachingConfiguration> {
     private int refreshTimeMinutes;
@@ -53,7 +54,19 @@ private List<String> getExcludedVersions() {
     }
 
     public Boolean isExcluded(String version) {
-        return getExcludedVersions().contains(version);
+        // exit early if the version passed in is null or empty
+        if (StringUtils.isBlank(version)) {
+            return false;
+        }
+        for (String it : getExcludedVersions()) {
+            // confirm that the excluded versions aren't null or empty
+            // and if the version contains the exclusion thus it can be
+            // anywhere in the string.
+            if (StringUtils.isNotBlank(it) && version.contains(it)){
+                return true;
+            }
+        }
+        return false;
     }
 
     @Override public String toString() {
@@ -82,4 +95,4 @@ public FormValidation doClearCache(@QueryParameter String name) throws Interrupt
         }
 
     }
-}
+}

src/main/resources/org/jenkinsci/plugins/workflow/libs/LibraryCachingConfiguration/help-excludedVersionsStr.html

@@ -1,3 +1,3 @@
 <div>
-    Space separated list of versions excluded from caching. Ex: "master release10 release9"
+    Space separated list of versions to exclude from caching via substring search using .contains() method. Ex: "release/ master release10 release9".
 </div>

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

@@ -37,6 +37,7 @@ public class LibraryCachingConfigurationTest {
     private LibraryCachingConfiguration nullVersionConfig;
     private LibraryCachingConfiguration oneVersionConfig;
     private LibraryCachingConfiguration multiVersionConfig;
+    private LibraryCachingConfiguration substringVersionConfig;
 
     private static int REFRESH_TIME_MINUTES = 23;
     private static int NO_REFRESH_TIME_MINUTES = 0;
@@ -48,18 +49,25 @@ public class LibraryCachingConfigurationTest {
     private static String MULTIPLE_EXCLUDED_VERSIONS_2 = "branch-2";
     private static String MULTIPLE_EXCLUDED_VERSIONS_3 = "branch-3";
 
+    private static String SUBSTRING_EXCLUDED_VERSIONS_1 = "feature/test-substring-exclude";
+    private static String SUBSTRING_EXCLUDED_VERSIONS_2 = "test-other-substring-exclude";
+
     private static String MULTIPLE_EXCLUDED_VERSIONS =
         MULTIPLE_EXCLUDED_VERSIONS_1 + " " +
         MULTIPLE_EXCLUDED_VERSIONS_2 + " " +
         MULTIPLE_EXCLUDED_VERSIONS_3;
 
+    private static String SUBSTRING_EXCLUDED_VERSIONS =
+        "feature/ other-substring";
+
     private static String NEVER_EXCLUDED_VERSION = "never-excluded-version";
 
     @Before
     public void createCachingConfiguration() {
         nullVersionConfig = new LibraryCachingConfiguration(REFRESH_TIME_MINUTES, NULL_EXCLUDED_VERSION);
         oneVersionConfig = new LibraryCachingConfiguration(NO_REFRESH_TIME_MINUTES, ONE_EXCLUDED_VERSION);
         multiVersionConfig = new LibraryCachingConfiguration(REFRESH_TIME_MINUTES, MULTIPLE_EXCLUDED_VERSIONS);
+        substringVersionConfig = new LibraryCachingConfiguration(REFRESH_TIME_MINUTES, SUBSTRING_EXCLUDED_VERSIONS);
     }
 
     @Issue("JENKINS-66045") // NPE getting excluded versions
@@ -91,6 +99,7 @@ public void getExcludedVersionsStr() {
         assertThat(nullVersionConfig.getExcludedVersionsStr(), is(NULL_EXCLUDED_VERSION));
         assertThat(oneVersionConfig.getExcludedVersionsStr(), is(ONE_EXCLUDED_VERSION));
         assertThat(multiVersionConfig.getExcludedVersionsStr(), is(MULTIPLE_EXCLUDED_VERSIONS));
+        assertThat(substringVersionConfig.getExcludedVersionsStr(), is(SUBSTRING_EXCLUDED_VERSIONS));
     }
 
     @Test
@@ -104,17 +113,22 @@ public void isExcluded() {
         assertTrue(multiVersionConfig.isExcluded(MULTIPLE_EXCLUDED_VERSIONS_2));
         assertTrue(multiVersionConfig.isExcluded(MULTIPLE_EXCLUDED_VERSIONS_3));
 
+        assertTrue(substringVersionConfig.isExcluded(SUBSTRING_EXCLUDED_VERSIONS_1));
+        assertTrue(substringVersionConfig.isExcluded(SUBSTRING_EXCLUDED_VERSIONS_2));
+
         assertFalse(nullVersionConfig.isExcluded(NEVER_EXCLUDED_VERSION));
         assertFalse(oneVersionConfig.isExcluded(NEVER_EXCLUDED_VERSION));
         assertFalse(multiVersionConfig.isExcluded(NEVER_EXCLUDED_VERSION));
 
         assertFalse(nullVersionConfig.isExcluded(""));
         assertFalse(oneVersionConfig.isExcluded(""));
         assertFalse(multiVersionConfig.isExcluded(""));
+        assertFalse(substringVersionConfig.isExcluded(""));
 
         assertFalse(nullVersionConfig.isExcluded(null));
         assertFalse(oneVersionConfig.isExcluded(null));
         assertFalse(multiVersionConfig.isExcluded(null));
+        assertFalse(substringVersionConfig.isExcluded(null));
     }
 
 }