Building Serenity projects in Maven

Serenity BDD integrates with Maven via the serenity-maven-plugin.

Introduction

1. First, you need to add the Serenity BDD dependencies to your project.
2. You typically want the Serenity tests to run as integration tests rather than as unit tests.
3. You also want the build not to immediately fail when a test fails, but to continue until it has generated the Serenity aggregate reports before failing at the end of the build.
4. To do this, we use the maven-failsafe-plugin .
5. Add and configure the serenity-maven-plugin.
6. To run the tests and to generate the reports, you would run the following: mvn verify.
7. You need to pass system parameters to the tests (for example, the webdriver.driver property shown here), you need to use the <systemProperties> section.

Step One

 <properties>
     <version.serenity>1.0.47</version.serenity>
     <version.serenity.maven>1.0.47</version.serenity.maven>
     <webdriver.driver>firefox</webdriver.driver>
</properties>

Step Two

<dependencies>
          <dependency>
                   <groupId>net.serenity-bdd</groupId>
                   <artifactId>core</artifactId>
          </dependency>
          <dependency>
                  <groupId>net.serenity-bdd</groupId>
                  <artifactId>serenity-junit</artifactId>
         </dependency>
</dependencies>

Step Three

        <profile>
                <!-- Only run Unit Tests with Coverage -->
                <id>Unit-Tests</id>
                <activation>
                         <activeByDefault>true</activeByDefault>
                </activation>
                <build>
                    <plugins>
                         <plugin>
                              <groupId>net.serenity-bdd.maven.plugins</groupId>
                                   <artifactId>serenity-maven-plugin</artifactId>
                                        <dependencies>
                                             <dependency>
                                                 <groupId>net.serenity-bdd</groupId>
                                                 <artifactId>core</artifactId>
                                                 <version>${version.serenity}</version>
                                            </dependency>
                                       </dependencies>
                                       <executions>
                                           <execution>
                                              <id>serenity-reports</id>
                                                  <phase>post-integration-test</phase>
                                       <goals>
                                            <goal>aggregate</goal>
                                       </goals>
                                         </execution>
                                      </executions>
                        </plugin>

Step Four

<dependencyManagement>
     <dependencies>
         <dependency>
               <groupId>net.serenity-bdd</groupId>
               <artifactId>core</artifactId>
               <version>${version.serenity}</version>
         </dependency>
          <dependency>
               <groupId>net.serenity-bdd</groupId>
               <artifactId>serenity-junit</artifactId>
              <version>${version.serenity}</version>
         </dependency>
     </dependencies>
</dependencyManagement>

Step Five

 <pluginManagement>
     <plugins>
          <plugin>
               <groupId>net.serenity-bdd.maven.plugins</groupId>
               <artifactId>serenity-maven-plugin</artifactId>
               <version>${version.serenity.maven}</version>
         </plugin>
     </plugins>
</pluginManagement>

Now do the following

• Update Project
• Run clean install
• View report in target file

Sample Pom File

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
     <groupId>net.serenity_bdd.samples.junit</groupId>
     <artifactId>junit-quick-start</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     <packaging>jar</packaging>
     <name>Serenity JUnit Quick Start Project</name>
     <properties>
          <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
          <serenity.version>1.0.47</serenity.version>
          <serenity.maven.version>1.0.47</serenity.maven.version>
          <webdriver.driver>firefox</webdriver.driver>
     </properties>
     <dependencies>
         <dependency>
               <groupId>net.serenity-bdd</groupId>
               <artifactId>core</artifactId>
               <version>${serenity.version}</version>
          </dependency>
 
          <dependency>
               <groupId>net.serenity-bdd</groupId>
               <artifactId>serenity-junit</artifactId>
               <version>${serenity.version}</version>
          </dependency>
     </dependencies>
     <build>
          <plugins>
                <plugin>
                     <artifactId>maven-failsafe-plugin</artifactId>
                     <version>2.18</version>
                     <configuration>
                          <includes>
                              <include>**/features/**/When*.java</include>
                          </includes>
                          <systemProperties>
                                <webdriver.driver>${webdriver.driver}</webdriver.driver>
                                <surefire.rerunFailingTestsCount>${surefire.rerunFailingTestsCount}</surefire.rerunFailingTestsCount>
                                <surefire.rerunFailingTestsCount>${surefire.rerunFailingTestsCount}</surefire.rerunFailingTestsCount>
                          </systemProperties>
                     </configuration>
                     <executions>
                          <execution>
                              <goals>
                                    <goal>integration-test</goal>
                                    <goal>verify</goal>
                             </goals>
                        </execution>
                     </executions>
               </plugin>
               <plugin>
                  <groupId>net.serenity-bdd.maven.plugins</groupId>
                  <artifactId>serenity-maven-plugin</artifactId>
                  <version>${serenity.maven.version}</version>
                     <dependencies>
                         <dependency>
                              <groupId>net.serenity-bdd</groupId>
                              <artifactId>core</artifactId>
                              <version>${serenity.version}</version>
                         </dependency>
                     </dependencies>
                     <executions>
                         <execution>
                            <id>serenity-reports</id>
                            <phase>post-integration-test</phase>
                            <goals>
                                <goal>aggregate</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
           </plugins>
      </build>
</project>