DEV Community: Manul wickrmanayaka

How to do Multiple Browser Parallel Testing in a selenium TestNG project

Manul wickrmanayaka — Wed, 26 May 2021 19:17:03 +0000

Topics to be covered in this article.

What is Parallel Testing?
What is testing.xml?
Adding Dependencies to the pom.xml file
Creating a Java class
Creating a testing.xml file
Demo Test Run
Thread count

What is Parallel Testing?

In parallel testing, we test different modules or applications on multiple browsers in parallel rather than one by one.

The parallel test execution is different from sequential testing, where we test different modules or functionalities one after the other.

This approach of testing is very time-consuming.
Parallel testing helps to reduce execution time and efforts and results in a faster time to delivery. It proves to be handy specifically in case of cross browser testing.

So in this article we are going to work with Selenium, TestNG using testing.xml file. And practically discuss about parallel testing, parallel thread count and how to run tests in multiple browsers in parallel.

Then lets go for it…

What is testing.xml?

If you are using TestNG as your testing framework in your selenium project then testing.xml file is a configuration file in TestNG and we can use this file to set some execution settings to our tests.

Basically testing.xml file is used to control the execution of a TestNG test like what packages/ classes/ methods should included, what should not be excluded, setting dependencies and so on…

So lets start a simple test using TestNG by adding dependencies in the pom.xml file.

Adding Dependencies to the pom.xml file

First create a maven project and name it as Testing.XML. Then add following dependencies to the pom.xml file.

First copy the selenium dependency and set it in the pom.xml file.
https://mvnrepository.com/artifact/org.seleniumhq.selenium/selenium-java/3.141.59

<dependency>
    <groupId>org.seleniumhq.selenium</groupId>
    <artifactId>selenium-java</artifactId>
    <version>3.141.59</version>
</dependency>

Copy the TestNG dependency and set it in the pom.xml file.
https://mvnrepository.com/artifact/org.testng/testng

<! —  https://mvnrepository.com/artifact/org.testng/testng →
<dependency>
 <groupId>org.testng</groupId>
 <artifactId>testng</artifactId>
 <version>7.4.0</version>
 <scope>test</scope>
</dependency>

As well as set the WebDriver maven dependency for Chrome and Firefox drivers.
https://mvnrepository.com/artifact/io.github.bonigarcia/webdrivermanager/4.4.3

<dependency>
    <groupId>io.github.bonigarcia</groupId>
    <artifactId>webdrivermanager</artifactId>
    <version>4.4.3</version>
</dependency>

That all we have to do as prerequisites and we are good to go…

Creating a Java class

Create a new Java class called test.java inside the package “test”.

For a simple test lets try to navigate to “www.ebay.com” , validate the site based on title and search something and hit enter.

Paste this code into your project and run it as a TestNG Test.

package test;
import org.openqa.selenium.By;
import org.openqa.selenium.Keys;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.testng.Assert;
import org.testng.annotations.AfterTest;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;
import io.github.bonigarcia.wdm.WebDriverManager;
public class DarazSearchTestNG {

 WebDriver driver = null;
 static String expectedTitleebay ="Electronics, Cars, Fashion, Collectibles & More | eBay";

 @BeforeTest
 public void setUp(){
 String browserName = "chrome";
  if(browserName.equalsIgnoreCase("chrome")) {
  //initializing and starting the Chromebrowser
  WebDriverManager.chromedriver().setup();
  driver = new ChromeDriver();
 }else if(browserName.equalsIgnoreCase("firefox")) { 
  //initializing and starting the Chromebrowser  
  WebDriverManager.firefoxdriver().setup();   
  driver = new FirefoxDriver();  
 }
}
@Test
 public void test1() throws InterruptedException {

  //maximize the window 
  driver.manage().window().maximize();
  driver.get("https://www.ebay.com");
  Thread.sleep(1000);

  String actualTitle = driver.getTitle();
  Assert.assertEquals(actualTitle, expectedTitleebay);

  driver.findElement(By.xpath("//*[@id=\"gh-ac\"]")).sendKeys("Mobile");
  Thread.sleep(1000);
  driver.findElement(By.xpath("//*[@id=\"gh-btn\"]")).sendKeys(Keys.RETURN);
  Thread.sleep(1000);

 }

@Test
public void test2() throws InterruptedException {

 //maximize the window 
 driver.manage().window().maximize();
 driver.get("https://www.ebay.com");
 Thread.sleep(1000);

 String actualTitle = driver.getTitle();
 Assert.assertEquals(actualTitle, expectedTitleebay);

 driver.findElement(By.xpath("//*[@id=\"gh-ac\"]")).sendKeys("Mobile");
 Thread.sleep(1000);
 driver.findElement(By.xpath("//*[@id=\"gh-btn\"]")).sendKeys(Keys.RETURN);
 Thread.sleep(1000);

}

 @AfterTest
 public void  tearDown() {
  driver.quit();
}
}

You will see that two browsers are opening one after the another , validate the title, input “Mobile” as the value and hit enter.

This TestNG class contain two @test annotations and sites are running on one browser . In this case I have written the code to choose the browser in the @BeforeTest and if you want you can call it from another class. You can pass it from a parameter and change it.

So lets try to run the same thing using the testing.xml file by passing a parameter value to the class.

Creating a testing.xml file

Go to your test.java class right click on it, go to TestNG section and click on the convert to TestNG option. You will see a window like this.

AS you can see I have name my Suite name as “Suite1” and Test name as “Test1”

Class selection: Here we can select what level we want to create our XML document.(class or package)

Parallel mode: This will allow us to choose whether we want to run our tests in parallel mode(classes/methods/tests) or not.

Thread count: This will choose the thread count we want to run our tests.

For the moment lets create XML file in class level. You will see our testing.xml file like bellow.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd">
<suite name="Suite1">
  <test thread-count="5" name="Test1">
    <classes>
      <class name="test.test"/>
    </classes>
  </test> <!-- Test1 -->
</suite> <!-- Suite1 -->

You will see the browser is opening and do the actions accordingly. Now the case is what if we want to run the test in multiple browsers (both chrome and firefox) and parallelly.

Demo Test Run

Before our test run change the @BeforeTest as follow because we are passing the browserName as a parameter from testing.xml file

@Parameters("browserName")
@BeforeTest
public void setUp(String browserName){
if(browserName.equalsIgnoreCase("chrome")) {
  //initializing and starting the Chromebrowser
  WebDriverManager.chromedriver().setup();
  driver = new ChromeDriver();
 }else if(browserName.equalsIgnoreCase("firefox")) { 
  //initializing and starting the Chromebrowser  
  WebDriverManager.firefoxdriver().setup();   
  driver = new FirefoxDriver();  
 }
}

Also make sure you remove one @test annotation because we can launch multiple number of browsers from the testing.xml file here after.

You just need to make a little change in the testing.xml file to run on multiple browsers and run the suite.

Inside the Test tag pass the browser parameter to the class by putting this code. In here I have passed chrome and firefox.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd">
<suite name="Suite1" parallel="tests" thread-count="2">

  <test name="test on firefox">
  <parameter name="browserName" value="firefox"></parameter>
    <classes>
      <class name="test.test"/>
    </classes>
  </test> <!-- Test1 -->

  <test name="test on chrome">
  <parameter name="browserName" value="chrome"></parameter>
    <classes>
      <class name="test.test"/>
    </classes>
  </test> <!-- Test1 -->

