Xray Junit5 Json Plugin

A Maven Plugin for integrating Java (JUnit5) automation tests results with Xray Test Case Management System manual tests.

Features

• Import Java (JUnit5) automation results to Xray manual tests.

Getting Started

1. Add the plugin to your Maven project:

   <build>
       <plugins>
           <plugin>
               <groupId>io.github.kopytovskiy</groupId>
               <artifactId>xray-junit5-json-plugin</artifactId>
               <version>0.0.3</version>
           </plugin>
       </plugins>
   </build>

2. Configure the plugin in your pom.xml.

   <configuration>
       <projectKey>${projectKey}</projectKey>
       <issueType>${issueType}</issueType>
       <labels>${labelsList}</labels>
       <testPlanKey>${testPlanKey}</testPlanKey>
       <pathToJUnitReport>${pathToJUnitReport}</pathToJUnitReport>
       <xrayClientId>${xrayClientId}</xrayClientId>
       <xrayClientSecret>${xrayClientSecret}</xrayClientSecret>
       <customJiraFields>
           <customfield_10051>${customfield_10051_value}</customfield_10051>
       </customJiraFields>
       <summary>Test Run (${customfield_10051_value}) - Automation Report (${maven.build.timestamp})</summary>
   </configuration>

• projectKey (required): The key of the Xray project (e.g. "QA").
• issueType (required): The number of issue type to be created (e.g., "10007").
• labelsList: The list of labels to be added to the Test Execution (e.g., "Automation, API").
• testPlanKey: The key of the Xray test plan. If not provided, the Test Execution will be not linked to any.
• pathToJUnitReport (default: "target/TEST-junit-jupiter.xml"): The path to the JUnit XML report file.
• xrayClientId (required): The client ID for authenticating with the Xray API.
• xrayClientSecret (required): The client secret for authenticating with the Xray API.
• customJiraFields: The key where additional custom fields could be added.
• summary (default: "Test Execution - Automation Tests Result (${session.request.startTime})"): The test execution summary field.

3. Execute the plugin:

   mvn xray-junit5-json-plugin:import-results

Contributing

All contributions are welcome!

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.