HOME

In the previous tutorial, I have explained about the Integration of Serenity BDD with JUnit4. In this tutorial, I'll explain the Integration of Serenity BDD with JUnit5.

Pre-Requisite

  1. Java 11 installed
  2. Maven installed
  3. Eclipse or IntelliJ installed

This framework consists of:

  1. Java 11
  2. Maven – 3.8.1
  3. Serenity – 2.6.0
  4. Serenity JUnit5– 1.6.0
  5. JUnit Jupiter – 5.8.0
  6. JUnit Vintage - 5.8.0
  7. Maven Surefire Plugin – 3.0.0-M5
  8. Maven Failsafe Plugin – 3.0.0-M5
  9. Maven Compiler Plugin – 3.8.1

Implementation Steps

  1. Update Properties section in Maven pom.xml
  2. Add repositories and pluginRepository to Maven pom.xml
  3. Add Serenity, Serenity Cucumber and JUnit dependencies to POM.xml
  4. Update Build Section of pom.xml
  5. Create test code under src/test/java folder
  6. Create serenity.conf file under src/test/resources
  7. Create serenity.properties file in the root of the project
  8. Run the tests through commandline which generates Serenity Report

Structure of Project

Step 1 – Update Properties section in Maven pom.xml

 <properties>     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>         <serenity.version>2.6.0</serenity.version>         <serenity.junit5.version>1.6.0</serenity.junit5.version>         <junit.jupiter.version>5.8.0</junit.jupiter.version>         <junit.vintage.version>5.8.0</junit.vintage.version>         <maven.compiler.plugin.version>3.8.1</maven.compiler.plugin.version>         <maven.compiler.source>11</maven.compiler.source>         <maven.compiler.target>11</maven.compiler.target>         <maven.surefire.plugin.version>3.0.0-M5</maven.surefire.plugin.version>         <maven.failsafe.plugin.version>3.0.0-M5</maven.failsafe.plugin.version>   </properties>  

Step 2 – Add repositories and pluginRepository to Maven pom.xml

 <repositories>         <repository>             <snapshots>                 <enabled>false</enabled>             </snapshots>             <id>central</id>             <name>bintray</name>             <url>https://jcenter.bintray.com</url>         </repository>     </repositories>     <pluginRepositories>         <pluginRepository>             <snapshots>                 <enabled>false</enabled>             </snapshots>             <id>central</id>             <name>bintray-plugins</name>             <url>https://jcenter.bintray.com</url>         </pluginRepository>     </pluginRepositories>  

Step 3 – Add Serenity and JUnit dependencies to POM.xml

 <dependencies>          <!-- JUnit 5 -->         <dependency>             <groupId>org.junit.jupiter</groupId>             <artifactId>junit-jupiter-engine</artifactId>             <version>${junit.jupiter.version}</version>             <scope>test</scope>         </dependency>                  <dependency>             <groupId>org.junit.jupiter</groupId>             <artifactId>junit-jupiter-api</artifactId>             <version>${junit.jupiter.api.version}</version>             <scope>test</scope>         </dependency>                   <!-- Serenity -->          <dependency>             <groupId>net.serenity-bdd</groupId>             <artifactId>serenity-core</artifactId>             <version>${serenity.version}</version>             <scope>test</scope>         </dependency>                  <dependency>             <groupId>net.serenity-bdd</groupId>             <artifactId>serenity-screenplay-webdriver</artifactId>             <version>${serenity.version}</version>             <scope>test</scope>         </dependency>                  <dependency>             <groupId>io.github.fabianlinz</groupId>             <artifactId>serenity-junit5</artifactId>             <version>${serenity.junit5.version}</version>        </dependency>      </dependencies> 

