This is a fork of org.apache.maven.plugins:maven-surefire-plugin:2.6:test which allows you to run tests using modular classloading provided by jboss-modules. The source for this plugin is available in github (https://github.com/kabir/jboss-modules-surefire-plugin).
It works by suppying it with a prebuilt modules root (such as the one from a built JBoss AS 7) and a module definition file to define more modules for your test. The plugin will then create an additional modules directory from the module definition file, and then invoke org.jboss.modules.Main using the configured modules directories. Since everything is now run via jboss modules, you should not execute tests directly from your IDE, but rather run them via maven. If you want to debug the tests, do a
mvn install -Dmaven.surefire.debug=true
and attach a debugger to port 5005.
Configuration
It has the configuration options of the original surefire plugin, although your mileage may vary if you start playing with the fork modes. The plugin takes a module definition file and creates a directory structure containing modules in the jboss-modules format.
For the forked module there are some more options for configuring the modules:
roots:
Points to a list of exisiting module root directories, such as jboss-as7/modules
- Type: java.io.File[]
- Required: No
- Type: boolean
- Required: No
- Expression: ${jboss.modules.clean}
- Default: true
modulesDirectory:
The absolute path of the modules output directory created from moduleDefinitionFile
- Type: java.io.File
- Required: No
- Expression: ${jboss.modules.directory}
- Default: ${project.build.directory}/modules
logModule:
The name of the -logmodule parameter passed in to JBoss Modules (i.e. the name of the module containg the jboss logmanager). This is needed if the target project uses java.util.Logging or jboss logging, and the jboss log manager is not on the system classpath.
- Type: java.lang.String
- Required: No
- Expression: ${jboss.modules.logmodule}
logConfiguration:
The JBoss logging configuration if any. This must be set if the target project uses jboss logging and you want any output to be displayed
- Type: java.io.File
- Required: No
- Expression: ${logging.configuration}
moduleDefinitionFile:
The path of the module definition file.
- Type java.io.File
- Required: Yes
- Expression: ${jboss.modules.definition}
- Default: ${project.build.testOutputDirectory}/modules/module-def.xml
In addition, when using jboss logging you will need to set the following system properties in your pom when using this plugin (full example later):
<systemProperties>
<property>
<name>java.util.logging.manager</name>
<value>org.jboss.logmanager.LogManager</value>
</property>
<property>
<name>jboss.home.dir</name>
<value>${jboss.home}</value>
</property>
<property>
<name>org.jboss.boot.log.file</name>
<value>${jboss.home}/standalone/log/boot.log</value>
</property>
</systemProperties>
Module Definition File
To summarize, you have the following options to set the resource-root paths.
- Full path: Nothing special happens in this case, the module will simply point to that place
- $$CLASSES$$: Copies the main classes directory from your project to the created module
- $$TEST.CLASSES$$: Copies the test classes directory from your project to the created module
- $maven.group.id:maven.artifact.id$: Resolves the maven dependency from your project dependencies and copies the jar to the created module
Consuming the plugin from a pom
Normally you want to turn off the normal surefire plugin since that does not understand modular classloading
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.6</version>
<!-- Disable the standard surefire plugin since that runs tests without modular classloading -->
<configuration>
<skipTests>true</skipTests>
</configuration>
</plugin>
Running Arquillian Tests
The plugin can be used to run arquillian tests against an embedded AS 7 instance using modular classloading everywhere at runtime.
If running an Arquillian IN_CONTAINER test, Arquillian will first execute parts of the test on the client side to create the deployments, before starting an embedded AS instance and deploying the tests into the started server. The test is then run in the server as part of the deployment.
If running an Arquillian AS_CLIENT test, Arquiilian will start the embedded AS instance and then run the test on the client to connect to the started AS instance.
Since the tests are now booted up using JBoss Modules, there is no runtime classpath to speak of, so you need to set up your modules to be able to see the arquillian classes and to be able to see the test class and the dependencies for what is executed on the client (the parts of the test run inside the server don't need anything special since that is handled for us by the server). Here is an example of a module definition file for running an Arquillian test:
<?xml version="1.0" encoding="UTF-8"?>
<modules xmlns="urn:jboss:surefire-module:1.0" targetNs="urn:jboss:module:1.0">
<test-module-resources>
<resource-root path="$org.jboss.as:jboss-as-arquillian-container-embedded$"/>
<resource-root path="$org.jboss.as:jboss-as-arquillian-container-common$"/>
<resource-root path="$$TEST.CLASSES$$"/>
</test-module-resources>
<test-module-dependencies>
<!-- Arquillian dependencies -->
<module services="import" name="org.jboss.surefire.arquillian-deps"/>
<!-- Add other test dependencies here -->
</test-module-dependencies>
<!-- Add more test modules as needed -->
</modules>
org.jboss.surefire.arquillian-deps is a module that ships with JBoss AS 7, and contains the dependencies needed for arquillian. It can be found here. In addition, the test module in this example contains the project test classes directories, and it adds the resource roots containing the JBoss AS 7 embedded Arquillian container and the common Arquillian container classes. Including these container classes makes Arquillian start up the embedded AS 7 container.
TBD
- Investigate if surefire report works with this or if that needs forking too
Comments