Delivery of fix to #159 (#160)

* Corrected groupId & version of fugue * Updated to 0.9.2 * Bug #157 - adding test for empty text * Correcting capitalisation on Jira * Moving on to next snapshot iteration * Fixed #159 - updated to use the project URL
schrepfler · May 12, 2021 · fae88d9 · fae88d9
1 parent 6a218fe
commit fae88d9
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 30 deletions.
diff --git a/src/main/java/net/sigmalab/maven/plugin/jira/AbstractJiraMojo.java b/src/main/java/net/sigmalab/maven/plugin/jira/AbstractJiraMojo.java
@@ -247,6 +247,10 @@ public String getSettingsKey() {
         return settingsKey;
     }
 
+    public String getJiraURL() {
+        return jiraURL;
+    }
+
     public void setJiraProjectKey(String jiraProjectKey) {
         this.jiraProjectKey = jiraProjectKey;
     }

diff --git a/src/main/java/net/sigmalab/maven/plugin/jira/GenerateReleaseNotesMojo.java b/src/main/java/net/sigmalab/maven/plugin/jira/GenerateReleaseNotesMojo.java
@@ -141,9 +141,9 @@ private void output(JiraRestClient restClient, Iterable<Issue> issues) throws IO
                 String formatPackage = ( format.contains(".") ? "" : "net.sigmalab.maven.plugin.jira.formats" );
 
                 Class<?> clazz = Class.forName(formatPackage + "." + format);
-                Constructor<?> constructor = clazz.getConstructor(JiraRestClient.class, Iterable.class, String.class,
-                                                                  String.class);
-                generator = (Generator) constructor.newInstance(restClient, issues, beforeText, afterText);
+                Constructor<?> constructor = clazz.getConstructor(JiraRestClient.class, Iterable.class, String.class, 
+                                                                  String.class, String.class);
+                generator = (Generator) constructor.newInstance(restClient, issues, this.getJiraURL(), beforeText, afterText);
 
                 log.info("Using " + format + " format for release notes.");
             }

