A long executing test would slog the other tests. In such cases we can add the timeOut attribute to the test methods.<\/p>\n
timeOut attribute<\/h3>\n
Sample usage of the timeOut attribute. For example to set the timeout of 5 secs to a test method:<\/p>\n
@Test(timeOut = 5000) \/\/ SLA – 5secs<\/p>\n
public void testMethodWithFiveSecSLA()<\/p>\n
<\/p>\n
![\"Timeout](\"https:\/\/www.testingdocs.com\/questions\/wp-content\/uploads\/Timeout-Test-methods-in-TestNG.png\" "\\"\\"")
<\/p>\n
Sample Code<\/h3>\n
<\/p>\n
package com.testingdocs.tests.timeouts; \r\n\r\nimport org.testng.annotations.Test; \r\n\r\n\/\/################################### \r\n\/\/ Testing timeout in Test methods \r\n\/\/ www.TestingDocs.com\r\n\/\/################################### \r\n\r\npublic class TimeoutsTestNG { \r\n\r\n@Test(timeOut = 5000) \/\/ SLA - 5secs Time in milliseconds \r\npublic void testMethodShouldPass() throws InterruptedException { \r\n Thread.sleep(4000); \r\n} \r\n\r\n@Test(timeOut = 5000) \r\npublic void testMethodShouldFail() { \r\n while (true);\/\/ indefinite loop - this test will fail\r\n } \r\n}<\/pre>\n <\/p>\n
Timeout in XML file<\/h3>\n
Notice that for every Test method we are specifying the timeOut attribute. To set the timeout for multiple tests we can set this in the TestNG XML file.<\/p>\n
We can specify the timeout at various level in the XML file.<\/p>\n
- \n
- Suite<\/strong><\/li>\n
- Test<\/strong><\/li>\n
- Groups<\/strong><\/li>\n
- Classes<\/strong><\/li>\n<\/ul>\n
Let’s see how we can specify the timeout in the XML file.<\/p>\n
<\/p>\n
<!DOCTYPE suite SYSTEM \"https:\/\/testng.org\/testng-1.0.dtd\" >\r\n \r\n<!-- TestNG Tutorials -->\r\n<!-- www.TestingDocs.com --> \r\n<suite name=\"Timeout Tests\" time-out=\"5000\"> \r\n <test name=\"SampleTest1\"> \r\n\t<classes>\r\n\t <class name=\"com.testingdocs.tests.timeouts.TimeoutsSuiteXMLDemo\" \/>\r\n\t<\/classes> \r\n <\/test> \r\n<\/suite><\/pre>\n
<\/p>\n
<\/p>\n
We can remove the timeout attributes from the @Test annotation in the test methods. We can place all the test classes that test with the timeout = 5 secs under this suite.<\/p>\n
Test methods without timeOut<\/strong> annotation attribute. Timeout for both the methods would be set to 5 secs as specified in the XML file.<\/p>\n
<\/p>\n
<\/p>\n
package com.testingdocs.tests.timeouts;\r\n\r\nimport org.testng.annotations.Test;\r\n\r\n\/\/###################################\r\n\/\/# Testing timeout in Test methods\r\n\/\/# www.TestingDocs.com\r\n\/\/###################################\r\n\r\npublic class TimeoutsSuiteXMLDemo {\r\n\t\/\/ 5 secs timeout specified in the testng.xml file\r\n\t@Test \r\n\tpublic void testMethodShouldPass() throws InterruptedException {\r\n\t\tThread.sleep(4000);\r\n\t}\r\n\r\n\t@Test\r\n\tpublic void testMethodShouldFail() {\r\n\t\twhile (true);\/\/ indefinite loop - this test will fail\r\n\t}\r\n\r\n}\r\n<\/pre>\n<\/p>\n
<\/p>\n
![\"Timeout](\"https:\/\/www.testingdocs.com\/questions\/wp-content\/uploads\/Timeout-Five-Secs-Suite-XML.png\" "\\"Timeout")
<\/p>\n<\/p>\n
<\/p>\n
Use of Timeouts<\/strong><\/p>\n
For example, assume we are testing an API call with SLA( Service level agreement) that the API should respond within 5 secs of time from the API request is sent. It is considered a failure if the API responds after 5 sec as per the SLA. We can use the timeout for the service tests to check the slow API calls.<\/p>\n
Points to Ponder<\/h3>\n
1.What happens if we specify time-out as 5000 ms in <suite> XML file and @Test(timeOut=7000ms) in the test method. The test method takes 6000 ms to complete execution.<\/p>\n
2.<\/p>\n
<\/p>\n
<!DOCTYPE suite SYSTEM \"https:\/\/testng.org\/testng-1.0.dtd\" >\r\n<!-- TestNG Tutorials -->\r\n<!-- www.TestingDocs.com --> \r\n<suite name=\"Timeout Tests\" time-out=\"5000\"> \r\n <test name=\"SampleTest1\" time-out=\"3000\"> \r\n\t<classes>\r\n\t <class name=\"com.testingdocs.tests.timeouts.TimeoutsSuiteXMLDemo\" \/>\r\n\t<\/classes> \r\n <\/test> \r\n<\/suite><\/pre>\n
<\/p>\n
Given the Test method:<\/p>\n
@Test \r\npublic void testMethod() throws InterruptedException {\r\nThread.sleep(4000);\r\n}<\/pre>\nWhat is the test result Pass\/Fail?<\/p>\n
—<\/p>\n
TestNG Tutorials on this website can be found at:<\/p>\n
- Test<\/strong><\/li>\n