org.apache.maven.plugins.changes.issues.IssueUtils Maven / Gradle / Ivy

Go to download
/*
 * 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.
 */
package org.apache.maven.plugins.changes.issues;

import java.util.ArrayList;
import java.util.List;

import org.apache.maven.plugin.MojoExecutionException;

/**
 * A utility class for working with issue objects.
 *
 * @author Dennis Lundberg
 * @version $Id$
 * @since 2.4
 */
public class IssueUtils {
    public static final String SNAPSHOT_SUFFIX = "-SNAPSHOT";

    /**
     * Find the issues that has a Fix Version that matches the supplied prefix.
     *
     * @param issues A list of issues
     * @param prefix The prefix of the "Fix Version" that should match
     * @return A List of issues fixed in versions that match the supplied prefix
     * @throws org.apache.maven.plugin.MojoExecutionException If no issues could be found for the supplied prefix
     */
    public static List filterIssuesWithVersionPrefix(List issues, String prefix)
            throws MojoExecutionException {
        List filteredIssues = new ArrayList<>();
        boolean isFound = false;
        Issue issue;

        for (Issue issue1 : issues) {
            issue = issue1;

            if (issue.getFixVersions() != null) {
                for (String fixVersion : issue.getFixVersions()) {
                    if (prefix == null || fixVersion.startsWith(prefix)) {
                        isFound = true;
                        filteredIssues.add(issue);
                        break;
                    }
                }
            }
        }

        if (!isFound) {
            throw new MojoExecutionException("Couldn't find any issues with a Fix Version prefix of '" + prefix
                    + "' among the supplied issues: " + toString(issues));
        }
        return filteredIssues;
    }

    /**
     * Find the issues for the supplied version, by matching the "Fix for" version in the supplied list of issues
     * with the supplied version. If the supplied version is a SNAPSHOT, then that part of the version will be removed
     * prior to the matching.
     *
     * @param issues a list of issues
     * @param version the version that issues should be returned for
     * @return a List of issues for the supplied version, possibly empty if there are no issues
     */
    public static List getIssuesForVersion(List issues, String version) {
        List issuesForVersion = new ArrayList<>();
        String releaseVersion = version;

        // Remove "-SNAPSHOT" from the end of the version, if it's there
        if (version != null && version.endsWith(SNAPSHOT_SUFFIX)) {
            releaseVersion = version.substring(0, version.length() - SNAPSHOT_SUFFIX.length());
        }

        for (Issue issue : issues) {
            if (issue.getFixVersions() != null && issue.getFixVersions().contains(releaseVersion)) {
                issuesForVersion.add(issue);
            }
        }

        return issuesForVersion;
    }

    public static String toString(List issues) {
        List issueStrings = new ArrayList<>(issues.size());
        for (Issue issue : issues) {
            issueStrings.add(issue.toString());
        }
        return issueStrings.toString();
    }
}