TracMojo.java
package org.apache.maven.plugins.trac;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.net.MalformedURLException;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.changes.AbstractChangesReport;
import org.apache.maven.plugins.changes.ProjectUtils;
import org.apache.maven.plugins.issues.Issue;
import org.apache.maven.plugins.issues.IssuesReportGenerator;
import org.apache.maven.plugins.issues.IssuesReportHelper;
import org.apache.maven.reporting.MavenReportException;
import org.apache.xmlrpc.XmlRpcException;
/**
* Goal which downloads issues from the Issue Tracking System and generates a report.
*
* @author Noriko Kinugasa
* @version $Id$
* @since 2.1
*/
@Mojo( name = "trac-report", threadSafe = true )
public class TracMojo
extends AbstractChangesReport
{
/**
* Deprecated Trac columns.
*/
private static final Map<String, Integer> DEPRECATED_TRAC_COLUMNS = new HashMap<String, Integer>();
/**
* Valid Trac columns.
*/
private static final Map<String, Integer> TRAC_COLUMNS = new HashMap<String, Integer>();
static
{
DEPRECATED_TRAC_COLUMNS.put( "changed", IssuesReportHelper.COLUMN_UPDATED );
DEPRECATED_TRAC_COLUMNS.put( "component", IssuesReportHelper.COLUMN_COMPONENT );
DEPRECATED_TRAC_COLUMNS.put( "created", IssuesReportHelper.COLUMN_CREATED );
DEPRECATED_TRAC_COLUMNS.put( "id", IssuesReportHelper.COLUMN_ID );
DEPRECATED_TRAC_COLUMNS.put( "milestone", IssuesReportHelper.COLUMN_FIX_VERSION );
DEPRECATED_TRAC_COLUMNS.put( "owner", IssuesReportHelper.COLUMN_ASSIGNEE );
DEPRECATED_TRAC_COLUMNS.put( "priority", IssuesReportHelper.COLUMN_PRIORITY );
DEPRECATED_TRAC_COLUMNS.put( "reporter", IssuesReportHelper.COLUMN_REPORTER );
DEPRECATED_TRAC_COLUMNS.put( "resolution", IssuesReportHelper.COLUMN_RESOLUTION );
DEPRECATED_TRAC_COLUMNS.put( "status", IssuesReportHelper.COLUMN_STATUS );
DEPRECATED_TRAC_COLUMNS.put( "summary", IssuesReportHelper.COLUMN_SUMMARY );
DEPRECATED_TRAC_COLUMNS.put( "type", IssuesReportHelper.COLUMN_TYPE );
TRAC_COLUMNS.put( "Assignee", IssuesReportHelper.COLUMN_ASSIGNEE );
TRAC_COLUMNS.put( "Component", IssuesReportHelper.COLUMN_COMPONENT );
TRAC_COLUMNS.put( "Created", IssuesReportHelper.COLUMN_CREATED );
TRAC_COLUMNS.put( "Fix Version", IssuesReportHelper.COLUMN_FIX_VERSION );
TRAC_COLUMNS.put( "Id", IssuesReportHelper.COLUMN_ID );
TRAC_COLUMNS.put( "Priority", IssuesReportHelper.COLUMN_PRIORITY );
TRAC_COLUMNS.put( "Reporter", IssuesReportHelper.COLUMN_REPORTER );
TRAC_COLUMNS.put( "Resolution", IssuesReportHelper.COLUMN_RESOLUTION );
TRAC_COLUMNS.put( "Status", IssuesReportHelper.COLUMN_STATUS );
TRAC_COLUMNS.put( "Summary", IssuesReportHelper.COLUMN_SUMMARY );
TRAC_COLUMNS.put( "Type", IssuesReportHelper.COLUMN_TYPE );
TRAC_COLUMNS.put( "Updated", IssuesReportHelper.COLUMN_UPDATED );
}
/**
* Sets the column names that you want to show in the report. The columns will appear in the report in the same
* order as you specify them here. Multiple values can be separated by commas.
* <p>
* Valid columns are: <code>Assignee</code>, <code>Component</code>, <code>Created</code>, <code>Fix Version</code>,
* <code>Id</code>, <code>Priority</code>, <code>Reporter</code>, <code>Resolution</code>, <code>Status</code>,
* <code>Summary</code>, <code>Type</code> and <code>Updated</code>.
* </p>
*
* @since 2.2
*/
@Parameter( defaultValue = "Id,Type,Summary,Assignee,Reporter,Priority,Status,Resolution,Created,Updated" )
private String columnNames;
/**
* Defines the Trac query for searching ticket.
*/
@Parameter( defaultValue = "order=id" )
private String query;
/**
* Defines the Trac password for authentication into a private Trac installation.
*/
@Parameter( defaultValue = "" )
private String tracPassword;
/**
* Defines the Trac username for authentication into a private Trac installation.
*/
@Parameter( defaultValue = "" )
private String tracUser;
/* --------------------------------------------------------------------- */
/* Public methods */
/* --------------------------------------------------------------------- */
/**
* @see org.apache.maven.reporting.AbstractMavenReport#canGenerateReport()
*/
public boolean canGenerateReport()
{
// Run only at the execution root
if ( runOnlyAtExecutionRoot && !isThisTheExecutionRoot() )
{
getLog().info( "Skipping the Trac Report in this project because it's not the Execution Root" );
return false;
}
String message = ProjectUtils.validateIssueManagement( project, "Trac", "Trac Report" );
if ( message != null )
{
getLog().warn( message );
}
return message == null;
}
public void executeReport( Locale locale )
throws MavenReportException
{
// Validate parameters
List<Integer> columnIds =
IssuesReportHelper.getColumnIds( columnNames, TRAC_COLUMNS, DEPRECATED_TRAC_COLUMNS, getLog() );
if ( columnIds.size() == 0 )
{
// This can happen if the user has configured column names and they are all invalid
throw new MavenReportException( "maven-changes-plugin: None of the configured columnNames '" + columnNames
+ "' are valid." );
}
try
{
// Download issues
TracDownloader issueDownloader = new TracDownloader();
configureIssueDownloader( issueDownloader );
List<Issue> issueList = issueDownloader.getIssueList();
// Generate the report
IssuesReportGenerator report = new IssuesReportGenerator( IssuesReportHelper.toIntArray( columnIds ) );
if ( issueList.isEmpty() )
{
report.doGenerateEmptyReport( getBundle( locale ), getSink() );
getLog().warn( "No ticket has matched." );
}
else
{
report.doGenerateReport( getBundle( locale ), getSink(), issueList );
}
}
catch ( MalformedURLException e )
{
// Rethrow this error so that the build fails
throw new MavenReportException( "The Trac URL is incorrect." );
}
catch ( XmlRpcException e )
{
// Rethrow this error so that the build fails
throw new MavenReportException( "XmlRpc Error.", e );
}
catch ( Exception e )
{
e.printStackTrace();
}
}
public String getDescription( Locale locale )
{
return getBundle( locale ).getString( "report.issues.description" );
}
public String getName( Locale locale )
{
return getBundle( locale ).getString( "report.issues.name" );
}
public String getOutputName()
{
return "trac-report";
}
/* --------------------------------------------------------------------- */
/* Private methods */
/* --------------------------------------------------------------------- */
private ResourceBundle getBundle( Locale locale )
{
return ResourceBundle.getBundle( "trac-report", locale, this.getClass().getClassLoader() );
}
private void configureIssueDownloader( TracDownloader issueDownloader )
{
issueDownloader.setProject( project );
issueDownloader.setQuery( query );
issueDownloader.setTracPassword( tracPassword );
issueDownloader.setTracUser( tracUser );
}
}