How to include screenshots in ReportNG report?

Any test automation report is incomplete without the screenshots and including them in ReportNG is not that much difficult. In today’s post we will see how we can include the screenshots in ReportNG report. If you are wondering how to configure ReportNg with selenium then you can refer my previous post.

Here I am again considering that you already have below set-up-

  • Your project is already set-up in Eclipse
  • Project already has testng.xml file.
  • ReportNG is already set-up with Selenium and TestNG.

If above conditions are true then you just need to complete two steps-

1: Make it Escape_Property=false like this-

Screenshot

2: Now take the screenshot after some actions and pass through Reporter.log method to ReportNG report-

Screenshot1

Now run your testng.xml file and open the test report. If you have configured ReportNG properly and above set-up then you report should look like this-

screenshot3

How to configure ReportNG with Selenium WebDriver?

Selenium WebDriver is open source test automation framework which does not come with reporting facility. So selenium user has to be depended upon the third party plug-ins.

ReportNG is a simple HTML reporting plug-in for the TestNG unit-testing framework. It is intended as a replacement for the default TestNG HTML report. There are very few steps to configure ReportNG with WebDriver+TestNG.

To configure it we need three jar files (Guice, ReportNG, and Velocity-dep) which you can download from here-

http://reportng.uncommons.org/

and

https://github.com/google/guice/wiki/Guice30

Once you have these three jar files, please include them in your project-

lib

Here I am considering that you already have TestNg.xml file inside your project; if Yes, please include below listeners inside suite tag-

<listeners>
<listener class-name=”org.uncommons.reportng.HTMLReporter”/>
<listener class-name=”org.uncommons.reportng.JUnitXMLReporter”/>
</listeners>

Once you done, your testng.xml file should look like this-

TestNg

Now last step, disable the default testng listener by-

Right click on Project folder > click on Properties > click on TestNG which visible in left pane.

Test

All set, now run your testng.xml file and refresh your project. Once all done, It will add ‘test-output’ folder. Go to test-output > html > and open index.html to see the report.

report

Your report should look like this after all above set-up-

reports

How to configure Properties file with Selenium WebDriver?

Why Properties file?

To hide sensitive information of the projects we save the information in properties file.

To configure Properties file, create a new file and save as with .properties extension. Now add the data in following manner in Properties file:

URL=http://www.google.com
INT_USR=msrivastava
INT_PWD=Hello123&

Now use below lines of code to read this property file-

try{
FileInputStream prop = new FileInputStream (“D:\\Selenium_Projects\\Property\\setup.properties”);
Properties a = new Properties ();
try {
a.load(prop);
} catch (IOException e) {

e.printStackTrace();
}
String URL=a.getProperty(“URL”);
String USR=a.getProperty(“INT_USR”);
String PWD=a.getProperty(“INT_PWD”);
System.out.println(URL);
System.out.println(USR);
System.out.println(PWD);
}catch (FileNotFoundException e){
e.printStackTrace();
}

How to configure Selenium Grid?

Here I noted down some quick steps to configure Selenium Grid on windows. I am assuming that you are aware about selenium and its features. So here we go-

  • Download Selenium Standalone Jar file from here.
  • Dump it somewhere in host and node machines.
  • Open CMD at Host machine and go to location where you have been dumped the jar file.
  • Now run this command Java –jar seleniumserver-standalone_version.jar –role hub.
  • Now open http://localhost:4444/grid/console.
  • Now go to Node machine.
  • Open CMD at Node machine and go to location where you have been dumped the jar file.
  • Run the below commend if machine is remote-

java –jar selenium-server-standalone_version – role webdriver –hubHost HOST MACHINE NAME – “browserName=iexplorer, platform=WINDOWS” –port 5556

  • Run the below commend if machine is same machine where host is running-

java –jar selenium-server-standalone_version – role webdriver – “browserName=iexplorer, platform=WINDOWS” hubHost http://localhost:4444/grid/register –port 5555

How to run Selenium + TestNG script from Command Line?

This is an alternate way to execute our selenium script from command prompt. Here, I am considering few points-

  • Your project is already set-up in Eclipse
  • Project already has testng.xml file.
  • All selenium and other third party jar files are located under project home folder (lib folder).
  • You are able to execute your script by running testng.xml file.

