testable-mock/testable-maven-plugin/src/main/java/com/alibaba/testable/TestableMojo.java

package com.alibaba.testable;

import com.google.common.base.Strings;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;

import java.util.Map;
import java.util.Properties;

/**
 * Goal which prepare testable agent.
 *
 * @author flin
 */
@Mojo(name = "prepare", defaultPhase = LifecyclePhase.INITIALIZE,
    requiresDependencyResolution = ResolutionScope.RUNTIME, threadSafe = true)
public class TestableMojo extends AbstractMojo
{
    /**
     * Maven project.
     */
    @Parameter(property = "project", required = true, readonly = true)
    private MavenProject project;

    /**
     * Map of plugin artifacts.
     */
    @Parameter(property = "plugin.artifactMap", required = true, readonly = true)
    private Map<String, Artifact> pluginArtifactMap;

    /**
     * Location of local maven repository
     */
    @Parameter(defaultValue = "${localRepository}", readonly = true, required = true)
    private ArtifactRepository localRepository;

    /**
     * JavaAgent log level (mute/debug/verbose)
     */
    @Parameter
    private String logLevel;

    /**
     * Path to dump transformed class file
     */
    @Parameter
    private String dumpPath;

    /**
     * Package prefixes of class need to be mocked (comma split)
     */
    @Parameter
    private String pkgPrefix;

    /**
     * Name of the Testable Agent artifact.
     */
    private static final String AGENT_ARTIFACT_NAME = "com.alibaba.testable:testable-agent";
    /**
     * Testable agent jar path in local repository
     */
    private static final String AGENT_LOCAL_REPOSITORY_PATH =
            "/com/alibaba/testable/testable-agent/${testable.version}/testable-agent-${testable.version}.jar";
    /**
     * Name of the property used in maven-osgi-test-plugin.
     */
    private static final String TYCHO_ARG_LINE = "tycho.testArgLine";
    /**
     * Name of the property used in maven-surefire-plugin.
     */
    private static final String SUREFIRE_ARG_LINE = "argLine";
    /**
     * Name of eclipse test plugin
     */
    private static final String ECLIPSE_TEST_PLUGIN = "eclipse-test-plugin";

    @Override
    public void execute() throws MojoExecutionException
    {
        final String testArgsPropertyKey = getEffectivePropertyKey();
        final Properties projectProperties = project.getProperties();
        if (projectProperties == null) {
            getLog().error("failed to fetch project properties");
            return;
        }

        String extraArgs = "";
        if (!Strings.isNullOrEmpty(logLevel)) {
            extraArgs += "&logLevel=" + logLevel;
        }
        if (!Strings.isNullOrEmpty(dumpPath)) {
            extraArgs += "&dumpPath=" + dumpPath;
        }
        if (!Strings.isNullOrEmpty(pkgPrefix)) {
            extraArgs += "&pkgPrefix=" + pkgPrefix;
        }
        final String oldArgs = projectProperties.getProperty(testArgsPropertyKey);
        String newArgs = (oldArgs == null) ? getAgentJarArgs().trim() : (oldArgs + getAgentJarArgs());
        if (!extraArgs.isEmpty()) {
            newArgs += ("=" + extraArgs.substring(1));
        }
        getLog().info(testArgsPropertyKey + " set to " + newArgs);
        projectProperties.setProperty(testArgsPropertyKey, newArgs);
    }

    private String getAgentJarArgs() {
        final Artifact testableAgentArtifact = pluginArtifactMap.get(AGENT_ARTIFACT_NAME);
        if (testableAgentArtifact == null) {
            getLog().error("failed to find testable agent jar");
            return "";
        }
        String agentJarPath = testableAgentArtifact.getFile().getAbsolutePath();
        if (agentJarPath.endsWith("target/classes")) {
            // Just for testcases within testable project itself
            agentJarPath = localRepository.getBasedir() + AGENT_LOCAL_REPOSITORY_PATH;
        }
        return " -javaagent:" + agentJarPath;
    }

    private String getEffectivePropertyKey() {
        return ECLIPSE_TEST_PLUGIN.equals(project.getPackaging()) ? TYCHO_ARG_LINE : SUREFIRE_ARG_LINE;
    }
}