</suite> <!-- Suite1 -->

I have written two tags for each browser mentioning its name. You will see two browsers are running parallelly.

So this is how we run multiple browsers parallelly using testing.xml file.
But if you noticed I have given a thread count as 2. What is meant by this?

Thread count

It’s the number of tests that are run at the same time. It’s like saying how many cars in a fleet that you want on the highway at the same time. If you say you want them to take up three lanes, then they will take up no more than three lanes, but it will take longer to get all cars through. If you say five lanes, then they will take up no more than five lanes, but it will take less time to get all cars through.

So in here as I running this test only from two browsers I have mentioned thread count as 2. So lets see How it works. For better understanding I have put another firefox browser tag in the testing.xml file to understand the thread count.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd">
<suite name="Suite1" parallel="tests" thread-count="2">

  <test name="test on firefox">
  <parameter name="browserName" value="firefox"></parameter>
    <classes>
      <class name="test.test"/>
    </classes>
  </test> <!-- Test1 -->

  <test name="test on chrome">
  <parameter name="browserName" value="chrome"></parameter>
    <classes>
      <class name="test.test"/>
    </classes>
  </test> <!-- Test1 -->

  <test name="test2 on firefox">
  <parameter name="browserName" value="firefox"></parameter>
    <classes>
      <class name="test.test"/>
    </classes>
  </test> <!-- Test1 -->
</suite> <!-- Suite1 -->

First put this code at the end of *test() method and see the output in the console. This will show the current thread ID the test is running.

System.out.println("This test is on: " + Thread.currentThread().getId());

In bellow results you will see two tests are running on two different threads.
First it runs on thread 15 at the same time thread 16 is used. In the third test it search for the available thread and use that. In this case thread 15 was free and launched the test 2 on firefox.

This test is on: 15
This test is on: 16
This test is on: 15

So this is how we use thread count and maximize our efficiency. Its recommended to use higher thread count as it won’t make any unnecessary traffic in the memory.

In here I have only used one class but you can use multiple classes and also we can run our tests calling methods using tag. You can or any given method.

<class name="class_name" />
<method>
    <include name="MethodName"></include>
    <exclude name="MethodName"></include>
</method>

Here in this article we have used testing.xml file to run our TestNG tests parallelly in a selenium project. Also we used multiple browsers to run them parallelly.

For your reference find my GitHub project here

𝑻𝑯𝑰𝑵𝑲 𝑸𝑼𝑨𝑳𝑰𝑻𝒀!

How to run a Selenium Project from command line using JAR files

Manul wickrmanayaka — Mon, 24 May 2021 21:18:22 +0000

What is JAR ?

JAR(Java ARchive) files are archive files that include a Java-specific manifest file. They are built on the ZIP format and typically have a .jar file extension.

In simple words JAR file is a compressed format of a compiled Java project. This file contains with .class files, meta data and some other resources. Also these files are a way to distribute our source code and can be used by external programs.

In here we are focusing on how to run a .jar file from command line without using any IDE.

First step should be we are going to need a java project to create a .jar file and I’ll use one of my previous program which I used to run with selenium and TestNG.

You can refer to my article on “Use of .properties file in selenium project with TestNG” and I’ll take the same code and continue it further.

For your reference find my GitHub project here

PropertiesFile Class:



package test;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Properties;
import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.reporter.ExtentSparkReporter;
public class PropertiesFile {
//Create a object for class properties 
 static Properties prop = new Properties();
 //defining the project path
 static String projectPath = System.getProperty("user.dir");
//setting expected title from the ebay.com/Daraz.lk
 static String expectedTitleebay ="Electronics, Cars, Fashion, Collectibles & More | eBay";
 static String expectedTitledaraz ="Online Shopping Sri Lanka: Clothes, Electronics & Phones | Daraz.lk";
//create the htmlReporter object
static ExtentSparkReporter htmlReporter;
 static ExtentReports extent;
 static ExtentTest test1;
public static String browserName = null;
public static void main(String[] args) throws InterruptedException {
PropertiesFileTestNG.setup();
  PropertiesFileTestNG.test1();
  PropertiesFileTestNG.tearDown();
 }
public static void getProperties() {
try {
//create a object for class InputStream
   InputStream input = new FileInputStream(projectPath + "/src/test/java/test/config.properties");
   //Load properties file
   prop.load(input);
   //get values from properties file
   String browser = prop.getProperty("browser");
   System.out.println(browser);
   //Setting browsername in the PropertiesFileTestNG class
   PropertiesFileTestNG.browserName = browser;
} catch (Exception exp) {
System.out.println(exp.getMessage());
   System.out.println(exp.getCause());
   exp.printStackTrace();
}
}
public static void setProperties() {
try {
//create a object for class OuputStream
   OutputStream output = new FileOutputStream(projectPath + "/src/test/java/test/config.properties");
   //Load properties file and set firefox
   prop.setProperty("result", "test passed");
   //store values i properties file
   prop.store(output, "setting firefox");
} catch (Exception exp) {
System.out.println(exp.getMessage());
   System.out.println(exp.getCause());
   exp.printStackTrace();
  }
}
}

PropertiesFileTestNG Class:



package test;
import org.openqa.selenium.By;
import org.openqa.selenium.Keys;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.testng.Assert;
import org.testng.annotations.AfterSuite;
import org.testng.annotations.BeforeSuite;
import org.testng.annotations.Test;
import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.reporter.ExtentSparkReporter;
import io.github.bonigarcia.wdm.WebDriverManager;
public class PropertiesFileTestNG {
//creating driver object
 private static WebDriver driver = null;
//setting expected title from the ebay.com/Daraz.lk
 static String expectedTitleebay ="Electronics, Cars, Fashion, Collectibles & More | eBay";
 static String expectedTitledaraz ="Online Shopping Sri Lanka: Clothes, Electronics & Phones | Daraz.lk";
//create the htmlReporter object
static ExtentSparkReporter htmlReporter;
 static ExtentReports extent;
 static ExtentTest test1;

 public static String browserName = null;

 @BeforeSuite
 public static void setup() {

  PropertiesFile.getProperties();
if(browserName.equalsIgnoreCase("chrome")) {
   //initializing and starting the chrome browser
   WebDriverManager.chromedriver().setup();
   driver = new ChromeDriver();

  }else if(browserName.equalsIgnoreCase("firefox")) {
   //initializing and starting the firefox browser
   WebDriverManager.firefoxdriver().setup();
   driver = new FirefoxDriver();

  }
htmlReporter = new ExtentSparkReporter("extentReport.html");
  //create ExtentReports and attach reporter(s)
  extent = new ExtentReports();
  extent.attachReporter(htmlReporter);

 }
@Test  
 public static void test1() throws InterruptedException {

  //creates a toggle for the given test, add all log events under it
  test1 = extent.createTest("ebay Search Test", "test to validate search box ");
test1.log(Status.INFO, "Starting test case");

  if (browserName.equals("firefox")) {
   System.out.println("Starting test on Firefox");
   test1.pass("Starting test on Firefox");
  }else if(browserName.equals("chrome")) {
   System.out.println("Starting test on chrome");
   test1.pass("Starting test on chrome");
  }

  //maximize the window 
  driver.manage().window().maximize();
  test1.pass("maximize has done");
//Navigate to Ebay.com
  driver.get("https://www.ebay.com");
  Thread.sleep(1000);
  test1.pass("Navigate to Ebay.com");
//compare whether the title id matching
  String actualTitle = driver.getTitle();
  Assert.assertEquals(actualTitle, expectedTitleebay);
  test1.pass("title is correct");
//enter in the TextBox
  driver.findElement(By.xpath("//*[@id=\"gh-ac\"]")).sendKeys("Mobile");
  test1.pass("Entered text in the text box");
  Thread.sleep(1000);
  //hit enter
  driver.findElement(By.xpath("//*[@id=\"gh-btn\"]")).sendKeys(Keys.RETURN); 
  test1.pass("Press keybopard enter key");
  Thread.sleep(1000);

 }

