Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 140 Next »

A Maven 2 plugin that wraps the Cargo Java API

Functional tests

Icon

The usage of Cargo for executing functional tests on a container do not need this m2 plugin. You should directly use the Cargo Java API from your Java unit test classes (JUnit, TestNG, etc), as described on http://tinyurl.com/btmwa.

Table of Contents

This page documents the following:

  • Installation: explains how to install the plugin
  • Features: explains how to use the plugin on several use cases
  • Configuration: provide reference documentation for all configuration options
  • Tips: tips for using the plugin

Installation

There is no installation necessary. The Cargo artifacts are hosted on ibiblio. Note that you may also find older artifacts on ibiblio but those shouldn't be used and won't work with this plugin.

Note that the Cargo project has a snapshot repository on Codehaus. If you want use snapshot versions of the Cargo m2 plugin you'll need to add this definition in your POM or settings file:

Features

As usual the best way to learn to use a tool is through examples. We have several sample projects that we use as our internal functional tests suite. We'd really recommend that you check them out. In addition here are the typical uses cases covered by the plugin:

Goals

Description

cargo:start

Start a container and optionally deploy deployables (WAR, EAR, etc)

cargo:stop

Stop a container

cargo:deploy

Deploy a J2EE archive to a running container

cargo:undeploy

Undeploy a J2EE archive from a running container

cargo:uberwar

Merge several WAR files into one


The configuration elements are described in the configuration section.

Configuration

These are the various XML configuration elements that you can use to configure the Cargo Maven2 plugin. Make sure you also check the use cases which show how to use them.

Top level configuration elements

Description

Mandatory?

Default value

<configuration>

Definition of a Configuration

(thumbs down)

No default, cannot call cargo:start or cargo:stop if not defined

<container>

Definition of a Container

(thumbs down)

Defaults to a Jetty 5.x container if not specified

<deployer>

Definition of a Deployer

(thumbs down)

No default, cannot call cargo:deploy and cargo:undeploy if not defined

<configuration> elements

Description

Mandatory?

Default value

<deployables>

List of modules to deploy when the container is started. You specify each module using a <deployable> element

(thumbs down)

No default

<dir>

For standalone configuration this is the location where Cargo willc create the configuration and for existing configuration this is where it is located

(thumbs down)

${java.io.tmpdir}/cargo/<some unique directory>

<implementation>

Full classname of a customer configuration implementation to use. In that case the custom configuration is registered with the <containerId> and <type> specified

(thumbs down)

No default

<properties>

Values to use for various Configuration properties

(thumbs down)

Default configuration properties

<type>

Configuration's type. Valid values are standalone, existing and runtime

(thumbs down)

standalone

<container> elements

Description

Mandatory?

Default value

<append>

If true then the file specified by <output> will not be erased across different runs

(thumbs down)

False

<containerId>

Id of the container to use. Valid values can be found in the description page for each container

(thumbs down)

jetty5xEmbedded

<dependencies>

List of extra dependencies that will be added to the container execution classpath

(thumbs down)

No default

<home>

Location where the container is installed

(thumbs down)

No default, must define either a zipUrlInstaller or a home element

<implementation>

Full classname of a custom container implementation to use. In that case, the custom container is registered with the <containerId> and <type> specified

(thumbs down)

No default

<log>

Path to a file where Cargo logs are saved

(thumbs down)

No logs are saved

<output>

Path to a file where container logs are saved

(thumbs down)

No logs are saved

<timeout>

The timeout after which Cargo reports an error if the container is not started

(thumbs down)

120000 ms (2 minutes)

<type>

Container's type. Valid values are local, remote

(thumbs down)

local

<zipUrlInstaller>

Defines the location of a container distribution zip that will be downloaded and installed

(thumbs down)

No default, a home directory for the container has to be defined in that case

<deployer> elements

Description

Default value

<deployables>

TODO

TODO

<implementation>

TODO

TODO

<type>

TODO

TODO

<deployable> elements

Description

Mandatory

Default value

<artifactId>

Maven artifact id for the module. This artifact id must match either the project's artifact id if your project generates a J2EE artifact (WAR, EAR, EJB and RAR) or it must match a specified <project>/<dependencies>/<dependency> artifact id

(thumbs down)

Defaults to the project's artifact id

<groupId>

Maven group id for the module. This group id must match either the project's group id if your project generates a J2EE artifact (WAR, EAR, EJB and RAR) or it must match a specified <project>/<dependencies>/<dependency> group id

(thumbs down)

Defaults to the project's group id

<implementation>

TODO

(thumbs down)

No default

<location>

Path location where the module can be found

(thumbs down)

Default's to the project's generated artifact location or to the specified <project>/<dependencies>/<dependency> location

<pingURL>

TODO

(thumbs down)

No default

<properties>

TODO

(thumbs down)

No default

<type>

Maven type for the module. This type must match either the project's packaging if your project generates a J2EE artifact (WAR, EAR, EJB and RAR) or it must match a specified <project>/<dependencies>/<dependency> type

(thumbs down)

Defaults to the project's packaging

<properties> elements

Description

Default value

<dependencies> elements

Description

Default value

<artifactId>

Maven's artifact id. This artifact id must match a specified <project>/<dependencies>/<dependency> artifact id

(thumbs down)

Defaults to the project's artifact id

<groupId>

Maven's group id. This group id must match a specified <project>/<dependencies>/<dependency> group id

(thumbs down)

Defaults to the project's group id

<type>

Maven's type. This type must match a specified <project>/<dependencies>/<dependency> type

(thumbs down)

Defaults to the project's packaging

<zipUrlInstaller> elements

Description

Default value

<installDir>

TODO

(thumbs down)

TODO

<proxy>

TODO

(thumbs down)

No default

<url>

TODO

(thumbs down)

No default

Tips

Starting mutiple containers conditionally

Maven 2 supports the notion of profiles which can be used with Cargo to decide for example when to run tests on a specific container. Here's how you could use the Cargo m2 plugin to that effect:

Then to start the tomcat 5.x container you would type mvn -P tomcat5x integration-test. if you want to start both containers you would type mvn -P tomcat5x,orion2x integration-test.

If you want to define a profile as the default you can use the <activation> element with an activation strategy. For example if you want a profile to be always on, use:

TODO: Show how to share configuration data between profiles (this should work by defining the default config data in the <build> element).

  • No labels