cmd3

If above conditions are matching then very few steps are there to execute same script from command prompt. Follow the below steps-

Open Command Prompt and Go to Project home directory-

CMD

Set the class path and libraries path by running below command-

set classpath=<Project Home Path>\bin;<Project Home Path>\lib\*

cmd1

Now run the testng.xml file by running below command-

java org.testng.TestNG testng.xml—-Make sure “org.testng.TestNG” TestNG word should have ‘T’ and ‘NG’ in caps.

CMD2

I hope it would help people to run testng.xml file from the command prompt.

EventFiringWebDriver, WebDriverEventListener, and AbstarctWebDriverEventListener

Before getting into the sample code, lets have a look on EventFiringWebDriver, WebDriverEventListener, and AbstarctWebDriverEventListener descriptions.

  • EventFiringWebDriver is a class and wrapper around an arbitrary webdriver instance which supports registering of a WebDriverEventListener.
  • WebDriverEventListener is interface which includes list of abstract events methods and all should be implemented if we are implementing it.
  • AbstarctWebDriverEventListener is abstract class which has implemented WebDriverEventListener interface. We can extend this class if we are only interested in some events. All methods provided by this class have an empty method body.

So we can choose between EventFiringWebDriver and AbstarctWebDriverEventListener according to our needs.

Note: I have used AbstarctWebDriverEventListener class in below example.

Let’s have a look on example-

Create a class file and extends AbstarctWebDriverEventListener class-
public class WebDriverEventListenerClass extends AbstractWebDriverEventListener {
@Override
public void onException(Throwable arg0, WebDriver driver) {

File screenShot = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);
try {
FileUtils.copyFile(screenShot, new File(“c:\\tmp\\exception.png”));
} catch (IOException e) {
e.printStackTrace();
}}}

Create another class file and register WebDriverEventListenerClass file as it has implemented onException event method-

public class EventFiringDriverExample {
@Test
public void Events(){
System.setProperty(“webdriver.ie.driver”, “D:/Training/IE_Driver/IEDriverServer.exe”);

WebDriver driver = new InternetExplorerDriver();

// Creating EventFiringWebDriver instance

EventFiringWebDriver eventFiringDriver= new EventFiringWebDriver(driver);

// Creating instance of eventListener, that we just defined
eventFiringDriver.register(new WebDriverEventListenerClass());

eventFiringDriver.get(“https://www.google.co.in/&#8221;);

eventFiringDriver.findElement(By.className(“nosuchelement”));

}}

Once you run ‘Events()’ method, it will open Google and search for element which is not available. In this case, method will throw WebElementNotFound exception and system will capture the screenshot and save it at “c:\\tmp\\exception.png” location..

How to generate logs with CodedUI?

Why logs? Well, it helps to debug the problem in our script. Usually logging and capturing the screenshots are not enable by default with CodedUI and to make it, we need to make some set up.

Follow the below steps to enable logging and capturing the screenshots-

1: Go to C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE location and search for ‘QTAgent32_40.exe.config’ and ‘QTAgent32.exe.config’. Make sure you have edit permission for these config files.

2: Modify the value for ‘EqtTraceLevel‘:

Log

3: Add App.config file in your project and add the following code under the configuration node:

Log1

4: Add following code in CodedUITest1.cs file-

Log2

5: Now run the test.

6: Open Test Explorer and click on Output hyperlink-

Log3

7: Click on UITestActionLog.html link.

Log4

8: Now check your script logs-

Log5

Log6

Difference between @BeforeTest and @BeforeClass annotation in TestNg

Ah ha…a topic which confused me also to understand the difference between BeforeTest and BeforeClass annotation. When we read first time it looks same and then we think if it is same then why TestNg included it. So clue is, it is not same and included for two different purposes-

We will go through again with these annotations definition which is available under TestNg official site and that are-

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

@BeforeClass-The annotated method will be run before the first test method in the current class is invoked.

Have a look on below example-

public class FirstClass {
@BeforeTest
public void BT(){
System.out.println(“This is before test”);
}
@AfterTest
public void AT(){
System.out.println(“This is after test”);
}
@Test (priority =-20)
public void fctestmethod(){
System.out.println(“This is First Class test method.”);
}}

————————————————————————————————-

public class SecondClass {
@BeforeClass
public void BC(){
System.out.println(“This is before class”);
}
@AfterClass
public void AC(){
System.out.println(“This is after class”);
}
@Test (priority =-19)
public void sctestFirstmethod(){
System.out.println(“This is Second Class first test method.”);
}
@Test (priority =-18)
public void sctestSecondmethod(){
System.out.println(“This is Second Class second test method.”);
}}

————————————————————————————————-

————————————————————————————————-

[TestNG] Running:
D:\Training\BeforeTestndClassExample\testng.xml

This is before test
This is First Class test method.
This is before class
This is Second Class first test method.
This is Second Class second test method.
This is after class
This is after test

===============================================
My test suite
Total tests run: 3, Failures: 0, Skips: 0
===============================================

————————————————————————————————-

Hints:

