Cucumber scenarios parallel execution with ThreadLocal driver and dynamic dataproviderthreadcount | TestNG, Java Selenium, Maven , POM page factory

• Scenario Independence
• Thread Safety
• Tagging Scenarios
• Synchronization

• DriverFactory for chrome and edge - How to pass chrome or edge as command line argument ? 
• Parallel execution configurations - Where and how to configure parallel execution with TestNG? 
• POM model with page factory pattern - How to isolate locators and step definitions ? 
• Cucumber hooks  - What is the recommendation of cucumber hooks over TestNG hooks ?  
• Reports 
• Which report is to be used - cucumber reports or extent reports ?  cucumber reports 
• Where to write email code to send the latest reports ? In JVM shutdown hook that is written in cucumber AfterAll hook
  (Did you ever try to remove or refresh a folder to have the latest reports to be sent over email)
• How to run the project ?
• Through command line 
• Through eclipse run as TestNG
• Through executable jar file

Jumping on to the core of this article i.e., parallel testing 

Parallel execution configurations:

(For complete code download project from GitHub or Use this link to download as Zip) 

• Declare thread local driver in WebDriverFactory java class and then set, get and remove instances of the driver. 
  
  

  privatestatic ThreadLocal<WebDriver> driver = new ThreadLocal<>();

• Override the DataProvider annotation with parallel=true in CucumberRunnerTest that extends AbstractTestNGCucumberTests class. 
  

  publicclass CucumberRunnerTest extends AbstractTestNGCucumberTests {

  
  

  @Override

  @DataProvider(parallel = true)

  public Object[][] scenarios() {

  returnsuper.scenarios();

  }

  }

• Create a testng.xml file and give parallel=true and data-provider-thread-count=1 and the runner class as shown below.
  

  <?xml version="1.0" encoding="UTF-8"?>

  <!DOCTYPEsuite SYSTEM "https://testng.org/testng-1.0.dtd">

  <suitename="Suite"parallel="true"data-provider-thread-count="1"verbose="2">

  <testname="Test">

  <classes>

  <classname="runners.CucumberRunnerTest" />

  </classes>

  </test> <!--

  Test -->

  </suite> <!--

  Suite -->

• In pom.xml add the testng.xml as suiteXml file  in maven-surefire-plugin.
  

  <plugin>

  <groupId>org.apache.maven.plugins</groupId>

  <artifactId>maven-surefire-plugin</artifactId>

  <version>3.1.2</version>

  <configuration>

  <suiteXmlFiles>

  <suiteXmlFile>testng.xml</suiteXmlFile>

  </suiteXmlFiles>

  </configuration>

  </plugin>

That's all we need to make cucumber scenarios to run parallel with TestNG as testing framework. 
So, after configurations - How to run the code to see parallel execution ? 

On the command prompt - maven execution

• Navigate to the the project folder location - you should have the pom.xml in it. 
• Run below command in Command prompt. 
  
  mvn -Dbrowser=chrome -Ddataproviderthreadcount=2 test
  
  
• This command opens two chrome browser parallelly as passing dataproviderthreadcount =2 
• If passed 1 then sequential execution takes place. 

On the command prompt - jar execution 

• Use the maven-assembly-plugin and Main.run method creation technique to create a jar file
  (scroll down to the complete code section below and see how assembly plugin is configured in pom.xml and how Main.main takes arguments in CucumberRunnerCLI.java class )
  
  
• Now to create executable/runnable jar file give below goal in eclipse 
  (Runs As -> Maven build -> Goals)  (Note: Make sure to clean the project prior assembling)
   
  clean package assembly:single -Dmaven.test.skip=true
  
  
