JENKINS-69312 JiraTestResultReporter plugin does not show plus button to create an issue (#211)

* - fix for https://issues.jenkins.io/browse/JENKINS-69312 and dup https://issues.jenkins.io/browse/JENKINS-67777
  with an additional checkbox to enable manual linking

* avoid potentially problematic resorting of members, see #211 (review)

Author: chcg

README.md

@@ -90,6 +90,7 @@ junit (
      autoUnlinkIssue: false,
      additionalAttachments: false,
      overrideResolvedIssues: false,
+     manualAddIssue: false,
    )
  ]
 )
@@ -123,6 +124,8 @@ If you check the **Auto unlink issues when test passes** check box, this plugin
 
 If you check the **Auto override resolved issues** check box, this plugin will create new issues automatically for failing tests that are linked to already resolved issues.
 
+If you check the **Manually link or raise issues** check box, this plugin will allow to manually link or create issues to the failing tests in new builds also if auto raise is not enabled.
+
 ![image of job config settings](img/job-config1.png)
 
 Only after configuring the fields above, if you want you can override the **Summary** and **Description** values by clicking the **Advanced** button.

src/main/java/org/jenkinsci/plugins/JiraTestResultReporter/JiraTestDataPublisher.java

@@ -138,6 +138,10 @@ public boolean getOverrideResolvedIssues() {
         return JobConfigMapping.getInstance().getOverrideResolvedIssues(getJobName());
     }
 
