Skip to main content
Skip table of contents

TestNG XML result

There are 2 approaches to importing TestNG XML Result files using the API:

This TestNG framework supports only Generic test cases. Test step details for other types will be excluded from the parsed results.

1. Import Test Result only

This approach allows you to quickly upload test results to AgileTest without needing to include extra metadata like test execution timestamps, environment details, or other specific execution parameters.

You can locate the endpoint at the POST /ds/test-executions/testng in the API document.

When you click on the 🔽 button, a dialog will appear. Here you can input your information for the test result file upload.

There are 2 main sections:

  • Parameters: fields that you define as key parameters required to make a successful API request. These parameters include:

Parameters

Type

Required

Description

projectKey

string

✅

Key of the project where the test results will be imported.

milestoneId

integer

 

Milestone id to link to Test execution.

testExecutionKey

string

 

Test execution key to import test report.

testPlanKeys

array[string]

 

Test plan key to import test report.

If you specify a Test Plan, the tests will automatically be added to it if they are not already included.

testEnvironments

array[string]

 

A string containing a list of test environments separated by ",".

fixVersions

array[string]

 

A string containing a list of fixVersions separated by “,”.

revision

string

 

Revision to link to Test execution.

  • Request body: where you can input an XML file, which is a TestNG report that is going to be imported.