 @AfterSuite
 public static void tearDown() {
driver.quit();
  test1.pass("closed the browser");
test1.info("test completed"); 

  //write results into the file
  extent.flush();
PropertiesFile.setProperties();
 }
}

config.properties:



browser=chrome

Since we were calling main() from the PropertiesFileTestNG class we won’t be able to run the actual test in main() method class. For that I have pasted this code in the class level in PropertiesFile Class.



//setting expected title from the ebay.com/Daraz.lk
 static String expectedTitleebay ="Electronics, Cars, Fashion, Collectibles & More | eBay";
 static String expectedTitledaraz ="Online Shopping Sri Lanka: Clothes, Electronics & Phones | Daraz.lk";
//create the htmlReporter object
static ExtentSparkReporter htmlReporter;
 static ExtentReports extent;
 static ExtentTest test1;
public static String browserName = null;

Copy all the above codes to your project and run it.

This will go to the site www.ebay.com and then it will validate site by comparing Title. After will enter "mobile" in the search box and hit enter.

I have used @test annotation to execute the test case which is test1 and used extent Reports as the reporting library.

After a successful test it will call the PropertiesFile and write the status of our test to the .properties file.

So in above code we had to change the browser name as "chrome" or "firefox" by opening the project. So the same thing can be done with CMD without using Eclipse.

So First lets create a .jar file by right clicking on the project and going to export option.

You will see this window and click Runnable JAR file.

Under Launch Configuration select the class which you included the main() method. In our case it is PropertiesFile.class

Give a name to the JAR file (in my case I named it as selenium.jar ) and define the export Destination and Finish.

Go to the physical location that you have saved the JAR file and you will see it created there as selenium.jar

Now we have created our JAR file and lets run it from the command line.

Open the cmd and navigate to the selenium.jar file location.

Enter this command to execute the selenium.jar file and hit Enter.



java -jar selenium.jar

You will see the progress in the cmd and passing all tests.

You will see the SOP() outputs we print in the console and its passing. Also we can go to extent reports and see the test results.

In this article we created a JAR file and ran a selenium TestNG framework using command line without using any IDE.

𝑻𝑯𝑰𝑵𝑲 𝑸𝑼𝑨𝑳𝑰𝑻𝒀!

Use of .properties file in selenium project with TestNG

Manul wickrmanayaka — Mon, 24 May 2021 00:01:49 +0000

.properties files are mainly used in Java programs to maintain project configuration data, database config or project settings, etc. You can easily read properties from some file using an object of type Properties. This is a utility provided by Java itself.

In simple words Properties file is a file with .properties as extension. Each parameter in properties file is stored as a pair of strings, in key-value pair format(key = value), where each key is on one line. They can also be used for storing strings for Internationalization and localization.

Since .properties file is a java library from .util package we do not need any dependencies. but because I’m using TestNG, Selenium and doing browser action lets start with a maven project.

1.Adding Dependencies to the pom.xml file

First create a maven project and name it as PropertiesFile. Then add following dependencies to the pom.xml file.

First copy the selenium dependency and set it in the pom.xml file.



https://mvnrepository.com/artifact/org.seleniumhq.selenium/selenium-java/3.141.59
<dependency>
    <groupId>org.seleniumhq.selenium</groupId>
    <artifactId>selenium-java</artifactId>
    <version>3.141.59</version>
</dependency>

Copy the TestNG dependency and set it in the pom.xml file.



https://mvnrepository.com/artifact/org.testng/testng
<! —  https://mvnrepository.com/artifact/org.testng/testng →
<dependency>
 <groupId>org.testng</groupId>
 <artifactId>testng</artifactId>
 <version>7.4.0</version>
 <scope>test</scope>
</dependency>

As well as set the WebDriver maven dependency for make our test simple.



https://mvnrepository.com/artifact/io.github.bonigarcia/webdrivermanager/4.4.3
<dependency>
    <groupId>io.github.bonigarcia</groupId>
    <artifactId>webdrivermanager</artifactId>
    <version>4.4.3</version>
</dependency>

That all we have to do as prerequisites and you are good to go…

2.Create a file with a .properties extension

Under PropertiesFile project create a package called config.
Right click on it and create a File as config.properties.
This is the vey first step we are going to do by initializing our key value pair as below.



browser=chrome

3.Create a Java class

Create a new class called “PropertiesFile”. And include the main() method.

For understand the behavior of the .properties file lets write a simple code.

I have written this code with the Code Modular and to handle the exceptions its written in the try-catch block.



package test;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Properties;
public class PropertiesFile {
//Create a object for class properties 
 static Properties prop = new Properties();
 //defining the project path
 static String projectPath = System.getProperty("user.dir");
public static void main(String[] args) {
getProperties();
  setProperties();
  getProperties();
}
public static void getProperties() {
try {
//create a object for class InputStream
   InputStream input = new FileInputStream(projectPath + "/src/test/java/test/config.properties");
   //Load properties file
   prop.load(input);
   //get values from properties file
   String browser = prop.getProperty("browser");
   System.out.println(browser);
} catch (Exception exp) {
System.out.println(exp.getMessage());
   System.out.println(exp.getCause());
   exp.printStackTrace();
}
}
public static void setProperties() {
try {
//create a object for class OuputStream
   OutputStream output = new FileOutputStream(projectPath + "/src/test/java/test/config.properties");
   //Load properties file and set firefox
   prop.setProperty("browser", "firefox");
   //store values i properties file
   prop.store(output, "setting firefox");
} catch (Exception exp) {
System.out.println(exp.getMessage());
   System.out.println(exp.getCause());
   exp.printStackTrace();
  }
}
}

Press CTRL + SHIFT + O to import all classes from the .util package.
This code will read the value from .properties file and print the value in the console. Then It will write new value to the same key from .properties file and again call the previous function. Lets understand what I have done here inside the code.

First I have created two methods inside the class named getProperties() and setProperties()



getProperties()
setProperties()

getProperties() will read the values from the .properties file.
setProperties()will write values to the .properties file.

Then I have created a object called prop from the class level.



static Properties prop = new Properties();

In getProperties() method I have set the path to the .properties file and created the object input



InputStream input = new FileInputStream(projectPath + "/src/test/java/test/config.properties");

And In here its reading the value from the .properties file and store in the variable browse*



String browser = prop.getProperty("browser");

In setProperties() method I have again set the path to the .properties file and created the object output