• Running above command downloads required jar files in .m2 repository and creates and copy the jar file in target folder. 
  

  [ [1;34mINFO [m] Building jar: E:\Automation\CucumberParallelExecutionTestNG\ target\CucumberParallelExecutionTestNG-0.0.1-SNAPSHOT-jar-with-dependencies.jar

  [ [1;34mINFO [m] [1m------------------------------------------------------------------------ [m

  [ [1;34mINFO [m] [1;32mBUILD SUCCESS

• Use below command to run the scenarios from jar generated in target folder. 
  
  java -Ddataproviderthreadcount=1 -Dbrowser=chrome -jar CucumberParallelExecutionTestNG-0.0.1-SNAPSHOT-jar-with-dependencies.jar

In the Eclipse Run As TestNG with Run Configurations

• Run As -> TestNG -> Run Configurations -> VM Arguments 
   --> -Dbrowser=chrome -Ddataproviderthreadcount=2

This is how one could able to run the scenarios in parallel with TestNG as the testing framework. 


Interesting Research Observations: 

<projectxmlns="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 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>CucumberParallelExecutionTestNG</groupId><artifactId>CucumberParallelExecutionTestNG</artifactId><version>0.0.1-SNAPSHOT</version><name>CucumberParallelExecutionTestNG</name><description>CucumberParallelExecutionTestNG</description><dependencies><dependency><groupId>io.cucumber</groupId><artifactId>cucumber-java</artifactId><version>7.12.0</version></dependency><!-- https://mvnrepository.com/artifact/io.cucumber/cucumber-java --><dependency><groupId>io.cucumber</groupId><artifactId>cucumber-testng</artifactId><version>7.12.0</version></dependency><dependency><groupId>org.seleniumhq.selenium</groupId><artifactId>selenium-java</artifactId><version>4.10.0</version></dependency><!-- https://mvnrepository.com/artifact/org.testng/testng --><!--	<dependency><groupId>org.testng</groupId><artifactId>testng</artifactId><version>7.8.0</version></dependency>--><dependency><groupId>tech.grasshopper</groupId><artifactId>extentreports-cucumber7-adapter</artifactId><version>1.2.0</version></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.24</version><scope>provided</scope></dependency><!-- https://mvnrepository.com/artifact/javax.mail/mail --><dependency><groupId>javax.mail</groupId><artifactId>mail</artifactId><version>1.4.7</version></dependency></dependencies><build><pluginManagement><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-surefire-plugin</artifactId><version>3.1.2</version><configuration><suiteXmlFiles><suiteXmlFile>testng.xml</suiteXmlFile></suiteXmlFiles></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.11.0</version><configuration><source>17</source><target>17</target></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-assembly-plugin</artifactId><version>3.1.1</version><configuration><archive><manifest><addClasspath>true</addClasspath><mainClass>runners.CucumberRunnerCLI</mainClass></manifest><manifestEntries><Class-Path>.</Class-Path></manifestEntries></archive><descriptorRefs><descriptorRef>jar-with-dependencies</descriptorRef></descriptorRefs></configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions></plugin></plugins></pluginManagement></build></project>

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd"><suitename="Suite"parallel="true"data-provider-thread-count="1"verbose="2"><testname="Test"><classes><classname="runners.CucumberRunnerTest"/></classes></test><!--	Test --></suite><!--Suite -->

package driverfactory;importorg.openqa.selenium.WebDriver;importorg.openqa.selenium.chrome.ChromeDriver;importorg.openqa.selenium.chrome.ChromeOptions;importorg.openqa.selenium.edge.EdgeDriver;publicfinalclassWebDriverFactory{privatestatic ThreadLocal<WebDriver> driver =new ThreadLocal<>();publicstaticvoidsetDriver(){

		String browser = System.getProperty("browser","chrome");if(browser.equalsIgnoreCase("chrome")){
			System.setProperty("webdriver.chrome.driver","E:\\Drivers\\chromedriver.exe");
			ChromeOptions options =new ChromeOptions();
			options.addArguments("--remote-allow-origins=*");
			driver.set(new ChromeDriver(options));
			getDriver().manage().window().maximize();
			getDriver().manage().deleteAllCookies();}elseif(browser.equalsIgnoreCase("edge")){
			System.setProperty("webdriver.edge.driver","E:\\Drivers\\msedgedriver.exe");
			driver.set(new EdgeDriver());
			getDriver().manage().window().maximize();
			getDriver().manage().deleteAllCookies();}}publicstatic WebDriver getDriver(){return driver.get();}publicstaticvoidcloseDriver(){
		driver.get().quit();
		driver.remove();}}

package hooks;importjava.net.InetAddress;importjava.net.UnknownHostException;importdriverfactory.WebDriverFactory;importio.cucumber.java.After;importio.cucumber.java.AfterAll;importio.cucumber.java.Before;importio.cucumber.java.Scenario;publicclassHooks{@Before(order =0)publicvoidbefore(Scenario scenaio)throws Exception {

		WebDriverFactory.setDriver();
		System.out.println("Current Thread Name:"+ Thread.currentThread().getName());
		System.out.println("Current Thread ID:"+ Thread.currentThread().getId());}@After(order =0)publicvoidafter()throws Exception {
		WebDriverFactory.closeDriver();}@AfterAll(order =0)publicstaticvoidafterAll()throws UnknownHostException {
		System.out.println("AfterAll - with order=0");

		InetAddress localhost = InetAddress.getLocalHost();
		System.out.println("System IP Address : "+(localhost.getHostAddress()).trim());

		Runtime.getRuntime().addShutdownHook(new Thread(new Runnable(){@Overridepublicvoidrun(){

				System.out.println("Write email code in this method - Shutdown Hook is running and this text prints before JVM shut downs!");}}));
		System.out.println("This text prints before Shutdown hook");}}

package pagefactory;importorg.openqa.selenium.WebDriver;importorg.openqa.selenium.WebElement;importorg.openqa.selenium.support.FindBy;publicclassLoginPageFactory{public WebDriver driver;publicLoginPageFactory(WebDriver driver){this.driver= driver;}// Username locator@FindBy(xpath ="//input[@name='username']")public WebElement userName;// Password locator@FindBy(xpath ="//input[@name='password']")public WebElement passWord;// Login button locator@FindBy(xpath ="//button[@type='submit']")public WebElement loginButton;// Forgot password locator@FindBy(xpath ="//p[@class='oxd-text oxd-text--p orangehrm-login-forgot-header']")public WebElement forgotPassword;// Method that performs Username actionpublicvoidenterUsername(String uname){
		userName.sendKeys(uname);}// Method that performs Password actionpublicvoidenterPassword(String pwd){
		passWord.sendKeys(pwd);}// Method that performs Login actionpublicvoidclickLogin(){
		loginButton.click();}// Method that performs Forgot Password link verificationpublicbooleanisForgotPasswordLinkPresent(){return forgotPassword.isDisplayed();}}

package runners;importio.cucumber.core.cli.*;publicclassCucumberRunnerCLI{publicstaticvoidmain(String[] args){

		String threadCount = System.getProperty("dataproviderthreadcount","1");
		Main.run(new String[]{"classpath:scenarios","-g","driverfactory","-g","hooks","-g","pagefactory","-g","runners","-g","stepdef","-p","pretty","-p","json:target/cucumber-reports/cucumber.json","-p","html:target/cucumber-reports/cucumber-report.html","-m","--threads",threadCount
				

		}, Thread.currentThread().getContextClassLoader());}}

package runners;importorg.testng.annotations.DataProvider;importio.cucumber.testng.AbstractTestNGCucumberTests;importio.cucumber.testng.CucumberOptions;@CucumberOptions(

		features ="classpath:scenarios", 
		tags ="@Login or @ForgotPassword", 
		glue ={"driverfactory","hooks","pagefactory","runners","stepdef"}, 
		plugin ={"pretty","json:target/cucumber-reports/cucumber.json","html:target/cucumber-reports/cucucmber-report.html"}, 
		monochrome =true)publicclassCucumberRunnerTestextends AbstractTestNGCucumberTests {@Override@DataProvider(parallel =true)public Object[][]scenarios(){returnsuper.scenarios();}}

package stepdef;importorg.openqa.selenium.support.PageFactory;importorg.testng.Assert;importdriverfactory.WebDriverFactory;importio.cucumber.java.en.Given;importio.cucumber.java.en.Then;importio.cucumber.java.en.When;importpagefactory.LoginPageFactory;publicclassLoginStepDef{
	LoginPageFactory login = PageFactory.initElements(WebDriverFactory.getDriver(), LoginPageFactory.class);@Given("User is on login page")publicvoiduser_is_on_login_page()throws InterruptedException {

		WebDriverFactory.getDriver().get("https://opensource-demo.orangehrmlive.com/web/index.php/auth/login");
		Thread.sleep(3000);}@When("User enters username {string}")publicvoiduser_enters_username(String username){
		login.enterUsername(username);}@When("User enters password {string}")publicvoiduser_enters_password(String password){
		login.enterPassword(password);}@When("User clicks on Login button")publicvoiduser_clicks_on_login_button()throws InterruptedException {
		login.clickLogin();
		Thread.sleep(3000);}@Then("User should navigate to Orange HRM home page")publicvoiduser_should_navigate_to_orange_hrm_home_page(){

		String expectedURLToNavigate ="https://opensource-demo.orangehrmlive.com/web/index.php/dashboard/index";
		String actualURLNavigated = WebDriverFactory.getDriver().getCurrentUrl();
		Assert.assertEquals(actualURLNavigated, expectedURLToNavigate);}@Then("User verifies Forgot password link display")publicvoiduser_verifies_forgot_password_link_display(){
		Assert.assertTrue(login.isForgotPasswordLinkPresent());}}

cucumber.publish.enabled=true