Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Issue #1743 Refactor to make unassembled webapp params clearer. 

Signed-off-by: Jan Bartel <janb@webtide.com>
This commit is contained in:
Jan Bartel 2019-11-06 12:23:00 +11:00
parent ee7f860a2e
commit 335f07f71e
7 changed files with 283 additions and 227 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

264
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractUnassembledWebAppMojo.java Normal file
View File

@ -0,0 +1,264 @@
//
// ========================================================================
// Copyright (c) 1995-2019 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.maven.plugin;
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Parameter;
import org.eclipse.jetty.util.resource.Resource;
/**
* Base class for all goals that operate on unassembled webapps.
*
*/
public abstract class AbstractUnassembledWebAppMojo extends AbstractWebAppMojo
{
/**
* The default location of the web.xml file. Will be used
* if &lt;webApp&gt;&lt;descriptor&gt; is not set.
*/
@Parameter (defaultValue = "${project.baseDir}/src/main/webapp/WEB-INF/web.xml")
protected File webXml;
/**
* The directory containing generated test classes.
*
*/
@Parameter (defaultValue = "${project.build.testOutputDirectory}", required = true)
protected File testClassesDirectory;
/**
* An optional pattern for includes/excludes of classes in the testClassesDirectory
*/
@Parameter
protected ScanPattern scanTestClassesPattern;
/**
* The directory containing generated classes.
*/
@Parameter (defaultValue = "${project.build.outputDirectory}", required = true)
protected File classesDirectory;
/**
* An optional pattern for includes/excludes of classes in the classesDirectory
*/
@Parameter
protected ScanPattern scanClassesPattern;
/**
* Root directory for all html/jsp etc files
*/
@Parameter (defaultValue = "${project.baseDir}/src/main/webapp")
protected File webAppSourceDirectory;
protected void verifyPomConfiguration() throws MojoExecutionException
{
// check the location of the static content/jsps etc
try
{
if ((webAppSourceDirectory == null) || !webAppSourceDirectory.exists())
{
getLog().info("webAppSourceDirectory" + (webAppSourceDirectory == null ? " not set." : (webAppSourceDirectory.getAbsolutePath() + " does not exist.")) + " Trying " + DEFAULT_WEBAPP_SRC);
webAppSourceDirectory = new File(project.getBasedir(), DEFAULT_WEBAPP_SRC);
if (!webAppSourceDirectory.exists())
{
getLog().info("webAppSourceDirectory " + webAppSourceDirectory.getAbsolutePath() + " does not exist. Trying " + project.getBuild().getDirectory() + File.separator + FAKE_WEBAPP);
//try last resort of making a fake empty dir
File target = new File(project.getBuild().getDirectory());
webAppSourceDirectory = new File(target, FAKE_WEBAPP);
if (!webAppSourceDirectory.exists())
webAppSourceDirectory.mkdirs();
}
}
else
getLog().info("Webapp source directory = " + webAppSourceDirectory.getCanonicalPath());
}
catch (IOException e)
{
throw new MojoExecutionException("Webapp source directory does not exist", e);
}
// check the classes to form a classpath with
try
{
//allow a webapp with no classes in it (just jsps/html)
if (classesDirectory != null)
{
if (!classesDirectory.exists())
getLog().info("Classes directory " + classesDirectory.getCanonicalPath() + " does not exist");
else
getLog().info("Classes = " + classesDirectory.getCanonicalPath());
}
else
getLog().info("Classes directory not set");
}
catch (IOException e)
{
throw new MojoExecutionException("Location of classesDirectory does not exist");
}
}
@Override
protected void configureWebApp() throws Exception
{
super.configureWebApp();
configureUnassembledWebApp();
}
/**
* Configure a webapp that has not been assembled into a war.
*
* @throws Exception
*/
protected void configureUnassembledWebApp() throws Exception
{
//Set up the location of the webapp.
//There are 2 parts to this: setWar() and setBaseResource(). On standalone jetty,
//the former could be the location of a packed war, while the latter is the location
//after any unpacking. With this mojo, you are running an unpacked, unassembled webapp,
//so the two locations should be equal.
Resource webAppSourceDirectoryResource = Resource.newResource(webAppSourceDirectory.getCanonicalPath());
if (webApp.getWar() == null)
webApp.setWar(webAppSourceDirectoryResource.toString());
//The first time we run, remember the original base dir
if (originalBaseResource == null)
{
if (webApp.getBaseResource() == null)
originalBaseResource = webAppSourceDirectoryResource;
else
originalBaseResource = webApp.getBaseResource();
}
//On every subsequent re-run set it back to the original base dir before
//we might have applied any war overlays onto it
webApp.setBaseResource(originalBaseResource);
if (classesDirectory != null)
webApp.setClasses(classesDirectory);
if (useTestScope && (testClassesDirectory != null))
webApp.setTestClasses(testClassesDirectory);
List<File> webInfLibs = getWebInfLibArtifacts().stream()
.map(a ->
{
Path p = mavenProjectHelper.getPathFor(a);
getLog().debug("Artifact " + a.getId() + " loaded from " + p + " added to WEB-INF/lib");
return p.toFile();
}).collect(Collectors.toList());
webApp.setWebInfLib(webInfLibs);
//if we have not already set web.xml location, need to set one up
if (webApp.getDescriptor() == null)
{
//Has an explicit web.xml file been configured to use?
if (webXml != null)
{
Resource r = Resource.newResource(webXml);
if (r.exists() && !r.isDirectory())
{
webApp.setDescriptor(r.toString());
}
}
//Still don't have a web.xml file: try the resourceBase of the webapp, if it is set
if (webApp.getDescriptor() == null && webApp.getBaseResource() != null)
{
Resource r = webApp.getBaseResource().addPath("WEB-INF/web.xml");
if (r.exists() && !r.isDirectory())
{
webApp.setDescriptor(r.toString());
}
}
//Still don't have a web.xml file: finally try the configured static resource directory if there is one
if (webApp.getDescriptor() == null && (webAppSourceDirectory != null))
{
File f = new File(new File(webAppSourceDirectory, "WEB-INF"), "web.xml");
if (f.exists() && f.isFile())
{
webApp.setDescriptor(f.getCanonicalPath());
}
}
}
//process any overlays and the war type artifacts, and
//sets up the base resource collection for the webapp
mavenProjectHelper.getOverlayManager().applyOverlays(webApp);
getLog().info("web.xml file = " + webApp.getDescriptor());
getLog().info("Webapp directory = " + webAppSourceDirectory.getCanonicalPath());
getLog().info("Web defaults = " + (webApp.getDefaultsDescriptor() == null ? " jetty default" : webApp.getDefaultsDescriptor()));
getLog().info("Web overrides = " + (webApp.getOverrideDescriptor() == null ? " none" : webApp.getOverrideDescriptor()));
}
/**
* Find which dependencies are suitable for addition to the virtual
* WEB-INF lib.
*/
protected Collection<Artifact> getWebInfLibArtifacts()
{
//if this project isn't a war, then don't calculate web-inf lib
String type = project.getArtifact().getType();
if (!"war".equalsIgnoreCase(type) && !"zip".equalsIgnoreCase(type))
return Collections.emptyList();
return project.getArtifacts().stream()
.filter(this::isArtifactOKForWebInfLib)
.collect(Collectors.toList());
}
/**
* Check if the artifact is suitable to be considered part of the
* virtual web-inf/lib.
*
* @param artifact the artifact to check
* @return true if the artifact represents a jar, isn't scope provided and
* is scope test, if useTestScope is enabled. False otherwise.
*/
private boolean isArtifactOKForWebInfLib(Artifact artifact)
{
//The dependency cannot be of type war
if ("war".equalsIgnoreCase(artifact.getType()))
return false;
//The dependency cannot be scope provided (those should be added to the plugin classpath)
if (Artifact.SCOPE_PROVIDED.equals(artifact.getScope()))
return false;
//Test dependencies not added by default
if (Artifact.SCOPE_TEST.equals(artifact.getScope()) && !useTestScope)
return false;
return true;
}
}