OutputStream output = new FileOutputStream(projectPath + "/src/test/java/test/config.properties");

Here its overwriting the value in the .properties file to the firefox and finally store it.



prop.setProperty("browser", "firefox");
prop.store(output, "setting firefox");

And in the .properties file you will see its replaced with the value firefox and the date is also has been set.



#setting firefox
#Mon May 24 01:08:49 IST 2021
browser=firefox

So this is how we write and read from the .properties file. So lets try to put another step by using TestNG and doing some browser actions with selenium.

4.Create a TestNG Class

Use the same package and create another class called "PropertiesFileTestNG". And do not include a main() method since it is a TestNG class.

For this example I will use a code which I had in my previous article "How to use Extent Reports with TestNG in Selenium Java"

Just check in the link below. I have explained the code there.
https://manulwick.medium.com/how-to-use-extent-reports-with-testng-in-selenium-java-c892cf256737

This will go to the site www.ebay.com and then it will validate site by comparing Title. After will enter "mobile" in the search box and hit enter.
I have used @test annotation to execute the test case which is test1 and used extent Reports as the reporting library.



package test;
import org.openqa.selenium.By;
import org.openqa.selenium.Keys;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.testng.Assert;
import org.testng.annotations.AfterSuite;
import org.testng.annotations.BeforeSuite;
import org.testng.annotations.Test;
import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.reporter.ExtentSparkReporter;
import io.github.bonigarcia.wdm.WebDriverManager;
public class PropertiesFileTestNG {
//creating driver object
 private static WebDriver driver = null;
//setting expected title from the ebay.com/Daraz.lk
 static String expectedTitleebay ="Electronics, Cars, Fashion, Collectibles & More | eBay";
 static String expectedTitledaraz ="Online Shopping Sri Lanka: Clothes, Electronics & Phones | Daraz.lk";
//create the htmlReporter object
ExtentSparkReporter htmlReporter;
 ExtentReports extent;
 ExtentTest test1;

 public static String browserName = null;

 @BeforeSuite
 public void setup() {

  PropertiesFile.getProperties();
if(browserName.equalsIgnoreCase("chrome")) {
   //initializing and starting the chrome browser
   WebDriverManager.chromedriver().setup();
   driver = new ChromeDriver();

  }else if(browserName.equalsIgnoreCase("firefox")) {
   //initializing and starting the firefox browser
   WebDriverManager.firefoxdriver().setup();
   driver = new FirefoxDriver();

  }
htmlReporter = new ExtentSparkReporter("extentReport.html");
  //create ExtentReports and attach reporter(s)
  extent = new ExtentReports();
  extent.attachReporter(htmlReporter);

 }
@Test  
 public void test1() throws InterruptedException {

  //creates a toggle for the given test, add all log events under it
  test1 = extent.createTest("ebay Search Test", "test to validate search box ");
test1.log(Status.INFO, "Starting test case");

  if (browserName.equals("firefox")) {
   System.out.println("Starting test on Firefox");
   test1.pass("Starting test on Firefox");
  }else if(browserName.equals("chrome")) {
   System.out.println("Starting test on chrome");
   test1.pass("Starting test on chrome");
  }

  //maximize the window 
  driver.manage().window().maximize();
  test1.pass("maximize has done");
//Navigate to Ebay.com
  driver.get("https://www.ebay.com");
  Thread.sleep(1000);
  test1.pass("Navigate to Ebay.com");
//compare whether the title id matching
  String actualTitle = driver.getTitle();
  Assert.assertEquals(actualTitle, expectedTitleebay);
  test1.pass("title is correct");
//enter in the TextBox
  driver.findElement(By.xpath("//*[@id=\"gh-ac\"]")).sendKeys("Mobile");
  test1.pass("Entered text in the text box");
  Thread.sleep(1000);
  //hit enter
  driver.findElement(By.xpath("//*[@id=\"gh-btn\"]")).sendKeys(Keys.RETURN); 
  test1.pass("Press keybopard enter key");
  Thread.sleep(1000);

 }

 @AfterSuite
 public void tearDown() {
driver.quit();
  test1.pass("closed the browser");
test1.info("test completed"); 

  //write results into the file
  extent.flush();
PropertiesFile.setProperties();
}
}

I have created a variable named browserName in this class so I can reference it with the PropertiesFile class.



public static String browserName = null;

I have put this reference in the PropertiesFile so the browser can be defined from .properties file.



PropertiesFileTestNG.browserName = browser;

Here the only thing we have to do is change the key value in the .properties file as firefox or chrome so the rest will continue with the classes PropertiesFile and PropertiesFileTestNG

Since we are using Extent Reports here as the reporting library Calling the flush method writes/updates the test information of your reporter to the destination type.

So lets have a look at it.

extentReport.html (firefox)

extentReport.html (chrome)

As you can see its clearly mentioning the status and all the tests are passing. And if you noticed that i have called the PropertiesFile again to write the status of our test to the .properties file.



PropertiesFile.setProperties();

Before that make sure you replace setPropertiesFile with the following code line. This will write a new key result setting the value as test passed



prop.setProperty("result", "test passed");

config.properties

So its clear that if the .properties file is updating with this value our test has passed.
Ok that's it…

In this article i have shown you guys What is .properties file, How to create one with our selenium project as well as with a TestNG. Also we analyzed test results with the Reporting library Extent Reports and we also updated the .properties file after a successful automation.

In my next article let's talk about how to run this same selenium test framework using Jar files from command line without using any IDE.

For your reference find my GitHub project here

𝑻𝑯𝑰𝑵𝑲 𝑸𝑼𝑨𝑳𝑰𝑻𝒀!

How to use Extent Reports with TestNG in Selenium Java

Manul wickrmanayaka — Sat, 22 May 2021 16:30:06 +0000

What are Extent Reports?

Extent Reports is an open-source HTML reporting library useful for test automation. It can be easily integrated with major testing frameworks like JUnit, NUnit, TestNG, etc. These reports are HTML documents that depict results as pie charts.

Extent Reports in Selenium contain two major, frequently used classes:



ExtentReports class

ExtentTest class

Both classes can be used with the following built-in methods:

startTest:* Executes preconditions of a test case
endTest: Executes postconditions of a test case
Log: Logs the status of each test step onto the HTML report being generated
Flush: Erases any previous data on a relevant report and creates a whole new report

A Test Status can be indicated by the following values:



PASS
FAIL
SKIP
INFO

Lets get to know few methods of the above classes. First lets try to create a Project in Eclipse and apply it into a main method class then we can convert it into a TestNG Class.

OK, Now lets get started….

1.Adding Dependencies to the pom.xml file

Create a maven project and lets name it as “TestNGextentReports”.
Since we are going to create a maven project lets get Extent Reports from the maven dependencies.

First copy the selenium dependency and set it in the pom.xml file.



https://mvnrepository.com/artifact/org.seleniumhq.selenium/selenium-java/3.141.59
<dependency>
    <groupId>org.seleniumhq.selenium</groupId>
    <artifactId>selenium-java</artifactId>
    <version>3.141.59</version>
</dependency>

Copy the TestNG dependency and set it in the pom.xml file.



https://mvnrepository.com/artifact/org.testng/testng
<! —  https://mvnrepository.com/artifact/org.testng/testng →
<dependency>
 <groupId>org.testng</groupId>
 <artifactId>testng</artifactId>
 <version>7.4.0</version>
 <scope>test</scope>
