JENKINS-21430 issues can be filtered for assigned/unassigned by portlet

configuration. Also, the busiest assignees can be shown at the top of the portlet.
jenkinsci · Jan 19, 2014 · 1cded1f · 1cded1f
1 parent 45dce1f
commit 1cded1f
Show file tree

Hide file tree

Showing 7 changed files with 219 additions and 22 deletions.
diff --git a/src/main/java/javagh/jenkins/mashupportlets/SonarAssigneeStatus.java b/src/main/java/javagh/jenkins/mashupportlets/SonarAssigneeStatus.java
@@ -0,0 +1,28 @@
+package javagh.jenkins.mashupportlets;
+
+import java.util.LinkedList;
+import java.util.List;
+
+import org.apache.commons.lang.StringUtils;
+
+
+/**
+ * Sonar Assignee Status (used in config dropdowns).
+ * 
+ * @author G.Henzler
+ *
+ */
+public enum SonarAssigneeStatus {
+
+    ALL, UNASSIGNED, ASSIGNED;
+
+    public static String getPriorityValueByNameJson() {
+        List<String> items = new LinkedList<String>();
+        for (SonarAssigneeStatus sonarPriority : values()) {
+            items.add("'" + sonarPriority.name() + "':"
+                    + sonarPriority.ordinal());
+        }
+        return "{ " + StringUtils.join(items, ", ") + " }";
+    }
+
+}
diff --git a/src/main/java/javagh/jenkins/mashupportlets/SonarIssuesPortlet.java b/src/main/java/javagh/jenkins/mashupportlets/SonarIssuesPortlet.java
@@ -27,6 +27,9 @@ public class SonarIssuesPortlet extends AbstractMashupPortlet {
     private final int sonarPriorityThreshold;
     private final int sonarNewIssuesPriorityThreshold;
 
+    private final int sonarAssigneeStatus;
+    private final boolean sonarShowAssigneeBar;
+
     private final int maxEntries;
     private final int deltaDaysForNewIssues;
 
@@ -37,7 +40,7 @@ public class SonarIssuesPortlet extends AbstractMashupPortlet {
 
     @DataBoundConstructor
     public SonarIssuesPortlet(String name, String sonarBaseUrl,
-            String sonarProjectsList, int sonarPriorityThreshold,
+            String sonarProjectsList, int sonarPriorityThreshold, int sonarAssigneeStatus, boolean sonarShowAssigneeBar,
             int maxEntries, int sonarNewIssuesPriorityThreshold,
             int deltaDaysForNewIssues, int violationDescriptionMaximumLength, String sonarApiUser, String sonarApiPw) {
         super(name);
@@ -48,6 +51,9 @@ public SonarIssuesPortlet(String name, String sonarBaseUrl,
 
         this.sonarPriorityThreshold = sonarPriorityThreshold;
 
+        this.sonarAssigneeStatus = sonarAssigneeStatus;
+        this.sonarShowAssigneeBar = sonarShowAssigneeBar;
+
         this.maxEntries = maxEntries;
 
         this.sonarNewIssuesPriorityThreshold = sonarNewIssuesPriorityThreshold;
@@ -88,10 +94,17 @@ public int getSonarNewIssuesPriorityThreshold() {
     public int getDeltaDaysForNewIssues() {
         return deltaDaysForNewIssues > 0 ? deltaDaysForNewIssues : 5;
     }
-
-
 
-    public String getSonarApiUser() {
+    public int getSonarAssigneeStatus() {
+		return sonarAssigneeStatus;
+	}
+
+	public boolean isSonarShowAssigneeBar() {
+		return sonarShowAssigneeBar;
+	}
+
+
+	public String getSonarApiUser() {
 		return sonarApiUser;
 	}
 
@@ -127,6 +140,11 @@ private String getPrioritiesListForThreshold(int threshold) {
     public String getPriorityValueByNameJson() {
         return SonarPriority.getPriorityValueByNameJson();
     }
+    public String getAssigneeStatusValueByNameJson() {
+        return SonarAssigneeStatus.getPriorityValueByNameJson();
+    }
+
+
 
 	@JavaScriptMethod
     public HttpResponse ajaxViaJenkins(String urlStr) {
@@ -155,6 +173,14 @@ public ListBoxModel doFillSonarNewIssuesPriorityThresholdItems() {
             items.addAll(doFillSonarPriorityThresholdItems());
             return items;
         }
+
+        public ListBoxModel doFillSonarAssigneeStatusItems() {
+            ListBoxModel items = new ListBoxModel();
+            for (SonarAssigneeStatus sonarAssigneeStatus : SonarAssigneeStatus.values()) {
+                items.add(sonarAssigneeStatus.name(), String.valueOf(sonarAssigneeStatus.ordinal()));
+            }
+            return items;
+        }
 
     }
 

diff --git a/src/main/resources/javagh/jenkins/mashupportlets/SonarIssuesPortlet/config.jelly b/src/main/resources/javagh/jenkins/mashupportlets/SonarIssuesPortlet/config.jelly
@@ -12,6 +12,13 @@
      <f:select />
   </f:entry>    
 
+  <f:entry title="${%SonarAssigneeStatus}" field="sonarAssigneeStatus">
+     <f:select />
+  </f:entry>   
+
+  <f:entry title="${%SonarShowAssigneeBar}" field="sonarShowAssigneeBar">
+     <f:checkbox name="sonarShowAssigneeBar" value="true" checked="${it.isSonarShowAssigneeBar()}" />
+  </f:entry>   
 
   <f:advanced>
 	  <f:entry title="${%MaxEntries}" field="maxEntries">

diff --git a/src/main/resources/javagh/jenkins/mashupportlets/SonarIssuesPortlet/config.properties b/src/main/resources/javagh/jenkins/mashupportlets/SonarIssuesPortlet/config.properties
@@ -6,5 +6,8 @@ MaxEntries=Maximum entries shown
 SonarNewIssuesPriorityThreshold=Priority Threshold new issues
 DeltaDaysForNewIssues=Delta days for new issues
 
+SonarAssigneeStatus=Assignee Status
+SonarShowAssigneeBar=Show Busiest Assignees
+
 SonarApiUser=Sonar API User
 SonarApiPw=Sonar API Password
diff --git a/.../resources/javagh/jenkins/mashupportlets/SonarIssuesPortlet/help-sonarAssigneeStatus.html b/.../resources/javagh/jenkins/mashupportlets/SonarIssuesPortlet/help-sonarAssigneeStatus.html
@@ -0,0 +1,3 @@
+<div>
+  Filters for assigned or unassigned issues.
+</div>
diff --git a/...resources/javagh/jenkins/mashupportlets/SonarIssuesPortlet/help-sonarShowAssigneeBar.html b/...resources/javagh/jenkins/mashupportlets/SonarIssuesPortlet/help-sonarShowAssigneeBar.html
@@ -0,0 +1,3 @@
+<div>
+  If ticked, the portlet will show the busiest assignees at the top (assignee filter must not be set to UNASSIGNED for this feature to work).
+</div>
diff --git a/src/main/resources/javagh/jenkins/mashupportlets/SonarIssuesPortlet/sonarissuesportlet.jelly b/src/main/resources/javagh/jenkins/mashupportlets/SonarIssuesPortlet/sonarissuesportlet.jelly
@@ -14,15 +14,43 @@ td.sTableTop { vertical-align: top; }
 <st:bind var="mashupPlugin_${it.id}" value="${it}"/>
 <script type="text/javascript"><![CDATA[
 
-new function(divId, rootUrl, ajaxViaJenkins, sonarBase, sonarProjects, sonarPriorities, sonarPriorityThreshold, maxEntries, deltaDaysForNewIssues, sonarNewIssuesPriorities, prioValueByName) {
+new function(divId, rootUrl, ajaxViaJenkins, sonarBase, sonarProjects, sonarPriorities, 
+	sonarPriorityThreshold, maxEntries, deltaDaysForNewIssues, sonarNewIssuesPriorities, 
+	prioValueByName, sonarAssigneeStatus, assigneeStatusValueByNameJson, sonarShowAssigneeBar) 
+{
 
 	  var divSelect = "#" + divId;
+	  var userNameLookupTable = {};
+	  var UNASSIGNED = "unassigned";
 	
 	  function getPrioHtmlImg(prio) {
 	      var imgHtml = '<img src="'+sonarBase+'/images/priority/'+prioValueByName[prio]+'.png" border="0" alt="'+prio+'"/>';
 	      return imgHtml;        
 	  }
-	    
+
+	  function getUserNameForLogin(login) {
+	      var name = UNASSIGNED;
+	      if(login) {
+		      var name = userNameLookupTable[login];
+		      if(!name) {
+		          name = login;
+		      }
+	      }
+	      return name;	  		
+	  }
+	  
+	  function getUserNameWithLinkForLogin(login) {
+	      if(login) {
+		      var name = getUserNameForLogin(login);
+		      var link = sonarBase+'/issues/search?assignees='+login+'&sort=SEVERITY&asc=false';
+		      var linkHtml = '<a href="'+link+'" target="_blank">'+name+'</a>';
+		      return linkHtml;		      
+	      } else {
+	      	  return UNASSIGNED;
+	      }
+  		
+	  }
+
 	  function outputIssue(index, issue) {
 	  
 	     var message = issue.message;
@@ -31,20 +59,32 @@ new function(divId, rootUrl, ajaxViaJenkins, sonarBase, sonarProjects, sonarPrio
 	     
 	     var issueLinkParams = '?tab=violations&metric=info_violations&rule='+issue.severity; // key does not work anymore in 3.3.1 violation.rule.key; 
 	     var issueLink = sonarBase + '/resource/index/' + issue.component + issueLinkParams;  
-	          
-	     Q(divSelect+' table:last').append('<tr '+(issue.isNew?'bgcolor="#FFFF66"':'')+'><td>'+getPrioHtmlImg([issue.severity])
+	            	      
+	     var assignedColumnHtml = '';
+	     if(!showOnlyUnassigned()) {
+	     	assignedColumnHtml = '<td class="sTableTop">' + getUserNameWithLinkForLogin(issue.assignee) + '</td>';
+	     }   
+	    	     
+	     var rowHtml = '<tr '+(issue.isNew?'bgcolor="#FFFF66"':'')+'><td>'+getPrioHtmlImg([issue.severity])
 	              +'</td><td class="sMessage" style="white-space:normal"><a href="'+issueLink+'" target="_blank">'+message+ 
-	              "</a><br/>in " + issue.component 
-	              +'</td><td class="sTableTop">' + issue.creationDate.toISOString().substring(0, 19).replace('T',' ') + '</td></tr>'
-	              );	  
+	              "</a><br/>in " + issue.component  +'</td>'
+	              + assignedColumnHtml
+	              +'<td class="sTableTop">' + issue.creationDate.toISOString().substring(0, 19).replace('T',' ') + '</td></tr>';       	          
+	            	          
+	     Q(divSelect+' table:last').append(rowHtml);	  
 
 	     if(index == maxEntries-1) {
 	     	return false;
 	     }
 	  }
 	  
 	  function outputIssuesTable(issues) {
-	      Q(divSelect).append('<table class="pane bigtable"><th align="left">Prio.</th><th align="left" width="850">Message</th><th align="left">Created</th></table>');
+	      var colAssigneeHtml = '';	  	
+	      if(!showOnlyUnassigned()) {
+	      	colAssigneeHtml = '<th align="left" width="100">Assignee</th>';
+	      }
+	        	
+	      Q(divSelect).append('<table class="pane bigtable"><th align="left">Prio.</th><th align="left" width="850">Message</th>'+colAssigneeHtml+'<th align="left">Created</th></table>');
 	      Q.each(issues, outputIssue);
 	      if(issues.length>maxEntries) {
 	      	Q(divSelect).append( ('' + issues.length-maxEntries) + ' more validations in <a href="'+sonarBase+'" target="sonar">Sonar</a>');
@@ -76,8 +116,51 @@ new function(divId, rootUrl, ajaxViaJenkins, sonarBase, sonarProjects, sonarPrio
 	      return summary;
 	  }  
 	
+	  function renderAssigneeBar(allIssues) {
+	      Q(divSelect).append("<strong>Busiest Assignees: </strong>");
+	      
+	      var issueCountObjByLogin = {};
+	      var issueCountObjArr = [];
+	      Q.each(allIssues, function(index, issue) {
+	         if(issue.assignee) {
+	         	if(!issueCountObjByLogin[issue.assignee]) {
+	         		var issueCountObj = { login: issue.assignee, issueCount: 1 };
+	         		issueCountObjByLogin[issue.assignee] = issueCountObj;
+	         		issueCountObjArr.push(issueCountObj);
+	         	} else {
+	         		issueCountObjByLogin[issue.assignee].issueCount = issueCountObjByLogin[issue.assignee].issueCount + 1;	         		 
+	         	}
+	         }
+	      });
+	      
+	      issueCountObjArr.sort(function(countObjA, countObjB) { return countObjB.issueCount - countObjA.issueCount;  });
+	      
+
+	      
+	      Q.each(issueCountObjArr, function(index, issueCountObj) {
+	      	Q(divSelect).append( (index>0 ?', ':'') + getUserNameWithLinkForLogin(issueCountObj.login) + ' ('+issueCountObj.issueCount+')');
+	      	if((index+1) >= 5) {
+	      	   return false;
+	      	}
+	      });
+	      
+	      if(issueCountObjArr.length == 0) {
+	      	Q(divSelect).append('<i>no assignees found</i>');
+	      }
+	      
+	      Q(divSelect).append('<br /><br />');
+	  }  	
+	
 	  function displayIssues(allIssues) {
-	      Q(divSelect).html(getSummary(allIssues));
+	  
+	      Q(divSelect).html("");
+	      
+	      if(sonarShowAssigneeBar && !showOnlyUnassigned()) {
+	      	  renderAssigneeBar(allIssues);
+	      }
+	      
+	      Q(divSelect).append(getSummary(allIssues));
+	      
 	      allIssues.sort(issuesComparator);
 	      var newIssues = [];
 	      var oldIssues = [];
@@ -98,6 +181,34 @@ new function(divId, rootUrl, ajaxViaJenkins, sonarBase, sonarProjects, sonarPrio
 	      outputIssuesTable(oldIssues);
 	  }
 
+	  function showOnlyUnassigned() {
+	       return assigneeStatusValueByNameJson['UNASSIGNED'] == sonarAssigneeStatus;
+	  }	
+
+	  function showOnlyAssigned() {
+	       return assigneeStatusValueByNameJson['ASSIGNED'] == sonarAssigneeStatus;
+	  }		  
+
+	  function isRelevant(issue) {
+        	var isAssigned = false;
+        	if(issue.assignee) {
+        		isAssigned = true;
+        	}
+        	var isRelevant = true;
+        	if(showOnlyUnassigned()) {
+        		isRelevant = !isAssigned;
+        	} else if(showOnlyAssigned()) {
+        		isRelevant = isAssigned;
+        	}	  
+	  		return isRelevant;
+	  }
+	
+	  function populateUserNameLookupTable(users) {
+	        Q.each(users, function(index, user) { 
+	        	userNameLookupTable[user.login] = user.name;
+	        });	
+	  }	
+
 	
 	  function loadIssues() {
 	  
@@ -115,18 +226,31 @@ new function(divId, rootUrl, ajaxViaJenkins, sonarBase, sonarProjects, sonarPrio
 		             return;
 		        }        
 		        var responseObject = resp.responseObject();
-		        var issues = responseObject.issues;
-		        console.log('issues: ', issues);
+
+				populateUserNameLookupTable(responseObject.users);
+		        
+		        // console.log('issues in response: ', responseObject.issues);
+		        
+		        var relevantIssues = [];
 		        
 		        var today = new Date();
-		        Q.each(issues, function(index, issue) { 
-					issue.creationDate = new Date(issue.creationDate);         
-					var difference = today.getTime() - issue.creationDate.getTime();
-					var daysDiff = Math.round(difference/(1000*60*60*24));
-					issue.isNew = ((daysDiff <= deltaDaysForNewIssues) && Q.inArray(issue.severity, sonarNewIssuesPriorities)>-1);      
+		        Q.each(responseObject.issues, function(index, issue) { 
+
+		        	if(isRelevant(issue)) {
+						issue.creationDate = new Date(issue.creationDate);         
+						var difference = today.getTime() - issue.creationDate.getTime();
+						var daysDiff = Math.round(difference/(1000*60*60*24));
+						issue.isNew = ((daysDiff <= deltaDaysForNewIssues) && Q.inArray(issue.severity, sonarNewIssuesPriorities)>-1);   
+						
+						relevantIssues.push(issue);   
+
+		        	} else {
+		        		// console.log('issue not relevant: ', issue);
+		        	}
+		        
 		        });
 
-		        displayIssues(issues);
+		        displayIssues(relevantIssues);
 	      });      
 	  }
 
@@ -142,7 +266,10 @@ new function(divId, rootUrl, ajaxViaJenkins, sonarBase, sonarProjects, sonarPrio
 	${it.maxEntries},
 	${it.deltaDaysForNewIssues},
 	${it.sonarNewIssuesPrioritiesJson},
-	${it.priorityValueByNameJson}
+	${it.priorityValueByNameJson},
+	${it.sonarAssigneeStatus},
+	${it.assigneeStatusValueByNameJson},
+	${it.isSonarShowAssigneeBar()}
 );
 
 ]]></script>