218
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/AbstractWebAppMojo.java
View File

@ -170,40 +170,7 @@ public abstract class AbstractWebAppMojo extends AbstractMojo
*/
@Parameter (defaultValue = "false")
protected boolean useTestScope;
/**
* The directory containing generated test classes.
*
*/
@Parameter (defaultValue = "${project.build.testOutputDirectory}", required = true)
protected File testClassesDirectory;
/**
* An optional pattern for includes/excludes of classes in the testClassesDirectory
*/
@Parameter
protected ScanPattern scanTestClassesPattern;
/**
* The directory containing generated classes.
*/
@Parameter (defaultValue = "${project.build.outputDirectory}", required = true)
protected File classesDirectory;
/**
* An optional pattern for includes/excludes of classes in the classesDirectory
*/
@Parameter
protected ScanPattern scanClassesPattern;
/**
* Root directory for all html/jsp etc files
*/
@Parameter (defaultValue = "${project.baseDir}/src/main/webapp")
protected File webAppSourceDirectory;
/**
* List of directories with ant-style &lt;include&gt; and &lt;exclude&gt; patterns
* for extra targets to periodically scan for changes.Optional.
@ -214,13 +181,6 @@ public abstract class AbstractWebAppMojo extends AbstractMojo
@Parameter(defaultValue = "${reactorProjects}", readonly = true, required = true)
protected List<MavenProject> reactorProjects;
/**
* The default location of the web.xml file. Will be used
* if &lt;webApp&gt;&lt;descriptor&gt; is not set.
*/
@Parameter (defaultValue = "${project.baseDir}/src/main/webapp/WEB-INF/web.xml")
protected File webXml;
/**
* The target directory
*/
@ -599,55 +559,11 @@ public abstract class AbstractWebAppMojo extends AbstractMojo
}
/**
* Verify some basic configuration is present, supplying defaults if not.
* Used by subclasses.
* @throws MojoExecutionException
*/
protected void verifyPomConfiguration() throws MojoExecutionException
{
// check the location of the static content/jsps etc
try
{
if ((webAppSourceDirectory == null) || !webAppSourceDirectory.exists())
{
getLog().info("webAppSourceDirectory" + (webAppSourceDirectory == null ? " not set." : (webAppSourceDirectory.getAbsolutePath() + " does not exist.")) + " Trying " + DEFAULT_WEBAPP_SRC);
webAppSourceDirectory = new File(project.getBasedir(), DEFAULT_WEBAPP_SRC);
if (!webAppSourceDirectory.exists())
{
getLog().info("webAppSourceDirectory " + webAppSourceDirectory.getAbsolutePath() + " does not exist. Trying " + project.getBuild().getDirectory() + File.separator + FAKE_WEBAPP);
//try last resort of making a fake empty dir
File target = new File(project.getBuild().getDirectory());
webAppSourceDirectory = new File(target, FAKE_WEBAPP);
if (!webAppSourceDirectory.exists())
webAppSourceDirectory.mkdirs();
}
}
else
getLog().info("Webapp source directory = " + webAppSourceDirectory.getCanonicalPath());
}
catch (IOException e)
{
throw new MojoExecutionException("Webapp source directory does not exist", e);
}
// check the classes to form a classpath with
try
{
//allow a webapp with no classes in it (just jsps/html)
if (classesDirectory != null)
{
if (!classesDirectory.exists())
getLog().info("Classes directory " + classesDirectory.getCanonicalPath() + " does not exist");
else
getLog().info("Classes = " + classesDirectory.getCanonicalPath());
}
else
getLog().info("Classes directory not set");
}
catch (IOException e)
{
throw new MojoExecutionException("Location of classesDirectory does not exist");
}
{
}
/**
@ -883,94 +799,7 @@ public abstract class AbstractWebAppMojo extends AbstractMojo
getLog().info("Tmp directory = " + (webApp.getTempDirectory() == null ? " determined at runtime" : webApp.getTempDirectory()));
}
/**
* Configure a webapp that has not been assembled into a war.
*
* @throws Exception
*/
protected void configureUnassembledWebApp() throws Exception
{
//Set up the location of the webapp.
//There are 2 parts to this: setWar() and setBaseResource(). On standalone jetty,
//the former could be the location of a packed war, while the latter is the location
//after any unpacking. With this mojo, you are running an unpacked, unassembled webapp,
//so the two locations should be equal.
Resource webAppSourceDirectoryResource = Resource.newResource(webAppSourceDirectory.getCanonicalPath());
if (webApp.getWar() == null)
webApp.setWar(webAppSourceDirectoryResource.toString());
//The first time we run, remember the original base dir
if (originalBaseResource == null)
{
if (webApp.getBaseResource() == null)
originalBaseResource = webAppSourceDirectoryResource;
else
originalBaseResource = webApp.getBaseResource();
}
//On every subsequent re-run set it back to the original base dir before
//we might have applied any war overlays onto it
webApp.setBaseResource(originalBaseResource);
if (classesDirectory != null)
webApp.setClasses(classesDirectory);
if (useTestScope && (testClassesDirectory != null))
webApp.setTestClasses(testClassesDirectory);
List<File> webInfLibs = getWebInfLibArtifacts().stream()
.map(a ->
{
Path p = mavenProjectHelper.getPathFor(a);
getLog().debug("Artifact " + a.getId() + " loaded from " + p + " added to WEB-INF/lib");
return p.toFile();
}).collect(Collectors.toList());
webApp.setWebInfLib(webInfLibs);
//if we have not already set web.xml location, need to set one up
if (webApp.getDescriptor() == null)
{
//Has an explicit web.xml file been configured to use?
if (webXml != null)
{
Resource r = Resource.newResource(webXml);
if (r.exists() && !r.isDirectory())
{
webApp.setDescriptor(r.toString());
}
}
//Still don't have a web.xml file: try the resourceBase of the webapp, if it is set
if (webApp.getDescriptor() == null && webApp.getBaseResource() != null)
{
Resource r = webApp.getBaseResource().addPath("WEB-INF/web.xml");
if (r.exists() && !r.isDirectory())
{
webApp.setDescriptor(r.toString());
}
}
//Still don't have a web.xml file: finally try the configured static resource directory if there is one
if (webApp.getDescriptor() == null && (webAppSourceDirectory != null))
{
File f = new File(new File(webAppSourceDirectory, "WEB-INF"), "web.xml");
if (f.exists() && f.isFile())
{
webApp.setDescriptor(f.getCanonicalPath());
}
}
}
//process any overlays and the war type artifacts, and
//sets up the base resource collection for the webapp
mavenProjectHelper.getOverlayManager().applyOverlays(webApp);
getLog().info("web.xml file = " + webApp.getDescriptor());
getLog().info("Webapp directory = " + webAppSourceDirectory.getCanonicalPath());
getLog().info("Web defaults = " + (webApp.getDefaultsDescriptor() == null ? " jetty default" : webApp.getDefaultsDescriptor()));
getLog().info("Web overrides = " + (webApp.getOverrideDescriptor() == null ? " none" : webApp.getOverrideDescriptor()));
}
/**
* Try and find a jetty-web.xml file, using some
@ -1037,45 +866,4 @@ public abstract class AbstractWebAppMojo extends AbstractMojo
}
}
}
/**
* Find which dependencies are suitable for addition to the virtual
* WEB-INF lib.
*/
private Collection<Artifact> getWebInfLibArtifacts()
{
//if this project isn't a war, then don't calculate web-inf lib
String type = project.getArtifact().getType();
if (!"war".equalsIgnoreCase(type) && !"zip".equalsIgnoreCase(type))
return Collections.emptyList();
return project.getArtifacts().stream()
.filter(this::isArtifactOKForWebInfLib)
.collect(Collectors.toList());
}
/**
* Check if the artifact is suitable to be considered part of the
* virtual web-inf/lib.
*
* @param artifact the artifact to check
* @return true if the artifact represents a jar, isn't scope provided and
* is scope test, if useTestScope is enabled. False otherwise.
*/
private boolean isArtifactOKForWebInfLib(Artifact artifact)
{
//The dependency cannot be of type war
if ("war".equalsIgnoreCase(artifact.getType()))
return false;
//The dependency cannot be scope provided (those should be added to the plugin classpath)
if (Artifact.SCOPE_PROVIDED.equals(artifact.getScope()))
return false;
//Test dependencies not added by default
if (Artifact.SCOPE_TEST.equals(artifact.getScope()) && !useTestScope)
return false;
return true;
}
}