</dependency>

As well as set the WebDriver maven dependency for make our test simple.



https://mvnrepository.com/artifact/io.github.bonigarcia/webdrivermanager/4.4.3
<dependency>
    <groupId>io.github.bonigarcia</groupId>
    <artifactId>webdrivermanager</artifactId>
    <version>4.4.3</version>
</dependency>

This is the dependency we need to import libraries from Extent Reports.



https://mvnrepository.com/artifact/com.relevantcodes/extentreports
<!-- https://mvnrepository.com/artifact/com.relevantcodes/extentreports -->
<dependency>
    <groupId>com.relevantcodes</groupId>
    <artifactId>extentreports</artifactId>
    <version>2.41.2</version>
</dependency>

2.Create a Java class

Create a new class called “ExtentReport”. And include the main() method.

To create Extent Report references first you need to copy this statement to the main method.



ExtentSparkReporter htmlReporter = new ExtentSparkReporter("extentReport.html");

We have now created a object called “htmlReporter” from the class “ExtentSparkReporter”. Here i gave the file name as “extentReport.html” so my results will be store there.

So after reference has set put this code in the class.



package test;
import org.openqa.selenium.By;
import org.openqa.selenium.Keys;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.testng.Assert;
import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.reporter.ExtentSparkReporter;
import io.github.bonigarcia.wdm.WebDriverManager;
public class ExtentReport {
//creating driver object
 private static WebDriver driver = null;
 //setting expected title from the ebay.com
 static String expectedTitleebay ="Electronics, Cars, Fashion, Collectibles & More | eBay";
public static void main(String[] args) throws InterruptedException {
//create the htmlReporter object 
  ExtentSparkReporter htmlReporter = new ExtentSparkReporter("extentReport.html");
//create ExtentReports and attach reporter(s)
  ExtentReports extent = new ExtentReports();
  extent.attachReporter(htmlReporter);
//creates a toggle for the given test, add all log events under it
  ExtentTest test1 = extent.createTest("ebay Search Test", "test to validate search box ");
//initializing and starting the browser
  WebDriverManager.chromedriver().setup();
  driver = new ChromeDriver();
  test1.log(Status.INFO, "Starting test case");
//maximize the window 
  driver.manage().window().maximize();
  test1.pass("maximize has done");
//Navigate to Ebay.com
  driver.get("https://www.ebay.com");
  Thread.sleep(1000);
  test1.pass("Navigate to Ebay.com");
//compare whether the title id matching
  String actualTitle = driver.getTitle();
  Assert.assertEquals(actualTitle, expectedTitleebay);
  test1.pass("title is correct");
//enter in the TextBox
  driver.findElement(By.xpath("//*[@id=\"gh-ac\"]")).sendKeys("Mobile");
  test1.pass("Entered thex in the text box");
  //hit enter
  driver.findElement(By.xpath("//*[@id=\"gh-btn\"]")).sendKeys(Keys.RETURN); 
  test1.pass("Press keybopard enter key");
driver.close();
  test1.pass("closed the browser");
test1.info("test completed");
  //write results into the file
  extent.flush();
 }
}

So this code will go to https://www.ebay.com, validate the site by comparing Title and enter “mobile” in the search box and hit enter.

Press CTRL + SHIFT + O to import all classes from the avenstack package.

You will find this method in above code.



extent.flush();

Calling the flush method writes/updates the test information of your reporter to the destination type. otherwise if you do not use this you will not see any error in your program because you won’t get any report.

Now you have to refresh your Project and you will see “extentReport.html” file.

now Right click on it and open in a browser.

As you can see these are way better than TestNG Reports. It have very beautiful, clear and informative GUI. It also have two views which is very clear.

You can have the Time line graph, pass/fail rate, date/time and you will notice that it mentioned pass, info status clearly as we have given them in the code.

So this is how we create Extent Reports in selenium. Now lets try to apply the same test scenario to the TestNG class.

3.Create a TestNG Class

Use the same package and create another class called “ExtendReportTestNG”.

Now create three functions as below. We are going to use TestNG annotations for these functions.



@BeforeSuite
public void setup(){
}
@Test
public void test(){
}
@AfterSuite
public void tearDown(){
}

@BeforeSuite — In BeforeSuite I have initialized the ExtentSparkReporter and ChromeDriver

@test — I have written the code to go to Daraz.lk and ebay.com and the Title will be checked with the actual title. Then it will insert “mobile” inside the textbox and hit enter.”

@AfterSuite — In here browser will be close and flush()

Copy this code to your project and run as a “TestNG Test”



package test;
import org.openqa.selenium.By;
import org.openqa.selenium.Keys;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.testng.Assert;
import org.testng.annotations.AfterSuite;
import org.testng.annotations.BeforeSuite;
import org.testng.annotations.Test;
import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.reporter.ExtentSparkReporter;
import io.github.bonigarcia.wdm.WebDriverManager;
public class ExtendReportTestNG {
//creating driver object
 private static WebDriver driver = null;
 //setting expected title from the ebay.com/Daraz.lk
 static String expectedTitleebay ="Electronics, Cars, Fashion, Collectibles & More | eBay";
 static String expectedTitledaraz ="Online Shopping Sri Lanka: Clothes, Electronics & Phones | Daraz.lk";
//create the htmlReporter object
ExtentSparkReporter htmlReporter;
 ExtentReports extent;
 ExtentTest test1,test2;
@BeforeSuite
 public void setup() {
htmlReporter = new ExtentSparkReporter("extentReport.html");
//create ExtentReports and attach reporter(s)
  extent = new ExtentReports();
  extent.attachReporter(htmlReporter);

  //initializing and starting the browser
  WebDriverManager.chromedriver().setup();
  driver = new ChromeDriver();

 }
@Test (priority = 1)
 public void test1() throws InterruptedException {
//creates a toggle for the given test, add all log events under it
  test1 = extent.createTest("ebay Search Test", "test to validate search box ");
test1.log(Status.INFO, "Starting test case");

  //maximize the window 
  driver.manage().window().maximize();
  test1.pass("maximize has done");
//Navigate to Ebay.com
  driver.get("https://www.ebay.com");
  Thread.sleep(1000);
  test1.pass("Navigate to Ebay.com");
//compare whether the title id matching
  String actualTitle = driver.getTitle();
  Assert.assertEquals(actualTitle, expectedTitleebay);
  test1.pass("title is correct");
//enter in the TextBox
  driver.findElement(By.xpath("//*[@id=\"gh-ac\"]")).sendKeys("Mobile");
  test1.pass("Entered text in the text box");
  //hit enter
  driver.findElement(By.xpath("//*[@id=\"gh-btn\"]")).sendKeys(Keys.RETURN); 
  test1.pass("Press keybopard enter key");
}
@Test (priority = 0)
 public void test2() throws InterruptedException {
//creates a toggle for the given test, add all log events under it
  test2 = extent.createTest("Daraz Search Test", "test to validate search box ");
test2.log(Status.INFO, "Starting test case");
//maximize the window 
  driver.manage().window().maximize();
  test2.pass("maximize has done");

  //Navigate to daraz.lk
  driver.get("https://www.daraz.lk/#");
  Thread.sleep(1000);
  test2.pass("Navigate to Daraz.lk");
//compare whether the title id matching
  String actualTitle = driver.getTitle();
  Assert.assertEquals(actualTitle, expectedTitledaraz);
  test2.pass("title is correct");
//enter in the TextBox
  driver.findElement(By.xpath("//*[@id=\"q\"]")).sendKeys("Mobile");
  test2.pass("Entered thex in the text box");
  //hit enter
  driver.findElement(By.xpath("//*[@id=\"topActionHeader\"]/div/div[2]/div/div[2]/form/div/div[2]/button")).sendKeys(Keys.RETURN); 
  test2.pass("Press keybopard enter key");

 }