+    public boolean getManualAddIssue() {
+        return JobConfigMapping.getInstance().getManualAddIssue(getJobName());
+    }
+
     /**
      * Getter for list of attachments by test method identified by its classname and name
      * @param className
@@ -187,10 +191,11 @@ public void setAdditionalAttachments(boolean additionalAttachments) {
                 .withProjectKey(this.jobConfig.getProjectKey())
                 .withIssueType(this.jobConfig.getIssueType())
                 .withAutoRaiseIssues(this.jobConfig.getAutoRaiseIssue())
-                .withOverrideResolvedIssues(this.jobConfig.getOverrideResolvedIssues())
                 .withAutoResolveIssues(this.jobConfig.getAutoResolveIssue())
                 .withAutoUnlinkIssues(this.jobConfig.getAutoUnlinkIssue())
                 .withAdditionalAttachments(additionalAttachments)
+                .withOverrideResolvedIssues(this.jobConfig.getOverrideResolvedIssues())
+                .withManualAddIssues(this.jobConfig.getManualAddIssue())
                 .withConfigs(this.jobConfig.getConfigs())
                 .build();
     }
@@ -204,6 +209,7 @@ public void setAdditionalAttachments(boolean additionalAttachments) {
      * @param autoResolveIssue
      * @param autoUnlinkIssue
      * @param overrideResolvedIssues
+     * @param manualAddIssue
      */
     @DataBoundConstructor
     public JiraTestDataPublisher(
@@ -213,7 +219,8 @@ public JiraTestDataPublisher(
             boolean autoRaiseIssue,
             boolean autoResolveIssue,
             boolean autoUnlinkIssue,
-            boolean overrideResolvedIssues) {
+            boolean overrideResolvedIssues,
+            boolean manualAddIssue) {
 
         long defaultIssueType;
         try {
@@ -226,9 +233,10 @@ public JiraTestDataPublisher(
                 .withProjectKey(projectKey)
                 .withIssueType(defaultIssueType)
                 .withAutoRaiseIssues(autoRaiseIssue)
-                .withOverrideResolvedIssues(overrideResolvedIssues)
                 .withAutoResolveIssues(autoResolveIssue)
                 .withAutoUnlinkIssues(autoUnlinkIssue)
+                .withOverrideResolvedIssues(overrideResolvedIssues)
+                .withManualAddIssues(manualAddIssue)
                 .withConfigs(Util.fixNull(configs))
                 .build();
 
@@ -297,6 +305,10 @@ public TestResultAction.Data contributeTestData(
             hasTestData |= unlinkIssuesForPassedTests(listener, project, job, envVars, getTestCaseResults(testResult));
         }
 
+        if (JobConfigMapping.getInstance().getManualAddIssue(project)) {
+            hasTestData |= true;
+        }
+
         if (hasTestData) {
             // Workaround to make feasible to use the publisher in parallel executions
             if (!reportedTestDataBefore(envVars)) {

src/main/java/org/jenkinsci/plugins/JiraTestResultReporter/JiraUtils.java

@@ -209,11 +209,13 @@ public static Set<String> searchIssueKeys(Job<?, ?> job, EnvVars envVars, CaseRe
                 return issueKeys;
             }
 
-            IssueInput issueInput = JiraUtils.createIssueInput(job, test, envVars, JiraIssueTrigger.JOB);
-            SearchResult searchResult = JiraUtils.findIssues(job, test, envVars, issueInput);
-            if (searchResult != null && searchResult.getTotal() > 0) {
-                for (Issue issue : searchResult.getIssues()) {
-                    issueKeys.add(issue.getKey());
+            if (!JobConfigMapping.getInstance().getManualAddIssue(job)) {
+                IssueInput issueInput = JiraUtils.createIssueInput(job, test, envVars, JiraIssueTrigger.JOB);
+                SearchResult searchResult = JiraUtils.findIssues(job, test, envVars, issueInput);
+                if (searchResult != null && searchResult.getTotal() > 0) {
+                    for (Issue issue : searchResult.getIssues()) {
+                        issueKeys.add(issue.getKey());
+                    }
                 }
             }
             return issueKeys;

src/main/java/org/jenkinsci/plugins/JiraTestResultReporter/JobConfigMapping.java

@@ -61,6 +61,7 @@ public static class JobConfigEntry implements Serializable {
         protected boolean autoResolveIssue;
         protected boolean autoUnlinkIssue;
         protected boolean additionalAttachments;
+        protected boolean manualAddIssue;
         protected transient Pattern issueKeyPattern;
 
         /**
@@ -77,7 +78,8 @@ public JobConfigEntry(
                 boolean autoResolveIssue,
                 boolean autoUnlinkIssue,
                 boolean overrideResolvedIssues,
-                boolean additionalAttachments) {
+                boolean additionalAttachments,
+                boolean manualAddIssue) {
             this.projectKey = projectKey;
             this.issueType = issueType;
             this.configs = configs;
@@ -86,6 +88,7 @@ public JobConfigEntry(
             this.autoUnlinkIssue = autoUnlinkIssue;
             this.overrideResolvedIssues = overrideResolvedIssues;
             this.additionalAttachments = additionalAttachments;
+            this.manualAddIssue = manualAddIssue;
             compileIssueKeyPattern();
         }
 
@@ -133,6 +136,10 @@ public boolean getOverrideResolvedIssues() {
             return overrideResolvedIssues;
         }
 
+        public boolean getManualAddIssue() {
+            return manualAddIssue;
+        }
+
         /**
          * Getter for the issue key pattern
          * @return
@@ -165,7 +172,7 @@ public static class JobConfigEntryBuilder extends JobConfigEntry {
          * Constructor
          */
         public JobConfigEntryBuilder() {
-            super(null, null, new ArrayList<>(), false, false, false, false, false);
+            super(null, null, new ArrayList<>(), false, false, false, false, false, false);
         }
 
         public JobConfigEntryBuilder withProjectKey(String projectKey) {
@@ -209,6 +216,11 @@ public JobConfigEntryBuilder withOverrideResolvedIssues(boolean overrideResolved
             return this;
         }
 
+        public JobConfigEntryBuilder withManualAddIssues(boolean manualAddIssue) {
+            this.manualAddIssue = manualAddIssue;
+            return this;
+        }
+
         public JobConfigEntry build() {
             if (projectKey == null) {
                 throw new IllegalStateException("The Project Key may not be null");
@@ -377,7 +389,8 @@ public synchronized void saveConfig(
             boolean autoResolveIssue,
             boolean autoUnlinkIssue,
             boolean overrideResolvedIssues,
-            boolean additionalAttachments) {
+            boolean additionalAttachments,
+            boolean manualAddIssue) {
         JobConfigEntry entry = new JobConfigEntry(
                 projectKey,
                 issueType,
@@ -386,7 +399,8 @@ public synchronized void saveConfig(
                 autoResolveIssue,
                 autoUnlinkIssue,
                 overrideResolvedIssues,
-                additionalAttachments);
+                additionalAttachments,
+                manualAddIssue);
         saveConfig(project, entry);
     }
 
@@ -472,6 +486,11 @@ public boolean getOverrideResolvedIssues(Job<?, ?> project) {
         return entry != null ? entry.getOverrideResolvedIssues() : false;
     }
 
+    public boolean getManualAddIssue(Job<?, ?> project) {
+        JobConfigEntry entry = getJobConfigEntry(project);
+        return entry != null ? entry.getManualAddIssue() : false;
+    }
+
     /**
      * Getter for the issue key pattern, used to validate user input
      * @param project

src/main/resources/org/jenkinsci/plugins/JiraTestResultReporter/JiraTestDataPublisher/config.jelly

@@ -31,6 +31,10 @@
                 <f:checkbox/>
             </f:entry>
 
+            <f:entry title="Manually link or raise issues" field="manualAddIssue">
+                <f:checkbox/>
+            </f:entry>
+
             <f:advanced>
                 <j:set var="items" value="${ instance.configs != null ? instance.configs : descriptor.templates }"/>
                 <f:entry field="configs">

src/main/resources/org/jenkinsci/plugins/JiraTestResultReporter/JiraTestDataPublisher/help-manualAddIssue.html

@@ -0,0 +1,3 @@
+<div>
+    Allow issues to be manually linked via the jenkins webinterface for failing tests that aren't linked yet.
+</div>