2
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyEffectiveWebXml.java
View File

@ -32,7 +32,7 @@ import org.eclipse.jetty.util.StringUtil;
*
*/
@Mojo(name = "effective-web-xml", requiresDependencyResolution = ResolutionScope.RUNTIME)
public class JettyEffectiveWebXml extends AbstractWebAppMojo
public class JettyEffectiveWebXml extends AbstractUnassembledWebAppMojo
{
/**
* The name of the file to generate into

2
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunMojo.java
View File

@ -53,7 +53,7 @@ import org.eclipse.jetty.webapp.WebAppContext;
*/
@Mojo (name = "run", requiresDependencyResolution = ResolutionScope.TEST)
@Execute (phase = LifecyclePhase.TEST_COMPILE)
public class JettyRunMojo extends AbstractWebAppMojo
public class JettyRunMojo extends AbstractUnassembledWebAppMojo
{
//Start of parameters only valid for runType=inprocess
/**

1
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyRunWarMojo.java
View File

@ -75,6 +75,7 @@ public class JettyRunWarMojo extends AbstractWebAppMojo
public void configureWebApp() throws Exception
{
super.configureWebApp();
//if no war has been explicitly configured, use the one from the webapp project
if (StringUtil.isBlank(webApp.getWar()))
{
war = target.toPath().resolve(project.getBuild().getFinalName() + ".war");

10
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyStartMojo.java
View File

@ -41,15 +41,9 @@ import org.apache.maven.plugins.annotations.ResolutionScope;
*/
@Mojo(name = "start", requiresDependencyResolution = ResolutionScope.TEST)
@Execute(phase = LifecyclePhase.VALIDATE)
public class JettyStartMojo extends AbstractWebAppMojo
public class JettyStartMojo extends AbstractUnassembledWebAppMojo
{
@Override
protected void configureWebApp() throws Exception
{
super.configureWebApp();
super.configureUnassembledWebApp();
}
/**
* Starts the webapp - without first compiling the classes -
* in the same process as maven.

13
jetty-maven-plugin/src/main/java/org/eclipse/jetty/maven/plugin/JettyStartWarMojo.java
View File

@ -18,10 +18,15 @@
package org.eclipse.jetty.maven.plugin;
import java.io.File;
import java.nio.file.Path;
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;
import org.eclipse.jetty.util.StringUtil;
import org.eclipse.jetty.util.resource.Resource;
/**
* <p>
@ -52,6 +57,9 @@ import org.eclipse.jetty.util.StringUtil;
@Mojo(name = "start-war", requiresDependencyResolution = ResolutionScope.RUNTIME)
public class JettyStartWarMojo extends AbstractWebAppMojo
{
@Parameter (defaultValue = "${project.baseDir}/src/main/webapp")
protected File webAppSourceDirectory;
protected JettyEmbedder embedder;
protected JettyForker forker;
protected JettyDistroForker distroForker;
@ -60,10 +68,11 @@ public class JettyStartWarMojo extends AbstractWebAppMojo
public void configureWebApp() throws Exception
{
super.configureWebApp();
//if a war has not been explicitly configured, use the one from the project
if (StringUtil.isBlank(webApp.getWar()))
{
super.verifyPomConfiguration();
configureUnassembledWebApp();
Path war = target.toPath().resolve(project.getBuild().getFinalName() + ".war");
webApp.setWar(war.toFile().getAbsolutePath());
}
getLog().info("War = " + webApp.getWar());