com.github.lucapino.jira.AbstractJiraMavenReport Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011 Tomasz Maciejewski
 * Copyright 2012 George Gastaldi
 * Copyright 2013-2017 Luca Tagliani
 * 
 * Licensed 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.
 */
package com.github.lucapino.jira;

import com.github.lucapino.jira.helpers.IssuesReportHelper;
import com.github.lucapino.jira.helpers.JiraClient;
import java.util.HashMap;
import java.util.Map;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.settings.Server;
import org.apache.maven.settings.Settings;

/**
 *
 * @author Tagliani
 */
public abstract class AbstractJiraMavenReport extends AbstractMavenReport {

    /**
     * Report output encoding. Note that this parameter is only relevant if the
     * goal is run from the command line or from the default build lifecycle. If
     * the goal is run indirectly as part of a site generation, the output
     * encoding configured in the Maven Site Plugin is used instead.
     */
    @Parameter(defaultValue = "${project.reporting.outputEncoding}", property = "outputEncoding")
    protected String outputEncoding;
    /**
     * Skip plugin execution
     */
    @Parameter(defaultValue = "false")
    public boolean skip;
    /**
     * Max number of issues to return
     */
    @Parameter(defaultValue = "100", required = true)
    int maxIssues = 100;
    /**
     * Server's id in settings.xml to look up username and password.
     */
    @Parameter
    protected String serverId;
    /**
     * JIRA Installation URL. If not informed, it will use the
     * project.issueManagement.url info.
     */
    @Parameter(name = "jira.url", defaultValue = "${project.issueManagement.url}", required = true)
    protected String url;
    /**
     * JIRA Authentication User.
     */
    @Parameter(defaultValue = "${scmUsername}")
    protected String username;
    /**
     * JIRA Authentication Password.
     */
    @Parameter(defaultValue = "${scmPassword}")
    protected String password;
    /**
     * JIRA Project Key.
     */
    @Parameter(required = true)
    protected String jiraProjectKey;
    /**
     * JQL Template to generate release notes. Parameter 0 = Project Key
     * Parameter 1 = Fix version
     */
    @Parameter(defaultValue = "project = ''{0}'' AND status in (Resolved, Closed) AND fixVersion = ''{1}''", required = true)
    protected String jqlTemplate = "project = ''{0}'' AND status in (Resolved, Closed) AND fixVersion = ''{1}''";
    /**
     * Sets the names of the columns that you want 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.
     * 
     * Valid columns are: Assignee, Component,
     * Created, Fix Version, Id,
     * Key, Priority, Reporter,
     * Resolution, Status, Summary,
     * Type, Updated and Version.
     * 
     */
    @Parameter(defaultValue = "Key,Summary,Status,Resolution,Assignee")
    protected String columnNames;

    /**
     * Maven settings
     */
    @Parameter(defaultValue = "${settings}", readonly = true, required = true)
    protected Settings settings;
    /**
     * Released Version
     */
    @Parameter(defaultValue = "${project.version}", required = true)
    public String releaseVersion;

    /**
     * Valid JIRA columns.
     */
    protected static final Map JIRA_COLUMNS = new HashMap(15);

    static {
        JIRA_COLUMNS.put("Assignee", Integer.valueOf(IssuesReportHelper.COLUMN_ASSIGNEE));
        JIRA_COLUMNS.put("Component", Integer.valueOf(IssuesReportHelper.COLUMN_COMPONENT));
        JIRA_COLUMNS.put("Created", Integer.valueOf(IssuesReportHelper.COLUMN_CREATED));
        JIRA_COLUMNS.put("Fix Version", Integer.valueOf(IssuesReportHelper.COLUMN_FIX_VERSION));
        JIRA_COLUMNS.put("Id", Integer.valueOf(IssuesReportHelper.COLUMN_ID));
        JIRA_COLUMNS.put("Key", Integer.valueOf(IssuesReportHelper.COLUMN_KEY));
        JIRA_COLUMNS.put("Priority", Integer.valueOf(IssuesReportHelper.COLUMN_PRIORITY));
        JIRA_COLUMNS.put("Reporter", Integer.valueOf(IssuesReportHelper.COLUMN_REPORTER));
        JIRA_COLUMNS.put("Resolution", Integer.valueOf(IssuesReportHelper.COLUMN_RESOLUTION));
        JIRA_COLUMNS.put("Status", Integer.valueOf(IssuesReportHelper.COLUMN_STATUS));
        JIRA_COLUMNS.put("Summary", Integer.valueOf(IssuesReportHelper.COLUMN_SUMMARY));
        JIRA_COLUMNS.put("Type", Integer.valueOf(IssuesReportHelper.COLUMN_TYPE));
        JIRA_COLUMNS.put("Updated", Integer.valueOf(IssuesReportHelper.COLUMN_UPDATED));
    }

    protected JiraClient client;

    public AbstractJiraMavenReport() {
        loadUserCredentials();
    }

    public JiraClient getClient() throws MojoFailureException {
        if (client == null) {
            getLog().debug("Connecting to JIRA server");
            try {
                client = new JiraClient(username, password, url);
                getLog().info("Successfuly connected to JIRA server");
            } catch (Exception e) {
                getLog().error("Unable to connect to JIRA server", e);
            }
        }
        return client;
    }

    private void loadUserCredentials() {
        if (serverId == null) {
            serverId = url;
        }
        // read credentials from settings.xml if user has not set them in configuration
        if ((username == null || password == null) && settings != null) {
            Server server = settings.getServer(serverId);
            if (server != null) {
                if (username == null) {
                    username = server.getUsername();
                }
                if (password == null) {
                    password = server.getPassword();
                }
            }
        }
    }
}