Selenium Automation Testing using Java: Listeners for logging in case of PASSED , FAILED, SKIPPED or test cases:

Listeners for logging in case of PASSED , FAILED, SKIPPED or test cases:

Refer :

https://testng.org/#_annotations

https://javadoc.io/doc/org.testng/testng/latest/org/testng/ITestListener.html

FAQ *** ItestListner:

// ITestListener - predefined Interface in TestNG

// only abstr methods -- in complete method - some where we have to implement

// Listen to test Method -

when test method starts execution,

when test method finishes execution,

when test method passed successfully,

when test method fails,

when test method skipped..etc

when test method failed with time out error

when test method failed with some success %

some methods in ItestListner:

-----------------------------

onStart()

{

}

onFinish()

{

}

onTestStart()

{

}

onTestSuccess()

{

}

onTestFailure()

{

}

onTestSkipped()

{

}

onTestFailedWithTimeout()

{

}

onTestFailedButWithinSuccessPercentage()

{

}

The ITestListener interface in TestNG provides a way to listen to various events related to test methods during their execution. Here are the key methods defined by ITestListener that you can implement to listen to different events:

onStart(ITestContext context):

Invoked before any test method belonging to the classes inside the <test> tag is run.
Provides an ITestContext object that contains all the information for a given test run.

onFinish(ITestContext context):

Invoked after all the test methods belonging to the classes inside the <test> tag have run.

onTestStart(ITestResult result):

Invoked when a test method starts execution.
Provides an ITestResult object containing details about the test method starting.

onTestSuccess(ITestResult result):

Invoked when a test method succeeds.
Provides an ITestResult object containing details about the successful test method.

onTestFailure(ITestResult result):

Invoked when a test method fails.
Provides an ITestResult object containing details about the failed test method.

onTestSkipped(ITestResult result):

Invoked when a test method is skipped.
Provides an ITestResult object containing details about the skipped test method.

onTestFailedButWithinSuccessPercentage(ITestResult result):

Invoked each time a test method fails but has been annotated with success percentage and this failure still keeps it within the success percentage.

onTestFailedWithTimeout(ITestResult result):

Invoked when a test method fails due to a timeout.
Provides an ITestResult object containing details about the test method that failed due to timeout.

System.out.println("onStart() - gets executed only once before executing all test methods ");

System.out.println("onFinish() method will be called only once after executing all Test nethods ");

System.out.println("onTestStart - gets executed every time before Starting Test Method");

System.out.println("onTestSuccess - gets executed for each test Method if Test MEthod passes succssfully ");

System.out.println("onTestFailure - If test method failed ");

System.out.println("onTestSkipped - ");

System.out.println("onTestFailedButWithinSuccessPercentage");

System.out.println("onTestFailedWithTimeout");

package TestNGBasics2;

import org.testng.ITestContext;

import org.testng.ITestListener;

import org.testng.ITestResult;

///Define MyTestListnerBasics , implements ItestListner methods

public class MyTestListnerBasics implements ITestListener

