First take on supporting 4.2 in SDK 3, and fix WAR assembly

This commit is contained in:
Martin Bergljung 2016-08-18 09:41:42 +01:00
parent d46fa394e7
commit a724b3596e
3 changed files with 161 additions and 26 deletions

View File

@ -36,7 +36,7 @@
<alfresco.platform.version>5.2.a-EA</alfresco.platform.version> <alfresco.platform.version>5.2.a-EA</alfresco.platform.version>
<alfresco.share.war.artifactId>share</alfresco.share.war.artifactId> <alfresco.share.war.artifactId>share</alfresco.share.war.artifactId>
<alfresco.share.version>5.1.g</alfresco.share.version> <alfresco.share.version>5.1.g</alfresco.share.version>
<alfresco.surf.version>6.3</alfresco.surf.version> <alfresco.surf.version>6.5</alfresco.surf.version>
<!-- Alfresco Repo Database configuration. <!-- Alfresco Repo Database configuration.
By default it uses a flat file H2 database to be able to run embedded. By default it uses a flat file H2 database to be able to run embedded.

View File

@ -19,7 +19,7 @@
<alfresco.groupId>org.alfresco</alfresco.groupId> <alfresco.groupId>org.alfresco</alfresco.groupId>
<alfresco.share.war.artifactId>share</alfresco.share.war.artifactId> <alfresco.share.war.artifactId>share</alfresco.share.war.artifactId>
<alfresco.share.version>5.1.g</alfresco.share.version> <alfresco.share.version>5.1.g</alfresco.share.version>
<alfresco.surf.version>6.3</alfresco.surf.version> <alfresco.surf.version>6.5</alfresco.surf.version>
<!-- Since alfresco.war (i.e. the Platform/Repository) is already running on port 8080, we run Share.WAR on port 8081. <!-- Since alfresco.war (i.e. the Platform/Repository) is already running on port 8080, we run Share.WAR on port 8081.
If Alfresco Platform is not running, then generate a platform-jar-module and start it up. --> If Alfresco Platform is not running, then generate a platform-jar-module and start it up. -->

View File

