io.openliberty.tools.maven.utils.ExecuteMojoUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of liberty-maven-plugin Show documentation
Show all versions of liberty-maven-plugin Show documentation
Liberty Maven Plugin : Install, Start/Stop, Package, Create Server, Deploy/Undeploy applications
/**
* (C) Copyright IBM Corporation 2019, 2023.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.openliberty.tools.maven.utils;
import static org.twdata.maven.mojoexecutor.MojoExecutor.configuration;
import static org.twdata.maven.mojoexecutor.MojoExecutor.element;
import static org.twdata.maven.mojoexecutor.MojoExecutor.name;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.PluginExecution;
import org.apache.maven.plugin.logging.Log;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.twdata.maven.mojoexecutor.MojoExecutor.Element;
public class ExecuteMojoUtil {
// https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html
private static final ArrayList COMPILE_PARAMS = new ArrayList<>(Arrays.asList(
"annotationProcessorPaths", "annotationProcessors", "compilerArgs", "compilerArgument",
"compilerArguments", "compilerId", "compilerReuseStrategy", "compilerVersion", "debug",
"debuglevel", "encoding", "excludes", "executable", "failOnError", "failOnWarning",
"fileExtensions", "forceJavacCompilerUse", "fork", "generatedSourcesDirectory",
"includes", "jdkToolchain", "maxmem", "meminitial", "multiReleaseOutput", "optimize",
"outputFileName", "parameters", "proc", "release", "showDeprecation", "showWarnings",
"skipMain", "skipMultiThreadWarning", "source", "staleMillis", "target",
"useIncrementalCompilation", "verbose"
));
// https://maven.apache.org/plugins/maven-compiler-plugin/testCompile-mojo.html
private static final ArrayList TEST_COMPILE_PARAMS = new ArrayList<>(Arrays.asList(
"annotationProcessorPaths", "annotationProcessors", "compilerArgs", "compilerArgument",
"compilerArguments", "compilerId", "compilerReuseStrategy", "compilerVersion", "debug",
"debuglevel", "encoding", "executable", "failOnError", "failOnWarning",
"fileExtensions", "forceJavacCompilerUse", "fork", "generatedTestSourcesDirectory",
"jdkToolchain", "maxmem", "meminitial", "optimize", "outputFileName", "parameters",
"proc", "release", "showDeprecation", "showWarnings", "skip", "skipMultiThreadWarning",
"source", "staleMillis", "target", "testCompilerArgument", "testCompilerArguments",
"testExcludes", "testIncludes", "testRelease", "testSource", "testTarget",
"useIncrementalCompilation", "verbose"
));
// https://maven.apache.org/plugins/maven-resources-plugin/resources-mojo.html
private static final ArrayList RESOURCES_PARAMS = new ArrayList<>(Arrays.asList(
"outputDirectory", "resources", "addDefaultExcludes", "delimiters", "encoding", "escapeString",
"escapeWindowsPaths", "fileNameFiltering", "filters", "includeEmptyDirs",
"mavenFilteringHints", "nonFilteredFileExtensions", "overwrite", "skip",
"supportMultiLineFiltering", "useBuildFilters", "useDefaultDelimiters"
));
// https://maven.apache.org/plugins/maven-resources-plugin/testResources-mojo.html
private static final ArrayList TEST_RESOURCES_PARAMS = new ArrayList<>(Arrays.asList(
"outputDirectory", "resources", "addDefaultExcludes", "delimiters", "encoding",
"escapeString", "escapeWindowsPaths", "fileNameFiltering", "filters",
"includeEmptyDirs", "mavenFilteringHints", "nonFilteredFileExtensions",
"overwrite", "skip", "supportMultiLineFiltering", "useBuildFilters",
"useDefaultDelimiters"
));
// https://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html
private static final ArrayList TEST_PARAMS = new ArrayList<>(Arrays.asList(
"testSourceDirectory", "additionalClasspathElements", "argLine", "basedir",
"childDelegation", "classesDirectory", "classpathDependencyExcludes",
"classpathDependencyScopeExclude", "debugForkedProcess", "dependenciesToScan",
"disableXmlReport", "enableAssertions", "encoding", "environmentVariables",
"excludedGroups", "excludes", "excludesFile", "failIfNoSpecifiedTests",
"failIfNoTests", "forkCount", "forkMode", "forkedProcessExitTimeoutInSeconds",
"forkedProcessTimeoutInSeconds", "groups", "includes", "includesFile",
"junitArtifactName", "junitPlatformArtifactName", "jvm", "objectFactory",
"parallel", "parallelOptimized", "parallelTestsTimeoutForcedInSeconds",
"parallelTestsTimeoutInSeconds", "perCoreThreadCount", "printSummary",
"properties", "redirectTestOutputToFile", "remoteRepositories", "reportFormat",
"reportNameSuffix", "reportsDirectory", "rerunFailingTestsCount", "reuseForks",
"runOrder", "shutdown", "skip", "skipAfterFailureCount", "skipExec",
"skipTests", "suiteXmlFiles", "systemProperties", "systemPropertiesFile",
"systemPropertyVariables", "tempDir", "test", "testClassesDirectory",
"testFailureIgnore", "testNGArtifactName", "threadCount", "threadCountClasses",
"threadCountMethods", "threadCountSuites", "trimStackTrace", "useFile",
"useManifestOnlyJar", "useModulePath", "useSystemClassLoader",
"useUnlimitedThreads", "workingDirectory"
));
// https://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html
private static final ArrayList INTEGRATION_TEST_PARAMS = new ArrayList<>(Arrays.asList(
"summaryFile", "testSourceDirectory", "additionalClasspathElements", "argLine",
"basedir", "childDelegation", "classesDirectory", "classpathDependencyExcludes",
"classpathDependencyScopeExclude", "debugForkedProcess", "dependenciesToScan",
"disableXmlReport", "enableAssertions", "encoding", "environmentVariables",
"excludedGroups", "excludes", "excludesFile", "failIfNoSpecifiedTests",
"failIfNoTests", "forkCount", "forkMode", "forkedProcessExitTimeoutInSeconds",
"forkedProcessTimeoutInSeconds", "groups", "includes", "includesFile",
"junitArtifactName", "junitPlatformArtifactName", "jvm", "objectFactory",
"parallel", "parallelOptimized", "parallelTestsTimeoutForcedInSeconds",
"parallelTestsTimeoutInSeconds", "perCoreThreadCount", "printSummary",
"properties", "redirectTestOutputToFile", "remoteRepositories", "reportFormat",
"reportNameSuffix", "reportsDirectory", "rerunFailingTestsCount", "reuseForks",
"runOrder", "shutdown", "skip", "skipAfterFailureCount", "skipExec", "skipITs",
"skipTests", "suiteXmlFiles", "systemProperties", "systemPropertiesFile",
"systemPropertyVariables", "tempDir", "test", "testClassesDirectory",
"testNGArtifactName", "threadCount", "threadCountClasses", "threadCountMethods",
"threadCountSuites", "trimStackTrace", "useFile", "useManifestOnlyJar",
"useModulePath", "useSystemClassLoader", "useUnlimitedThreads", "workingDirectory"
));
// https://maven.apache.org/surefire/maven-failsafe-plugin/verify-mojo.html
private static final ArrayList VERIFY_PARAMS = new ArrayList<>(Arrays.asList(
"summaryFile", "basedir", "encoding", "failIfNoTests", "reportsDirectory",
"skip", "skipExec", "skipITs", "skipTests", "summaryFiles",
"testClassesDirectory", "testFailureIgnore"
));
// https://maven.apache.org/surefire/maven-surefire-report-plugin/report-only-mojo.html
private static final ArrayList REPORT_ONLY_PARAMS = new ArrayList<>(Arrays.asList(
"outputName", "showSuccess", "aggregate", "alwaysGenerateSurefireReport",
"description", "linkXRef", "reportsDirectories", "reportsDirectory",
"skipSurefireReport", "title", "xrefLocation"
));
// https://maven.apache.org/surefire/maven-surefire-report-plugin/failsafe-report-only-mojo.html
private static final ArrayList FAILSAFE_REPORT_ONLY_PARAMS = REPORT_ONLY_PARAMS;
// https://maven.apache.org/plugins/maven-war-plugin/exploded-mojo.html
// as of Version: 3.4.1-SNAPSHOT, 2023-06-11
private static final ArrayList EXPLODED_PARAMS = new ArrayList<>(Arrays.asList(
// Required
"warSourceDirectory", "webappDirectory", "workDirectory",
// Optional - skip archive* options which may not make sense with our loose app approach
"containerConfigXML", "delimiters", "dependentWarExcludes",
"dependentWarIncludes", "escapedBackslashesInFilePath", "escapeString", "failOnMissingWebXml",
"filteringDeploymentDescriptors", "filters", "includeEmptyDirectories", "nonFilteredFileExtensions",
"outdatedCheckPath", "outputFileNameMapping", "outputTimestamp", "overlays", "propertiesEncoding", "recompressZippedFiles",
"resourceEncoding", "supportMultiLineFiltering", "useDefaultDelimiters", "useJvmChmod", "warSourceExcludes", "warSourceIncludes",
"webResources", "webXml"
));
// https://maven.apache.org/plugins/maven-ear-plugin/ear-mojo.html
private static final ArrayList EAR_PARAMS = new ArrayList<>(
Arrays.asList("earSourceDirectory", "outputDirectory", "outputFileNameMapping", "tempFolder", "workDirectory",
"applicationXml", "archive", "artifactTypeMappings", "classifier", "defaultLibBundleDir", "earSourceExcludes",
"earSourceIncludes", "encoding", "escapeString", "escapedBackslashesInFilePath",
"fileNameMapping", "filtering", "filters", "generatedDescriptorLocation",
"includeLibInApplicationXml", "jboss", "mainArtifactId", "modules", "nonFilteredFileExtensions", "outputTimestamp",
"packagingExcludes", "packagingIncludes", "skinnyModules", "skinnyWars", "skipClassPathModification", "unpackTypes",
"useBaseVersion", "useJvmChmod", "version"));
// https://maven.apache.org/plugins/maven-jar-plugin/jar-mojo.html
private static final ArrayList JAR_PARAMS = new ArrayList<>(
Arrays.asList("classesDirectory", "outputDirectory", "archive", "classifier", "excludes", "forceCreation",
"includes", "outputTimestamp", "skipIfEmpty", "useDefaultManifestFile"));
// https://maven.apache.org/plugins/maven-ejb-plugin/ejb-mojo.html
private static final ArrayList EJB_PARAMS = new ArrayList<>(
Arrays.asList("sourceDirectory", "archive", "classifier", "clientClassifier", "clientExcludes",
"clientIncludes", "ejbJar", "ejbVersion", "escapeBackslashesInFilePath", "escapeString", "excludes",
"filterDeploymentDescriptor", "filters", "generateClient", "outputTimestamp"));
// https://felix.apache.org/documentation/_attachments/components/bundle-plugin/bundle-mojo.html
private static final ArrayList BUNDLE_PARAMS = new ArrayList<>(
Arrays.asList("archive", "buildDirectory", "classifier", "createDependencyReducedPom", "dependencyReducedPomLocation",
"dumpClasspath", "dumpInstructions", "excludeDependencies", "exportScr", "finalName", "instructions",
"manifestLocation", "niceManifest", "noWarningProjectTypes", "outputDirectory", "packaging", "scrLocation",
"supportedProjectTypes", "unpackbundle"));
// https://maven.apache.org/plugins/maven-war-plugin/war-mojo.html
private static final ArrayList WAR_PARAMS = new ArrayList<>(Arrays.asList("outputDirectory",
"warSourceDirectory", "webappDirectory", "workDirectory", "archive", "archiveClasses", "attachClasses",
"classesClassifier", "classifier", "containerConfigXML", "delimiters", "dependentWarExcludes",
"dependentWarIncludes", "escapeString", "escapedBackslashesInFilePath", "failOnMissingWebXml",
"filteringDeploymentDescriptors", "filters", "includeEmptyDirectories", "nonFilteredFileExtensions",
"outdatedCheckPath", "outputFileNameMapping", "outputTimestamp", "overlays", "packagingExcludes",
"packagingIncludes", "primaryArtifact", "recompressZippedFiles", "resourceEncoding", "skip",
"supportMultiLineFiltering", "useDefaultDelimiters", "useJvmChmod", "warSourceExcludes",
"warSourceIncludes", "webResources", "webXml"));
// https://maven.apache.org/plugins/maven-ear-plugin/generate-application-xml-mojo.html
private static final ArrayList EAR_GENERATE_APPLICATION_XML_PARAMS = new ArrayList<>(
Arrays.asList("outputFileNameMapping", "tempFolder", "workDirectory", "applicationId", "applicationName",
"artifactTypeMappings", "defaultLibBundleDir", "description", "displayName", "ejbRefs", "encoding",
"envEntries", "fileNameMapping", "generateApplicationXml", "generateModuleId",
"generatedDescriptorLocation", "includeLibInApplicationXml", "initializeInOrder", "jboss",
"libraryDirectoryMode", "mainArtifactId", "modules", "resourceRefs", "security", "useBaseVersion",
"version"));
private static final ArrayList LIBERTY_COMMON_PARAMS = new ArrayList<>(Arrays.asList(
"installDirectory", "assemblyArchive", "assemblyArtifact", "libertyRuntimeVersion",
"install", "licenseArtifact", "serverName", "userDirectory", "outputDirectory",
"assemblyInstallDirectory", "refresh", "skip", "serverXmlFile", "configDirectory",
"serverEnvFile", "mergeServerEnv"
// executeMojo can not use alias parameters:
// "runtimeArchive", "runtimeArtifact", "runtimeInstallDirectory" "configFile" "serverEnv"
));
private static final ArrayList LIBERTY_COMMON_SERVER_PARAMS = new ArrayList<>(
Arrays.asList("copyDependencies", "bootstrapProperties", "bootstrapPropertiesFile", "jvmOptions", "jvmOptionsFile"
));
private static final ArrayList CREATE_PARAMS;
static {
CREATE_PARAMS = new ArrayList<>(Arrays.asList(
"template", "libertySettingsFolder", "noPassword"
));
CREATE_PARAMS.addAll(LIBERTY_COMMON_PARAMS);
CREATE_PARAMS.addAll(LIBERTY_COMMON_SERVER_PARAMS);
}
private static final ArrayList DEPLOY_PARAMS;
static {
DEPLOY_PARAMS = new ArrayList<>(Arrays.asList(
"appsDirectory", "stripVersion", "deployPackages", "timeout", "looseApplication",
"copyLibsDirectory"
// executeMojo can not use alias parameters:
// "installAppPackages"
));
DEPLOY_PARAMS.addAll(LIBERTY_COMMON_PARAMS);
DEPLOY_PARAMS.addAll(LIBERTY_COMMON_SERVER_PARAMS);
}
private static final ArrayList INSTALL_FEATURE_PARAMS;
static {
INSTALL_FEATURE_PARAMS = new ArrayList<>(Arrays.asList("features"));
INSTALL_FEATURE_PARAMS.addAll(LIBERTY_COMMON_PARAMS);
}
private static final ArrayList GENERATE_FEATURES_PARAMS;
static {
GENERATE_FEATURES_PARAMS = LIBERTY_COMMON_PARAMS;
}
private static final Map LIBERTY_ALIAS_MAP;
static {
MaptempMap = new HashMap();
tempMap.put("runtimeArtifact", "assemblyArtifact");
tempMap.put("runtimeArchive", "assemblyArchive");
tempMap.put("runtimeInstallDirectory", "assemblyInstallDirectory");
tempMap.put("configFile", "serverXmlFile");
tempMap.put("serverEnv", "serverEnvFile");
tempMap.put("installAppPackages", "deployPackages");
LIBERTY_ALIAS_MAP = Collections.unmodifiableMap(tempMap);
}
/**
* Given the Plugin get the goal execution configuration.
*
* @param plugin
* @param goal
* @return configuration for the plugin execution goal
*/
public static Xpp3Dom getPluginGoalConfig(Plugin plugin, String goal, Log log) {
Xpp3Dom config = null;
String execId = "default";
int numExec = 0;
List executions = plugin.getExecutions();
if (executions != null) {
for (PluginExecution e : executions) {
if (e.getGoals() != null && e.getGoals().contains(goal)) {
if (numExec == 0) {
// execution configuration is already merged with the common plugin
// configuration
config = (Xpp3Dom) e.getConfiguration();
execId = e.getId();
}
numExec++;
}
}
if (config == null) {
config = (Xpp3Dom) plugin.getConfiguration();
}
} else {
config = (Xpp3Dom) plugin.getConfiguration();
}
if (numExec > 1) {
log.warn(plugin.getArtifactId() + ":" + goal
+ " goal has multiple execution configurations (default to \"" + execId + "\" execution)");
}
if (config == null) {
config = configuration();
} else {
config = Xpp3Dom.mergeXpp3Dom(configuration(), config);
config = validateConfiguration(plugin, goal, config, log);
}
log.debug(plugin.getArtifactId() + ":" + goal + " configuration\n" + config);
return config;
}
private static Xpp3Dom validateConfiguration(Plugin plugin, String goal, Xpp3Dom config, Log log) {
Xpp3Dom goalConfig;
String executionGoal = plugin.getArtifactId() + ":" + goal;
switch (executionGoal) {
case "liberty-maven-plugin:create":
config = convertLibertyAlias(config);
goalConfig = stripConfigElements(config, CREATE_PARAMS);
break;
case "liberty-maven-plugin:deploy":
config = convertLibertyAlias(config);
goalConfig = stripConfigElements(config, DEPLOY_PARAMS);
break;
case "liberty-maven-plugin:install-feature":
config = convertLibertyAlias(config);
goalConfig = stripConfigElements(config, INSTALL_FEATURE_PARAMS);
break;
case "liberty-maven-plugin:generate-features":
config = convertLibertyAlias(config);
goalConfig = stripConfigElements(config, GENERATE_FEATURES_PARAMS);
break;
case "maven-compiler-plugin:compile":
goalConfig = stripConfigElements(config, COMPILE_PARAMS);
break;
case "maven-compiler-plugin:testCompile":
goalConfig = stripConfigElements(config, TEST_COMPILE_PARAMS);
break;
case "maven-resources-plugin:resources":
goalConfig = stripConfigElements(config, RESOURCES_PARAMS);
break;
case "maven-resources-plugin:testResources":
goalConfig = stripConfigElements(config, TEST_RESOURCES_PARAMS);
break;
case "maven-surefire-plugin:test":
goalConfig = stripConfigElements(config, TEST_PARAMS);
break;
case "maven-failsafe-plugin:integration-test":
goalConfig = stripConfigElements(config, INTEGRATION_TEST_PARAMS);
break;
case "maven-failsafe-plugin:verify":
goalConfig = stripConfigElements(config, VERIFY_PARAMS);
break;
case "maven-surefire-report-plugin:report-only":
goalConfig = stripConfigElements(config, REPORT_ONLY_PARAMS);
break;
case "maven-surefire-report-plugin:failsafe-report-only":
goalConfig = stripConfigElements(config, FAILSAFE_REPORT_ONLY_PARAMS);
break;
case "maven-war-plugin:exploded":
goalConfig = stripConfigElements(config, EXPLODED_PARAMS);
break;
case "maven-ear-plugin:generate-application-xml":
goalConfig = stripConfigElements(config, EAR_GENERATE_APPLICATION_XML_PARAMS);
break;
case "maven-ear-plugin:ear":
goalConfig = stripConfigElements(config, EAR_PARAMS);
break;
case "maven-jar-plugin:jar":
goalConfig = stripConfigElements(config, JAR_PARAMS);
break;
case "maven-ejb-plugin:ejb":
goalConfig = stripConfigElements(config, EJB_PARAMS);
break;
case "maven-bundle-plugin:bundle":
goalConfig = stripConfigElements(config, BUNDLE_PARAMS);
break;
case "maven-war-plugin:war":
goalConfig = stripConfigElements(config, WAR_PARAMS);
break;
case "liberty-maven-plugin:dev":
goalConfig = config;
break;
default:
goalConfig = config;
log.debug("skip execution goal configuration validation for " + executionGoal);
break;
}
return goalConfig;
}
private static Xpp3Dom convertLibertyAlias(Xpp3Dom config) {
// convert alias parameter key to actual parameter key
Xpp3Dom alias;
for (String key : LIBERTY_ALIAS_MAP.keySet()) {
alias = config.getChild(key);
if (alias != null) {
if ("runtimeArtifact".contentEquals(key)) {
Xpp3Dom artifact = new Xpp3Dom(LIBERTY_ALIAS_MAP.get(key));
for (Xpp3Dom child : alias.getChildren()) {
artifact.addChild(child);
}
config.addChild(artifact);
} else {
Element e = (element(name(LIBERTY_ALIAS_MAP.get(key)), alias.getValue()));
config.addChild(e.toDom());
}
}
}
return config;
}
/**
* Strip all config elements except the ones in the goalParams list.
*
* @param config existing config
* @param goalParams the config elements to keep
* @return config with non applicable elements removed
*/
private static Xpp3Dom stripConfigElements(Xpp3Dom config, ArrayList goalParams) {
// strip non applicable parameters
List removeChildren = new ArrayList();
for (int i=0; i © 2015 - 2025 Weber Informatics LLC | Privacy Policy