net.ltgt.gwt.maven.AbstractDevModeMojo Maven / Gradle / Ivy
package net.ltgt.gwt.maven;
import java.io.File;
import java.io.IOException;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.ArtifactUtils;
import org.apache.maven.artifact.DependencyResolutionRequiredException;
import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.utils.StringUtils;
import org.apache.maven.shared.utils.io.FileUtils;
import org.codehaus.plexus.util.cli.CommandLineException;
import org.codehaus.plexus.util.cli.CommandLineUtils;
import org.codehaus.plexus.util.cli.Commandline;
import org.codehaus.plexus.util.cli.StreamConsumer;
public abstract class AbstractDevModeMojo extends AbstractMojo {
/**
* Sets the level of logging detail. Defaults to Maven's own log level.
*/
@Parameter(property = "gwt.logLevel")
protected GwtOptions.LogLevel logLevel;
/**
* Comma-delimited list of the modules to run.
*
* Defaults to the discovered module names from {@code gwt-app} projects.
*/
@Parameter(property = "gwt.modules")
protected String modules;
/**
* Comma-delimited list of the reactor projects to run.
*
* Defaults to all the {@code gwt-app} projects in the reactor.
*/
@Parameter(property = "gwt.projects")
protected String projects;
/**
* Specifies Java source level.
*/
@Parameter(property = "maven.compiler.source")
protected String sourceLevel;
/**
* Only succeed if no input files have errors.
*/
@Parameter(property = "gwt.failOnError", defaultValue = "false")
protected boolean failOnError;
/**
* Arguments to be passed to the forked JVM (e.g. {@code -Xmx})
*/
@Parameter
protected List jvmArgs;
/**
* List of system properties to pass to the GWT compiler.
*/
@Parameter
protected Map systemProperties;
@Parameter(defaultValue = "${reactorProjects}", required = true, readonly = true)
protected List reactorProjects;
@Parameter(defaultValue = "${project}", required = true, readonly = true)
protected MavenProject project;
@Parameter(defaultValue = "${plugin}", required = true, readonly = true)
PluginDescriptor pluginDescriptor;
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
List projectList = new ArrayList<>();
if (StringUtils.isBlank(projects)) {
for (MavenProject p : reactorProjects) {
if (p.getPackaging().equals("gwt-app")) {
projectList.add(p);
}
}
} else {
Map projectMap = new HashMap<>();
for (MavenProject p : reactorProjects) {
// XXX: how about duplicates?
String key = p.getArtifactId();
projectMap.put(key, p);
key = ":" + key;
projectMap.put(key, p);
key = p.getGroupId() + key;
projectMap.put(key, p);
}
for (String key : StringUtils.split(projects, ",")) {
MavenProject p = projectMap.get(key);
if (p == null) {
throw new MojoExecutionException("Could not find the selected project in the reactor: " + key);
}
// XXX: check module packaging for known illegal values? (e.g. war, ear, etc.)
projectList.add(p);
}
}
if (projectList.isEmpty()) {
throw new MojoExecutionException("No project found");
}
List moduleList = new ArrayList<>();
if (StringUtils.isBlank(modules)) {
List nonGwtAppProjects = new ArrayList<>();
for (MavenProject p : projectList) {
if (!"gwt-app".equals(p.getPackaging())) {
nonGwtAppProjects.add(ArtifactUtils.versionlessKey(p.getGroupId(), p.getArtifactId()));
continue;
}
moduleList.add(p.getGoalConfiguration(pluginDescriptor.getGroupId(), pluginDescriptor.getArtifactId(), null, null).getChild("moduleName").getValue());
}
if (!nonGwtAppProjects.isEmpty()) {
getLog().warn("Found projects with packaging different form gwt-app when discovering GWT modules; they've been ignored: "
+ StringUtils.join(nonGwtAppProjects.iterator(), ", "));
}
} else {
moduleList.addAll(Arrays.asList(StringUtils.split(modules, ",")));
}
if (moduleList.isEmpty()) {
throw new MojoExecutionException("No module found");
}
LinkedHashSet sources = new LinkedHashSet<>();
for (MavenProject p : projectList) {
if (p.getExecutionProject() != null) {
p = p.getExecutionProject();
}
addSources(p, sources);
}
List args = new ArrayList<>();
if (jvmArgs != null) {
args.addAll(jvmArgs);
}
if (systemProperties != null) {
for (Map.Entry entry : systemProperties.entrySet()) {
args.add("-D" + entry.getKey() + "=" + entry.getValue());
}
}
args.add(getMainClass());
args.add("-logLevel");
args.add((logLevel == null ? GwtOptions.LogLevel.getLogLevel(getLog()) : logLevel).name());
args.add("-workDir");
args.add(getWorkDir().getAbsolutePath());
if (sourceLevel != null) {
args.add("-sourceLevel");
args.add(sourceLevel);
}
if (failOnError) {
args.add("-failOnError");
}
args.addAll(getSpecificArguments(sources));
args.addAll(moduleList);
LinkedHashSet cp = new LinkedHashSet<>();
if (prependSourcesToClasspath()) {
cp.addAll(sources);
}
try {
for (MavenProject p : projectList) {
cp.addAll(p.getCompileClasspathElements());
}
} catch (DependencyResolutionRequiredException e) {
throw new MojoExecutionException(e.getMessage(), e);
}
try {
FileUtils.forceMkdir(new File(project.getBuild().getDirectory()));
FileUtils.forceMkdir(getWorkDir());
forceMkdirs();
} catch (IOException ioe) {
throw new MojoFailureException(ioe.getMessage(), ioe);
}
Commandline commandline = new Commandline();
commandline.setWorkingDirectory(project.getBuild().getDirectory());
commandline.setExecutable(Paths.get(System.getProperty("java.home"), "bin", "java").toString());
commandline.addEnvironment("CLASSPATH", StringUtils.join(cp.iterator(), File.pathSeparator));
commandline.addArguments(args.toArray(new String[args.size()]));
if (getLog().isDebugEnabled()) {
getLog().debug("Arguments: " + StringUtils.join(commandline.getArguments(), " "));
getLog().debug("Classpath: " + StringUtils.join(cp.iterator(), File.pathSeparator));
}
int result;
try {
result = CommandLineUtils.executeCommandLine(commandline,
new StreamConsumer() {
@Override
public void consumeLine(String s) {
getLog().info(s);
}
},
new StreamConsumer() {
@Override
public void consumeLine(String s) {
getLog().warn(s);
}
});
} catch (CommandLineException e) {
throw new MojoExecutionException(e.getMessage(), e);
}
if (result != 0) {
throw new MojoExecutionException("GWT exited with status " + result);
}
}
protected abstract String getMainClass();
protected abstract File getWorkDir();
protected abstract Collection getSpecificArguments(Set sources);
protected boolean prependSourcesToClasspath() {
return false;
}
protected abstract void forceMkdirs() throws IOException;
private final ScopeArtifactFilter artifactFilter = new ScopeArtifactFilter(Artifact.SCOPE_RUNTIME_PLUS_SYSTEM);
private void addSources(MavenProject p, LinkedHashSet sources) {
getLog().debug("Adding sources for " + p.getId());
sources.addAll(p.getCompileSourceRoots());
for (Artifact artifact : p.getDependencyArtifacts()) {
if (!artifactFilter.include(artifact)) {
continue;
}
if (!"java-source".equals(artifact.getArtifactHandler().getPackaging()) &&
!"gwt-lib".equals(artifact.getArtifactHandler().getPackaging()) &&
!"sources".equals(artifact.getClassifier())) {
getLog().debug("Ignoring " + artifact.getId() + "; neither a java-source, gwt-lib or jar:sources.");
continue;
}
String key = ArtifactUtils.key(artifact);
MavenProject reference = p.getProjectReferences().get(key);
if (reference == null) {
getLog().debug("Ignoring " + artifact.getId() + "; no corresponding project reference.");
continue;
}
addSources(reference, sources);
}
}
}