In order to install the 
Maven Plugin, it is necessary to add a plugin entry to your project's pom.xml.
<plugin> <groupId>com.greenpepper</groupId> <artifactId>greenpepper-maven-plugin</artifactId> <version>4.0.0-SNAPSHOT</version> ... <!-- further configuration here --> </plugin> |
For automatic downloads and upgrades, it is possible to add additional repositories to your project's pom.xml like this:
<repositories> <repository> <id>novatec</id> <url>http://nexus.novatec-gmbh.lan/content/groups/public</url> <snapshots> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </snapshots> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> </repositories> <pluginRepositories> <id>novatec</id> <url>http://nexus.novatec-gmbh.lan/content/groups/public</url> <snapshots> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </snapshots> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> </pluginRepositories> |
Within the default Maven Build Lifecycle, there are three phases using the Maven Plugin.
In step one ("Installing the Maven Plugin") we had a look on a short block of code where it said "further configuration here". Below you find an example of how said configuration could look like.
<plugin>
<groupId>com.greenpepper</groupId>
<artifactId>greenpepper-maven-plugin</artifactId>
<version><!-- your version of the GreenPepper Maven Plugin --></version>
<configuration>
<source><!-- your source version --></source>
<target><!-- your target version --></target>
<fixtureSourceDirectory><!-- source directory of your fixtures, for example: src/fixture/java --></fixtureSourceDirectory>
<fixtureOutputDirectory><!-- output directory of the compiled fixture classes, for example: target/fixture-test-classes --></fixtureOutputDirectory>
<specsDirectory><!-- destination for downloaded specification files, for example: src/sprecs--></specsDirectory>
<reportsDirectory><!-- destination for generated HTML reports, for example: target/greenpepper-reports</reportsDirectory>
<reportsType><!-- the file format of your reports (XML or HTML, default is HTML) --></reportsType>
<resources>
<resource>
<directory><! -- directory for a specific resource. Example: src/fixture/resources--></directory>
<excludes>
<exclude>**/*.java</exclude>
</excludes>
</resource>
</resources>
<repositories>
<repository>
<type><!-- fully qualified name of your suit resolver class, for instance: com.greenpepper.repository.FileSystemRepository --></type>
<root><!-- root directory of the current repository. Example: ${basedir}/src/fixture/specs --></root>
<suites>
<suite><!-- the suit's URI --></suite>
</suites>
</repository>
<repository>
<type><!-- fully qualified name of your test resolver. --></type>
<tests>
<test><!-- the test's URI --></test>
</tests>
</repository>
</repositories>
<goalPrefix><!-- the prefix that will be associated with the plugin (optional, see below "Using the GreenPepper Maven Plugin"), eg: greenpepper --></goalPrefix>
</configuration>
</plugin> |
Generally, the goals of the Maven Plugin correspond to the phases of the default Maven Build Lifecycle (with exception of the Freeze goal). Therefore, in order to interact with our fixture sources, we only have to tell Maven until which goal it should run.
NOTE: In order to use a prefix as we do below, it might be necessary to define the goalPrefix tag within the plugin configuration (see the code box above).
Compile fixture sources
mvn greenpepper:compile |
Copy resources to the destination directory
mvn greenpepper:resources |
Execute specifications
mvn greenpepper:run |
Create fixture jars
mvn greenpepper:fixture-jar |
Download specification files
mvn greenpepper:freeze |
Now that we know which goals exist for the Maven Plugin, let's have a closer look at each of them.
Compiles the fixtures of an application.
Mojo attributes:
| Name | Type | Description |
|---|---|---|
| fixtureSourceDirectory | File | Source directory containing the fixture classes to be compiled. |
| fixtureOutputDirectory | File | Output directory in which the compiled sources are placed. |
The optional parameters are exactly the same as in the Maven Compiler Plugin.
Note that the values of the expressions given below are merely default values, so their use is not mandatory.
fixtureSourceDirectory: Source directory containing the fixture classes to be compiled
Expression (example): src/fixture/java
fixtureOutputDirectory: Output directory in which the compiled sources are placed.
Copies resources for the main source code to the main output directory.
Mojo attributes:
| Name | Type | Description |
|---|---|---|
| resources | List | List of resources to be copied to the output directory. |
| fixtureOutputDirectory | File | Output directory the resources are copied to. |
The optional parameters resemble those for the Maven 2 resources plugin.
Note that the values of the expressions given below are merely default values, so their use is not mandatory.
resources: List of resources to be copied to the output directory.
fixtureOutputDirectory: Output directory the resources are copied to.
Executes specifications.
Mojo attributes:
| Name | Type | Description |
|---|---|---|
| basedir | File | Base directory of the project under test (can be obtained in the unit tests using System.getProperty("basedir")) |
| classesDirectory | File | Contains the generated classes of the project under test. |
| fixtureOutputDirectory | File | Contains generated fixture classes of the project under test. |
| repositories | Repository | suite or test URI of specifications to test. |
| reportsDirectory | File | Output directory for generated reports. |
| stopOnFirstFailure | Boolean | Stops the specification's execution on the first failure if set to true. |
| testFailureIgnore | Boolean | Ignores test failures if set to true. Although this is not recommended, there are several occasions where it might come in handy. |
None.
Note that the values of the expressions given below are merely default values, so their use is not mandatory.
basedir: Base directory of the project under test.
classesDirectory: Contains the generated classes of the project under test.
Expression: ${project.build.outputDirectory}
Builds the fixture jars.
Mojo attributes:
| Name | Type | Description |
|---|---|---|
| fixtureOutputDirectory | File | Directory containing the compiled fixture classes. |
None.
Note that the values of the expressions given below are merely default values, so their use is not mandatory.
fixtureOutputDirectory: Directory containing the compiled fixture classes.
Downloads specification files from a remote repository and stores them locally.
Mojo attributes:
| Name | Type | Description |
|---|---|---|
| specsDirectory | File | Directory the specification files are downloaded to. |
| repositories | Repository | suite or test URI of specifications to download. |
None.
Note that the values of the expressions given below are merely default values, therefore their use is not mandatory.
specsDirectory: Destination directory for specifications to be downloaded. Specifications are stored in a subdirectory named after the given repository and optionally in a subdirectory named after the suite.
The following code block shows an example of how your GreenPepper Core's pom.xml could look like.
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>greenpepper-core</artifactId>
<packaging>jar</packaging>
<name>${project.subproject.title}</name>
<parent>
<groupId>com.greenpepper</groupId>
<artifactId>greenpepper</artifactId>
<version>3.1.2</version>
</parent>
<build>
<resources>
<resource>
<directory>src/main/filter</directory>
<filtering>true</filtering>
<targetPath>../filtered-sources</targetPath>
<includes>
<include>**/*.java</include>
</includes>
</resource>
<resource>
<directory>src/main/resources</directory>
<filtering>false</filtering>
</resource>
</resources>
<plugins>
<plugin>
<groupId>com.greenpepper</groupId>
<artifactId>greenpepper-maven-plugin</artifactId>
<version>${greenpepper.maven.plugin.version}</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
<fixtureSourceDirectory>src/fixture/java</fixtureSourceDirectory>
<fixtureOutputDirectory>target/fixture-test-classes</fixtureOutputDirectory>
<specsDirectory>src/specs</specsDirectory>
<reportsDirectory>target/greenpepper-reports</reportsDirectory>
<reportsType>xml</reportsType>
<systemUnderDevelopment>com.greenpepper.systemunderdevelopment.GreenPepperSystemUnderDevelopment</systemUnderDevelopment>
<resources>
<resource>
<directory>src/fixture/resources</directory>
</resource>
</resources>
<repositories>
<repository>
<name>Seeds</name>
<type>com.greenpepper.repository.FileSystemRepository</type>
<root>${basedir}/src/fixture/specs</root>
<suites>
<suite>Seeds</suite>
</suites>
</repository>
</repositories>
<goalPrefix>greenpepper</goalPrefix>
</configuration>
<executions>
<execution>
<id>greenpepper</id>
<goals>
<goal>compile</goal>
<goal>resources</goal>
<goal>fixture-jar</goal>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project> |
In the following example, the specifications will be saved in ${basedir}/src/fixture/specs, as specified in the root element. The first repository will save its specifications in a subdirectory called Demo, the second one in a subdirectory called DemoPhoneBook.
<repositories>
<repository>
<name>Demo</name>
<type>com.greenpepper.repository.FileSystemRepository</type>
<root>${basedir}/src/fixture/specs</root>
<suites>
<suite>Demo</suite>
</suites>
</repository>
<repository>
<name>DemoPhoneBook</name>
<type>com.greenpepper.repository.FileSystemRepository</type>
<root>${basedir}/src/fixture/specs</root>
<suites>
<suite>DemoPhoneBook</suite>
</suites>
</repository>
</repositories> |
Skip execution of the GreenPepper tests
-Dmaven.greenpepper.test.skip=true |
Change the report type (default is HTML)
-Dmaven.greenpepper.reports.type=xml |
Stop execution on first failed test
-Dmaven.greenpepper.test.stop=true |
Activate debug mode
-Dmaven.greenpepper.debug=true |
Ignore failed tests during execution (won't cause Maven to stop execution with an error message)
-Dmaven.greenpepper.test.failure.ignore=true |
Sonar, also known as SonarQube, is an open platform that aims at managing the quality of your code. The Sonar GreenPepper Plugin feeds Sonar with the test reports provided by the GreenPepper Maven Plugin.
The easiest way to produce a Sonar report using GreenPepper test reports is the following:
mvn clean integration-test sonar:sonar |
The integration-test will trigger the following goals:
Please note that in order to use the Sonar GreenPepper Plugin, the GreenPepper reports need to have XML file format which can be achieved by doing either of the following:
Add the reportsType tag to the plugin configuration in your project's pom.xml
<reportsType>xml</reportsType> |
Add a reports type specification to the command line
-Dmaven.greenpepper.reports.type=xml |