Fix folder credential usage

src/main/java/jenkins/plugins/slack/CredentialsObtainer.java

@@ -0,0 +1,41 @@
+package jenkins.plugins.slack;
+
+import com.cloudbees.plugins.credentials.CredentialsMatcher;
+import com.cloudbees.plugins.credentials.CredentialsMatchers;
+import hudson.model.Item;
+import hudson.security.ACL;
+import org.apache.commons.lang.StringUtils;
+import org.jenkinsci.plugins.plaincredentials.StringCredentials;
+
+import java.util.Collections;
+import java.util.List;
+
+public class CredentialsObtainer {
+
+    public static StringCredentials lookupCredentials(String credentialId, Item item) {
+        List<StringCredentials> credentials = com.cloudbees.plugins.credentials.CredentialsProvider.lookupCredentials(StringCredentials.class, item, ACL.SYSTEM, Collections.emptyList());
+        CredentialsMatcher matcher = CredentialsMatchers.withId(credentialId);
+        return CredentialsMatchers.firstOrNull(credentials, matcher);
+    }
+
+    /**
+     * Attempts to obtain the credential with the providedId from the item's credential context, otherwise returns token
+     * @param credentialId the id from the credential to be used
+     * @param item the item with the context to obtain the credential from.
+     * @param token the fallback token
+     * @return the obtained token
+     */
+    public static  String getTokenToUse(String credentialId, Item item, String token) {
+        if (StringUtils.isEmpty(credentialId)) {
+            return token;
+        }
+        StringCredentials credentials = lookupCredentials(StringUtils.trim(credentialId), item);
+        final String response;
+        if (credentials != null) {
+            response = credentials.getSecret().getPlainText();
+        } else {
+            response = token;
+        }
+        return response;
+    }
+}

src/main/java/jenkins/plugins/slack/SlackNotifier.java

@@ -1,5 +1,6 @@
 package jenkins.plugins.slack;
 
+import com.cloudbees.plugins.credentials.Credentials;
 import com.cloudbees.plugins.credentials.common.StandardListBoxModel;
 import com.cloudbees.plugins.credentials.domains.HostnameRequirement;
 import hudson.EnvVars;
@@ -34,6 +35,7 @@
 import org.kohsuke.stapler.QueryParameter;
 import org.kohsuke.stapler.StaplerRequest;
 
+import java.util.NoSuchElementException;
 import java.util.function.Function;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -428,7 +430,14 @@ public SlackService newSlackService(AbstractBuild r, BuildListener listener) {
         authToken = env.expand(authToken);
         authTokenCredentialId = env.expand(authTokenCredentialId);
         room = env.expand(room);
-        return new StandardSlackService(baseUrl, teamDomain, authToken, authTokenCredentialId, botUser, room, false, r.getProject());
+        final String populatedToken = CredentialsObtainer.getTokenToUse(authTokenCredentialId, r.getProject(), authToken);
+        if (populatedToken != null) {
+            return new StandardSlackService(baseUrl, teamDomain, botUser, room, false, populatedToken);
+        } else {
+            logger.log(Level.INFO, "No explicit token specified and could not obtain credentials for id: " + authTokenCredentialId);
+            return new StandardSlackService(baseUrl, teamDomain, authToken, authTokenCredentialId, botUser, room, false);
+        }
+
 
     }
 
@@ -606,7 +615,12 @@ public boolean configure(StaplerRequest req, JSONObject formData) {
         }
 
         SlackService getSlackService(final String baseUrl, final String teamDomain, final String authTokenCredentialId, final boolean botUser, final String roomId, final Item item) {
-            return new StandardSlackService(baseUrl, teamDomain, null, authTokenCredentialId, botUser, roomId, false, item);
+            final String populatedToken = CredentialsObtainer.getTokenToUse(authTokenCredentialId, item,null );
+            if (populatedToken != null) {
+                return new StandardSlackService(baseUrl, teamDomain, botUser, roomId, false, populatedToken);
+            } else {
+                throw new NoSuchElementException("Could not obtain credentials with credential id: " + authTokenCredentialId);
+            }
         }
 
         @Nonnull

src/main/java/jenkins/plugins/slack/StandardSlackService.java

