Maven plugins for managing Liberty profile servers #devops
Clone or download
chyt Merge pull request #400 from chyt/update18003
Test 18.0.0.3 runtimes
Latest commit 7dda616 Oct 15, 2018

README.md

ci.maven Maven Central Latest Build Status Build status Codacy Badge

Collection of Maven plug-ins and archetypes for managing WebSphere Application Server Liberty servers and applications.

Build

Use Maven 3.x to build the Liberty plug-ins and archetypes.

  • mvn install : builds the plug-in and the archetypes.
  • mvn install -Poffline-its -DlibertyInstallDir=<liberty_install_directory> : builds the plug-in and the archetypes and runs the integration tests by providing an existing installation.
  • mvn install -Ponline-its -Druntime=<ol|wlp> -DruntimeVersion=<runtime_version> : builds the plug-in and archetypes and runs the integration tests by downloading a new server. Set runtime to ol to run tests using the Open Liberty runtime, or wlp to run tests using the WLP Java EE 7 runtime.

Plug-ins

liberty-maven-plugin

liberty-maven-plugin provides a number of goals for managing a Liberty server and applications.

Configuration

To enable liberty-maven-plugin in your project add the following to your pom.xml:

<project>
    ...
    <build>
        <plugins>
            <!-- Enable liberty-maven-plugin -->
            <plugin>
                <groupId>net.wasdev.wlp.maven.plugins</groupId>
                <artifactId>liberty-maven-plugin</artifactId>
                <version>2.5</version>
                <!-- Specify configuration, executions for liberty-maven-plugin -->
                ...
            </plugin>
        </plugins>
    </build>
    ...
</project>

If you are using a snapshot version of liberty-maven-plugin then you will also need to add the following plug-in repository to your pom.xml:

<project>
    ...
    <pluginRepositories>
        <!-- Configure Sonatype OSS Maven snapshots repository -->
        <pluginRepository>
            <id>sonatype-nexus-snapshots</id>
            <name>Sonatype Nexus Snapshots</name>
            <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
            <releases>
                <enabled>false</enabled>
            </releases>
        </pluginRepository>
    </pluginRepositories>
    ...
</project>
Liberty installation configuration

The liberty-maven-plugin must first be configured with the Liberty server installation information. The installation information can be specified as an existing installation directory, a packaged server, or as a Maven artifact. The liberty-maven-plugin can also download and install a Liberty server from the Liberty repository or other location using the install parameter. By default, the plug-in installs the Liberty runtime with the Java EE 7 Web Profile features from the Liberty repository.

Goals

The liberty-maven-plugin provides the following goals.

Goal Description
install-server Installs the Liberty runtime. This goal is implicitly invoked by all the other plug-in goals and usually does not need to be executed explicitly.
create-server Create a Liberty server.
start Start a Liberty server in background. The server instance will be automatically created if it does not exist.
start-server Alias of the start goal.
test-start-server Allows you to bypass automatically starting the server during the pre-integration-test phase with pom configuration or a Liberty-specific command line argument.
run Start a Liberty server in foreground. The server instance will be automatically created if it does not exist.
run-server Alias of the run goal.
stop Stop a Liberty server. The server instance must exist and must be running.
stop-server Alias of the stop goal.
test-stop-server Allows you to bypass automatically stopping the server during the post-integration-test phase with pom configuration or a Liberty-specific command line argument.
debug Start a Liberty server in debug mode.
debug-server Alias of the debug goal.
package-server Package a Liberty server.
clean-server Deletes every file in the ${outputDirectory}/logs, ${outputDirectory}/workarea, ${userDirectory}/dropins or ${userDirectory}/apps.
dump-server Dump diagnostic information from the server into an archive.
java-dump-server Dump diagnostic information from the server JVM.
deploy Deploy an application to a Liberty server. The server instance must exist and must be running.
undeploy Undeploy an application to a Liberty server. The server instance must exist and must be running.
install-feature Install a feature packaged as a Subsystem Archive (esa) to the Liberty runtime.
uninstall-feature Uninstall a feature from the Liberty runtime.
install-apps Copy applications specified as Maven compile dependencies to Liberty server's dropins or apps directory.
compile-jsp Compile JSPs in the src/main/webapp into the target/classes directory
display-url Display the application URL in the default browser.
status Check a Liberty server status.
server-status Alias of the status goal.
Common Parameters