 @AfterSuite
 public void tearDown() {
driver.quit();
test1.pass("closed the browser");
  test2.pass("closed the browser");
test1.info("test completed");
  test2.info("test completed");

  //write results into the file
  extent.flush();
}
}

I have used two @test annotations to run two different sites separately. And have used prioritize method in each @test

priority = int means that we can choose which @test to run first and which one will run after that. It takes lowest number as the highest priority. And also it count minus numbers.

Ex: priority = -1 > priority = 0 (-1 has higher priority than 0)

If we do not mentioned the priority it takes the alphabetical order of the method name.

Now lets have a look at the extent Reports.

As you can see in the left panel we can see both tests are categorized separately. We can go to each one and view the results.

So that’s it. This is how we use extent reports in our TestNG projects.

When we are dealing with bigger projects in selenium we can prioritize the tests, separate each one and have a clean code.

For your reference find my GitHub project here

𝑻𝑯𝑰𝑵𝑲 𝑸𝑼𝑨𝑳𝑰𝑻𝒀!

Getting started with TestNG

Manul wickrmanayaka — Sat, 22 May 2021 09:15:27 +0000

TestNG is an automation testing framework for the Java programming language in which NG stands for "Next Generation". TestNG is inspired from JUnit which uses the annotations (@). TestNG overcomes the disadvantages of JUnit and is designed to make end-to-end testing easy.

Since Selenium does not have itself a reporting functionality TestNG makes test creation, execution, reporting more efficient and you can easily come to know how many test cases are passed, failed, and skipped. You can execute the failed test cases separately.

Its much easier to add TestNG plugin in Eclipse plugin.
So lets get started…

1.Adding TestNG plugin in Eclipse

Select help tab, go to Eclipse Marketplace and search for TestNG for Eclipse. You will see the plugin and just install it.

2.Adding Dependencies

Create a maven project and lets name it as "SeleniumTestNG".
Since we are going to create a maven project lets get selenium and other JAR files from the maven dependencies.

First copy the selenium dependency and set it in the pom.xml file.

https://mvnrepository.com/artifact/org.seleniumhq.selenium/selenium-java/3.141.59
<dependency>
    <groupId>org.seleniumhq.selenium</groupId>
    <artifactId>selenium-java</artifactId>
    <version>3.141.59</version>
</dependency>

Copy the TestNG dependency and set it in the pom.xml file.

https://mvnrepository.com/artifact/org.testng/testng
<! -  https://mvnrepository.com/artifact/org.testng/testng →
<dependency>
 <groupId>org.testng</groupId>
 <artifactId>testng</artifactId>
 <version>7.4.0</version>
 <scope>test</scope>
</dependency>

As well as set the WebDriver maven dependency for make our test simple.

https://mvnrepository.com/artifact/io.github.bonigarcia/webdrivermanager/4.4.3
<dependency>
    <groupId>io.github.bonigarcia</groupId>
    <artifactId>webdrivermanager</artifactId>
    <version>4.4.3</version>
</dependency>

3.TestNG annotations

Before begin our test lets have look at the TestNG annotations that we are going to use in here.

@BeforeTest - The annotated method will be run before any test method belonging to the classes inside the tag is run.

@test - Marks a class or a method as part of the test.

@AfterTest - The annotated method will be run after all the test methods belonging to the classes inside the tag have run.

4.Create the TestNG class

First create a class named "TestNG_Demo". You do not need to write main() method in a TestNG class to run it as TestNG takes care of that by defining annotations. You just need to provide proper annotations to methods and rest TestNG will execute them in a manner by implicit call to main method of TestNG class.

First for a simple test lets take a code that validate the title of a page.

public static void main(String[] args) {
WebDriverManager.chromedriver().setup();
WebDriver driver = new ChromeDriver();
driver.manage().window().maximize();
driver.get("https://ikman.lk/");
String expectedTitleikman = "ikman.lk - Electronics, Cars, Property and Jobs in Sri Lanka";
String actualTitle = driver.getTitle();
if (actualTitle.contentEquals(expectedTitleikman)) {
System.out.println("Test Passed");
}else {
System.out.println("Test Failed");
}
driver.close();
}

This code explains how to get the title from the "ikman.lk" and validate with the actual title. Since this is written in a main method this should be run on a Java class.

You can see we have mentioned the actual URL and we have used if statement to decide whether its really the actual title or not.

Lets write the same code in a TestNG class.

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.testng.Assert;
import org.testng.annotations.AfterTest;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;
import io.github.bonigarcia.wdm.WebDriverManager;
public class TestNG_Demo {
String expectedTitleikman ="ikman.lk - Electronics, Cars,        Property and Jobs in Sri Lanka";
    private static WebDriver driver = null;

@BeforeTest
public void setup() {
WebDriverManager.chromedriver().setup();
    driver = new ChromeDriver();
}

@Test
public void test() {
driver.manage().window().maximize();
    driver.get("https://ikman.lk/");
String actualTitle = driver.getTitle();
Assert.assertEquals(actualTitle, expectedTitleikman);
}
@AfterTest
public void tearDownTest() {
driver.close();
}
}

In this code you can see we have used @test, @BeforeTest, @AfterTest annotations to separate the code. As this test, first its run the @BeforeTest and run the actual @test. Then comes the tearDown method.

And you cannot notice a if statement here because we have use the assertion to compare both actualTitle and the expectedTitle by importing the Assert class from TestNG.

import org.testng.Assert;

5.TestNG test-output

After running above TestNG Class we can see the actions performing and after a refresh a Results folder is creating as "test-output".

As you can see it has generated different kind of reports as output. Leta have a look at a one of them.

It has shown us a clear report of our results by grouping into different categories. In here since my test is passing it does not show any failed tests but if some exist this will show them and time taken to execute that test case and so on.

For your reference find my GitHub project here

𝑻𝑯𝑰𝑵𝑲 𝑸𝑼𝑨𝑳𝑰𝑻𝒀!

What is XPath in Selenium?

Manul wickrmanayaka — Thu, 20 May 2021 09:17:38 +0000

In selenium XPath is a very important strategy to locate elements. It can be simple as well as complex at the same time if you did not grab it correctly.

Topics to be covered in this article.

What is XPath and XML Document?
Syntax of the XPath
Syntax Demo
Types of XPath
Tips to follow

What is XPath and XML Document?

XPath (also called as XML Path) is a technique to locate elements in Selenium. It consists path expression along with some conditions.

Now lets see how a XML Document looks like.

<mobileshop>
<mobile category= “samsung”>
<model lang=”en”>Note 10</model>
<manufacture>samsung</manufacture>
<mobile>
<mobile category= “apple”>
<model lang=”en”>iphone11</model>
<manufacture>apple</manufacture>
<mobile>

