Archive for the ‘Maven’ Category

Preventing Maven Plugin Mojo running multiple times for multi module projects

Amongst other tasks, in development we have a need occasionally to copy static content files into our web root from a network location.

We decided to create a maven plugin to allow these tasks to be setup quickly on the command line (rather than having a collection of batch scripts to do this).

Our maven project is a multi module project with a layout similar to this:

  • parent
    • web
      • core
      • producta
      • productb
      • webapp

The plugin was included in the parent pom, so that the environment setup commands could be easily excused from the parent folder.

However, the task was running multiple times. In fact, on closer inspection it was running 6 times which is exactly how many modules we have in our project.

A quick read of the Mojo API Specification pointed me to the javadoc annotation @requiresProject, setting this value to false (the default is true) prevents the goal being run for each module.

/**
 * <p>
 * Description of MOJO.
 * </p>
 *
 * @goal some-goalname
 * @requiresProject false
 *
 */
public class MyMojoThatDoesntRunManyTimes extends AbstractMojo
....

Beware what you put in the endorsed dir!

We use docflex to build our XSD documentation, integrating with maven to produce XSD documentation in our maven site reports.

I recently had to upgrade some developers from docflex-re 1.8.0 to 1.8.5, this migration went fine.

For some reason it didn’t on my machine.

I received the following error:

java.lang.NoClassDefFoundError: org/apache/xml/resolver/CatalogManager

Anyway to cut a long story short it transpired that about a year ago whilst working on another project I had changed the jdk’s xerces jar by placing

  • xalan.jar
  • xercesImpl.jar
  • xml-apis.jar
  • serializer.jar

in the jre/lib/endorsed directory and completely forgot about it.

Removing these jars (which were probably older versions and I didn’t need in there anyway) and everything works fine.

I’d imagine putting a new version of xerces in endorsed would probably fix this as well….

Upgrading to Maven 3 Site Reporting

Whilst upgrading our build to use maven 3.0.3 and the reporting to use the maven-site-plugin 3.0-beta-3 I used the following steps to upgrade the reporting.

When I ran the build it failed

With the message


Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.0-beta-3:site
(default-site) on project webapp: failed to get Reports: Could not find goal
'index' in plugin org.jvnet.mcvp:maven-css-validator-plugin:1.0.0-SNAPSHOT
among available goals report, validate -> [Help 1]

The plugin I was using (a version of the maven css validation plugin that I have modified to generate reports) was defined in the maven 3 build as follows

....
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-site-plugin</artifactId>
    <version>3.0-beta-3</version>
    <configuration>
        <reportPlugins>
         ....
            <plugin>
                <groupId>org.jvnet.mcvp</groupId>
                <artifactId>maven-css-validator-plugin</artifactId>
                <version>1.0.0-SNAPSHOT</version>
            </plugin>
         .....
        </reportPlugins>
   </configuration>
    ....
</plugin>

When the plugin was configured under maven 2 (using the legacy reporting i.e. being in a <reporting> tag) it ran fine.

The fix

The last part of the exception states: among available goals report, validate

The “report” goal creates the report therefore modifiynig the pom so it specifies the “report” goal in a report set seems to work.

....
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-site-plugin</artifactId>
    <version>3.0-beta-3</version>
    <configuration>
        <reportPlugins>
         ....
            <plugin>
                <groupId>org.jvnet.mcvp</groupId>
                <artifactId>maven-css-validator-plugin</artifactId>
                <version>1.0.0-SNAPSHOT</version>
                <reportSets>
                    <reportSet>
                            <reports>
                                <report>report</report>
                            </reports>
                    </reportSet>
                </reportSets>
            </plugin>
         .....
        </reportPlugins>
   </configuration>
    ....
</plugin>

I assume that the Could not find goal ‘index’ portion of the error means that if I set the name of the goal to index perhaps the reportsets are not necessary?

Update: Changing the goal to “index” does indeed remove the need for the reportsets, however for legacy plugins you may not be able to modify the source code!

Another thing to note is that this plugin uses the Maven Anno Mojo