diff --git a/src/main/java/net/sigmalab/maven/plugin/jira/formats/Generator.java b/src/main/java/net/sigmalab/maven/plugin/jira/formats/Generator.java
@@ -10,15 +10,17 @@ public abstract class Generator {
     private JiraRestClient restClient;
     protected IssueRestClient issueClient;
     private Iterable<Issue> issues;
+    private String jiraUrl;
     private String beforeText;
     private String afterText;
 
-    public Generator(JiraRestClient r, Iterable<Issue> i, String b, String a) {
+    public Generator(JiraRestClient r, Iterable<Issue> i, String u, String b, String a) {
         this.restClient = r;
         this.issues = i;
         this.issueClient = restClient.getIssueClient();
-        this.setBeforeText(b);
-        this.setAfterText(a);
+        this.jiraUrl = u;
+        this.beforeText = b;
+        this.afterText = a;
     }
 
     public abstract String addHeader();
@@ -60,15 +62,22 @@ public String getBeforeText() {
         return beforeText;
     }
 
-    public void setBeforeText(String beforeText) {
-        this.beforeText = beforeText;
-    }
-
     public String getAfterText() {
         return afterText;
     }
-
-    public void setAfterText(String afterText) {
-        this.afterText = afterText;
+
+    protected String computeIssueUrl(Issue i) {
+        // Use the jiraUrl as the basis for the URL of the issue passed to the method.
+        // Do this by stripping back the URL to just .../browse/ ending and then append
+        // the issue key.
+        int position = jiraUrl.lastIndexOf("/browse/");
+
+        // If we haven't found /browse/ in the Jira URL then just return the issue key.
+        if ( position < 0 ) {
+            return i.getKey();
+        }
+
+        // Otherwise return the issue key appended to the substring of the Jira URL.
+        return jiraUrl.substring(0, position) + "/browse/" + i.getKey();
     }
 }
diff --git a/src/main/java/net/sigmalab/maven/plugin/jira/formats/HtmlGenerator.java b/src/main/java/net/sigmalab/maven/plugin/jira/formats/HtmlGenerator.java
@@ -9,19 +9,19 @@ public class HtmlGenerator extends Generator {
     static final String ISSUETEMPLATE = "<td>[<a href=\"{0}\">{1}</a>]</td><td>{2}</td>";
     static final String HORIZONTAL_RULE = "<hr/>";
 
-    public HtmlGenerator(JiraRestClient r, Iterable<Issue> i, String b, String a) {
-        super(r, i, b, a);
+    public HtmlGenerator(JiraRestClient r, Iterable<Issue> i, String u, String b, String a) {
+        super(r, i, u, b, a);
     }
 
     @Override
     public String addHeader() {
         return "<html><body>";
     }
-
+    
     @Override
     public String addRow(Issue i) {
         return "<tr>" + 
-               format(ISSUETEMPLATE, i.getSelf(), i.getKey(), i.getSummary()) +
+               format(ISSUETEMPLATE, this.computeIssueUrl(i), i.getKey(), i.getSummary()) +
                "</tr>";       
     }
 

diff --git a/src/main/java/net/sigmalab/maven/plugin/jira/formats/MarkDownGenerator.java b/src/main/java/net/sigmalab/maven/plugin/jira/formats/MarkDownGenerator.java
@@ -9,8 +9,8 @@ public class MarkDownGenerator extends Generator {
     static final String ISSUETEMPLATE = "| [{0}]({1}) | {2} |";
     static final String HORIZONTAL_RULE = "---";
 
-    public MarkDownGenerator(JiraRestClient r, Iterable<Issue> i, String b, String a) {
-        super(r, i, b, a);
+    public MarkDownGenerator(JiraRestClient r, Iterable<Issue> i, String u, String b, String a) {
+        super(r, i, u, b, a);
     }
 
     @Override
@@ -20,7 +20,7 @@ public String addHeader() {
 
     @Override
     public String addRow(Issue i) {
-        return format(ISSUETEMPLATE, i.getKey(), i.getSelf(), i.getSummary());
+        return format(ISSUETEMPLATE, i.getKey(), this.computeIssueUrl(i), i.getSummary());
     }
 
     @Override

diff --git a/src/main/java/net/sigmalab/maven/plugin/jira/formats/PlainTextGenerator.java b/src/main/java/net/sigmalab/maven/plugin/jira/formats/PlainTextGenerator.java
@@ -10,8 +10,8 @@ public class PlainTextGenerator extends Generator {
     static final String HORIZONTAL_RULE = "==============================";
 
 
-    public PlainTextGenerator(JiraRestClient r, Iterable<Issue> i, String b, String a) {
-        super(r, i, b, a);
+    public PlainTextGenerator(JiraRestClient r, Iterable<Issue> i, String u, String b, String a) {
+        super(r, i, u, b, a);
     }
 
     @Override

diff --git a/src/test/java/net/sigmalab/maven/plugin/jira/testClasses/GenerateReleaseNotesMojoTest.java b/src/test/java/net/sigmalab/maven/plugin/jira/testClasses/GenerateReleaseNotesMojoTest.java
@@ -59,6 +59,7 @@ public void setUp() throws Exception {
         releaseNoteMojo.setJiraUser("user");
         releaseNoteMojo.setJiraPassword("password");
         releaseNoteMojo.setJiraProjectKey("DUMMY");
+        releaseNoteMojo.setJiraURL("https://dummy.jira.server/browse/KEY");
         releaseNoteMojo.setBeforeText("This is BEFORE TEXT");
         releaseNoteMojo.setAfterText("This is AFTER TEXT");
         releaseNoteMojo.setJiraProjectKey("KEY");

diff --git a/src/test/resources/expectedReleaseNotes.html b/src/test/resources/expectedReleaseNotes.html
@@ -4,10 +4,10 @@
 <tr><th>Key</th><th>Summary</th></tr>
 </thead>
 <tbody>
-<tr><td>[<a href="null">DUMMY-1</a>]</td><td>Dummy Issue</td></tr>
-<tr><td>[<a href="null">DUMMY-4</a>]</td><td>Dummy Issue</td></tr>
-<tr><td>[<a href="null">DUMMY-3</a>]</td><td>Dummy Issue</td></tr>
-<tr><td>[<a href="null">DUMMY-2</a>]</td><td>Dummy Issue</td></tr>
+<tr><td>[<a href="https://dummy.jira.server/browse/DUMMY-1">DUMMY-1</a>]</td><td>Dummy Issue</td></tr>
+<tr><td>[<a href="https://dummy.jira.server/browse/DUMMY-4">DUMMY-4</a>]</td><td>Dummy Issue</td></tr>
+<tr><td>[<a href="https://dummy.jira.server/browse/DUMMY-3">DUMMY-3</a>]</td><td>Dummy Issue</td></tr>
+<tr><td>[<a href="https://dummy.jira.server/browse/DUMMY-2">DUMMY-2</a>]</td><td>Dummy Issue</td></tr>
 </tbody>
 </table>
 <hr/>

diff --git a/src/test/resources/expectedReleaseNotes.md b/src/test/resources/expectedReleaseNotes.md
@@ -2,9 +2,9 @@ This is BEFORE TEXT
 ---
 | ISSUE KEY | SUMMARY |
 |-----------|---------|
-| [DUMMY-1](null) | Dummy Issue |
-| [DUMMY-4](null) | Dummy Issue |
-| [DUMMY-3](null) | Dummy Issue |
-| [DUMMY-2](null) | Dummy Issue |
+| [DUMMY-1](https://dummy.jira.server/browse/DUMMY-1) | Dummy Issue |
+| [DUMMY-4](https://dummy.jira.server/browse/DUMMY-4) | Dummy Issue |
+| [DUMMY-3](https://dummy.jira.server/browse/DUMMY-3) | Dummy Issue |
+| [DUMMY-2](https://dummy.jira.server/browse/DUMMY-2) | Dummy Issue |
 ---
 This is AFTER TEXT