com.atlassian.maven.plugins.ListDependenciesArtifactsMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smartass-maven-plugin Show documentation
Maven Smart Assembly Plugin
The newest version!
/*
 * Copyright © 2022 Atlassian Pty Ltd. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.atlassian.maven.plugins;

import com.google.common.annotations.VisibleForTesting;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.resolver.ArtifactResolver;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectHelper;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.List;

/**
 * List dependencies as gavpc MOJO.
 */
@Mojo(name = "generate-artifact-list")
public class ListDependenciesArtifactsMojo extends DependencyInspectingMojo {

    /**
     * Whether or not to attach the output file to the reactor's artifacts
     * and install/deploy.
     */
    @Parameter(defaultValue = "false")
    private String attach;
    /**
     * The name of the output file that this MOJO will create.
     */
    @Parameter(defaultValue = "${project.build.finalName}.artifacts.txt")
    private String listFileName;

    public ListDependenciesArtifactsMojo() {
        //used by Maven and Plexus
    }

    @VisibleForTesting
    ListDependenciesArtifactsMojo(ArtifactResolver artifactResolver, String excludeArtifactIds,
                                  String includeScope, ArtifactRepository localRepository, MavenProject project,
                                  MavenProjectHelper projectHelper, List remoteRepositories,
                                  String attach, String listFileName) {
        //used by tests
        super(artifactResolver, excludeArtifactIds, includeScope, localRepository, project, projectHelper, remoteRepositories);
        this.attach = attach;
        this.listFileName = listFileName;
    }

    @Override
    public void execute() throws MojoFailureException {
        ArtifactUtil artifactUtil = new ArtifactUtil();
        List allArtifacts = resolveAllArtifacts();
        File listFile = new File(project.getBuild().getOutputDirectory(), listFileName);
        listFile.getParentFile().mkdirs();
        try (BufferedWriter writer = new BufferedWriter(new FileWriter(listFile))) {
            for (Artifact artifact : allArtifacts) {
                writer.write(artifactUtil.toString(artifact));
                writer.newLine();
            }
        } catch (IOException e) {
            throw new MojoFailureException("Failed to list dependencies", e);
        }

        if (Boolean.parseBoolean(attach) && listFile.isFile()) {
            projectHelper.attachArtifact(project, "txt", null, listFile);
        }
    }
}