{

// define ItestListner -methods

// onstart(), onfinish(), onTestStart(), onTestSucess(), OnTestFailure, ontestSkipped()

// onTestFailureWithtime, ....

//Define onStart()

@Override

public void onStart(ITestContext context) {

System.out.println("onStart - gets executed only once before executing all test methods ");

}

// Define onTestStart() == BEforeMethod

@Override

public void onTestStart(ITestResult result) {

System.out.println("onTestStart - gets executed every time before Starting Test Method");

}

// Define onTestSuccess()

@Override

public void onTestSuccess(ITestResult result) {

System.out.println("onTestSuccess - gets executed for each test Method if Test MEthod passes succssfully ");

}

// Define onTestFailure

@Override

public void onTestFailure(ITestResult result) {

System.out.println("onTestFailure() gets executed when test Method fails ");

}

//Define onTestSkipped()

@Override

public void onTestSkipped(ITestResult result) {

System.out.println("onTestSkipped gets executed if test method is skipped for execution");

}

//Define onTestFailedWithTimeout()

@Override

public void onTestFailedWithTimeout(ITestResult result) {

System.out.println("onTestFailedWithTimeout() gets excuted when test method failed with time out error ");

}

//Define onTestFailedButWithinSuccessPercentage()

@Override

public void onTestFailedButWithinSuccessPercentage(ITestResult result) {

System.out.println("onTestFailedButWithinSuccessPercentage - if test method fail with in some % ");

}

//Define onFinish()

@Override

public void onFinish(ITestContext context) {

System.out.println("onFinish method will be called only once after executing all Test nethods ");

}

-----------------------------------

//Listen to ???

//Define @Listners before class name

package TestNGBasics2;

import org.testng.annotations.Listeners;

import org.testng.annotations.Test;

//Listen to ???

//Define @Listners before class name

@Listeners(MyTestListnerBasics.class)

public class TestA

{

@Test

public void testA()

{

System.out.println("Calling test A -statement -1");

System.out.println("Calling test A -statement -2");

}

run this class

o/p:

----

[RemoteTestNG] detected TestNG version 7.0.0

onStart - gets executed only once before executing all test methods

onTestStart - gets executed every time before Starting Test Method

Caling test A -stmt- 1

Caling test A -statement -2

onTestSuccess - gets executed for each test Method if Test MEthod passes succssfully

onFinish method will be called only once after executing all Test nethods

PASSED: testA

===============================================

Default test

Tests run: 1, Failures: 0, Skips: 0

===============================================

Default suite

Total tests run: 1, Passes: 1, Failures: 0, Skips: 0

===============================================

ex2: Define class with 2 @test methods:

package TestNGBasics2;

import org.testng.Assert;

import org.testng.SkipException;

import org.testng.annotations.Listeners;

import org.testng.annotations.Test;

//Listen to ???

//Define @Listners before class name

@Listeners(MyTestListnerBasics.class)

public class TestA

{

@Test

public void testA()

{

System.out.println("Calling test A -statement -1");

System.out.println("Calling test A -statement -2");

}

// when test Method fails,it calls onTestFailure ()

// Define testB() with assertion fail stmt

@Test

public void testB()

{

System.out.println("Calling test B -stmt-1");

Assert.assertEquals("ram", "sita");// fails testB()

}

// // Define testC() with skip

//////when test Method skips,it calls onTestSkipped()

@Test

public void testC()

{

System.out.println("Calling test c -stmt-1");

// throw skip exception

// ex throw new ArithematicExcepion();

throw new SkipException("throwing Skip exception");

}

// // Define testD() with time out = 5000 ThreadTimeoutException exception

@Test(timeOut = 5000)// if method takes >5 sec,it throws ThreadTimeoutException exception

public void testD() throws InterruptedException

{

System.out.println("Calling test D -stmt-1");

Thread.sleep(8000);

//org.testng.internal.thread.ThreadTimeoutException: Method TestNGBasics2.TestA.testD() didn't finish within the time-out 5000

}

run :

o/p:

[RemoteTestNG] detected TestNG version 7.0.0

onStart - gets executed only once before executing all test methods

onTestStart - gets executed every time before Starting Test Method

Calling test A -stmt-1

Calling test A -statement -2

onTestSuccess - gets executed for each test Method if Test MEthod passes succssfully

onTestStart - gets executed every time before Starting Test Method

Calling test B -stmt-1

onTestFailure() gets executed when test Method fails

onTestStart - gets executed every time before Starting Test Method

Calling test c -stmt-1

onTestSkipped gets executed if test method is skipped for execution

onTestStart - gets executed every time before Starting Test Method

Calling test D -stmt-1

onTestFailedWithTimeout() gets excuted when test method failed with time out error

onFinish method will be called only once after executing all Test nethods

PASSED: testA

FAILED: testB

java.lang.AssertionError: expected [sita] but found [ram]

at org.testng.Assert.fail(Assert.java:97)

at org.testng.Assert.assertEqualsImpl(Assert.java:136)

at org.testng.Assert.assertEquals(Assert.java:118)

at org.testng.Assert.assertEquals(Assert.java:575)

at org.testng.Assert.assertEquals(Assert.java:585)

at TestNGBasics3.TestA.testB(TestA.java:27)

at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)

at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:64)

at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)

at java.base/java.lang.reflect.Method.invoke(Method.java:564)

at org.testng.internal.MethodInvocationHelper.invokeMethod(MethodInvocationHelper.java:133)

at org.testng.internal.TestInvoker.invokeMethod(TestInvoker.java:584)

at org.testng.internal.TestInvoker.invokeTestMethod(TestInvoker.java:172)

at org.testng.internal.MethodRunner.runInSequence(MethodRunner.java:46)

at org.testng.internal.TestInvoker$MethodInvocationAgent.invoke(TestInvoker.java:804)

at org.testng.internal.TestInvoker.invokeTestMethods(TestInvoker.java:145)

at org.testng.internal.TestMethodWorker.invokeTestMethods(TestMethodWorker.java:146)

at org.testng.internal.TestMethodWorker.run(TestMethodWorker.java:128)

at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)

at org.testng.TestRunner.privateRun(TestRunner.java:770)

at org.testng.TestRunner.run(TestRunner.java:591)

at org.testng.SuiteRunner.runTest(SuiteRunner.java:402)

at org.testng.SuiteRunner.runSequentially(SuiteRunner.java:396)

at org.testng.SuiteRunner.privateRun(SuiteRunner.java:355)

at org.testng.SuiteRunner.run(SuiteRunner.java:304)

at org.testng.SuiteRunnerWorker.runSuite(SuiteRunnerWorker.java:53)

at org.testng.SuiteRunnerWorker.run(SuiteRunnerWorker.java:96)

at org.testng.TestNG.runSuitesSequentially(TestNG.java:1180)

at org.testng.TestNG.runSuitesLocally(TestNG.java:1102)

at org.testng.TestNG.runSuites(TestNG.java:1032)

at org.testng.TestNG.run(TestNG.java:1000)

at org.testng.remote.AbstractRemoteTestNG.run(AbstractRemoteTestNG.java:115)

at org.testng.remote.RemoteTestNG.initAndRun(RemoteTestNG.java:251)

at org.testng.remote.RemoteTestNG.main(RemoteTestNG.java:77)

FAILED: testD

org.testng.internal.thread.ThreadTimeoutException: Method TestNGBasics3.TestA.testD() didn't finish within the time-out 5000

SKIPPED: testC

org.testng.SkipException: skipping the current test C()

at TestNGBasics3.TestA.testC(TestA.java:38)