As you can see here mobileshop node has a child node mobile and its futher followed by attribute called category and its value as samsung.
This mobile node has two child nodes which is model and manufacture.

If we write the XPath to locate the title of the mobile we have to write it like this.

Xpath = /mobilestore/mobile[@category='apple']/title

So this is how we write our XPath.

Syntax of the XPath

Syntax Demo

lets go to the google.com and we can see the google search box. So we are going to create the Xpath to this google search box.

Do a right click on the search box and open the developer console. You will now see the particular area for the selected node.

<input class="gLFyf gsfi" jsaction="paste:puy29d;" maxlength="2048" name="q" type="text" aria-autocomplete="both" aria-haspopup="false" autocapitalize="off" autocomplete="off" autocorrect="off" autofocus="" role="combobox" spellcheck="false" title="Search" value="" aria-label="Search" data-ved="0ahUKEwj9q8C8ydfwAhWG63MBHbWRDSMQ39UDCAQ">

As you can see it have a name attribute inside the input tag. So we are going to use it to create our Xpath.

In the console press CTRL + F and the area will come up to test our xpath.

//input[@name='q']

When you enter this path you will see it highlighting the element. This is the way of catching any element using Relative Xpath.

We can identify elements using Absolute Xpath also. To Absolute path of the same element you can just right click on the input tag and copy the Xpath.

/html/body/div[2]/div[3]/form/div[1]/div[1]/div[1]/div/div[2]/input

In absolute Xpath we start from the very first root node and go all the way until the element on the web page.
As a best practice its not recommended to use absolute path because this can break if you have any changes in your web application.

On the other hand Relative Xpath have very less chances of breakage and we can also locate a element using two attributes in Relative Xpath.
And incase if we do not know the tag name we can replace it by * sign.

//input[@type='text'][@name='q']

//*[@type='text'][@name='q']

XPath Functions

Now lets talk about few functions that can be used with Xpath.
Lets take ikman.lk as the example site.

contains()

This is a method used in Xpath expression when the value of any attribute changes dynamically.

Lets take the vehicle section of the ikman.lk site. If we write the XPath to this element it should look like this.

//span[@class=’ui-sprite categories-36 vehicles’]

In a situation that this class path is changed we cannot track the element using class attribute. In this case we can use contain() function

//span[contains(@class,’vehicles’)]

You see now we just mentioned ‘vehicles’ inside the contains() class and its working.
That because its only searching for the word vehicle in this scenario. So if any of the word changed in the class it does not affect to identify the element.

text()

This expression is used to locate element with the exact text. Lets have a example.

If we go to the vehicle section text area we can see it mentioned “Vehicles”.

<span>Vehicles</span>

So we can use text() function to locate this element. It says go anywhere in the page and does not matter where you go but it should have a text whose value is “Vehicles”.

//*[text()='Vehicles']

starts-with()

This one is very useful when we have some elements, some part of the value is common but the other part is always changing.

For example lets take ikman.lk login page where you have to enter your email and password to login.

Email box:

<input id="input_email" name="email" aria-label="Email" type="email" class="input-field--3A-bW themed-form-input--2Q2dw input-field-error--2NJwO" placeholder="Email">

Password box:

<input id="input_password" name="password" aria-label="Password" type="password" class="input-field--3A-bW themed-form-input--2Q2dw" placeholder="Password">

You can write the xpath this way. In this its match the starting text of the attribute that is used to locate an element which have both “email” and ”password”.

//input[starts-with(@id,’input’)]

or / and

Lets say we have two input tags whose attributes are different. So to uniquely identify each input tag we can use or/and functions.

Lets take the same example above.
This will give only one input tag which is name=“password”

//input[starts-with(@id,'input') and @name='password']

//input[@id='input_password'] | //input[@name='password']

This will give two input tags which is name=“password” and name=“email”

//input[starts-with(@id,'input') or @name='password']

For your reference find my GitHub project here

Tips

If you are using Firefox or Chrome for test automation there are some extensions to identify XPath automatically. you just need to add the extension to your browser.

https://chrome.google.com/webstore/detail/chropath/ljngjbnaijcbncmcnjfhigebomdlkcjo/related

𝑻𝑯𝑰𝑵𝑲 𝑸𝑼𝑨𝑳𝑰𝑻𝒀!

Using WebDriver Manager with Maven POM dependency

Manul wickrmanayaka — Wed, 19 May 2021 14:07:18 +0000

If you read my previous post about writing the first selenium script using code modular you will find that we tried to run our selenium script by downloading the chrome driver and geckodriver to our local machine and provided the location in our project.

So this process is very difficult and also a manual process. But we can manage all these web drivers using WebDriver Manager.

Cool right? Then lets go for it.

What is WebDriver Manager?

This is application or library that helps to automatically manage browser drivers for selenium. It is an awesome solution for setting up a selenium server for your end to end web tests.

If we are going to set the browser drivers for our project manually then we have to go to internet and download the relevant drivers and give the location in your project like this.

System.setProperty("webdriver.chrome.driver", "/path/to/chromedriver");

So you will know that we need to create a separate folder for drivers and give location path every time we use it.

Now all this can be handled by using WebDriver Manager. We can get WebDriver using Maven and lets try to sort out everything step by step.

1.Create a Maven Project in Eclipse

Right click on your package Explorer and create a new project. Search for maven and create a Maven project.

The Group Id is nothing but a unique identifier that owns the project.
Artifact Id will be the final name of the compilation unit of our project.

So this is is the tress structure of our project.

For this simple test we just need these marked folders and the most important one is "pom.xml".

<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>test.webdriver</groupId>
  <artifactId>SeleniumWebDriverManager</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</project>

2.Add dependencies to the pom.xml file

Now this is the file that we are going to add our all dependencies and plugins needed for the project.

So lets go to the Maven central repository and copy the following dependencies.
https://mvnrepository.com

First add selenium java maven dependencies by the latest versions. For here I used version 3.141.59

<!-- https://mvnrepository.com/artifact/org.seleniumhq.selenium/selenium-java -->
<dependency>
    <groupId>org.seleniumhq.selenium</groupId>
    <artifactId>selenium-java</artifactId>
    <version>3.141.59</version>
</dependency>

Then search for WebDriver Manager and get the maven dependencies by the latest release. Here I am using version 4.4.3


<!-- https://mvnrepository.com/artifact/io.github.bonigarcia/webdrivermanager -->
<dependency>
    <groupId>io.github.bonigarcia</groupId>
    <artifactId>webdrivermanager</artifactId>
    <version>4.4.3</version>
</dependency>

Make sure to add these dependencies within the "dependencies" tag.

And press CRTL + I to ident the code.

So we have added all the maven dependencies to our pom.xml file. So lets clean and build the project.
Project-->Clean

After build you should get a maven dependencies folder.

As you can see it contains all the selenium libraries and also the WebDriver Manager.
From here on we don't need to specify locations to the drivers. All those are now available in our WebDriver Manager.
Now we can go straight away to our test.

3.Create the test

Go to "src/test/java" and create a class called "SeleniumTest1" and copy this code.

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;

import io.github.bonigarcia.wdm.WebDriverManager;

