ru.yandex.qatools.allure.report.AllureResolveMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of allure-maven-plugin Show documentation
There is a newer version: 2.6
package ru.yandex.qatools.allure.report;

import org.apache.maven.model.Dependency;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.artifact.DefaultArtifact;
import org.eclipse.aether.repository.RemoteRepository;
import ru.qatools.clay.aether.Aether;
import ru.qatools.clay.aether.AetherException;

import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * @author Dmitry Baev [email protected]
 *         Date: 31.07.15
 */
public abstract class AllureResolveMojo extends AllureBaseMojo {

    @Component
    protected RepositorySystem repositorySystem;

    @Parameter(defaultValue = "${repositorySystemSession}", readonly = true)
    protected RepositorySystemSession repositorySession;

    @Parameter(defaultValue = "${project.remoteProjectRepositories}", readonly = true)
    protected List projectRepositories;

    /**
     * The version on Allure report to generate.
     */
    @Parameter(property = "allure.version", defaultValue = "RELEASE")
    protected String version;

    /**
     * The list of report plugins for the report.
     */
    @Parameter
    protected List plugins = Collections.emptyList();

    /**
     * Creates an instance of aether to resolve bundle and plugins.
     */
    protected Aether createAether() {
        return Aether.aether(repositorySystem, repositorySession, projectRepositories);
    }

    /**
     * Resolve all artifacts.
     *
     * @throws AetherException if any occurs.
     */
    protected ClassLoader resolve() throws AetherException {
        Set artifacts = new HashSet<>();
        Aether aether = createAether();
        for (Dependency plugin : plugins) {
            artifacts.addAll(collect(aether, plugin));
        }
        artifacts.addAll(collect(aether, getDefaultBundleDependency()));
        return aether.resolveAll(artifacts.toArray(new Artifact[artifacts.size()])).getAsClassLoader();
    }

    /**
     * Collect all dependencies for given artifact.
     */
    protected List collect(Aether aether, Dependency dependency) throws AetherException {
        List collected = aether.collect(convert(dependency));
        getLog().debug("Found " + collected.size() + " dependencies for " + dependency);
        for (Artifact element : collected) {
            getLog().debug(String.format("%s:%s:%s", element.getGroupId(),
                    element.getArtifactId(), element.getVersion()));
        }
        return collected;
    }

    /**
     * Convert the given dependency to {@link Artifact}.
     */
    protected Artifact convert(Dependency dependency) {
        return new DefaultArtifact(
                dependency.getGroupId(), dependency.getArtifactId(),
                dependency.getClassifier(), dependency.getType(), dependency.getVersion()
        );
    }

    /**
     * Returns the default bundle dependency.
     */
    protected Dependency getDefaultBundleDependency() {
        Dependency dependency = new Dependency();
        dependency.setGroupId("ru.yandex.qatools.allure");
        dependency.setArtifactId("allure-bundle");
        dependency.setVersion(version);
        return dependency;
    }
}