Test result example
CODE 
<?xml version="1.0" encoding="UTF-8"?>
<testng-results ignored="0" total="24" passed="24" failed="0" skipped="0">
  <reporter-output>
  </reporter-output>
  <suite started-at="2024-11-06T07:52:04 ICT" name="Surefire suite" finished-at="2024-11-06T07:52:04 ICT" duration-ms="31">
    <groups>
    </groups>
    <test started-at="2024-11-06T07:52:04 ICT" name="Surefire test" finished-at="2024-11-06T07:52:04 ICT" duration-ms="31">
      <class name="ProductTest">
        <test-method signature="testIsInStock()[pri:0, instance:ProductTest@4c402120]" started-at="2024-11-06T07:52:04 ICT" name="testIsInStock" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testIsInStock -->
        <test-method signature="testRestock()[pri:0, instance:ProductTest@4c402120]" started-at="2024-11-06T07:52:04 ICT" name="testRestock" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testRestock -->
        <test-method signature="testGetPrice()[pri:0, instance:ProductTest@4c402120]" started-at="2024-11-06T07:52:04 ICT" name="testGetPrice" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testGetPrice -->
      </class> <!-- ProductTest -->
      <class name="CartServiceTest">
        <test-method signature="testCheckoutCart()[pri:0, instance:CartServiceTest@22ff4249]" started-at="2024-11-06T07:52:04 ICT" name="testCheckoutCart" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testCheckoutCart -->
        <test-method signature="testCreateCart()[pri:0, instance:CartServiceTest@22ff4249]" started-at="2024-11-06T07:52:04 ICT" name="testCreateCart" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testCreateCart -->
        <test-method signature="testGetCart()[pri:0, instance:CartServiceTest@22ff4249]" started-at="2024-11-06T07:52:04 ICT" name="testGetCart" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testGetCart -->
      </class> <!-- CartServiceTest -->
      <class name="BillingTest">
        <test-method signature="testValidatePayment()[pri:0, instance:BillingTest@2d1ef81a]" started-at="2024-11-06T07:52:04 ICT" name="testValidatePayment" finished-at="2024-11-06T07:52:04 ICT" duration-ms="1" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testValidatePayment -->
        <test-method signature="testCalculateFinalAmount()[pri:0, instance:BillingTest@2d1ef81a]" started-at="2024-11-06T07:52:04 ICT" name="testCalculateFinalAmount" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testCalculateFinalAmount -->
      </class> <!-- BillingTest -->
      <class name="DeliveryOptionTest">
        <test-method signature="testGetCost()[pri:0, instance:DeliveryOptionTest@1165b38]" started-at="2024-11-06T07:52:04 ICT" name="testGetCost" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testGetCost -->
        <test-method signature="testToString()[pri:0, instance:DeliveryOptionTest@1165b38]" started-at="2024-11-06T07:52:04 ICT" name="testToString" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testToString -->
        <test-method signature="testGetOptionName()[pri:0, instance:DeliveryOptionTest@1165b38]" started-at="2024-11-06T07:52:04 ICT" name="testGetOptionName" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testGetOptionName -->
      </class> <!-- DeliveryOptionTest -->
      <class name="DeliveryTest">
        <test-method signature="testGetDeliveryDetails()[pri:0, instance:DeliveryTest@5b12b668]" started-at="2024-11-06T07:52:04 ICT" name="testGetDeliveryDetails" finished-at="2024-11-06T07:52:04 ICT" duration-ms="5" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testGetDeliveryDetails -->
        <test-method signature="testSetDeliveryDate()[pri:0, instance:DeliveryTest@5b12b668]" started-at="2024-11-06T07:52:04 ICT" name="testSetDeliveryDate" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testSetDeliveryDate -->
        <test-method signature="testSetDeliveryAddress()[pri:0, instance:DeliveryTest@5b12b668]" started-at="2024-11-06T07:52:04 ICT" name="testSetDeliveryAddress" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testSetDeliveryAddress -->
      </class> <!-- DeliveryTest -->
      <class name="AddressTest">
        <test-method signature="testGetFullAddress()[pri:0, instance:AddressTest@327514f]" started-at="2024-11-06T07:52:04 ICT" name="testGetFullAddress" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testGetFullAddress -->
        <test-method signature="testAddressInequality()[pri:0, instance:AddressTest@327514f]" started-at="2024-11-06T07:52:04 ICT" name="testAddressInequality" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testAddressInequality -->
        <test-method signature="testAddressEquality()[pri:0, instance:AddressTest@327514f]" started-at="2024-11-06T07:52:04 ICT" name="testAddressEquality" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testAddressEquality -->
      </class> <!-- AddressTest -->
      <class name="ProductServiceTest">
        <test-method signature="testAddProduct()[pri:0, instance:ProductServiceTest@22555ebf]" started-at="2024-11-06T07:52:04 ICT" name="testAddProduct" finished-at="2024-11-06T07:52:04 ICT" duration-ms="2" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testAddProduct -->
        <test-method signature="testUpdateProduct()[pri:0, instance:ProductServiceTest@22555ebf]" started-at="2024-11-06T07:52:04 ICT" name="testUpdateProduct" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testUpdateProduct -->
      </class> <!-- ProductServiceTest -->
      <class name="DeliveryServiceTest">
        <test-method signature="testAddDeliveryOption()[pri:0, instance:DeliveryServiceTest@4c12331b]" started-at="2024-11-06T07:52:04 ICT" name="testAddDeliveryOption" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testAddDeliveryOption -->
        <test-method signature="testGetAvailableOptions()[pri:0, instance:DeliveryServiceTest@4c12331b]" started-at="2024-11-06T07:52:04 ICT" name="testGetAvailableOptions" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testGetAvailableOptions -->
      </class> <!-- DeliveryServiceTest -->
      <class name="CartTest">
        <test-method signature="testGetTotalPrice()[pri:0, instance:CartTest@7586beff]" started-at="2024-11-06T07:52:04 ICT" name="testGetTotalPrice" finished-at="2024-11-06T07:52:04 ICT" duration-ms="1" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testGetTotalPrice -->
        <test-method signature="testAddItem()[pri:0, instance:CartTest@7586beff]" started-at="2024-11-06T07:52:04 ICT" name="testAddItem" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testAddItem -->
        <test-method signature="testRemoveItem()[pri:0, instance:CartTest@7586beff]" started-at="2024-11-06T07:52:04 ICT" name="testRemoveItem" finished-at="2024-11-06T07:52:04 ICT" duration-ms="0" status="PASS">
          <reporter-output>
          </reporter-output>
        </test-method> <!-- testRemoveItem -->
      </class> <!-- CartTest -->
    </test> <!-- Surefire test -->
  </suite> <!-- Surefire suite -->