@ -17,6 +17,7 @@
*/ */
package org.alfresco.maven.plugin; package org.alfresco.maven.plugin;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils; import org.apache.commons.lang.StringUtils;
import org.apache.maven.execution.MavenSession; import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Dependency; import org.apache.maven.model.Dependency;
@ -30,6 +31,8 @@ import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.ResolutionScope; import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject; import org.apache.maven.project.MavenProject;
import java.io.File;
import java.io.IOException;
import java.util.*; import java.util.*;
import static org.twdata.maven.mojoexecutor.MojoExecutor.*; import static org.twdata.maven.mojoexecutor.MojoExecutor.*;
@ -44,7 +47,7 @@ import static org.twdata.maven.mojoexecutor.MojoExecutor.*;
*/ */
@Mojo(name = "run", @Mojo(name = "run",
defaultPhase = LifecyclePhase.TEST, defaultPhase = LifecyclePhase.TEST,
aggregator = true, aggregator = true, // Only run against the top-level project in a Maven build
requiresDependencyResolution = ResolutionScope.TEST) requiresDependencyResolution = ResolutionScope.TEST)
public class RunMojo extends AbstractMojo { public class RunMojo extends AbstractMojo {
public static final String MAVEN_DEPENDENCY_PLUGIN_VERSION = "2.10"; public static final String MAVEN_DEPENDENCY_PLUGIN_VERSION = "2.10";
@ -168,7 +171,7 @@ public class RunMojo extends AbstractMojo {
@Parameter(property = "alfresco.groupId", defaultValue = "org.alfresco") @Parameter(property = "alfresco.groupId", defaultValue = "org.alfresco")
protected String alfrescoGroupId; protected String alfrescoGroupId;
@Parameter(property = "alfresco.platform.war.artifactId", defaultValue = "alfresco") @Parameter(property = "alfresco.platform.war.artifactId", defaultValue = "alfresco-platform")
protected String alfrescoPlatformWarArtifactId; protected String alfrescoPlatformWarArtifactId;
@Parameter(property = "alfresco.share.war.artifactId", defaultValue = "share") @Parameter(property = "alfresco.share.war.artifactId", defaultValue = "share")
@ -180,10 +183,10 @@ public class RunMojo extends AbstractMojo {
@Parameter(property = "alfresco.api.explorer.artifactId", defaultValue = "api-explorer") @Parameter(property = "alfresco.api.explorer.artifactId", defaultValue = "api-explorer")
protected String alfrescoApiExplorerArtifactId; protected String alfrescoApiExplorerArtifactId;
@Parameter(property = "alfresco.platform.version", defaultValue = "5.1.g") @Parameter(property = "alfresco.platform.version", defaultValue = "5.2.a-EA")
protected String alfrescoPlatformVersion; protected String alfrescoPlatformVersion;
@Parameter(property = "alfresco.share.version", defaultValue = "5.1.f") @Parameter(property = "alfresco.share.version", defaultValue = "5.1.g")
protected String alfrescoShareVersion; protected String alfrescoShareVersion;
@Parameter(property = "alfresco.api.explorer.version", defaultValue = "1.0") @Parameter(property = "alfresco.api.explorer.version", defaultValue = "1.0")
@ -227,7 +230,7 @@ public class RunMojo extends AbstractMojo {
if (enableSolr) { if (enableSolr) {
unpackSolrConfig(); unpackSolrConfig();
replaceSolrConfigProperties(); replaceSolrConfigProperties();
installSolr10InLocalRepo();
} }
if (enableTestProperties) { if (enableTestProperties) {
@ -255,6 +258,7 @@ public class RunMojo extends AbstractMojo {
*/ */
protected void unpackSolrConfig() throws MojoExecutionException { protected void unpackSolrConfig() throws MojoExecutionException {
getLog().info("Unpacking Solr config"); getLog().info("Unpacking Solr config");
executeMojo( executeMojo(
plugin( plugin(
groupId("org.apache.maven.plugins"), groupId("org.apache.maven.plugins"),
@ -267,15 +271,17 @@ public class RunMojo extends AbstractMojo {
element(name("artifactItems"), element(name("artifactItems"),
element(name("artifactItem"), element(name("artifactItem"),
element(name("groupId"), alfrescoGroupId), element(name("groupId"), alfrescoGroupId),
element(name("artifactId"), alfrescoSolrArtifactId), element(name("artifactId"), getSolrArtifactId()),
element(name("version"), alfrescoPlatformVersion), element(name("version"), alfrescoPlatformVersion),
element(name("classifier"), "config"), // The Solr config is not in a special file with classifier config if <= 4.2
isPlatformVersionLtOrEqTo42() ? element(name("classifier"), "") : element(name("classifier"), "config"),
element(name("type"), "zip") element(name("type"), "zip")
) )
) )
), ),
execEnv execEnv
); );
} }
/** /**
@ -310,6 +316,36 @@ public class RunMojo extends AbstractMojo {
); );
} }
/**
* If we are in Alfresco version 4.2 or younger the Solr 1.0 WAR is not available as Maven artifact, just
* as part of a ZIP file, so install it locally so we can deploy from embedded tomcat
*
* @throws MojoExecutionException
*/
protected void installSolr10InLocalRepo() throws MojoExecutionException {
if (isPlatformVersionLtOrEqTo42()) {
getLog().info("Installing Solr 1.0 WAR in local Maven repo");
// Install the Solr 1.0 war file in local maven repo
executeMojo(
plugin(
groupId("org.apache.maven.plugins"),
artifactId("maven-install-plugin"),
version(MAVEN_INSTALL_PLUGIN_VERSION)
),
goal("install-file"),
configuration(
element(name("file"), solrHome + "/apache-solr-1.4.1.war"),
element(name("groupId"), "${project.groupId}"),
element(name("artifactId"), getSolrArtifactId()),
element(name("version"), "${project.version}"),
element(name("packaging"), "war")
)
, execEnv
);
}
}
/** /**
* Replaces web.xml where applicable in platform webapp (alfresco.war), * Replaces web.xml where applicable in platform webapp (alfresco.war),
* commenting out the security-constraints. * commenting out the security-constraints.
@ -393,7 +429,7 @@ public class RunMojo extends AbstractMojo {
* the {@code <platformModules> } configuration. * the {@code <platformModules> } configuration.
*/ */
protected void buildPlatformWar() throws MojoExecutionException { protected void buildPlatformWar() throws MojoExecutionException {
buildCustomWar(PLATFORM_WAR_PREFIX_NAME, platformModules, buildCustomWarInDir(PLATFORM_WAR_PREFIX_NAME, platformModules,
alfrescoPlatformWarArtifactId, alfrescoPlatformVersion); alfrescoPlatformWarArtifactId, alfrescoPlatformVersion);
commentOutSecureCommsInPlatformWebXml(); commentOutSecureCommsInPlatformWebXml();
@ -412,7 +448,7 @@ public class RunMojo extends AbstractMojo {
* the {@code <shareModules> } configuration. * the {@code <shareModules> } configuration.
*/ */
protected void buildShareWar() throws MojoExecutionException { protected void buildShareWar() throws MojoExecutionException {
buildCustomWar(SHARE_WAR_PREFIX_NAME, shareModules, alfrescoShareWarArtifactId, alfrescoShareVersion); buildCustomWarInDir(SHARE_WAR_PREFIX_NAME, shareModules, alfrescoShareWarArtifactId, alfrescoShareVersion);
String shareWarArtifactId = packageAndInstallCustomWar(SHARE_WAR_PREFIX_NAME); String shareWarArtifactId = packageAndInstallCustomWar(SHARE_WAR_PREFIX_NAME);
@ -423,7 +459,8 @@ public class RunMojo extends AbstractMojo {
} }
/** /**
* Build a customized webapp, applying a number of AMPs and JARs from alfresco maven plugin configuration. * Build a customized webapp in a directory,
* applying a number of AMPs and JARs from alfresco maven plugin configuration.
* *
* @param warName the name of the custom war * @param warName the name of the custom war
* @param modules the modules that should be applied to the custom war * @param modules the modules that should be applied to the custom war
@ -431,10 +468,10 @@ public class RunMojo extends AbstractMojo {
* @param originalWarVersion the version for the original war file that should be customized * @param originalWarVersion the version for the original war file that should be customized
* @throws MojoExecutionException * @throws MojoExecutionException
*/ */
protected void buildCustomWar(String warName, protected void buildCustomWarInDir(String warName,
List<ModuleDependency> modules, List<ModuleDependency> modules,
String originalWarArtifactId, String originalWarArtifactId,
String originalWarVersion) throws MojoExecutionException { String originalWarVersion) throws MojoExecutionException {
final String warOutputDir = getWarOutputDir(warName); final String warOutputDir = getWarOutputDir(warName);
final String ampsOutputDir = "${project.build.directory}/modules/" + warName + "/amps"; final String ampsOutputDir = "${project.build.directory}/modules/" + warName + "/amps";
List<Element> ampModules = new ArrayList<>(); List<Element> ampModules = new ArrayList<>();
@ -557,7 +594,22 @@ public class RunMojo extends AbstractMojo {
*/ */
protected String packageAndInstallCustomWar(String warName) throws MojoExecutionException { protected String packageAndInstallCustomWar(String warName) throws MojoExecutionException {
final String warArtifactId = "${project.artifactId}-" + warName; final String warArtifactId = "${project.artifactId}-" + warName;
final String warOutputDir = getWarOutputDir(warName); final String warSourceDir = getWarOutputDir(warName);
/*
Runtime rt = Runtime.getRuntime();
try {
String warFilePath = project.getBasedir() + "/target/" + warName + ".war";
String warSourceDir2 = project.getBasedir() + "/target/" + warName + "-war";
String cmd = "jar cf " + warFilePath + " " + warSourceDir2 + "/*";
getLog().info("Creating WAR: " + cmd);
Process pr = rt.exec(cmd);
} catch (IOException e) {
e.printStackTrace();
}
*/
// Package the customized war file // Package the customized war file
executeMojo( executeMojo(
@ -569,18 +621,29 @@ public class RunMojo extends AbstractMojo {
goal("war"), goal("war"),
configuration( configuration(
element(name("warName"), warName), element(name("warName"), warName),
element(name("warSourceDirectory"), warOutputDir), element(name("warSourceDirectory"), warSourceDir),
// Specifically tell the archiver where the manifest file is, // Specifically tell the archiver where the manifest file is,
// so a new manifest is not generated. // so a new manifest is not generated.
// We are picking the manifest from the original war. // We are picking the manifest from the original war.
// If we don't do this, then customized share.war will not start properly. // If we don't do this, then customized share.war will not start properly.
element(name("archive"), element(name("archive"),
element(name("manifestFile"), warOutputDir + "/META-INF/MANIFEST.MF") element(name("manifestFile"), warSourceDir + "/META-INF/MANIFEST.MF")
) )
) )
, execEnv , execEnv
); );
// Delete temporary webapp assembly dir, so it is not added to next webapp that is assembled...
// (otherwise share.war will contain alfresco.war stuff)
String tempAssemblyDir = project.getBasedir() + "/target/aio-1.0-SNAPSHOT";
getLog().info("Deleting temp webapp assembly dir: " + tempAssemblyDir);
File tempWebAppAssemblyDir = new File(tempAssemblyDir);
try {
FileUtils.deleteDirectory(tempWebAppAssemblyDir);
} catch (IOException e) {
e.printStackTrace();
}
// Install the customized war file in local maven repo // Install the customized war file in local maven repo
executeMojo( executeMojo(
plugin( plugin(
@ -593,7 +656,8 @@ public class RunMojo extends AbstractMojo {
element(name("file"), "${project.build.directory}/" + warName + ".war"), element(name("file"), "${project.build.directory}/" + warName + ".war"),
element(name("groupId"), "${project.groupId}"), element(name("groupId"), "${project.groupId}"),
element(name("artifactId"), warArtifactId), element(name("artifactId"), warArtifactId),
element(name("version"), "${project.version}") element(name("version"), "${project.version}"),
element(name("packaging"), "war") // Don't forget, otherwise installed as .POM
) )
, execEnv , execEnv
); );
@ -625,15 +689,12 @@ public class RunMojo extends AbstractMojo {
dependency("javax.servlet", "javax.servlet-api", "3.0.1")); dependency("javax.servlet", "javax.servlet-api", "3.0.1"));
if (enableH2) { if (enableH2) {
Dependency h2ScriptsDependency = dependency(alfrescoGroupId, "alfresco-repository", alfrescoPlatformVersion);
h2ScriptsDependency.setClassifier("h2scripts");
tomcatDependencies.add( tomcatDependencies.add(
// Bring in the flat file H2 database // Bring in the flat file H2 database
dependency("com.h2database", "h2", "1.4.190")); dependency("com.h2database", "h2", "1.4.190"));
tomcatDependencies.add( tomcatDependencies.add(
// Bring in the H2 Database scripts for the Alfresco version we use // Bring in the H2 Database scripts for the Alfresco version we use
h2ScriptsDependency); getH2ScriptsDependency());
} }
if (enablePlatform) { if (enablePlatform) {
@ -649,8 +710,7 @@ public class RunMojo extends AbstractMojo {
} }
if (enableSolr) { if (enableSolr) {
webapps2Deploy.add(createWebAppElement(alfrescoGroupId, alfrescoSolrArtifactId, alfrescoPlatformVersion, webapps2Deploy.add(getSolrWebappElement());
"/solr4", "${project.build.testOutputDirectory}/tomcat/context-solr.xml"));
} }
if (enableApiExplorer) { if (enableApiExplorer) {
@ -807,6 +867,81 @@ public class RunMojo extends AbstractMojo {
return false; return false;
} }
/**
* Returns true if current platform version (i.e. version of alfresco.war) is
* <= 4.2
*
* @return true if platform version <= 4.2
*/
private boolean isPlatformVersionLtOrEqTo42() {
int versionNumber = Integer.parseInt(
alfrescoPlatformVersion.replaceAll("[^0-9]", "").substring(0, 2));
if (versionNumber <= 42) {
return true;
}
return false;
}
/**
* Get the Solr artifactId, it changes when we move to Solr 4 in Alfresco version 5
*
* @return the Maven artifactId for Solr
*/
private String getSolrArtifactId() {
// artifactId for Solr defaults to version 4 = alfresco-solr4
if (isPlatformVersionLtOrEqTo42()) {
// Solr version 1 is used in Alfresco 4.0 -> 4.2, Solr version 4.0 was introduced in Alfresco version 5.0
alfrescoSolrArtifactId = "alfresco-solr";
}
return alfrescoSolrArtifactId;
}
/**
* Get the Solr webapp element for use by Tomcat, it changes when we move to Solr 4 in Alfresco version 5
*
* @return tomcat webapp element
*/
private Element getSolrWebappElement() {
Element webappElement = null;
if (isPlatformVersionLtOrEqTo42()) {
// Solr version 1.0
webappElement = createWebAppElement("${project.groupId}", getSolrArtifactId(), "${project.version}",
"/solr", "${project.build.testOutputDirectory}/tomcat/context-solr.xml");
} else {
// Solr version 4.0
webappElement = createWebAppElement(alfrescoGroupId, getSolrArtifactId(), alfrescoPlatformVersion,
"/solr4", "${project.build.testOutputDirectory}/tomcat/context-solr.xml");
}
return webappElement;
}
/**
* Return the H2 database scripts dependency, so Tomcat knows where to grab them.
*
* @return
*/
private Dependency getH2ScriptsDependency() {
Dependency h2ScriptsDependency = null;
if (isPlatformVersionLtOrEqTo42()) {
// The alfresco-repository H2 Scripts artifact is not available until version 5.0 of Alfresco,
// have to grab it from a community project called h2-support instead, this artifact is used by
// previous versions of the SDK, version 1.5 is for Alfresco 4.2 community
// See https://github.com/skuro/alfresco-h2-support/wiki/H2-Database-support-for-Alfresco
h2ScriptsDependency = dependency("tk.skuro.alfresco", "h2-support", "1.5");
} else {
h2ScriptsDependency = dependency(alfrescoGroupId, "alfresco-repository", alfrescoPlatformVersion);
h2ScriptsDependency.setClassifier("h2scripts");
}
return h2ScriptsDependency;
}
/** /**
* The directory where the custom war will be assembled * The directory where the custom war will be assembled
* *