add a way to choose if the notification will be sent in case of success (issue #1)

Author: Ataxexe

.idea/compiler.xml

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.2
+
+- Option to not send notifications in case of success (issue #1)
+
 ## 1.0.1
 
 - Changed build step name

changelog.md

@@ -12,7 +12,7 @@
   </parent>
   <groupId>tools.devnull</groupId>
   <artifactId>jenkins-notifier</artifactId>
-  <version>1.0.1</version>
+  <version>1.0.2</version>
   <packaging>hpi</packaging>
 
   <name>Jenkins Notifier Plugin</name>

pom.xml

@@ -45,33 +45,43 @@ public class BuildNotifier {
   private final AbstractBuild build;
   private final Result result;
   private final String baseUrl;
+  private final boolean sendIfSuccess;
 
   /**
    * Constructs a new BuildNotifier based on the given objects
    *
    * @param message the message to populate and send
    * @param build   the target build
    */
-  public BuildNotifier(Message message, AbstractBuild build) {
+  public BuildNotifier(Message message, AbstractBuild build, boolean sendIfSuccess) {
     this.message = message;
     this.build = build;
     this.result = build.getResult();
     this.baseUrl = JenkinsLocationConfiguration.get().getUrl();
+    this.sendIfSuccess = sendIfSuccess;
   }
 
   /**
    * Sends the notification through the given message object.
    */
   public void sendNotification() {
+    if (result.ordinal == 0) {
+      if (sendIfSuccess) {
+        sendMessage();
+      }
+    } else {
+      sendMessage();
+    }
+  }
+
+  private void sendMessage() {
+    LOGGER.info("Sending push notification...");
+
     setPriority();
     setContent();
     setTitle();
     setUrl();
-    sendMessage();
-  }
 
-  private void sendMessage() {
-    LOGGER.info("Sending push notification...");
     message.send();
   }
 

src/main/java/tools/devnull/jenkinsnotifier/BuildNotifier.java

@@ -51,17 +51,20 @@ public class PushoverNotifier extends Notifier {
 
   private final String userToken;
   private final String device;
+  private final boolean sendIfSuccess;
 
   /**
    * Creates a new notifier based on the given parameters
    *
-   * @param userToken the pushover target token
-   * @param device    the optional device to send the message
+   * @param userToken     the pushover target token
+   * @param device        the optional device to send the message
+   * @param sendIfSuccess if the notification should be sent if the build succeed
    */
   @DataBoundConstructor
-  public PushoverNotifier(String userToken, String device) {
+  public PushoverNotifier(String userToken, String device, boolean sendIfSuccess) {
     this.userToken = userToken;
     this.device = device;
+    this.sendIfSuccess = sendIfSuccess;
   }
 
   public String getUserToken() {
@@ -72,6 +75,10 @@ public String getDevice() {
     return device;
   }
 
+  public boolean isSendIfSuccess() {
+    return sendIfSuccess;
+  }
+
   @Override
   public BuildStepMonitor getRequiredMonitorService() {
     return BuildStepMonitor.BUILD;
@@ -83,7 +90,7 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
     PushoverDescriptor descriptor = (PushoverDescriptor) Jenkins.getInstance()
         .getDescriptor(PushoverNotifier.class);
     Message message = new PushoverMessage(userToken, descriptor.appToken, device);
-    BuildNotifier notifier = new BuildNotifier(message, build);
+    BuildNotifier notifier = new BuildNotifier(message, build, sendIfSuccess);
     notifier.sendNotification();
     return true;
   }

src/main/java/tools/devnull/jenkinsnotifier/PushoverNotifier.java

@@ -50,16 +50,28 @@
 public class TelegramNotifier extends Notifier {
 
   private final String chatId;
+  private final boolean sendIfSuccess;
 
+  /**
+   * Creates a new notifier based on the given parameters
+   *
+   * @param chatId        the telegram chat id
+   * @param sendIfSuccess if the notification should be sent if the build succeed
+   */
   @DataBoundConstructor
-  public TelegramNotifier(String chatId) {
+  public TelegramNotifier(String chatId, boolean sendIfSuccess) {
     this.chatId = chatId;
+    this.sendIfSuccess = sendIfSuccess;
   }
 
   public String getChatId() {
     return chatId;
   }
 
+  public boolean isSendIfSuccess() {
+    return sendIfSuccess;
+  }
+
   @Override
   public BuildStepMonitor getRequiredMonitorService() {
     return BuildStepMonitor.BUILD;
@@ -71,7 +83,7 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
     TelegramDescriptor descriptor = (TelegramDescriptor) Jenkins.getInstance()
         .getDescriptor(TelegramNotifier.class);
     Message message = new TelegramMessage(descriptor.getBotToken(), chatId);
-    BuildNotifier notifier = new BuildNotifier(message, build);
+    BuildNotifier notifier = new BuildNotifier(message, build, sendIfSuccess);
     notifier.sendNotification();
     return true;
   }

src/main/java/tools/devnull/jenkinsnotifier/TelegramNotifier.java

@@ -2,11 +2,16 @@
          xmlns:f="/lib/form">
 
   <f:entry title="User Token" field="userToken" description="The user token from Pushover">
-    <f:textbox field="userToken"/>
+    <f:textbox/>
   </f:entry>
 
   <f:entry title="Device (optional)" field="device" description="The device to which the message should be sent.">
-    <f:textbox field="device"/>
+    <f:textbox/>
+  </f:entry>
+
+  <f:entry title="Send if success?" field="sendIfSuccess"
+           description="Sends the notification even if the build succeed">
+    <f:checkbox/>
   </f:entry>
 
 </j:jelly>

src/main/resources/tools/devnull/jenkinsnotifier/PushoverNotifier/config.jelly

@@ -2,7 +2,12 @@
          xmlns:f="/lib/form">
 
   <f:entry title="Chat ID" field="chatId" description="The target ID to send notifications">
-    <f:textbox field="chatId"/>
+    <f:textbox/>
+  </f:entry>
+
+  <f:entry title="Send if success?" field="sendIfSuccess"
+           description="Sends the notification even if the build succeed">
+    <f:checkbox />
   </f:entry>
 
 </j:jelly>