core-it-support/core-it-plugins/maven-it-plugin-dependency-resolution/src/main/java/org/apache/maven/plugin/coreit/CompileRuntimeMojo.java

/*
 * 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.plugin.coreit;

import org.apache.maven.artifact.DependencyResolutionRequiredException;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;

/**
 * Creates text files that list the dependencies with scope compile and runtime in the order returned from the Maven
 * core. The path parameters of this mojo support the token <code>&#64;idx&#64;</code> to dynamically insert a running
 * index in order to distinguish multiple executions of the same mojo.
 *
 * @author Benjamin Bentmann
 *
 */
@Mojo(name = "compile-runtime", requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME)
public class CompileRuntimeMojo extends AbstractDependencyMojo {

    /**
     * The path to the output file for the project artifacts, relative to the project base directory. Each line of this
     * UTF-8 encoded file specifies an artifact identifier. If not specified, the artifact list will not be written to
     * disk. Unlike the compile artifacts, the collection of project artifacts additionally contains those artifacts
     * that do not contribute to the class path.
     */
    @Parameter(property = "depres.projectArtifacts")
    private String projectArtifacts;

    /**
     * The path to the output file for the compile artifacts, relative to the project base directory. Each line of this
     * UTF-8 encoded file specifies an artifact identifier. If not specified, the artifact list will not be written to
     * disk.
     */
    @Parameter(property = "depres.compileArtifacts")
    private String compileArtifacts;

    /**
     * The path to the output file for the compile class path, relative to the project base directory. Each line of
     * this UTF-8 encoded file specifies the absolute path to a class path element. If not specified, the class path
     * will not be written to disk.
     */
    @Parameter(property = "depres.compileClassPath")
    private String compileClassPath;

    /**
     * The path to the properties file for the checksums of the compile class path elements, relative to the project
     * base directory. The (trimmed) path to a JAR is used as the property key, the property value is the SHA-1 hash of
     * the JAR. If not specified, the class path checksums will not be calculated.
     */
    @Parameter(property = "depres.compileClassPathChecksums")
    private String compileClassPathChecksums;

    /**
     * The path to the output file for the runtime artifacts, relative to the project base directory. Each line of this
     * UTF-8 encoded file specifies an artifact identifier. If not specified, the artifact list will not be written to
     * disk.
     */
    @Parameter(property = "depres.runtimeArtifacts")
    private String runtimeArtifacts;

    /**
     * The path to the output file for the runtime class path, relative to the project base directory. Each line of
     * this UTF-8 encoded file specifies the absolute path to a class path element. If not specified, the class path
     * will not be written to disk.
     */
    @Parameter(property = "depres.runtimeClassPath")
    private String runtimeClassPath;

    /**
     * The path to the properties file for the checksums of the runtime class path elements, relative to the project
     * base directory. The (trimmed) path to a JAR is used as the property key, the property value is the SHA-1 hash of
     * the JAR. If not specified, the class path checksums will not be calculated.
     */
    @Parameter(property = "depres.runtimeClassPathChecksums")
    private String runtimeClassPathChecksums;

    /**
     * Runs this mojo.
     *
     * @throws MojoExecutionException If the output file could not be created or any dependency could not be resolved.
     */
    public void execute() throws MojoExecutionException {
        try {
            writeArtifacts(projectArtifacts, project.getArtifacts());
            writeArtifacts(compileArtifacts, project.getCompileArtifacts());
            writeClassPath(compileClassPath, project.getCompileClasspathElements());
            writeClassPathChecksums(compileClassPathChecksums, project.getCompileClasspathElements());
            writeArtifacts(runtimeArtifacts, project.getRuntimeArtifacts());
            writeClassPath(runtimeClassPath, project.getRuntimeClasspathElements());
            writeClassPathChecksums(runtimeClassPathChecksums, project.getRuntimeClasspathElements());
        } catch (DependencyResolutionRequiredException e) {
            throw new MojoExecutionException("Failed to resolve dependencies", e);
        }
    }
}