org.apache.maven.plugins.resources.TestResourcesMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-resources-plugin Show documentation

The Resources Plugin handles the copying of project resources to the output directory. There are two different kinds of resources: main resources and test resources. The difference is that the main resources are the resources associated to the main source code while the test resources are associated to the test source code. Thus, this allows the separation of resources for the main source code and its unit tests.

The newest version!

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

import java.nio.file.Path;
import java.util.List;
import java.util.stream.Collectors;

import org.apache.maven.api.ProjectScope;
import org.apache.maven.api.plugin.MojoException;
import org.apache.maven.api.plugin.annotations.Mojo;
import org.apache.maven.api.plugin.annotations.Parameter;
import org.apache.maven.api.services.ProjectManager;
import org.apache.maven.shared.filtering.Resource;

/**
 * Copy resources for the test source code to the test output directory.
 * Always uses the project.build.testResources element to specify the resources to copy.
 *
 * @author Michal Maczka
 * @author Jason van Zyl
 */
@Mojo(name = "testResources", defaultPhase = "process-test-resources", projectRequired = true)
public class TestResourcesMojo extends ResourcesMojo {
    /**
     * The output directory into which to copy the resources.
     */
    @Parameter(defaultValue = "${project.build.testOutputDirectory}", required = true)
    private Path outputDirectory;

    /**
     * The list of resources we want to transfer.
     */
    @Parameter
    private List resources;

    /**
     * Set this to 'true' to bypass copying of test resources.
     * Its use is NOT RECOMMENDED, but quite convenient on occasion.
     * @since 2.6
     */
    @Parameter(property = "maven.test.skip", defaultValue = "false")
    private boolean skip;

    /**
     * {@inheritDoc}
     */
    public void execute() throws MojoException {
        if (skip) {
            getLog().info("Not copying test resources");
            return;
        }

        if (resources == null) {
            resources = session.getService(ProjectManager.class).getResources(project, ProjectScope.TEST).stream()
                    .map(ResourceUtils::newResource)
                    .collect(Collectors.toList());
        }

        super.doExecute();
    }

    /** {@inheritDoc} */
    public Path getOutputDirectory() {
        return outputDirectory;
    }

    /** {@inheritDoc} */
    public void setOutputDirectory(Path outputDirectory) {
        this.outputDirectory = outputDirectory;
    }

    /** {@inheritDoc} */
    public List getResources() {
        return resources;
    }

    /** {@inheritDoc} */
    public void setResources(List resources) {
        this.resources = resources;
    }
}