Capture Screenshot On Failure Or Pass - WebDriver Data Driven Framework

In our WebDriver data driven framework creation, We have Implemented calc software tests In all calc test cases of WebDriver data driven framework In STEP 30. Now supposing, You wants to capture screenshot of software web page when your test fails. It will helps you to analyse the test failure reason. Based on web page screenshot,
you can easily find out the test failure reason. Same way, Supposing you wants to capture screenshot when your test pass. This step will describe you how to capture screenshot on test failure or software automation test pass.

STEP 31

Prerequisite : All previous data driven framework creation steps should be Implemented. Find links of all previous steps on THIS PAGE.

What we will do In this step

As described above, We wants to capture screenshot on software test case fail or test case pass or both. We will Implement this functionality In such a way so that you can easily set which screenshot you wants to capture. For that you have to set flags In Param.properties file and then framework will capture screenshots based on your flag choice.

How To Do It

Do you have heard about testng listeners? We will use testng ITestListener Interface methods onTestFailure and onTestSuccess to solve our purpose. Question Is for what these methods are?

• onTestFailure : This method will be Invoked each time a test succeeds.
• onTestFailure : This method will be Invoked each time a test fails.

Both these testng ITestListener Interface methods will help us to capture screenshots In our data driven framework.

Download Required Files

You need new created ScreenshotUtility.java file for capturing screenshot on software test failure or success. We need to define listener In testng.xml file and also you need Param.properties to define screenShotOnFail or screenShotOnPass or both. So you need modified version of both these files too. You will get all these three files by downloading bellow given zip folder.

• Download Step 31.zip

Extract the folder and Add/Replace files as bellow In eclipse.

• Paste Param.properties File on com.stta.property Package.
• Paste ScreenshotUtility.java File on com.stta.utility Package.
• Paste testng.xml File on WDDF Project folder.

Your folder structure will looks like bellow.

If you open  testng.xml file, You will see that I have added some extra code In It to define listener. ScreenshotUtility.java file contains testng listener methods and captureScreenShot method to capture screenshot on pass or failure. I have added two new key In testng.xml File with values as bellow.

screenShotOnFail=yes
screenShotOnPass=yes

• screenShotOnFail=yes means you wants to capture screenshot when your test case fails. 
• Same way screenShotOnPass=yes will capture screenshot when test case pass.
• screenShotOnFail=no means screenshot will be not captured even test case fails.
• screenShotOnPass=no means screenshot will be not captured when test case pass.

You can set both these flags as per your requirement.

Run Test And Verify Output

Run test from "Shortcut to Run Test.bat" file. Right now screenShotOnFail and screenShotOnPass are set to yes so It will capture screenshots In both the cases. Means, We have total 8 data set lines for total 4 test cases so It will capture total 8 screenshots. 

When test execution completed, Refresh "WDDF" project folder. You will see that It has created new folder "screenshots" with 2 sub folders "Failures" and "Success". Expand all those folders. Our 2 tests are failed and 6 tests are pass so you will find total 2 .png files under "Failures" folder and 6 .png files under "Success" folder as shown In bellow given Image.

Now you can open all those files to analyse results. Basically screenshots are required only for failure conditions to see the software web page status when test was failed.

<- Go To STEP 30