How to create TestNG XML file and Execute TestNG.XML File?

TestNG is a powerful testing framework for Java developers, inspired by JUnit and NUnit. It supports a wide range of testing needs, from unit testing to integration testing. One of the key features of TestNG is the ability to control the execution of tests using an XML file, known as the TestNG XML file. This file defines which classes and methods should be included in the test run, allowing you to group tests, manage test configurations, and control test execution flow.

In this article, we will guide you through the process of generating these reports using Eclipse. We will start by creating a TestNG project, running test cases, and then exploring the reports generated automatically by TestNG.

Prerequisites

Before we begin, ensure that you have the following set up:

• Java Development Kit (JDK) installed on your machine.
• TestNG installed in your IDE (e.g., Eclipse or IntelliJ IDEA).
• A TestNG Project created in your IDE.

Steps to Create and Execute a TestNG XML File

Step 1. Set Up Your TestNG Project

Before creating the TestNG XML file, ensure you have a TestNG project set up in your IDE (like Eclipse or IntelliJ IDEA). If you don't have TestNG installed, follow these steps:

Install TestNG in Eclipse:

1. Open Eclipse.
2. Navigate to Help > Eclipse Marketplace.
3. Search for "TestNG" and install it.
4. Restart Eclipse to complete the installation.

Add TestNG to Your Maven Project

<!-- https://mvnrepository.com/artifact/org.testng/testng -->

<dependency>

<groupId>org.testng</groupId>

<artifactId>testng</artifactId>

<version>7.10.2</version>

<scope>test</scope>

</dependency>

Step 2. Create Test Classes

Create a Java class containing your test methods. Ensure the methods are annotated with @Test.

Step 3. Create the TestNG XML File

Create the File:

• Right-click on the src/test/resources folder (or create one if it doesn't exist) in your Eclipse project.
• Select New > File and name it testng.xml.
• Add the following content to the testng.xml file:

Define the Test Suite and Test

Add the following content to the testng.xml file:

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd">

<suite name="Suite">

<test thread-count="5" name="Test">

<classes>

<class name="practice.SampleTest"/>

</classes>

</test> <!-- Test -->

</suite> <!-- Suite -->

• <suite> Tag: This defines a test suite, which can contain multiple tests.
• <test> Tag: This defines a test, which can contain multiple classes.
• <classes> Tag: This contains the classes that need to be executed during the test.

Step 4: Execute the TestNG XML File

Now that your XML file is ready, it’s time to execute it and generate the reports.

Running the TestNG XML File in Eclipse

• Right-click on the testng.xml file in your Eclipse project.
• Select Run As > TestNG Suite.

This will execute the test suite defined in your XML file, and TestNG will automatically generate reports.

Step 5. View the Generated Reports

After running your tests, TestNG generates both an HTML report and an emailable report. These reports are stored in the test-output folder of your project.

1. HTML Report

The HTML report is a detailed summary of your test execution.

• Navigate to the test-output folder in your project directory.
• Open the index.html file in your web browser.

This file provides a comprehensive view of your test results, including pass/fail counts, error messages, and stack traces.

2. Emailable Report

The emailable report is a more concise version of the test results.

• Locate the emailable-report.html file in the test-output folder.
• Open this file in a web browser to view the report.

The emailable report is typically used for sharing results via email, as it provides a summary of the test execution.

Step 6. View the Output

Once the test suite has been executed, you can view the results.

In Eclipse

• The results will be displayed in the TestNG console tab in Eclipse, showing the status of each test (pass/fail) and any errors or exceptions that occurred.

Conclusion

Generating and viewing reports in TestNG is an essential aspect of the testing process. By following this guide, you should now be able to create a TestNG XML file, execute it, and generate both HTML and emailable reports in Eclipse. These reports provide valuable insights into your test execution and can be easily shared with your team. Customizing and automating report generation can further enhance your testing workflow, making it more efficient and effective.