Merge branch 'release/issue-9'

Author: Ataxexe

changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.2.3
+
+- Allowed different types of notifications (#9)
+
 ## 1.2.2
 
 - Updated code for new `boteco` versions

pom.xml

@@ -11,7 +11,7 @@
   </parent>
   <groupId>tools.devnull</groupId>
   <artifactId>build-notifications</artifactId>
-  <version>1.2.2</version>
+  <version>1.2.3</version>
   <packaging>hpi</packaging>
 
   <name>Jenkins Build Notification Plugin</name>
@@ -22,6 +22,43 @@
       <url>http://opensource.org/licenses/MIT</url>
     </license>
   </licenses>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+
+    <kodo.version>3.3.0</kodo.version>
+    <mockito.version>2.7.13</mockito.version>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>tools.devnull</groupId>
+      <artifactId>kodo</artifactId>
+      <version>${kodo.version}</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <version>${mockito.version}</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <source>1.8</source>
+          <target>1.8</target>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+
   <repositories>
     <repository>
       <id>repo.jenkins-ci.org</id>

src/main/java/tools/devnull/jenkins/plugins/buildnotifications/BotecoMessage.java

@@ -78,6 +78,11 @@ public void highPriority() {
     this.priority = "high";
   }
 
+  @Override
+  public void normalPriority() {
+    this.priority = "normal";
+  }
+
   @Override
   public void lowPriority() {
     this.priority = "low";
@@ -90,7 +95,7 @@ public void send() {
     post.setRequestHeader("Content-Type", "application/json; charset=utf-8");
     Map<String, String> values = new HashMap<String, String>();
     values.put("title", title);
-    values.put("content", content);
+    values.put("text", content);
     values.put("url", url);
     values.put("priority", priority);
     try {

src/main/java/tools/devnull/jenkins/plugins/buildnotifications/BotecoNotifier.java

@@ -82,7 +82,11 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
       throws InterruptedException, IOException {
     BotecoDescriptor descriptor = (BotecoDescriptor) Jenkins.getInstance()
         .getDescriptor(BotecoNotifier.class);
-    Message message = new BotecoMessage(eventId, descriptor.endpoint);
+    Message message = new BotecoMessage(
+        String.format("%s.%s",
+            eventId,
+            BuildStatus.of(build).name().toLowerCase().replaceAll("_", "-")),
+        descriptor.endpoint);
     BuildNotifier notifier = new BuildNotifier(message, build, sendIfSuccess);
     notifier.sendNotification();
     return true;

src/main/java/tools/devnull/jenkins/plugins/buildnotifications/BuildNotifier.java

@@ -45,6 +45,7 @@ public class BuildNotifier {
 
   private final Message message;
   private final AbstractBuild build;
+  private final BuildStatus status;
   private final Result result;
   private final String baseUrl;
   private final boolean sendIfSuccess;
@@ -58,6 +59,7 @@ public class BuildNotifier {
   public BuildNotifier(Message message, AbstractBuild build, boolean sendIfSuccess) {
     this.message = message;
     this.build = build;
+    this.status = BuildStatus.of(build);
     this.result = build.getResult();
     this.baseUrl = JenkinsLocationConfiguration.get().getUrl();
     this.sendIfSuccess = sendIfSuccess;
@@ -67,7 +69,7 @@ public BuildNotifier(Message message, AbstractBuild build, boolean sendIfSuccess
    * Sends the notification through the given message object.
    */
   public void sendNotification() {
-    if (result.ordinal == 0) {
+    if (status == BuildStatus.SUCCESSFUL) {
       if (sendIfSuccess) {
         sendMessage();
       }
@@ -92,12 +94,12 @@ private void setUrl() {
   }
 
   private void setContent() {
-    if(build.getChangeSet().getItems().length == 0){
+    if (build.getChangeSet().getItems().length == 0) {
       message.setContent(result.toString());
     } else {
       StringBuilder changes = new StringBuilder();
 
-      for (Iterator<? extends ChangeLogSet.Entry> i = build.getChangeSet().iterator(); i.hasNext();) {
+      for (Iterator<? extends ChangeLogSet.Entry> i = build.getChangeSet().iterator(); i.hasNext(); ) {
         ChangeLogSet.Entry change = i.next();
         changes.append("\n");
         changes.append(change.getMsg());
@@ -111,20 +113,25 @@ private void setContent() {
 
   private void setTitle() {
     message.setTitle(String.format(
-        "Build #%d of %s",
+        "%s - Build #%d of %s",
+        status.tag(),
         build.getNumber(),
         build.getProject().getName()
     ));
   }
 
   private void setPriority() {
-    switch (result.ordinal) {
-      case 0: //SUCCESS
-        message.lowPriority();
+    switch (status) {
+      case FIXED:
+        message.normalPriority();
         break;
-      case 2: //FAILURE
+      case BROKEN:
+      case STILL_BROKEN:
         message.highPriority();
         break;
+      case SUCCESSFUL:
+        message.lowPriority();
+        break;
     }
   }
 

src/main/java/tools/devnull/jenkins/plugins/buildnotifications/BuildStatus.java

@@ -0,0 +1,43 @@
+package tools.devnull.jenkins.plugins.buildnotifications;
+
+import hudson.model.AbstractBuild;
+import hudson.model.Result;
+
+/**
+ * Enumeration of the possible build status for notification purposes.
+ */
+public enum BuildStatus {
+
+  BROKEN("Broken"),
+  STILL_BROKEN("Still Broken"),
+  FIXED("Fixed"),
+  SUCCESSFUL("Successful");
+
+  private final String tag;
+
+  BuildStatus(String tag) {
+    this.tag = tag;
+  }
+
+  public String tag() {
+    return this.tag;
+  }
+
+  public static BuildStatus of(AbstractBuild build) {
+    AbstractBuild previousBuild = build.getPreviousBuild();
+    if (build.getResult().ordinal == Result.SUCCESS.ordinal) {
+      if (previousBuild != null) {
+        return previousBuild.getResult().ordinal == Result.SUCCESS.ordinal ? SUCCESSFUL : FIXED;
+      } else {
+        return SUCCESSFUL;
+      }
+    } else {
+      if (previousBuild != null) {
+        return previousBuild.getResult().ordinal != Result.SUCCESS.ordinal ? STILL_BROKEN : BROKEN;
+      } else {
+        return BROKEN;
+      }
+    }
+  }
+
+}

src/main/java/tools/devnull/jenkins/plugins/buildnotifications/Message.java

@@ -65,6 +65,11 @@ public interface Message {
    */
   void lowPriority();
 
+  /**
+   * Indicates that this is a normal priority message
+   */
+  void normalPriority();
+
   /**
    * Sends the message
    */

src/main/java/tools/devnull/jenkins/plugins/buildnotifications/PushoverMessage.java

@@ -98,6 +98,11 @@ public void highPriority() {
     this.priority = 1;
   }
 
+  @Override
+  public void normalPriority() {
+    this.priority = 0;
+  }
+
   public void lowPriority() {
     this.priority = -1;
   }

src/main/java/tools/devnull/jenkins/plugins/buildnotifications/TelegramMessage.java

@@ -82,6 +82,11 @@ public void highPriority() {
     // Not possible with Telegram
   }
 
+  @Override
+  public void normalPriority() {
+    // Not possible with Telegram
+  }
+
   @Override
   public void lowPriority() {
     // Not possible with Telegram

src/test/java/tools/devnull/jenkins/plugins/buildnotifications/BuildChain.java

@@ -0,0 +1,48 @@
+package tools.devnull.jenkins.plugins.buildnotifications;
+
+import hudson.model.AbstractBuild;
+import hudson.model.Result;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+/**
+ * Utility class for creating a build history for testing purposes
+ */
+public class BuildChain {
+
+  private final AbstractBuild build;
+
+  private BuildChain(AbstractBuild actual, AbstractBuild next, Result result) {
+    this.build = next;
+    when(build.getResult()).thenReturn(result);
+    when(next.getPreviousBuild()).thenReturn(actual);
+    when(actual.getNextBuild()).thenReturn(next);
+  }
+
+  private BuildChain(Result result) {
+    this.build = mock(AbstractBuild.class);
+    when(build.getResult()).thenReturn(result);
+  }
+
+  public BuildChain thenFailed() {
+    return new BuildChain(this.build, mock(AbstractBuild.class), Result.FAILURE);
+  }
+
+  public BuildChain thenSucceeded() {
+    return new BuildChain(this.build, mock(AbstractBuild.class), Result.SUCCESS);
+  }
+
+  public AbstractBuild get() {
+    return this.build;
+  }
+
+  public static BuildChain failed() {
+    return new BuildChain(Result.FAILURE);
+  }
+
+  public static BuildChain succeeded() {
+    return new BuildChain(Result.SUCCESS);
+  }
+
+}