Step 4 – Update Build Section of pom.xml

  <build>         <plugins>             <plugin>                 <groupId>org.apache.maven.plugins</groupId>                 <artifactId>maven-surefire-plugin</artifactId>                 <version>${maven.surefire.plugin.version}</version>                 <configuration>                     <skip>true</skip>                 </configuration>             </plugin>             <plugin>                 <artifactId>maven-failsafe-plugin</artifactId>                 <version>${maven.failsafe.plugin.version}</version>                 <configuration>                     <includes>                         <include>**/*.java</include>                     </includes>                     <parallel>methods</parallel>                     <useUnlimitedThreads>true</useUnlimitedThreads>                 </configuration>                 <executions>                     <execution>                         <goals>                             <goal>integration-test</goal>                             <goal>verify</goal>                         </goals>                     </execution>                 </executions>             </plugin>             <plugin>                 <groupId>org.apache.maven.plugins</groupId>                 <artifactId>maven-compiler-plugin</artifactId>                 <version>${maven.compiler.plugin.version}</version>                 <configuration>                     <source>${maven.compiler.source}</source>                     <target>${maven.compiler.target}</target>                 </configuration>             </plugin>            <plugin>                <groupId>net.serenity-bdd.maven.plugins</groupId>                <artifactId>serenity-maven-plugin</artifactId>                <version>${serenity.version}</version>                <dependencies>                    <dependency>                        <groupId>net.serenity-bdd</groupId>                        <artifactId>serenity-single-page-report</artifactId>                        <version>${serenity.version}</version>                   </dependency>                                </dependencies>                <configuration>                    <tags>${tags}</tags>                    <reports>single-page-html</reports>                 </configuration>                <executions>                   <execution>                       <id>serenity-reports</id>                       <phase>post-integration-test</phase>                       <goals>                           <goal>aggregate</goal>                       </goals>                    </execution>                </executions>            </plugin>         </plugins>     </build> </project> 

Step 5 - Create test code under src/test/java folder

LoginPageDefinitions.java

 @SerenityTest public class LoginPageDefinitions {  	@Managed 	WebDriver driver;  	@Steps 	StepLoginPage loginPage;  	@Steps 	StepDashboardPage dashPage;  	@Steps 	StepForgetPasswordPage forgetpasswordPage;  	@Test 	@Title("Login to application should be successful") 	public void sucessfulLogin() {  		// Given 		loginPage.open();  		// When 		loginPage.inputUserName("Admin"); 		loginPage.inputPassword("admin123"); 		loginPage.clickLogin();  		// Then 		dashPage.loginVerify(); 	}  	@Test 	@Ignore 	@Title("Login to application should be unsuccessful with error message") 	public void unsucessfulLogin() throws InterruptedException {  		// Given 		loginPage.open();  		// When 		loginPage.inputUserName("abc"); 		loginPage.inputPassword("abc12"); 		loginPage.clickLogin();  		// Then 		String actualErrorMessage = loginPage.errorMessage(); 		Assert.assertEquals("Invalid credentials", actualErrorMessage); 	}  	@Test 	@Title("Verify Forgot your password link") 	public void clickForgetPasswordLink() {  		// Given 		loginPage.open();  		// When 		loginPage.clickForgetPasswordLink();  		// Then 		Assert.assertTrue(forgetpasswordPage.ForgetPasswordPage()); 	}  } 

To run a JUnit5 test with Serenity BDD, simply add the annotation @net.serenitybdd.junit5.SerenityTest (instead of @org.junit.runner.RunWith(net.serenitybdd.junit.runners.SerenityRunner.class) for JUnit4.

 @SerenityTest 

@Test is imported from package:-

 import org.junit.jupiter.api.Test; 

StepDashboardPage.java

 public class StepDashboardPage extends PageObject {  	@Step("Successful login") 	public void loginVerify() { 		String dashboardTitle = $(By.id("welcome")).getText(); 		assertThat(dashboardTitle, containsString("Welcome")); 	} } 

StepForgetPasswordPage.java

 public class StepForgetPasswordPage extends PageObject {  	@Step("Verify Forget Password Page ") 	public boolean ForgetPasswordPage() { 		Boolean resetPasswordButton = $(By.id("btnSearchValues")).isDisplayed();  		return resetPasswordButton; 	} } 

StepLoginPage.java

 public class StepLoginPage extends PageObject {  	@Step("Enter Username") 	public void inputUserName(String userName) { 		$(By.name("txtUsername")).sendKeys((userName)); 	}  	@Step("Enter Password") 	public void inputPassword(String passWord) { 		$(By.name("txtPassword")).sendKeys((passWord)); 	}  	@Step("Click Submit Button") 	public void clickLogin() { 		$(By.name("Submit")).click(); 	}  	@Step("Error Message on unsuccessful login") 	public String errorMessage() { 		String actualErrorMessage = $(By.id("spanMessage")).getText(); 		return actualErrorMessage; 	}  	@Step("Click Forget Password Link") 	public void clickForgetPasswordLink() { 		$(By.linkText("Forgot your password?")).click(); 	} } 

The @Steps annotation marks a Serenity step library.
Create the test following the Given/When/Then pattern and using step methods from the step library.
The @Title annotation lets you provide your own title for this test in the test reports. Serenity @Title is considered for the Serenity report.Consistently with Junit4 the @Title annotation does not influence the name in the Junit report.

The JUnit Serenity integration provides some special support for Serenity Page Objects. In particular, Serenity will automatically instantiate any PageObject fields in your JUnit test.

Junit5 @Disabled annotation can be used on test and step methods(same as @Ignore in JUnit4).

Step 6 - Create serenity.conf file under src/test/resources

Serenity.conf file is used to specify various features like type of webdriver used, various test environments, run test in headless mode and many more options.

 webdriver {     driver = firefox }  drivers {   windows {     webdriver.chrome.driver = src/test/resources/webdriver/windows/chromedriver.exe     webdriver.gecko.driver = src/test/resources/webdriver/windows/geckodriver.exe   } }  environments {   default {     webdriver.base.url = "https://opensource-demo.orangehrmlive.com/"   }   dev {     webdriver.base.url = "https://opensource-demo.orangehrmlive.com/dev"   }   staging {     webdriver.base.url = "https://opensource-demo.orangehrmlive.com/staging"   }   prod {     webdriver.base.url = "https://opensource-demo.orangehrmlive.com/prod"   } }  

Step 7 - Create serenity.properties file in the root of the project

 serenity.project.name = Serenity and JUnit5 Demo 

Step 8 - Run the tests through commandline which generates Serenity Report - Index.html and Serenity-Summary.html

Execute the tests through command line by using below command

 mvn clean verify 

Here, you can see that one test is ignored because I have mentioned @Disabled for one of the test in the test script.

The path of Serenity reports are mentioned in the image. The reports are generated under /target/site/serenity/.

The disabled test is shown in the image.

Serenity-Summary.html

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!


This post is ad-supported