  • <test> tag is wrapped by @BeforeTest and @AfterTest
  • <class> tag is wrapped by @BeforeClass and @AfterClass

So if we see in test result @BeforeTest method executed very first and then lowest priority @Test method (fctestmethod). In third position @BeforeClass method executed which was defined in Second Class. Now question is why it got executed at third position, so answer is-

  • <class> tag is wrapped by @BeforeClass and @AfterClass

and

@BeforeClass-The annotated method will be run before the first test method in the current class is invoked.

As @Before and After was defined in Second Class therefore it got executed when testng.xml invoked Second Class class file not before any test.

Logging with Log4J

Log4j is widely used API for generating the logs and there are few steps to configure it with Selenium Webdriver.

  • Download the latest log4j api from here.
  • Include the log4j-1.2.XX.jar file in your project build path.
  • Right click on your project > New > Other…>XML>XML FIle> and create a XML file with the log4j.xml name.
  • Copy and paste the below xml contents in newly created XML file-

<?xml version=”1.0″ encoding=”UTF-8″?>
<!DOCTYPE log4j:configuration SYSTEM “log4j.dtd”>
<log4j:configuration xmlns:log4j=”http://jakarta.apache.org/log4j/&#8221; debug=”false”>
<appender name=”fileAppender” class=”org.apache.log4j.FileAppender”>
<param name=”Threshold” value=”INFO” />
<param name=”File” value=”logfile.log“/>
<param name=”append” value=”true”/>
<layout class=”org.apache.log4j.PatternLayout”>
<param name=”ConversionPattern” value=”%d %-5p [%c{1}] %m %n” />
</layout>
</appender>
<root>
<level value=”INFO”/>
<appender-ref ref=”fileAppender”/>
</root>
</log4j:configuration>

  • Create new class file without main method and paste below code-

public class TestCase_Logging {
public static WebDriver driver=null;
private static Logger Log = Logger.getLogger(TestCase_POF.class.getName());
public static void main(String[] args) {
DOMConfigurator.configure(“log4j.xml”);
System.setProperty(“webdriver.ie.driver”, “D:/IE_Driver/IEDriverServer.exe”);
driver = new InternetExplorerDriver();
driver.manage().timeouts().implicitlyWait(10, TimeUnit.SECONDS);

Log.info(“Start the application.”);
driver.get(“https://google.com&#8221;);

}
}

Note: Highlighted codes are important to generate the log, so don’t miss them.

  • Now run the program and go to Project root folder. System has been generated logfile.log file.

Apache ANT Setup

Follow the below steps to set-up ANT build tool-

  1. Go to the folder which have been downloaded in this cases

“C:\Selenium\ANT\apache-ant-1.8.4-bin\apache-ant-1.8.4”

  1. Go to Computer properties->Click on Advance tab->Environment Variables
  2. In the System Variable Create an new variable name as “ANT_HOME”
  3. Paste the above ANT directory in the path text box Click Search for a PATH variable select the variable and click on Edit button
  4. Append a semicolon”;” and paste the above ANT directory appending “/bin”
  5. To check whether ANT is completely set into the Environment Go to Command prompt and type ant and hit enter key.
  6. After pressing ant you will see “Buildfile: build.xml does not exist! Build failed”
  7. This message will confirm you that Ant is configured properly.