Index: D:/eclipse/workspace/zilverline/jira/xdocs/faq.fml =================================================================== --- D:/eclipse/workspace/zilverline/jira/xdocs/faq.fml (revision 231063) +++ D:/eclipse/workspace/zilverline/jira/xdocs/faq.fml (working copy) @@ -35,12 +35,15 @@ <issueTrackingUrl>http://jira.codehaus.org/secure/BrowseProject.jspa?id=10450</issueTrackingUrl>

- 2. make sure that your project allows group Anyone to view jira issues - (you may or may not need to also set your jira installation type to - public - this is in General Configuration under administration). + 2. Determine the credentials to log into the webserver, if any. The plugin supports basic authentication (and SSL). + Add the credentials to the project.properties, as maven.jira.webUser and maven.jira.webPassword

- 3. log out of jira (if you are using Remember me feature) and test your setup + 3. Determine the JIRA account to login to the JIRA installation. + Add the credentials to the project.properties, as maven.jira.jiraUser and maven.jira.jiraPassword +

+

+ 4. log out of jira (if you are using Remember me feature) and test your setup by going to url like this one:

[JIRA URL]/secure/IssueNavigator.jspa?view=rss&pid=[JIRA PROJECT ID]&sorter/field=issuekey&sorter/order=DESC&sorter/field=status&sorter/order=DESC&tempMax=1000&reset=true @@ -48,13 +51,27 @@ http://jira.codehaus.org/secure/IssueNavigator.jspa?view=rss&pid=10450&sorter/field=issuekey&sorter/order=DESC&sorter/field=status&sorter/order=DESC&tempMax=1000&reset=true

- 4. add this to your project.xml in reports section + 5. add this to your project.xml in reports section

<report>maven-jira-plugin</report>

- 5. run site:generate and you should have jira.html in your ${basedir}/target/docs directory + 6. run maven site (or just maven maven-jira-plugin:report xdoc) and you should have jira.html in your ${basedir}/target/docs directory

+ + + + My JIRA installation runs SSL with a self signed/home brewn certificate. + I get an error message that the certificate is untrusted. How do I proceed? + + +

+ Add the server certificate to your JAVA. You can get the certificate by exporting it from your browser. + With IE you click on the certificate info, go to the details TAB and export as .DER by clicking on 'Copy to File...'. + Using SUN's keytool you can import the certificate in your 'truststore'. It is located in $JAVA_HOME/jre/lib/security/cacerts + Import it using keytool -import -file <servercert>.cer -keystore cacerts +

+ \ No newline at end of file Index: D:/eclipse/workspace/zilverline/jira/xdocs/goals.xml =================================================================== --- D:/eclipse/workspace/zilverline/jira/xdocs/goals.xml (revision 231063) +++ D:/eclipse/workspace/zilverline/jira/xdocs/goals.xml (working copy) @@ -25,17 +25,17 @@ maven-jira-plugin:deregister - + The standard goal name for report plugins to register themselves with the site plugin. maven-jira-plugin:register - + The standard goal name for report plugins to deregister themselves from the site. maven-jira-plugin:report - Generate report with all entries defined in Jira. + Generate report for entries defined in Jira. Index: D:/eclipse/workspace/zilverline/jira/xdocs/properties.xml =================================================================== --- D:/eclipse/workspace/zilverline/jira/xdocs/properties.xml (revision 231063) +++ D:/eclipse/workspace/zilverline/jira/xdocs/properties.xml (working copy) @@ -1,45 +0,0 @@ - - - - - - Maven JIRA Plug-in Properties - - -
- - - - - - - - - - - -
PropertyOptional?Description
maven.jira.nbentriesYes -

- Defines the number of entries we want to obtain into the report. - Default value is 1000. -

