Maven 3 has a powerful feature called Archetype.
As part of the Cargo project we have created some archetypes that you can use to get a working sample project that uses the Cargo Maven 3 plugin.
This is the most basic example, showing how to configure Cargo and Maven 3 to run functional tests directly from a single webapp module. To run it, execute (one one line):
mvn archetype:generate -DarchetypeGroupId=org.codehaus.cargo -DarchetypeArtifactId=cargo-archetype-webapp-single-module -DarchetypeVersion=<version> |
where <version> is the version of the Cargo Archetype, as a result the Codehaus Cargo version to use.
The Maven 3 archetype plugin will then ask you what groupId
, artifactId
, version
, and package
you would like to use for generation. Once your Maven 3 project is generated, simply run:
mvn clean verify |
That command will:
That archetype also demonstrates another powerful feature of Codehaus Cargo coupled with Maven 3. If you now run:
mvn clean verify -P tomcat9x |
the same steps will be done with Tomcat instead of Jetty; thanks to Maven 3's profiles.
The archetype actually ships with Maven 3 profiles for the jetty9x (default), jetty10x, tomcat9x, jonas5x, jboss71x, glassfish5x, geronimo3x and wildfly21x containers. We tried to show with these archetypes as many examples as possible, so you will find that:
You can of course add and use any other container from the Containers list.
Shows how to configure Cargo and Maven 3 to run functional tests by creating a functional tests module next to the webapp module. To run it, execute (one one line):
mvn archetype:generate -DarchetypeGroupId=org.codehaus.cargo -DarchetypeArtifactId=cargo-archetype-webapp-functional-tests-module -DarchetypeVersion=<version> |
where <version> is the version of the Cargo Archetype, as a result the Codehaus Cargo version to use.
The remaining instructions for this archetype remain the same as the Single Webapp Module Archetype archetype.
Shows how to configure Cargo and Maven 3 to for a more complex setup, in particular with DataSource definitions. This includes:
Of course, the same kind of setup works for any other DataSource provider and driver.
To run it, execute (one one line):
mvn archetype:generate -DarchetypeGroupId=org.codehaus.cargo -DarchetypeArtifactId=cargo-archetype-webapp-with-datasource -DarchetypeVersion=<version> |
where <version> is the version of the Cargo Archetype, as a result the Codehaus Cargo version to use.
The overall remaining instructions for this archetype remain the same as the Single Webapp Module Archetype archetype, with the following differences:
As in the other examples, what's interesting to see is that the DataSource definition on Codehaus Cargo remains the same even if you switch container; as Codehaus Cargo handles all the container-specific DataSource setup steps.
Shows how to configure the various Maven capabilities together with the Codehaus Cargo Ant tasks in order to be able of starting (and stopping) multiple containers at the same time. To run it, execute (one one line):
mvn archetype:generate -DarchetypeGroupId=org.codehaus.cargo -DarchetypeArtifactId=cargo-archetype-multiple-containers -DarchetypeVersion=<version> |
where <version> is the version of the Cargo Archetype, as a result the Codehaus Cargo version to use.
This example shows you how to use Cargo to deploy your webapp to a running container remotely and perform integration tests on it. That container can therefore be running on any machine. To run it, execute (one one line):
mvn archetype:generate -DarchetypeGroupId=org.codehaus.cargo -DarchetypeArtifactId=cargo-archetype-remote-deployment -DarchetypeVersion=<version> |
where <version> is the version of the Cargo Archetype, as a result the Codehaus Cargo version to use.
Once your Maven 3 project is generated, simply run:
mvn clean verify |
That command will:
This archetype supports the following properties that can be changed by passing -DpropertyName=propertyValue
arguments to the mvn
command:
8080
localhost
admin
This archetype ships with Maven 3 profiles for the following containers:
Shows how to configure Cargo and Maven 3 to use the Cargo Daemon's features in order to remotely start the container, deploy your deployable on it, do some tests, and shut the server down remotely. To run it, execute (one one line):
mvn archetype:generate -DarchetypeGroupId=org.codehaus.cargo -DarchetypeArtifactId=cargo-archetype-daemon -DarchetypeVersion=<version> |
where <version> is the version of the Cargo Archetype, as a result the Codehaus Cargo version to use.
The Maven 3 archetype plugin will then ask you what groupId
, artifactId
, version
, and package
you would like to use for generation. Once your Maven 3 project is generated, you need to first start the Cargo Daemon. Then, simply run:
mvn clean verify -Dhostname=<daemon.hostname> -Ddaemon.port=<daemon.port> |
where <daemon.hostname> is the hostname / IP address of the machine running the Cargo Daemon and <daemon.port> the port for it.That command will:
The archetype actually ships with Maven 3 profiles for the jetty9x (default), tomcat9x, jonas5x, jboss71x, glassfish5x, geronimo3x and wildfly21x containers.
You can of course add and use any other container from the Containers list.