e.g.


@MojoGoal("index")
@MojoPhase("site")
public class CssReportingMojo extends AbstractMavenReport {

But I dont think this has anything to do with error.

I hope this is useful to anyone upgrading as I couldn’t find any info on this exception out there

Using maven to check facelets are valid

Although eclipse validates our xml documents, sometimes invalid xml documents can get committed into our source repository by accident.

Using the maven xml-maven-plugin we can force the build to break when xml documents aren’t welformed.

Currently we are only doing it for facelets files (with a .xhtml extension): The xml snippet below shows the configuration of the plugin for xhtml files.

Add this to the plugins element in the build section.

<plugin>
	<groupId>org.codehaus.mojo</groupId>
	<artifactId>xml-maven-plugin</artifactId>
	<executions>
		<execution>
			<goals>
				<goal>validate</goal>
			</goals>
		</execution>
	</executions>
	<configuration>
		<validationSets>
			<validationSet>
				<dir>src/main/webapp</dir>
				<includes>
					<include>**/*.xhtml</include>
				</includes>
			</validationSet>
		</validationSets>
	</configuration>
</plugin>

To Do:

Really we should be validating all xml files. Also we should investigate turning on schema validation, especially for facelets files.

Top reasons to adopt Maven 3

A great article was recently posted on the Sonatype blog on the top 10 reasons to move to Maven 3

It will be interesting to see if there is a significant speed increase, as it will be nice to reduce the time of our main nightly build which usually takes about 90-95 minutes.

Luckily, Hudson / Jenkins makes it easy to test out running builds using different versions of Maven, so there is no reason not to test it out. Remember that the reporting has changed significantly in Maven 3, so while your project may build successfully in Maven 3 without any changes to the pom, you will need to make changes to get the reporting working. This article on the Maven Site Plugin explains the changes and shows an example of the new configuration.

Maven pom Checkstyle configuration with Eclipse

In a previous post on Eclipse plugins, two excellent plugins were mentioned which can automatically set up your Eclipse project to use the same Checkstyle configuration that is configured in your pom file. However, the only problem with both of these plugins is that they will only be able to find your Checkstyle configuration if it is configured in the build section of the pom. If you just run Checkstlye as a reporting plugin, the plugins won’t pick up the configuration.

A very simple workaround for this is to take advantage of the skip parameter in the Checkstyle configuration. You can add the Checkstyle configuration into your build section of the pom and set the skip parameter to true. This will then prevent Checkstyle from running every time you build your project.

Example code to use in your pom.xml

<properties>
	<checkstylePluginVersion>2.6</checkstylePluginVersion>
</properties>
<build>
	<plugins>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-checkstyle-plugin</artifactId>
			<version>${checkstylePluginVersion}</version>
			<executions>
				<execution>
					<goals>
						<goal>check</goal>
					</goals>
				</execution>
			</executions>
			<configuration>
				<skip>true</skip>
				<configLocation>customCheckstyle.xml</configLocation>
			</configuration>
			<dependencies>
				<dependency>
					<groupId>com.company.web</groupId>
					<artifactId>company-maven-resources</artifactId>
					<version>1.0.0-SNAPSHOT</version>
				</dependency>
			</dependencies>
		</plugin>
	</plugins>
</build>
<reporting>
	<plugins>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-checkstyle-plugin</artifactId>
			<version>${checkstylePluginVersion}</version>
			<configuration>
				<skip>false</skip>
				<configLocation>customCheckstyle.xml</configLocation>
			</configuration>
        </plugin>
	</plugins>
</reporting>

In the above, we are also using a custom artifact as a dependency of the Checkstyle plugin. This artifact is a jar file which contains the customCheckstyle.xml file. We have also got the example code above in a parent pom file, which is in it’s own maven module with a packaging of pom, and artifactId of custom-super-pom. This way, any modules can specify custom-super-pom as their parent. Then when imported into Eclipse, they will automatically have Ckeckstyle configured, which will be referencing the customCheckstyle.xml file. Also, as these modules will inherit the reporting section from the custom-super-pom, they don’t need to have Checkstyle specified in them. This is great, since now all the configuration is in one single pom, making it much easier to maintain and update.

To change the customCheckstyle.xml file, all you would need to do is edit the file within the company-maven-resources artifact, and then install the artifact into your local repository. If you are also using a repository manager like Nexus, then deploy it there also. The following command takes care of it all:

mvn clean deploy

We have used a snapshot version for our super pom and custom maven resources modules so that when these are changed, we can just deploy new versions on top of the older ones. Then any modules that reference these snapshots should pick up the latest version of the artifcats the next time they are built.  You can also force the update to happen by passing in -U on the command line when building, if you find that it doesn’t seem to be checking for updates to snapshots automatically.

Maven site generation error: DTDDVFactoryImpl does not extend from DTDDVFactory

When generating a site with Maven, we encountered the following exception when a particular reporting plugin was executed:

org.apache.xerces.impl.dv.DVFactoryException:
DTD factory class org.apache.xerces.impl.dv.dtd.DTDDVFactoryImpl does not extend from DTDDVFactory.

This basically meant that an incompatible version of xerces was trying to be run. We have everything set to use Java 1.6, which ships with its own version of xerces. After some debugging, it was tracked down to the maven-site-plugin which we had recently upgraded to use version 2.1 of the plugin by specifying it in our pom file like so:

<pluginManagement>
	<plugins>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-site-plugin</artifactId>
			<version>2.1</version>
		</plugin>
	</plugins>
</pluginManagement>

The maven-site-site plugin has the following dependency structure:

  • org.apache.maven.plugins:maven-site-plugin:maven-plugin:2.1
    • org.apache.maven.doxia:doxia-module-xhtml:jar:1.1.2 (compile)
      • org.apache.maven.doxia:doxia-core:jar:1.1.2 (compile)
        • xerces:xercesImpl:jar:2.8.1 (compile)

It is the dependency of the xercesImpl jar 2.8.1 that is the problem. To get around this issue, you can tell the maven-site-plugin to exclude a particular dependency. This can be done like so:

<pluginManagement>
	<plugins>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-site-plugin</artifactId>
			<version>2.1</version>
			<dependencies>
				<dependency>
					<groupId>org.apache.maven.doxia</groupId>
					<artifactId>doxia-core</artifactId>
					<version>1.1.2</version>
					<exclusions>
						<exclusion>
							<groupId>xerces</groupId>
							<artifactId>xercesImpl</artifactId>
						</exclusion>
					</exclusions>
				</dependency>
			</dependencies>
		</plugin>
	</plugins>
</pluginManagement>

There are a couple of maven reporting plugins that we found produced this exception when run with maven-site-plugin 2.1. These plugins are:

If you use an older version of the maven-site-plugin then the above mentioned reporting plugins should work ok. It is only when specifying a version of 2.1 or above that the exception occurs.

Some of the solutions suggested on the net didn’t work for us, like adding the xercesImpl jar as a dependency to the actual reporting plugin in question, so hopefully the solution mentioned in this post is helpful.

Suppress logging in java unit tests

Here are a couple of different ways of suppressing logging when running unit tests. If you are using apache commons logging then you can suppress logging with the following code:

LogFactory.getFactory().setAttribute(
                "org.apache.commons.logging.Log",
                "org.apache.commons.logging.impl.NoOpLog");

If running your unit tests with JUnit, it is probably best to put this code in the setUp() method. However, if you only wanted it suppressed on particular tests, it could go at the top of the test method instead. Bear in mind that if the logger is a static in the class you are testing, you  may need to then reset the attribute at the end of the test method, otherwise, any tests being run after that one will also have their logging suppressed.

If you run your unit tests within an IDE, you may want to see the logging, but not see the logging when you actually run the build of your project with something like Maven. Thankfully, there is a very simple answer to this if you are using Maven. The maven-surefire-plugin is responsible for running the tests and there is a configuration option which needs to be specified to redirect all the test output to file instead of to the console. This keeps your build reports much cleaner as you aren’t interested in seeing the logging messages. As a bonus, since all output is saved to file, exceptions will also be output to file, so whenever exceptions are thrown in the methods being tested, the stack trace wont show up in the build report.

The configuration option that needs specifying is <redirectTestOutputToFile> and this needs to be set to true, as shown below.

<plugin>
	<artifactId>maven-surefire-plugin</artifactId>
	<configuration>
		<redirectTestOutputToFile>true</redirectTestOutputToFile>
	</configuration>
</plugin>

Cobertura code coverage with Maven and PowerMock

If you use Powermock for unit testing with Maven and Cobertura for code coverage, you are likely to be affected by the following issue noted on the PowerMock issue tracker. If you did not have the maven-surefire-plugin forkmode configured to ‘pertest’, you would find that any tests annotated with @RunWith(PowerMockRunner.class) had zero percentage code coverage when you viewed the resulting code coverage report produced by the cobertura-maven-plugin. Whilst running with ‘pertest’ fixed the issue, it was very slow to run the Maven build compared against a forkmode of ‘once’.

In September 2009, Cobertura released version 1.9.3 and one of the changes mentioned was the following:

  • Support the case where multiple classloaders each load the Cobertura classes.

Seeing this, I decided to test if that would fix the issue. At present, the latest version of the cobertura-maven-plugin is 2.3 which runs with Cobertura 1.9.2. There are some snapshots in the codehaus snapshot repository which run with Cobertura 1.9.3.  However, I found that the snapshots were constantly changing, and each run of the Maven build downloaded the latest version and sometimes the latest version had issues. There is probably a way to stop this from happening but if you don’t want to use snapshots, there is a change you can make to the 2.3 version which will also fix the issue. The cobertura-maven-plugin-2.3.pom file needs to be edited. It can be found in your repository under the following directory: org/codehaus/mojo/cobertura-maven-plugin/2.3/

Find the dependencies section of the pom file and change the versions of Cobertura from 1.9.2 to 1.9.3. There are two instances that need changing:

<dependency>
	<groupId>net.sourceforge.cobertura</groupId>
	<artifactId>cobertura</artifactId>
	<version>1.9.3</version>
</dependency>
<dependency>
	<groupId>net.sourceforge.cobertura</groupId>
	<artifactId>cobertura-runtime</artifactId>
	<version>1.9.3</version>
	<type>pom</type>
</dependency>

With that change, you should find that you can safely remove the ‘pertest’ forkmode configuration since by default the surefire plugin will run with forkmode set to ‘once’, and your cobertura code coverage results should be reporting correctly.

UPDATE (26th April 2010):

There is actually a better way of doing this which doesn’t involve having to edit the pom file for the actual plugin.

In your pom file you will have defined the cobertura-maven-plugin in the reporting section. The reporting section does not allow to add dependencies to a plugin. However the build section does, and the plugins defined in the reporting section will also pick up those dependencies. Therefore, you can also define the cobertura-maven-plugin in the build section as a plugin. This will allow you to specify some dependencies, as shown below.

<build>
	<plugins>
		<plugin>
			<groupId>org.codehaus.mojo</groupId>
			<artifactId>cobertura-maven-plugin</artifactId>
			<version>2.3</version>
			<dependencies>
				<dependency>
					<groupId>net.sourceforge.cobertura</groupId>
					<artifactId>cobertura</artifactId>
					<version>1.9.4.1</version>
				</dependency>
				<dependency>
					<groupId>net.sourceforge.cobertura</groupId>
					<artifactId>cobertura-runtime</artifactId>
					<version>1.9.4.1</version>
					<type>pom</type>
				</dependency>
			</dependencies>
		</plugin>
    </plugins>
</build>

This will then use cobertura 1.9.4.1.  Any version above 1.9.2 should fix the issue, but 1.9.4.1 is currently the latest and supposedly a lot faster than previous versions.

UPDATE (11th May 2010):

Good news! There is now version 2.4 of the cobertura-maven-plugin. This uses 1.9.4.1 version of Cobertura, so none of the above is now necessary.