Merge pull request #59 from jdavisp3/display-console-logs

Add display-console-logs option.

README.md

@@ -25,6 +25,7 @@ gocd.slack {
   channel = "#build"
   slackDisplayName = "gocd-slack-bot"
   slackUserIconURL = "http://example.com/slack-bot.png"
+  display-console-log-links = true
   displayMaterialChanges = true
   process-all-rules = true
   proxy {
@@ -40,6 +41,7 @@ gocd.slack {
 - `api-server-host` - This is an optional attribute. Set this field to localhost so server will use this endpoint to get `PipelineHistory` and `PipelineInstance`  
 - `webhookUrl` - Slack Webhook URL
 - `channel` - Override the default channel where we should send the notifications in slack. You can also give a value starting with `@` to send it to any specific user.
+- `display-console-log-links` - Display console log links in the notification. Defaults to true, set to false if you want to hide.
 - `displayMaterialChanges` - Display material changes in the notification (git revisions for example). Defaults to true, set to false if you want to hide.
 - `process-all-rules` - If true, all matching rules are applied instead of just the first.
 - `proxy` - Specify proxy related settings for the plugin.

docs/index.md

@@ -25,6 +25,7 @@ gocd.slack {
   channel = "#build"
   slackDisplayName = "gocd-slack-bot"
   slackUserIconURL = "http://example.com/slack-bot.png"
+  display-console-log-links = true
   displayMaterialChanges = true
   process-all-rules = true
   proxy {
@@ -40,6 +41,7 @@ gocd.slack {
 - `api-server-host` - This is an optional attribute. Set this field to localhost so server will use this endpoint to get `PipelineHistory` and `PipelineInstance`  
 - `webhookUrl` - Slack Webhook URL
 - `channel` - Override the default channel where we should send the notifications in slack. You can also give a value starting with `@` to send it to any specific user.
+- `display-console-log-links` - Display console log links in the notification. Defaults to true, set to false if you want to hide.
 - `displayMaterialChanges` - Display material changes in the notification (git revisions for example). Defaults to true, set to false if you want to hide.
 - `process-all-rules` - If true, all matching rules are applied instead of just the first.
 - `proxy` - Specify proxy related settings for the plugin.

src/main/java/in/ashwanthkumar/gocd/slack/SlackPipelineListener.java

@@ -97,7 +97,9 @@ private SlackAttachment slackAttachment(PipelineRule rule, GoNotificationMessage
                 buildAttachment.addField(new SlackAttachment.Field("Reason", details.buildCause.triggerMessage, true));
             }
             buildAttachment.addField(new SlackAttachment.Field("Label", details.label, true));
-            consoleLogLinks = createConsoleLogLinks(rules.getGoServerHost(), details, stage, pipelineStatus);
+            if (rules.getDisplayConsoleLogLinks()) {
+                consoleLogLinks = createConsoleLogLinks(rules.getGoServerHost(), details, stage, pipelineStatus);
+            }
         } catch (Exception e) {
             buildAttachment.text("(Couldn't fetch build details; see server log.) ");
             LOG.warn("Couldn't fetch build details", e);
@@ -144,7 +146,6 @@ private SlackAttachment slackAttachment(PipelineRule rule, GoNotificationMessage
             }
         }
 
-
         if (!consoleLogLinks.isEmpty()) {
             String logLinks = Lists.mkString(consoleLogLinks, "", "", "\n");
             buildAttachment.addField(new SlackAttachment.Field("Console Logs", logLinks, true));

src/main/java/in/ashwanthkumar/gocd/slack/ruleset/Rules.java

@@ -29,6 +29,7 @@ public class Rules {
     private String goAPIServerHost;
     private String goLogin;
     private String goPassword;
+    private boolean displayConsoleLogLinks;
     private boolean displayMaterialChanges;
     private boolean processAllRules;
 
@@ -131,6 +132,15 @@ public Rules setGoPassword(String goPassword) {
         return this;
     }
 
+    public boolean getDisplayConsoleLogLinks() {
+        return displayConsoleLogLinks;
+    }
+
+    public Rules setDisplayConsoleLogLinks(boolean displayConsoleLogLinks) {
+        this.displayConsoleLogLinks = displayConsoleLogLinks;
+        return this;
+    }
+
     public boolean getDisplayMaterialChanges() {
         return displayMaterialChanges;
     }
@@ -214,6 +224,11 @@ public static Rules fromConfig(Config config) {
             password = config.getString("password");
         }
 
+        boolean displayConsoleLogLinks = true;
+        if (config.hasPath("display-console-log-links")) {
+            displayConsoleLogLinks = config.getBoolean("display-console-log-links");
+        }
+
         // TODO - Next major release - change this to - separated config
         boolean displayMaterialChanges = true;
         if (config.hasPath("displayMaterialChanges")) {
@@ -256,6 +271,7 @@ public PipelineRule apply(Config input) {
                 .setGoAPIServerHost(apiServerHost)
                 .setGoLogin(login)
                 .setGoPassword(password)
+                .setDisplayConsoleLogLinks(displayConsoleLogLinks)
                 .setDisplayMaterialChanges(displayMaterialChanges)
                 .setProcessAllRules(processAllRules)
                 .setProxy(proxy);

src/main/resources/reference.conf

@@ -17,6 +17,10 @@ gocd.slack {
   # Setup up an incoming webhook in your slack team on https://my.slack.com/services/new/incoming-webhook/
   #webhookUrl: ""       # Mandatory field
 
+  # If you don't want to see the console log links in the notification (for size concerns).
+  # Defaults to true.
+  #display-console-log-links = true
+
   # If you don't want to see the revision changes in the notification (for size or confidentiality concerns)
   # defaults to true
   #displayMaterialChanges = true

src/test/java/in/ashwanthkumar/gocd/slack/ruleset/RulesReaderTest.java

@@ -19,6 +19,7 @@ public void shouldReadTestConfig() {
         assertThat(rules.getGoServerHost(), is("http://localhost:8080/"));
         assertThat(rules.getPipelineRules().size(), is(2));
         assertThat(rules.getPipelineRules().size(), is(2));
+        assertThat(rules.getDisplayConsoleLogLinks(), is(false));
         assertThat(rules.getDisplayMaterialChanges(), is(false));
 
         PipelineRule pipelineRule1 = new PipelineRule()
@@ -55,6 +56,7 @@ public void shouldReadMinimalConfig() {
 
         // Default rules
         assertThat(rules.getPipelineRules().size(), is(1));
+        assertThat(rules.getDisplayConsoleLogLinks(), is(true));
         assertThat(rules.getDisplayMaterialChanges(), is(true));
 
         PipelineRule pipelineRule = new PipelineRule()

src/test/resources/configs/test-config-1.conf

@@ -8,6 +8,8 @@ gocd.slack {
   # Enter full FQDN of your GoCD instance. We'll be sending links on your slack channel using this as the base uri.
   server-host = "http://localhost:8080/"
 
+  display-console-log-links = false
+
   # If you don't want to see the revision changes in the notification (for size or confidentiality concerns)
   # defaults to true
   displayMaterialChanges = false