1.5. Example of IConfigurationListener

1.5. Example of IConfigurationListener

IIConfigurationListener is the listener interface for events related to configuration methods.

In the below test class MyConfigListenerExample , we have a @BeforeSuite, @AfterSuite and a @Test method.
We can use @Listeners annotation to specify the listener class. Note that this is another way of providing listeners to TestNG other than the testng.xml way.

	MyConfigListenerExample:
	package com.IConfigurationListener;
	import java.util.Arrays;
	import org.testng.TestNG;
	import org.testng.annotations.AfterSuite;
	import org.testng.annotations.BeforeSuite;
	import org.testng.annotations.Listeners;
	import org.testng.annotations.Test;
	@Listeners(value=MyConfigListener.class)
	public class MyConfigListenerExample {
	@BeforeSuite
	public void beforeSuite() {
	System.out.println("in before suite mthods");
	}
	@Test
	public void testcase1() {
	System.out.println("test method testcase1");
	}
	@AfterSuite
	public void afterSuite() {
	System.out.println("in after suite method");
	}
	public static void main(String[] args) {
	TestNG testNG = new TestNG();
	testNG.setTestSuites(Arrays.asList("/yourpath/configurationListenerTestng.xml"));
	testNG.run();
	}
	}

view raw 1.IConfigurationListener.java hosted with ❤ by GitHub

	MyConfigListener:
	package com.IConfigurationListener;
	import org.testng.IConfigurationListener2;
	import org.testng.ITestResult;
	public class MyConfigListener implements IConfigurationListener2 {
	@Override
	public void onConfigurationSuccess(ITestResult tr) {
	System.out.println("Method - on configuration success");
	}
	@Override
	public void onConfigurationFailure(ITestResult tr) {
	System.out.println("Method -- on configuration failure");
	}
	@Override
	public void onConfigurationSkip(ITestResult tr) {
	System.out.println("Method -- on configuration skip");
	}
	@Override
	public void beforeConfiguration(ITestResult tr) {
	System.out.println("This is called before the configuration method is invoked");
	}
	}
	// Right click on the MyConfigListenerExample and run as TestNG Suite.

view raw 2.Listener.java hosted with ❤ by GitHub

	Output:
	[TestNG] Running:
	/private/var/folders/1q/8clrsf517cz46g_lmr_jr4nw0000gn/T/testng-eclipse--1710078531/testng-customsuite.xml
	This is called before the configuration method is invoked
	in before suite
	Method - on configuration success
	test method testcase1
	PASSED: testcase1
	===============================================
	Default test
	Tests run: 1, Failures: 0, Skips: 0
	===============================================
	This is called before the configuration method is invoked
	in after suite
	Method - on configuration success
	===============================================
	Default suite
	Total tests run: 1, Failures: 0, Skips: 0
	===============================================
	[TestNG] Time taken by org.testng.reporters.SuiteHTMLReporter@39ed3c8d: 24 ms
	[TestNG] Time taken by org.testng.reporters.JUnitReportReporter@48cf768c: 5 ms
	[TestNG] Time taken by org.testng.reporters.jq.Main@2d363fb3: 37 ms
	[TestNG] Time taken by [FailedReporter passed=0 failed=0 skipped=0]: 3 ms
	[TestNG] Time taken by org.testng.reporters.XMLReporter@16b3fc9e: 5 ms
	[TestNG] Time taken by org.testng.reporters.EmailableReporter2@1e81f4dc: 6 ms
	From the output, we can see that beforeConfiguration is called before the invocation of the configuration method.onConfigurationSuccess gets called on the success of a configuration method.

view raw 3.output.txt hosted with ❤ by GitHub