@@ -45,41 +45,70 @@ public class StandardSlackService implements SlackService {
     private String host = "slack.com";
     private String baseUrl;
     private String teamDomain;
-    private String token;
-    private String authTokenCredentialId;
+    private String token = null;
+    private String authTokenCredentialId = null;
     private boolean botUser;
     private String[] roomIds;
     private boolean replyBroadcast;
     private String responseString = null;
-    private Item item;
+    private String populatedToken = null;
 
+    /**
+     * @deprecated use {@link #StandardSlackService(String, String, boolean, String, boolean, String)} instead}
+     */
+    @Deprecated
     public StandardSlackService(String baseUrl, String teamDomain, String authTokenCredentialId, boolean botUser, String roomId) {
-        this(baseUrl, teamDomain, null, authTokenCredentialId, botUser, roomId, false, null);
+        this(baseUrl, teamDomain, null, authTokenCredentialId, botUser, roomId, false);
     }
 
+    /**
+     * @deprecated use {@link #StandardSlackService(String, String, boolean, String, boolean, String)} instead}
+     */
+    @Deprecated
     public StandardSlackService(String baseUrl, String teamDomain, String token, String authTokenCredentialId, boolean botUser, String roomId) {
-        this(baseUrl, teamDomain, token, authTokenCredentialId, botUser, roomId, false, null);
+        this(baseUrl, teamDomain, token, authTokenCredentialId, botUser, roomId, false);
     }
 
+    /**
+     * @deprecated use {@link #StandardSlackService(String, String, boolean, String, boolean, String)} instead}
+     */
+    @Deprecated
     public StandardSlackService(String baseUrl, String teamDomain, String token, String authTokenCredentialId, boolean botUser, String roomId, boolean replyBroadcast) {
-        this(baseUrl, teamDomain, token, authTokenCredentialId, botUser, roomId, replyBroadcast, null);
+        this(baseUrl, teamDomain, botUser, roomId, replyBroadcast);
+        this.token = token;
+        this.authTokenCredentialId = StringUtils.trim(authTokenCredentialId);
+    }
+
+    /**
+     * @param baseUrl the full url to use, this is an alternative to specifying teamDomain
+     * @param teamDomain the teamDomain inside slack.com to use
+     * @param botUser
+     * @param roomId a semicolon separated list of rooms to notify
+     * @param replyBroadcast
+     * @param populatedToken a non-null token to use for authentication
+     */
+    public StandardSlackService(String baseUrl, String teamDomain, boolean botUser, String roomId, boolean replyBroadcast, String populatedToken) {
+        this(baseUrl, teamDomain, botUser, roomId, replyBroadcast);
+        if (populatedToken == null) {
+            throw new IllegalArgumentException("populatedToken cannot be null");
+        }
+        this.populatedToken = populatedToken;
     }
 
-    public StandardSlackService(String baseUrl, String teamDomain, String token, String authTokenCredentialId, boolean botUser, String roomId, boolean replyBroadcast, Item item) {
+    private StandardSlackService(String baseUrl, String teamDomain, boolean botUser, String roomId, boolean replyBroadcast) {
         super();
         this.baseUrl = baseUrl;
         if(this.baseUrl != null && !this.baseUrl.isEmpty() && !this.baseUrl.endsWith("/")) {
             this.baseUrl += "/";
         }
         this.teamDomain = teamDomain;
-        this.token = token;
-        this.authTokenCredentialId = StringUtils.trim(authTokenCredentialId);
         this.botUser = botUser;
         this.roomIds = roomId.split("[,; ]+");
         this.replyBroadcast = replyBroadcast;
-        this.item = item;
     }
 
+
+
     public String getResponseString() {
         return responseString;
     }
@@ -193,25 +222,22 @@ public boolean publish(String message, JSONArray attachments, String color) {
     }
 
     private String getTokenToUse() {
-        if (authTokenCredentialId != null && !authTokenCredentialId.isEmpty()) {
-            StringCredentials credentials = lookupCredentials(authTokenCredentialId);
-            if (credentials != null) {
-                logger.fine("Using Integration Token Credential ID.");
-                return credentials.getSecret().getPlainText();
+        if (populatedToken != null) {
+            return populatedToken;
+        } else {
+            if (!StringUtils.isEmpty(authTokenCredentialId)) {
+                StringCredentials credentials = CredentialsObtainer.lookupCredentials(authTokenCredentialId, null);
+                if (credentials != null) {
+                    logger.fine("Using Integration Token Credential ID.");
+                    return credentials.getSecret().getPlainText();
+                }
             }
-        }
-
-        logger.fine("Using Integration Token.");
 
+            logger.fine("Using Integration Token.");
+        }
         return token;
     }
 
-    private StringCredentials lookupCredentials(String credentialId) {
-        List<StringCredentials> credentials = com.cloudbees.plugins.credentials.CredentialsProvider.lookupCredentials(StringCredentials.class, item, ACL.SYSTEM, Collections.emptyList());
-        CredentialsMatcher matcher = CredentialsMatchers.withId(credentialId);
-        return CredentialsMatchers.firstOrNull(credentials, matcher);
-    }
-
     protected CloseableHttpClient getHttpClient() {
     	final HttpClientBuilder clientBuilder = HttpClients.custom();
     	final CredentialsProvider credentialsProvider = new BasicCredentialsProvider();

src/main/java/jenkins/plugins/slack/workflow/SlackSendStep.java

@@ -15,6 +15,7 @@
 import hudson.util.FormValidation;
 import hudson.util.ListBoxModel;
 import jenkins.model.Jenkins;
+import jenkins.plugins.slack.CredentialsObtainer;
 import jenkins.plugins.slack.Messages;
 import jenkins.plugins.slack.SlackNotifier;
 import jenkins.plugins.slack.SlackService;
@@ -63,6 +64,7 @@ public class SlackSendStep extends Step {
     private boolean replyBroadcast;
 
 
+
     @Nonnull
     public String getMessage() {
         return message;
@@ -255,10 +257,14 @@ protected SlackResponse run() throws Exception {
                     defaultIfEmpty(baseUrl), defaultIfEmpty(teamDomain), channel, defaultIfEmpty(color), botUser,
                     defaultIfEmpty(tokenCredentialId))
             );
-
+            final String populatedToken = CredentialsObtainer.getTokenToUse(tokenCredentialId, item, token);
+            if (populatedToken == null) {
+                listener.error(Messages
+                        .NotificationFailedWithException(new IllegalArgumentException("the token with the provided ID could not be found and no token was specified")));
+                return null;
+            }
             SlackService slackService = getSlackService(
-                    baseUrl, teamDomain, token, tokenCredentialId, botUser, channel, step.replyBroadcast, item
-            );
+                    baseUrl, teamDomain, botUser, channel, step.replyBroadcast, populatedToken);
             final boolean publishSuccess;
             if (step.attachments != null) {
                 JSONArray jsonArray = getAttachmentsAsJSONArray();
@@ -357,8 +363,8 @@ private String defaultIfEmpty(String value) {
         }
 
         //streamline unit testing
-        SlackService getSlackService(String baseUrl, String team, String token, String tokenCredentialId, boolean botUser, String channel, boolean replyBroadcast, Item item) {
-            return new StandardSlackService(baseUrl, team, token, tokenCredentialId, botUser, channel, replyBroadcast, item);
+        SlackService getSlackService(String baseUrl, String team, boolean botUser, String channel, boolean replyBroadcast, String populatedToken) {
+            return new StandardSlackService(baseUrl, team, botUser, channel, replyBroadcast, populatedToken);
         }
     }
 }

src/test/java/jenkins/plugins/slack/StandardSlackServiceCredentialsTest.java

@@ -2,7 +2,6 @@
 
 import com.cloudbees.plugins.credentials.CredentialsProvider;
 import hudson.ExtensionList;
-import hudson.model.*;
 import hudson.security.ACL;
 import hudson.util.Secret;
 import jenkins.model.Jenkins;
@@ -21,7 +20,6 @@
 import java.util.Collections;
 import java.util.List;
 
-import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 import static org.powermock.api.mockito.PowerMockito.mock;
 import static org.powermock.api.mockito.PowerMockito.when;
@@ -38,24 +36,22 @@ public void setUp() {
     }
 
     @Test
-    public void providedJobCredentialsAreUsed() {
-        final String id = "cred-id";
-        final String secretText = "secret-text";
-        final Job job = createJobWithAvailableCredentialId(id, secretText);
-        final StandardSlackServiceStub service = new StandardSlackServiceStub("", "domain", null, id, true, "#room1:1528317530", job);
+    public void populatedTokenIsUsed() {
+        final String populatedToken = "secret-text";
+        final StandardSlackServiceStub service = new StandardSlackServiceStub("", "domain", true, "#room1:1528317530", populatedToken);
         final CloseableHttpClientStub httpClientStub = new CloseableHttpClientStub();
         httpClientStub.setHttpStatus(HttpStatus.SC_OK);
         service.setHttpClient(httpClientStub);
         service.publish("message");
-        assertTrue(httpClientStub.getLastRequest().getURI().toString().contains(secretText));
+        assertTrue(httpClientStub.getLastRequest().getURI().toString().contains(populatedToken));
     }
 
     @Test
-    public void globalCredentialsCanBeUsed() {
+    public void globalCredentialByIdUsed() {
         final String id = "cred-2id";
         final String secretText = "secret-2text";
         setupGlobalAvailableCredentialId(id, secretText);
-        final StandardSlackServiceStub service = new StandardSlackServiceStub("", "domain", null, id, true, "#room1:1528317530", null);
+        final StandardSlackServiceStub service = new StandardSlackServiceStub("", "domain", null, id, true, "#room1:1528317530");
         final CloseableHttpClientStub httpClientStub = new CloseableHttpClientStub();
         httpClientStub.setHttpStatus(HttpStatus.SC_OK);
         service.setHttpClient(httpClientStub);
@@ -64,50 +60,18 @@ public void globalCredentialsCanBeUsed() {
     }
 
     @Test
-    public void otherJobCredentialsAreNotObtained() {
-        final String id = "cred-id";
-        final String secretText = "secret-text";
-        final Job job = createJobWithAvailableCredentialId(id, secretText);
-        final StandardSlackServiceStub service = new StandardSlackServiceStub("", "domain", null, "wrongid", true, "#room1:1528317530", job);
-        final CloseableHttpClientStub httpClientStub = new CloseableHttpClientStub();
-        httpClientStub.setHttpStatus(HttpStatus.SC_OK);
-        service.setHttpClient(httpClientStub);
-        service.publish("message");
-        assertFalse(httpClientStub.getLastRequest().getURI().toString().contains(secretText));
-    }
-
-    @Test
-    public void ifNoJobProvidedTokenIsUsed() {
+    public void tokenIsUsed() {
         final String token = "explicittoken";
-        final StandardSlackServiceStub service = new StandardSlackServiceStub("", "domain", token, null, true, "#room1:1528317530", null);
+        final StandardSlackServiceStub service = new StandardSlackServiceStub("", "domain", token, null, true, "#room1:1528317530");
         final CloseableHttpClientStub httpClientStub = new CloseableHttpClientStub();
         httpClientStub.setHttpStatus(HttpStatus.SC_OK);
         service.setHttpClient(httpClientStub);
         service.publish("message");
         assertTrue(httpClientStub.getLastRequest().getURI().toString().contains(token));
     }
 
-    /**
-     * Creates a mocked job and sets up the mocking mechanism so the provided credential is obtainable.
-     * @param id the id of the credential to use.
-     * @param secretText the secret text of the credential.
-     * @return a mocked job set up so it can use the provided credentials
-     */
-    private Job createJobWithAvailableCredentialId(final String id, final String secretText) {
-        final Job job = mock(Job.class);
-        final CredentialsProvider credentialsProvider = mock(CredentialsProvider.class);
-        final List<StringCredentials> credentialList = setupMocks(id, secretText, credentialsProvider);
-        when(credentialsProvider.getCredentials(Matchers.eq(StringCredentials.class), Matchers.eq(job), Matchers.eq(ACL.SYSTEM), Matchers.eq(Collections.emptyList()))).thenReturn(credentialList);
-        return job;
-    }
-
     private void setupGlobalAvailableCredentialId(final String id, final String secretText) {
         final CredentialsProvider credentialsProvider = mock(CredentialsProvider.class);
-        final List<StringCredentials> credentialList = setupMocks(id, secretText, credentialsProvider);
-        when(credentialsProvider.getCredentials(Matchers.eq(StringCredentials.class), Matchers.eq(jenkins), Matchers.eq(ACL.SYSTEM), Matchers.eq(Collections.emptyList()))).thenReturn(credentialList);
-    }
-
-    private List<StringCredentials> setupMocks(String id, String secretText, CredentialsProvider credentialsProvider) {
         final ExtensionList<CredentialsProvider> extensionList = mock(ExtensionList.class);
         final List<CredentialsProvider> listProviders = new ArrayList<>(1);
         final List<StringCredentials> credentialList = new ArrayList<>();
@@ -121,7 +85,7 @@ private List<StringCredentials> setupMocks(String id, String secretText, Credent
         when(secret.getPlainText()).thenReturn(secretText);
         when(credentials.getSecret()).thenReturn(secret);
         credentialList.add(credentials);
-        return credentialList;
+        when(credentialsProvider.getCredentials(Matchers.eq(StringCredentials.class), Matchers.eq(jenkins), Matchers.eq(ACL.SYSTEM), Matchers.eq(Collections.emptyList()))).thenReturn(credentialList);
     }
 
 }

src/test/java/jenkins/plugins/slack/StandardSlackServiceStub.java

@@ -1,13 +1,15 @@
 package jenkins.plugins.slack;
 
-import hudson.model.Item;
-
 public class StandardSlackServiceStub extends StandardSlackService {
 
     private CloseableHttpClientStub httpClientStub;
 
-    public StandardSlackServiceStub(String baseUrl, String teamDomain, String token, String tokenCredentialId, boolean botUser, String roomId, Item item) {
-        super(baseUrl, teamDomain, token, tokenCredentialId, botUser, roomId, false, item);
+    public StandardSlackServiceStub(String baseUrl, String teamDomain, String token, String tokenCredentialId, boolean botUser, String roomId) {
+        super(baseUrl, teamDomain, token, tokenCredentialId, botUser, roomId, false);
+    }
+
+    public StandardSlackServiceStub(String baseUrl, String teamDomain, boolean botUser, String roomId, String populatedToken) {
+        super(baseUrl, teamDomain, botUser, roomId, false, populatedToken);
     }
 
     @Override