Adding configurable webhook endpoint

jenkinsci · Jan 8, 2016 · 27cc45a · 27cc45a
1 parent 5cf2087
commit 27cc45a
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 3 deletions.
diff --git a/src/main/java/jenkins/plugins/slack/webhook/GlobalConfig.java b/src/main/java/jenkins/plugins/slack/webhook/GlobalConfig.java
@@ -22,6 +22,7 @@
 public class GlobalConfig extends GlobalConfiguration {
 
     private String slackOutgoingWebhookToken;
+    private String slackOutgoingWebhookURL;
 
     public GlobalConfig() { 
         load(); 
@@ -42,6 +43,21 @@ public FormValidation doCheckSlackOutgoingWebhookToken(@QueryParameter String va
         return FormValidation.ok();
     }
 
+    public String getSlackOutgoingWebhookURL() {
+        return slackOutgoingWebhookURL;
+    }
+
+    public void setSlackOutgoingWebhookURL(String slackOutgoingWebhookURL) {
+        this.slackOutgoingWebhookURL = slackOutgoingWebhookURL;
+    }
+
+    public FormValidation doCheckSlackOutgoingWebhookURL(@QueryParameter String value) {
+        if (value == null || value.trim().isEmpty())
+            return FormValidation.warning("Please set a url endpoint");
+
+        return FormValidation.ok();
+    }
+
     @Override
     public boolean configure(StaplerRequest req, JSONObject json) throws FormException {
         req.bindJSON(this, json);

diff --git a/src/main/java/jenkins/plugins/slack/webhook/WebhookEndpoint.java b/src/main/java/jenkins/plugins/slack/webhook/WebhookEndpoint.java
@@ -57,14 +57,15 @@ public WebhookEndpoint() {
 
     @Override
     public String getUrlName() {
-        return "webhook";
+        return "/"+globalConfig.getSlackOutgoingWebhookURL();
     }
 
     @RequirePOST
     public HttpResponse doIndex(StaplerRequest req) throws IOException,
         ServletException {
 
-        if (globalConfig.getSlackOutgoingWebhookToken() == null) {
+        if (globalConfig.getSlackOutgoingWebhookToken() == null ||
+            globalConfig.getSlackOutgoingWebhookToken().equals("")) {
             return new JsonResponse(new SlackTextMessage("Slack token not set"),
                 StaplerResponse.SC_OK); 
         }

diff --git a/src/main/resources/jenkins/plugins/slack/webhook/GlobalConfig/config.groovy b/src/main/resources/jenkins/plugins/slack/webhook/GlobalConfig/config.groovy
@@ -6,4 +6,7 @@ f.section(title: _('Slack Webhook Settings')) {
     f.entry(field: 'slackOutgoingWebhookToken', title: _('Outgoing Webhook Token')) {
         f.textbox()
     }
+    f.entry(field: 'slackOutgoingWebhookURL', title: _('Outgoing Webhook URL Endpoint')) {
+        f.textbox()
+    }
 }
diff --git a/...in/resources/jenkins/plugins/slack/webhook/GlobalConfig/help-slackOutgoingWebhookURL.html b/...in/resources/jenkins/plugins/slack/webhook/GlobalConfig/help-slackOutgoingWebhookURL.html
@@ -0,0 +1,5 @@
+<div>
+This is the webhook endpoint to send requests to.
+<br />
+Example: "webook", "slackwebook". This endpoint will be mapped to your Jenkins root address at JENKINS_HOST/ENDPOINT
+</div>
diff --git a/src/test/java/jenkins/plugins/slack/webhook/WebhookEndpointTest.java b/src/test/java/jenkins/plugins/slack/webhook/WebhookEndpointTest.java
@@ -27,6 +27,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import static java.net.HttpURLConnection.HTTP_OK;
+import static java.net.HttpURLConnection.HTTP_NOT_FOUND;
 
 import org.apache.commons.httpclient.NameValuePair;
 
@@ -45,7 +46,8 @@ public class WebhookEndpointTest {
 
     private JenkinsRule.WebClient client;
 
-    private final String ENDPOINT = "webhook/";
+    private final String URL = "webook";
+    private final String ENDPOINT = URL+"/";
 
     private List<NameValuePair> data;
 
@@ -61,8 +63,18 @@ public void setUp() throws Exception {
         data.add(new NameValuePair("trigger_word", "jenkins")); 
     }
 
+    @Test
+    public void testUnconfiguredSlackURL() throws Exception {
+        WebResponse response = makeRequest(null);
+        assertThat(response.getStatusCode(), is(HTTP_NOT_FOUND));
+    }
+
     @Test
     public void testUnconfiguredSlackToken() throws Exception {
+        HtmlForm form = jenkinsRule.createWebClient().goTo("configure").getFormByName("config");
+        form.getInputByName("_.slackOutgoingWebhookURL").setValueAttribute(URL);
+        jenkinsRule.submit(form);
+
         WebResponse response = makeRequest(null);
 
         assertThat(response.getStatusCode(), is(HTTP_OK));
@@ -163,6 +175,7 @@ public void testGetProjectBuildLog() throws Exception {
 
     private void setConfigSettings() throws Exception {
         HtmlForm form = jenkinsRule.createWebClient().goTo("configure").getFormByName("config");
+        form.getInputByName("_.slackOutgoingWebhookURL").setValueAttribute(URL);
         form.getInputByName("_.slackOutgoingWebhookToken").setValueAttribute("GOOD_TOKEN");
         jenkinsRule.submit(form);
     }