public class SeleniumTest1 {
public static void main(String[] args) {

    WebDriverManager.chromedriver().setup();
    WebDriver driver = new ChromeDriver();

    driver.get("https://ikman.lk");
    driver.close();
}
}

For this test I have used the chrome but you can use any other browser if you want.

You see that we don't need to give any path to drivers from our project. We just need to call them from the WebDriver Manager.

WebDriverManager.chromedriver().setup();

So this is how we use WebDriver Manager in our code and also we know how the pom.xml maven dependencies used in our project.

For your reference find my GitHub project here

𝑻𝑯𝑰𝑵𝑲 𝑸𝑼𝑨𝑳𝑰𝑻𝒀!

Lets write our first Selenium test with the help of Code Modular

Manul wickrmanayaka — Tue, 18 May 2021 19:34:45 +0000

𝗪𝗵𝗮𝘁 𝗶𝘀 𝗦𝗲𝗹𝗲𝗻𝗶𝘂𝗺?

Selenium is a set of tools and libraries that automates web browser actions. If you go to selenium official site(www.selenium.dev) you will find it says "selenium automate browsers. That's it."

Selenium is free and currently is the most widely used and most popular open source solution for test automation of web applications.

Selenium supports all the major browsers like Firefox, Chrome, Internet Explorer, Safari and many more. And all the major Operating Systems are also supported.
If you go to official site you will find that selenium supported by many languages including Java, C#, JavaScript, Perl, PHP, Python, Ruby and so on.

So why not learning it!!!

ok, Lets try to write our first selenium script.

𝗜𝗻𝘀𝘁𝗮𝗹𝗹𝗮𝘁𝗶𝗼𝗻 𝘀𝘁𝗲𝗽𝘀

𝟭.𝗙𝗶𝗿𝘀𝘁 𝗶𝗻𝘀𝘁𝗮𝗹𝗹 𝗝𝗗𝗞 𝘁𝗼 𝘆𝗼𝘂𝗿 𝗰𝗼𝗺𝗽𝘂𝘁𝗲𝗿

https://www.oracle.com/java/technologies/javase-downloads.html

After installation is finished you can use the following command to check whether Java JDK is installed successfully in your system and installed version.

In Windows/Linux, go to Terminal
Enter command - "java -version"

𝟮.𝗗𝗼𝘄𝗻𝗹𝗼𝗮𝗱 𝗮𝗻𝗱 𝘀𝘁𝗮𝗿𝘁 𝗘𝗰𝗹𝗶𝗽𝘀𝗲

Download the latest version from this link
http://www.eclipse.org/downloads

𝟯.𝗖𝗿𝗲𝗮𝘁𝗲 𝗮 𝗝𝗮𝘃𝗮 𝗽𝗿𝗼𝗷𝗲𝗰𝘁 𝗶𝗻 𝗘𝗰𝗹𝗶𝗽𝘀𝗲

Right click on the package Explorer,
New-->Java Project
And lets name it as "SeleniumTest"

𝟰.𝗔𝗱𝗱 𝘀𝗲𝗹𝗲𝗻𝗶𝘂𝗺 𝗝𝗮𝗿𝘀

Go to Selenium official site and download the Selenium Client & WebDriver Language Bindings.
For this test lets choose Java language.

www.selenium.dev/downloads

After download has finished unzip the zip file and copy to a location you prefer.

Again go to Eclipse and create a folder.

Do a right click-->New-->Folder
And name it as "lib"
In this folder lets keep all our Jars.

Now go to the folder that you unzipped and copy all the jar files and paste it inside the lib folder.

Once it has copied select all those jars and add to build path.

Build-->Build Path

As soon as you do this you will see the jars you have selected is added to the Referenced Libraries now.

𝟱.𝗗𝗼𝘄𝗻𝗹𝗼𝗮𝗱 𝗴𝗲𝗰𝗸𝗼𝗱𝗿𝗶𝘃𝗲𝗿 𝗮𝗻𝗱 𝗰𝗵𝗿𝗼𝗺𝗲𝗱𝗿𝗶𝘃𝗲𝗿

To interact with Firefox and chrome we need geckodriver and chromedriver respectively. The purpose of these drivers are to launch each browsers. Without that, it is not possible to execute Selenium test scripts in browsers as well as automate any web application.

So lets download each of them.
https://chromedriver.chromium.org/downloads
https://github.com/mozilla/geckodriver/releases

Once its finished go to Eclipse and create another folder by right clicking on the project and name it as "WebDriver"

Go to Downloaded web drivers and copy paste them in to this folder.

To set the system properties to these drivers here are the code formats.

System.setProperty("webdriver.gecko.driver", "location of gecko driver exe");
System.setProperty("webdriver.gecko.driver", "location of chrome driver exe");

To copy the location of each driver right click on the driver and go to properties. you will see the location. You can give either relative path or the absolute path.

𝟲.𝗪𝗿𝗶𝘁𝗲 𝗮 𝗽𝗿𝗼𝗴𝗿𝗮𝗺 𝘁𝗼 𝗼𝗽𝗲𝗻 𝗕𝗿𝗼𝘄𝘀𝗲𝗿

Lets write a simple program to open the browser in both chrome and Firefox.

First go to your package, do a right click and create another package inside this package and name it as "Test".

In the Test package again do a right click and create a class, name it as "SeleniumTest1".

Copy the following code in to the class.

package SeleniumTest1;

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import org.openqa.selenium.firefox.FirefoxDriver;

public class SeleniumTest1 {

    static String browser = "";
    static WebDriver driver;

    public static void main(String[] args) {

        setBrowser();
        setBrowserConfig();
        runTest();

    }

    public static void setBrowser() {

        browser = "chrome";

    }

    public static void setBrowserConfig() {

        if (browser.contains("firefox")) {
            //Arrange the system properties for the firefox browser
            System.setProperty("webdriver.gecko.driver", "D:\\seleniumTests\\inprogress\\SeleniumTest\\WebDriver\\geckodriver.exe");
            //Initialize the firefoxdriver
            driver = new FirefoxDriver();
        }

        if (browser.contains("chrome")) {
            //Arrange the system properties for the chrome browser
            System.setProperty("webdriver.chrome.driver", "D:\\seleniumTests\\inprogress\\SeleniumTest\\WebDriver\\chromedriver.exe");
            //Initialize the chromedriver
            driver = new ChromeDriver();
        }

    }

    public static void runTest() {

        //Maximize the chrome browser
        driver.manage().window().maximize();

        driver.get("https://ikman.lk/");
        //Close the browser
        driver.quit();

    }

}

To import all missing packages press: CTRL + SHIFT + O

To switch between two browsers replace the browser string variable with one of them. “chrome” or “firefox”.

public static void setBrowser() {

        browser = "firefox";

Now here you see we have used a software design technique that emphasizes separating the functionality of a program into independent, interchangeable modules, such that each contains everything necessary to execute only one aspect of the desired functionality.

        setBrowser();
        setBrowserConfig();
        runTest();

We have divided the code into three simple functions and call each one when the test runs. As a best practice its recommended to use this method because it allows for easier management and we need to maintain the efficiency of the code. Now you can see our code is so much clean.

So here we created our simple selenium test to open a web browser and applied Modular programming software design technique to build the code.

For your reference find my GitHub profile here