Parameters shared by all goals. See common parameters.

Common Server Parameters

Additional parameters shared by all server-based goals. See common server parameters.

Extensions

Extensions improve the compatibility or user experience of third party libraries used with Liberty. The liberty-maven-plugin provides the following extensions.

Extension Description
configure-arquillian goal Integrates arquillian.xml configuration for the Liberty Managed and Remote Arquillian containers in the liberty-maven-plugin. Automatically configures required arquillian.xml parameters for the Liberty Managed container.
Spring Boot Support The liberty-maven-plugin provides support for Spring Boot applications, allowing you to install Spring Boot executable JARs directly to the Liberty runtime.

Packaging types

liberty-assembly

The liberty-assembly Maven packaging type is used to create a packaged Liberty server Maven artifact out of existing server installation, compressed archive, or another server Maven artifact. Any applications specified as Maven compile dependencies will be automatically packaged with the assembled server. Liberty features can also be installed and packaged with the assembled server. Any application or test code included in the project is automatically compiled and tests run at appropriate unit or integration test phase. Application code is installed as a loose application WAR file if installAppPackages is set to all or project and looseApplication is set to true.

The liberty-assembly default lifecycle includes:

Phase Goal
pre-clean liberty:stop-server
process-resources maven-resources-plugin:resources
compile maven-compiler-plugin:compile
process-test-resources maven-resources-plugin:testResources
test-compile maven-compiler-plugin:testCompile
test maven-surefire-plugin:test
prepare-package liberty:create-server, liberty:install-feature
package liberty:install-apps, liberty:package-server
pre-integration-test liberty:test-start-server
integration-test maven-failsafe-plugin:integration-test
post-integration-test liberty:test-stop-server
verify maven-failsafe-plugin:verify
install maven-install-plugin:install
deploy maven-deploy-plugin:deploy

Example:

<project>
    ...
    <groupId>myGroup</groupId>
    <artifactId>myServer</artifactId>
    <!-- Create Liberty server assembly -->
    <packaging>liberty-assembly</packaging>
    ...
    <dependencies>
        <!-- Package SimpleServlet.war with server assembly -->
        <dependency>
            <groupId>wasdev</groupId>
            <artifactId>SimpleServlet</artifactId>
            <version>1.0</version>
            <type>war</type>
        </dependency>
    </dependencies>
    ...
    <build>
        <plugins>
            <!-- Enable liberty-maven-plugin -->
            <plugin>
                <groupId>net.wasdev.wlp.maven.plugins</groupId>
                <artifactId>liberty-maven-plugin</artifactId>
                <version>2.5</version>
                <extensions>true</extensions>
                <configuration>
                    <installDirectory>/opt/ibm/wlp</installDirectory>
                    <serverName>test</serverName>
                    <features>
                        <acceptLicense>true</acceptLicense>
                        <feature>mongodb-2.0</feature>
                    </features>
                    <looseApplication>true</looseApplication>
                    <installAppPackages>all</installAppPackages>
                </configuration>
            </plugin>
        </plugins>
    </build>
    ...
</project>

Archetypes

By default, all archetypes that specify a Liberty runtime use the latest version of the Open Liberty runtime. You can use a different runtime by setting the runtimeGroupId and runtimeArtifactId. For example, you can use wlp-webProfile7 by setting -DruntimeGroupId=com.ibm.websphere.appserver.runtime and -DruntimeArtifactId=wlp-webProfile7.

The runtime version can also be set dynamically. For example, you can specify version 18.0.0.1 of the runtime by setting -DruntimeVersion=18.0.0.1.

Finally, the default liberty-maven-plugin version is set to be the latest version of the plugin. To specify a different version of the plugin, use the libertyPluginVersion parameter. For example, you could set -DlibertyPluginVersion=2.2.

liberty-plugin-archetype

The liberty-plugin-archetype is used to generate a basic multi-module project that builds a simple web application then deploys and tests it on a Liberty server. It also creates a Liberty server package that includes the application.

Usage