</testng-results>

Learn more about the TestNG testing framework.

Then, you will receive an output example

Output example
CODE 
{
    "id": "321016",
    "key": "ATP-1856",
    "url": "https://company.atlassian.net/browse/ATP-1856"
}

In case you want to use the command line, file pipeline, and other tools instead of API docs, you can copy the curl and input the token to import test results.

CODE 
curl -X 'POST' \
  'https://api.agiletest.app/ds/test-executions/testng?projectKey=ATP' \
  -H 'accept: application/json' \
  -H 'Authorization: JWT <token>' \
  -H 'Content-Type: application/xml' \
  --data-binary '@my-report.xml'

In that, <token> is the result from the Get Authenticated step.

2. Import Test Result with New Execution Details

This approach allows you to import TestNG XML test results while including additional execution details, such as timestamps, environment details, test execution keys, and other specific parameters related to the test executions.

You can locate the endpoint at the POST /ds/test-executions/testng/multipart in the API document.

For this request, it does not require any parameters. Instead, you need to submit two separate files:

  • A file containing the test results to import. This file resembles the test result files used in the Import Test Result only approach.

  • A file containing the test execution details. This file has some fields, and each of these fields serves a specific purpose in creating and organizing the test execution:

    • The fields object contains standard issue creation information, like what project it belongs to and what type of issue it is. It has 3 compulsory fields summary, project.id, and issuetype.id. Additionally, you can include other optional Jira fields, such as labels, priority, or any custom fields that your Jira instance uses.

    • The agileTestFields object contains Agile Test-specific information for linking the execution to milestones and test plans, both of which are optional.

Field

Group

Type

Required

Description

summary

fields

string

✅

Summary of Test execution issue that will be created.

project.id

string

✅

Project ID in which the Test execution will be created.

issuetype.id

string

✅

The identifier specifying the type of issue to be created.

…

…

 

…

milestoneId

agileTestFields

integer

 

The identifier of the milestone that this test execution should be associated with.

testPlanKeys

array of string

 

An array of issue keys of Test plan that this test execution is related to.

testEnvironments

array of string

 

A string containing a list of test environments separated by ",".

fixVersions

array of string

 

A string containing a list of fixVersions separated by “,”.

revision

string

 

Revision to link to Test execution.

Test Execution detail example
CODE 
{
  "fields": {
    "summary": "Regression test",
    "project": {
      "id": "17110"
    },
    "issuetype": {
      "id": "16396"
    }
  },
  "agileTestFields": {
    "milestoneId": 5555,
    "testPlanKeys": ["ATP-364", "ATP-362"]
  }
}

Make sure all details provided are accurate and relevant; otherwise, the request will fail. For example, if the issuetype.id you specify a value that does not exist in the project with ID 17110, the system will return an error with the corresponding error code 400.

Then, you will receive an output example

Output example
CODE 
{
  "id": "321348",
  "key": "ATP-1859",
  "url": "https://company.atlassian.net/browse/ATP-1859"
}

In case you want to use the command line, file pipeline, and other tools instead of API docs, you can copy the curl and input the token to import test results.

CODE 
curl -X 'POST' \
  'https://api.agiletest.app/ds/test-executions/testng/multipart' \
  -H 'accept: application/json' \
  -H 'Authorization: JWT <token>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'results=@my-report.xml;type=application/xml' \
  -F 'testExecution=@test-execution.json;type=application/json'

In that, <token> is the result from the Get Authenticated step.

Should you need any assistance or further AgileTest inquiries, contact our 24/7 Support Desk!

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close