-
-
- - \ No newline at end of file Index: D:/eclipse/workspace/zilverline/jira/project.properties =================================================================== --- D:/eclipse/workspace/zilverline/jira/project.properties (revision 231063) +++ D:/eclipse/workspace/zilverline/jira/project.properties (working copy) @@ -17,3 +17,13 @@ # ------------------------------------------------------------------- # P R O J E C T P R O P E R T I E S # ------------------------------------------------------------------- +maven.xdoc.date=navigation-top +maven.xdoc.date.format=HH:mm, dd MMMM yyyy +maven.changelog.factory = org.apache.maven.svnlib.SvnChangeLogFactory +maven.changelog.range=500 +maven.checkstyle.properties=${basedir}/checkstyle.xml + +maven.jira.webUser= +maven.jira.webPassword= +maven.jira.jiraUser= +maven.jira.jiraPassword= Index: D:/eclipse/workspace/zilverline/jira/maven.xml =================================================================== --- D:/eclipse/workspace/zilverline/jira/maven.xml (revision 231063) +++ D:/eclipse/workspace/zilverline/jira/maven.xml (working copy) @@ -16,5 +16,7 @@ */ --> - + + + Index: D:/eclipse/workspace/zilverline/jira/project.xml =================================================================== --- D:/eclipse/workspace/zilverline/jira/project.xml (revision 231063) +++ D:/eclipse/workspace/zilverline/jira/project.xml (working copy) @@ -19,15 +19,14 @@ --> - ../plugin-parent/project.xml 3 maven-jira-plugin Maven JIRA Plug-in - 1.1.3-SNAPSHOT - This plugin download issues from Jira and create a report. - Download issue from Jira + 1.2 + This plugin downloads issues from Jira and creates a report. + Download issues from Jira http://maven.apache.org/reference/plugins/jira/ - http://jira.codehaus.org/browse/MPJIRA + http://jira.codehaus.org/secure/IssueNavigator.jspa?id=10450 /www/maven.apache.org/reference/plugins/jira/ scm:svn:http://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk/jira/ @@ -36,24 +35,42 @@ - + + + maven + maven-pmd-plugin + 1.7 + plugin + + + maven-plugins + maven-findbugs-plugin + 0.9.1 + plugin + + + maven-plugins + maven-javancss-plugin + 1.3 + plugin + + commons-httpclient commons-httpclient - 2.0 + 2.0.2 commons-jelly commons-jelly - 1.0-beta-4 + 1.0 commons-logging commons-logging - 1.0.3 + 1.0.4 - log4j log4j 1.2.8 @@ -61,7 +78,7 @@ maven maven - 1.0-rc1 + 1.0.2 @@ -86,4 +103,52 @@ MAVEN_JIRA_1_1_2 + + + src/main + + test/main + + + **/*Test.java + + + + + + + src/main + + **/*.properties + + + + ${basedir}/src/plugin-resources + plugin-resources + + + ${basedir} + + plugin.jelly + plugin.properties + project.properties + project.xml + + + + + + maven-changelog-plugin + maven-developer-activity-plugin + maven-file-activity-plugin + maven-javadoc-plugin + maven-javancss-plugin + maven-jxr-plugin + maven-checkstyle-plugin + maven-pmd-plugin + maven-findbugs-plugin + maven-jdepend-plugin + maven-simian-plugin + maven-jira-plugin + Index: D:/eclipse/workspace/zilverline/jira/src/main/org/apache/maven/jira/JiraDownloader.java =================================================================== --- D:/eclipse/workspace/zilverline/jira/src/main/org/apache/maven/jira/JiraDownloader.java (revision 231063) +++ D:/eclipse/workspace/zilverline/jira/src/main/org/apache/maven/jira/JiraDownloader.java (working copy) @@ -17,6 +17,13 @@ * ==================================================================== */ +import java.io.File; +import java.io.FileWriter; +import java.io.PrintWriter; +import java.util.HashMap; +import java.util.Map; + +import org.apache.commons.httpclient.Credentials; import org.apache.commons.httpclient.Header; import org.apache.commons.httpclient.HostConfiguration; import org.apache.commons.httpclient.HttpClient; @@ -25,176 +32,437 @@ import org.apache.commons.httpclient.StatusLine; import org.apache.commons.httpclient.UsernamePasswordCredentials; import org.apache.commons.httpclient.methods.GetMethod; - import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; - import org.apache.maven.jelly.MavenJellyContext; import org.apache.maven.project.Project; -import java.io.File; -import java.io.FileWriter; -import java.io.PrintWriter; - -public class JiraDownloader -{ +/** + * Gets relevant issues in RSS from a given JIRA installation. + * + * Based on version 1.1.2 and patch by Dr. Spock (MPJIRA-8) + * @author mfranken@xebia.com + */ +public final class JiraDownloader { /** - * Log for debug output + * Log for debug output. */ - private static Log LOG = LogFactory.getLog(JiraDownloader.class); - - /** Output file for xml document */ + private static Log log = LogFactory.getLog(JiraDownloader.class); + + /** Output file for xml document. */ private File output; - - /** Number of entries max */ - private int nbEntriesMax; - + + /** Number of entries max. */ + private int maxIssues; + + /** The filter to apply to query to JIRA. */ + private String filter; + + /** Ids of status to show, as comma separated string. */ + private String statusIds; + + /** Ids of resolution to show, as comma separated string. */ + private String resolutionIds; + + /** Ids of priority to show, as comma separated string. */ + private String priorityIds; + + /** The component to show. */ + private String component; + + /** The username to log into JIRA. */ + private String jiraUser; + + /** The password to log into JIRA. */ + private String jiraPassword; + + /** The username to log into webserver. */ + private String webUser; + + /** The password to log into webserver. */ + private String webPassword; + + /** The maven project. */ private Project project; - - /** - * Set the output file for the log. - * @param output the output file - */ - public void setOutput(File output) - { - this.output = output; + + /** Mapping containing all JIRA status values. */ + private static Map statusMap = new HashMap(); + + /** Mapping containing all JIRA resolution values. */ + private static Map resolutionMap = new HashMap(); + + /** Mapping containing all JIRA priority values. */ + private static Map priorityMap = new HashMap(); + + static { + statusMap.put("Open", "1"); + statusMap.put("In Progress", "3"); + statusMap.put("Reopened", "4"); + statusMap.put("Resolved", "5"); + statusMap.put("Closed", "6"); + + resolutionMap.put("Unresolved", "-1"); + resolutionMap.put("Fixed", "1"); + resolutionMap.put("Won't Fix", "2"); + resolutionMap.put("Duplicate", "3"); + resolutionMap.put("Incomplete", "4"); + resolutionMap.put("Cannot Reproduce", "5"); + + priorityMap.put("Blocker", "1"); + priorityMap.put("Critical", "2"); + priorityMap.put("Major", "3"); + priorityMap.put("Minor", "4"); + priorityMap.put("Trivial", "5"); } - + /** - * @return Project + * Creates a filter given the maven.jira parameters and some defaults. + * + * @return request parameters to be added to URL used for downloading the JIRA issues */ - public Object getProject() - { - return project; + private String createFilter() { + if (this.filter != null && this.filter.length() > 0) { + if (this.filter.charAt(0) == '&') { + return this.filter.substring(1); + } + return this.filter; + } + + StringBuffer localFilter = new StringBuffer(); + // get the Status Ids + if (statusIds != null) { + String[] stats = statusIds.split(","); + for (int i = 0; i < stats.length; i++) { + String statusParam = (String) statusMap.get(stats[i]); + if (statusParam != null) { + localFilter.append("&statusIds=" + statusParam); + } + } + } + // get the Priority Ids + if (priorityIds != null) { + String[] prios = priorityIds.split(","); + for (int i = 0; i < prios.length; i++) { + String priorityParam = (String) priorityMap.get(prios[i]); + if (priorityParam != null) { + localFilter.append("&priorityIds=" + priorityParam); + } + } + } + if (resolutionIds != null) { + // get the Resolution Ids + String[] resos = resolutionIds.split(","); + for (int i = 0; i < resos.length; i++) { + String resoParam = (String) resolutionMap.get(resos[i]); + if (resoParam != null) { + localFilter.append("&resolutionIds=" + resoParam); + } + } + } + // add all components + if (component != null) { + String[] components = component.split(","); + for (int i = 0; i < components.length; i++) { + if (components[i].length() > 0) { + localFilter.append("&component=" + components[i]); + } + } + } + + // add default sorting (by priority and then creation date) + String sort = "&sorter/field=created&sorter/order=DESC" + "&sorter/field=priority&sorter/order=DESC"; + return localFilter + sort; } /** - * Sets the project. - * @param project The project to set + * Execute the query on the JIRA server. + * + * @throws Exception + * on error */ - public void setProject(Object project) - { - //System.out.println("Setting project: " + project); - this.project = (Project) project; - } - - /** - * Sets the number of entries. - * @param nbEntries The number of entries - */ - public void setNbEntries(int nbEntries) - { - nbEntriesMax = nbEntries; - } - - public void doExecute() throws Exception - { - MavenJellyContext ctx; - String proxyHost; - String proxyPort; - String proxyUser; - String proxyPass; - String link; - - if (getProject() == null) - { + public void doExecute() throws Exception { + if (project == null) { throw new Exception("No project set."); - } - else - { - if (((Project) getProject()).getIssueTrackingUrl() == null) - { + } else { + if (project.getIssueTrackingUrl() == null) { throw new Exception("No issue tracking url set."); } - else - { - String url = ((Project) getProject()).getIssueTrackingUrl(); - int pos = url.indexOf("?"); - String id = url.substring(pos+4); - url = url.substring(0, url.lastIndexOf("/")); - link = url + "/secure/IssueNavigator.jspa?view=rss&pid=" + id + "&sorter/field=issuekey&sorter/order=DESC&sorter/field=status&sorter/order=DESC&tempMax=" + String.valueOf(nbEntriesMax) + "&reset=true&decorator=none"; - } } - - ctx = ((Project) getProject()).getContext(); - - proxyHost = ctx.getProxyHost(); - proxyPort = ctx.getProxyPort(); - proxyUser = ctx.getProxyUserName(); - proxyPass = ctx.getProxyPassword(); - - try - { + + try { HttpClient cl = new HttpClient(); + HttpState state = new HttpState(); HostConfiguration hc = new HostConfiguration(); + cl.setHostConfiguration(hc); + cl.setState(state); - if (proxyHost != null) - { - hc.setProxy(proxyHost, Integer.parseInt(proxyPort)); + determineProxy(cl); + // get the Jira URL and project id + String url = project.getIssueTrackingUrl(); + // chop off the parameter part + int pos = url.indexOf("?"); + // and get the id while we're at it + String id = ""; + if (pos >= 0) { + // url + id = url.substring(url.lastIndexOf("=") + 1); } - HttpState state = new HttpState(); - - if (proxyUser != null && proxyPass != null) - { - state.setProxyCredentials(null, null, new UsernamePasswordCredentials(proxyUser, proxyPass)); + String jiraUrl = url.substring(0, url.lastIndexOf("/")); + if (jiraUrl.endsWith("secure")) { + jiraUrl = jiraUrl.substring(0, jiraUrl.lastIndexOf("/")); } + log.info("Jira lives at: " + jiraUrl); + doAuthentication(cl, jiraUrl); - cl.setHostConfiguration(hc); - cl.setState(state); - + // create the URL for getting the proper iussues from JIRA + String fullURL = jiraUrl + "/secure/IssueNavigator.jspa?view=rss&pid=" + id; + fullURL += createFilter(); + fullURL += "&tempMax=" + maxIssues + "&reset=true&decorator=none"; + // execute the GET - GetMethod gm = download(cl, link); - StatusLine sl = gm.getStatusLine(); - - if (sl == null) { - LOG.info("Unknown error validating link : " + link); - return; - } - - if (gm.getStatusCode() == HttpStatus.SC_MOVED_TEMPORARILY) - { - Header locationHeader = gm.getResponseHeader("Location"); - if (locationHeader == null) { - LOG.info("Site sent redirect, but did not set Location header"); - } else { - String newLink = locationHeader.getValue(); - LOG.debug("Following 1 redirect to " + newLink); - gm = download(cl, newLink); + download(cl, fullURL); + } catch (Exception e) { + log.error("Error accessing " + project.getIssueTrackingUrl(), e); + } + } + + /** + * Authenticate against webserver and into JIRA if we have to. + * + * @param client + * the HttpClient + * @param jiraUrl + * the JIRA installation + */ + private void doAuthentication(HttpClient client, final String jiraUrl) { + // check and prepare for basic authentication + if (webUser != null && webUser.length() > 0) { + client.getState().setAuthenticationPreemptive(true); + Credentials defaultcreds = new UsernamePasswordCredentials(webUser, webPassword); + log.info("Using username: " + webUser + " for Basic Authentication against the webserver at " + jiraUrl); + client.getState().setCredentials(null, null, defaultcreds); + } + + // log into JIRA if we have to + String loginUrl = null; + if (jiraUser != null && jiraUser.length() > 0 && jiraPassword != null) { + StringBuffer loginLink = new StringBuffer(jiraUrl); + loginLink.append("/login.jsp?os_destination=/secure/"); + loginLink.append("&os_username=").append(jiraUser); + log.info("Login URL: " + loginLink + "&os_password=*******"); + loginLink.append("&os_password=").append(jiraPassword); + loginUrl = loginLink.toString(); + } + + // execute the login + if (loginUrl != null) { + GetMethod loginGet = new GetMethod(loginUrl); + try { + client.executeMethod(loginGet); + log.info("Succesfully logged in into JIRA."); + } catch (Exception e) { + if (log.isDebugEnabled()) { + log.error("Error trying to login into JIRA:", e); + } else { + log.error("Error trying to login into JIRA. Cause is: " + e.getLocalizedMessage()); } + // continue any way, probably will fail later if authentication was necesaaray afterall } + } + } - if (gm.getStatusCode() != HttpStatus.SC_OK) - { - String msg = "Received: [" + gm.getStatusCode() + "] for " + link; - LOG.info(msg); - System.out.println(msg); + /** + * Setup proxy access if we have to. + * + * @param client + * the HttpClient + */ + private void determineProxy(HttpClient client) { + // see whether there is any proxy defined in maven + MavenJellyContext ctx = project.getContext(); + if (ctx == null) { + log.error("Maven project has no context. No proxy info available."); + return; + } + String proxyHost = ctx.getProxyHost(); + + if (proxyHost != null) { + String proxyPort = ctx.getProxyPort(); + client.getHostConfiguration().setProxy(proxyHost, Integer.parseInt(proxyPort)); + log.info("Using proxy: " + proxyHost + " at port " + proxyPort); + String proxyUser = ctx.getProxyUserName(); + if (proxyUser != null) { + log.info("Using proxy user: " + proxyUser); + String proxyPass = ctx.getProxyPassword(); + client.getState().setProxyCredentials(null, null, new UsernamePasswordCredentials(proxyUser, proxyPass)); } - } - catch (Exception e) - { - LOG.warn("Error accessing " + link); - e.printStackTrace(); - } } - - private GetMethod download(HttpClient cl, String link) - { + + /** + * Downloads the given link using the configured HttpClient, possibly following redirects. + * + * @param cl + * the HttpClient + * @param link + * the JiraUrl + * @return + */ + private void download(final HttpClient cl, final String link) { GetMethod gm = new GetMethod(link); - try - { - System.out.println("Downloading " + link); + try { + log.info("Downloading " + link); gm.setFollowRedirects(true); cl.executeMethod(gm); final String strGetResponseBody = gm.getResponseBodyAsString(); + // write the reponse to file PrintWriter pw = new PrintWriter(new FileWriter(output)); pw.print(strGetResponseBody); pw.close(); + StatusLine sl = gm.getStatusLine(); + if (sl == null) { + log.info("Unknown error validating link : " + link); + return; + } + + // if we get a redirect, do so + if (gm.getStatusCode() == HttpStatus.SC_MOVED_TEMPORARILY) { + Header locationHeader = gm.getResponseHeader("Location"); + if (locationHeader == null) { + log.info("Site sent redirect, but did not set Location header"); + } else { + String newLink = locationHeader.getValue(); + log.debug("Following redirect to " + newLink); + download(cl, newLink); + } + } + + if (gm.getStatusCode() != HttpStatus.SC_OK) { + log.warn("Received: [" + gm.getStatusCode() + "]"); + } + } catch (Exception e) { + log.error("Error downloading " + link, e); } - catch (Exception e) - { - System.out.println("Error downloading " + link); - } - return gm; } + + /** + * Set the output file for the log. + * + * @param thisOutput + * the output file + */ + public void setOutput(final File thisOutput) { + this.output = thisOutput; + } + + /** + * Sets the project. + * + * @param thisProject + * The project to set + */ + public void setProject(final Object thisProject) { + this.project = (Project) thisProject; + } + + /** + * Sets the maximum number of Issues to show. + * + * @param theseMaxIssues + * The maximum number of Issues + */ + public void setMaxIssues(final int theseMaxIssues) { + maxIssues = theseMaxIssues; + } + + /** + * Sets the statusIds. + * + * @param thisStatusIds + * The id(s) of the status to show, as comma separated string + */ + public void setStatusIds(final String thisStatusIds) { + statusIds = thisStatusIds; + } + + /** + * Sets the priorityIds. + * + * @param thisPriorityIds + * The id(s) of the priority to show, as comma separated string + */ + public void setPriorityIds(final String thisPriorityIds) { + priorityIds = thisPriorityIds; + } + + /** + * Sets the resolutionIds. + * + * @param thisResolutionIds + * The id(s) of the resolution to show, as comma separated string + */ + public void setResolutionIds(final String thisResolutionIds) { + resolutionIds = thisResolutionIds; + } + + /** + * Sets the password for authentication against the webserver. + * + * @param thisWebPassword + * The password of the webserver + */ + public void setWebPassword(final String thisWebPassword) { + this.webPassword = thisWebPassword; + } + + /** + * Sets the username for authentication against the webserver. + * + * @param thisWebUser + * The username of the webserver + */ + public void setWebUser(final String thisWebUser) { + this.webUser = thisWebUser; + } + + /** + * Sets the password to log into a secured JIRA. + * + * @param thisJiraPassword + * The password for JIRA + */ + public void setJiraPassword(final String thisJiraPassword) { + this.jiraPassword = thisJiraPassword; + } + + /** + * Sets the username to log into a secured JIRA. + * + * @param thisJiraUser + * The username for JIRA + */ + public void setJiraUser(final String thisJiraUser) { + this.jiraUser = thisJiraUser; + } + + /** + * Sets the filter to apply to query to JIRA. + * + * @param thisFilter + * The filter to query JIRA + */ + public void setFilter(final String thisFilter) { + this.filter = thisFilter; + } + + /** + * Sets the component(s) to apply to query JIRA. + * + * @param theseComponents + * The id(s) of components to show, as comma separated string + */ + public void setComponent(final String theseComponents) { + this.component = theseComponents; + } + } Index: D:/eclipse/workspace/zilverline/jira/src/plugin-resources/jira.jsl =================================================================== --- D:/eclipse/workspace/zilverline/jira/src/plugin-resources/jira.jsl (revision 231063) +++ D:/eclipse/workspace/zilverline/jira/src/plugin-resources/jira.jsl (working copy) @@ -42,22 +42,30 @@ Key Summary - Status - Resolution - By + Created + Priority + Status + Resolution + Assigned to + Reported by + + + ${key} ${summary} + ${createdate} + ${priority} @@ -82,6 +90,7 @@ ${resolution} ${assignee} + ${reporter} Index: D:/eclipse/workspace/zilverline/jira/plugin.properties =================================================================== --- D:/eclipse/workspace/zilverline/jira/plugin.properties (revision 231063) +++ D:/eclipse/workspace/zilverline/jira/plugin.properties (working copy) @@ -17,4 +17,13 @@ # ------------------------------------------------------------------- # P L U G I N P R O P E R I E S # ------------------------------------------------------------------- -maven.jira.nbentries=1000 +maven.jira.webUser= +maven.jira.webPassword= +maven.jira.jiraUser= +maven.jira.jiraPassword= +maven.jira.maxIssues=1000 +maven.jira.filter= +maven.jira.status=Open,In Progress,Reopened +maven.jira.resolution=Unresolved +maven.jira.priority= +maven.jira.component= Index: D:/eclipse/workspace/zilverline/jira/plugin.jelly =================================================================== --- D:/eclipse/workspace/zilverline/jira/plugin.jelly (revision 231063) +++ D:/eclipse/workspace/zilverline/jira/plugin.jelly (working copy) @@ -53,9 +53,19 @@ +