mvn archetype:generate \
    -DarchetypeGroupId=net.wasdev.wlp.maven \
    -DarchetypeArtifactId=liberty-plugin-archetype \
    -DarchetypeVersion=2.2 \
    -DlibertyPluginVersion=2.2 \
    -DgroupId=test \
    -DartifactId=test \
    -Dversion=1.0-SNAPSHOT

liberty-archetype-mp

The liberty-archetype-mp is used to generate a basic single-module project that builds a simple MicroProfile application then deploys and tests on a Liberty server. It also creates a minified, runnable Liberty server package that includes the application. The generated project includes liberty-maven-app-parent parent pom that binds liberty-maven-plugin goals to the Maven default build lifecycle.

Usage

mvn archetype:generate \
    -DarchetypeGroupId=net.wasdev.wlp.maven \
    -DarchetypeArtifactId=liberty-archetype-mp \
    -DarchetypeVersion=2.3-SNAPSHOT \
    -DgroupId=test \
    -DartifactId=test \
    -Dversion=1.0-SNAPSHOT

For this archetype, you might want to use the wlp-microprofile1 runtime. You can specify this by setting -DruntimeGroupId=com.ibm.websphere.appserver.runtime and -DruntimeArtifactId=wlp-microprofile1.

liberty-archetype-webapp

The liberty-archetype-webapp is used to generate a basic single-module project that builds a simple web application then deploys and tests on a Liberty server. It also creates a minified, runnable Liberty server package that includes the application. The generated project includes the liberty-maven-app-parent parent pom that binds liberty-maven-plugin goals to the Maven default build lifecycle.

Usage

mvn archetype:generate \
    -DarchetypeGroupId=net.wasdev.wlp.maven \
    -DarchetypeArtifactId=liberty-archetype-webapp \
    -DarchetypeVersion=2.2 \
    -DgroupId=test \
    -DartifactId=test \
    -Dversion=1.0-SNAPSHOT

liberty-archetype-ear

The liberty-archetype-ear is used to generate a multi-module project that includes an EJB module, a web application module and an EAR module. In the EAR module, it packages the application in a Java EE 7 Enterprise Archive then deploys and tests on a Liberty server. It also creates a minified, runnable Liberty server package that includes the application EAR file. The generated project includes liberty-maven-app-parent parent pom that binds liberty-maven-plugin goals to the Maven default build lifecycle.

Usage

mvn archetype:generate \
    -DarchetypeGroupId=net.wasdev.wlp.maven \
    -DarchetypeArtifactId=liberty-archetype-ear \
    -DarchetypeVersion=2.2 \
    -DgroupId=test \
    -DartifactId=test \
    -Dversion=1.0-SNAPSHOT

Using Archetype Snapshots

If you are using a snapshot version of liberty-archetype-webapp or liberty-archetype-ear, then you will also need to add the following archetype repository to ${user.home}/.m2/settings.xml:

<settings>
    ...
    <profiles>
        <profile>
            <id>archetype-snapshot-repo</id>
            <properties>
                <archetypeRepository>https://oss.sonatype.org/content/repositories/snapshots
                </archetypeRepository>
            </properties>
            <repositories>
                <repository>
                    <id>sonatype-nexus-snapshots</id>
                    <name>Sonatype Nexus Snapshots</name>
                    <url>https://oss.sonatype.org/content/repositories/snapshots/
                    </url>
                    <releases>
                        <enabled>false</enabled>
                    </releases>
                    <snapshots>
                        <enabled>true</enabled>
                    </snapshots>
                </repository>
            </repositories>
            <pluginRepositories>
                <pluginRepository>
                    <id>sonatype-nexus-snapshots</id>
                    <name>Sonatype Nexus Snapshots</name>
                    <url>https://oss.sonatype.org/content/repositories/snapshots/
                    </url>
                    <releases>
                        <enabled>false</enabled>
                    </releases>
                    <snapshots>
                        <enabled>true</enabled>
                    </snapshots>
                </pluginRepository>
            </pluginRepositories>
        </profile>
    </profiles>
    <activeProfiles>
        <activeProfile>archetype-snapshot-repo</activeProfile>
    </activeProfiles>
</settings>