Maven Plugin

qmetry-test-management-maven-plugin

QMetry Test Management plugin for Maven has been designed to seamlessly integrate your CI/CD pipeline with QMetry Test Management.

QMetry Test Management Maven Plugin uploads result file(s) generated in a Maven project to QMetry Test Management. The plugin, if used in a maven project, provides an additional maven goal 'uploadresults'

How to use the plugin?

Step 1: Prerequisite

To get qmetry configuration from QMetry Test Management :-

Login to QMetry Test Management application.
Choose an existing project or create new.
Goto Integration > Automation API > Copy Automation API Key OR directly visit https://testmanagement.qmetry.com/#/integration/automation-api

Open the pom.xml and add the configurations as described on the Automation API screen for Maven.

Step 2:Add following to the pom.xml:

<pluginRepositories>
	<pluginRepository>
		<id>qmetry-test-management-maven-plugin-mvn-repo</id>
		<url>https://raw.github.com/qmetry/qmetry-test-management-maven-plugin/mvn-repo/</url>
		<snapshots>
			<enabled>true</enabled>
			<updatePolicy>always</updatePolicy>
		</snapshots>
	</pluginRepository>
</pluginRepositories>

Step 3:Add the following to the -> block in your pom.xml:

<plugin>
	<groupId>com.qmetry</groupId>
	<artifactId>qmetry-test-management-maven-plugin</artifactId>
	<configuration>
		<url>https://testmanagement.qmetry.com/</url>
		<apikey>zEzs7iy7D8ARWX8xMFzJRZTzb66W0LCyaK6xde</apikey>
		<filepath>test-results\</filepath>
		<format>qas/json</format>
		<project>Demo Project</project> <!-- or <qtmProject>Demo Project</qtmProject> -->
		<automationHierarchy>1</automationHierarchy>
		<testsuite>Testsuite Key</testsuite>
		<testsuiteName>Demo Test suite</testsuiteName>
		<tsFolderPath>Fitness Tracker/Track1</tsFolderPath>
		<release>Demo Release</release>
		<cycle>Demo Cycle</cycle>
		<build>Demo Build</build>
		<platform>Demo Platform</platform>
		<testcaseFields>{"description":"Automated Test case","testCaseType":"Security","testCaseState":"Rejected","component":["x"],"priority":"Blocker","testcaseOwner":"Jack","estimatedTime":"143","userDefinedFields":{"Integrate":"Custom Field Testsuite"}}</testcaseFields>
		<testsuiteFields>{"description":"Automated Test suite","testsuiteOwner":"Jack","testSuiteState":"New","userDefinedFields":{"Integrate":"Custom Field Testsuite"}}</testsuiteFields>
		<skipWarning>0</skipWarning> <!-- Pass: 0/1 -->
		<isMatchingRequired>true</isMatchingRequired> <!-- Pass: true/false -->
	</configuration>
</plugin>

url (required) - URL of your QMetry instance
apikey (required) - Automation API Key
filepath (required) - path to result file (or directory for multiple files) relative to build directory
format (required) - junit/xml or testng/xml or cucumber/json or qas/json or hpuft/xml or robot/xml
project or qtmProject (required) - Project ID or Project Key or Project name
automationHierarchy (optional) - Hierarchy which will be used to parse test result files on QTM for JUnit and TestNG (In case of other frameworks automationHierarchy will be skipped if provided)
- JUnit
  - 1 - Use current Hierarchy in which JUnit Testcase is treated as TestStep and Testsuite is treated as Testcase
  - 2 - Use Junit Testcase as Testcase and link all those (from all testsuites and all files of Junit) to one Testsuite
  - 3 - Create Multiple Testsuites and then link their respective testcases in corresponding Testsuites
- TestNG
  - 1 - Use 'class' tag as Testcase and 'test-method' tag as TestStep
  - 2 - Use 'test-method' tag as Testcase
  - 3 - Use 'test' tag as Testcase and 'test-method' tag as TestStep
release (optional) - Release ID or Release name
cycle (optional) - Cycle Id or Cycle Name
build (optional) - Build ID or Build name
testsuite (optional) - Test suite ID or Entity Key (This will upload results to existing test suite)
testsuiteName (optional) - Test suite Name (This will create a new test suite with given name)
tsFolderPath (optional) - Test suite Folder Path (This will upload results to the mentioned Test Suite Folder)
platform (optional) - Platform Id or Platform Name
testcaseFields (optional) - Mention system defined fields and user defined fields for test case as shown in Test Case JSON format above
testsuiteFields (optional) - Mention system defined fields and user defined fields for test suite as shown in Test Suite JSON format above
skipWarning (optional) - 0 : (Default) Test Case Import will be failed if the result file contains test case summary with more than 255 characters, 1 : Test Cases can be imported by ignoring the warning about summary length. If the test case summary is longer, it will be truncated to 255 characters
isMatchingRequired (optional) - true : (Default) Create a new Test Case or Test Case Version if no version matches with the one being uploaded, false : Reuse already linked Test Case version on Test Suite OR auto link the existing latest version of Test Case, if the Test Case entity key OR Test Case summary is found matching

Important Points

Project name, key or id can be provided in 'project' or 'qtmProject' parameter, if both are provided then 'project' will be ignored.
Automation Hierarchy which will be used to parse test result files on QTM is only supported for TestNG and JUnit framework.
cycle refers to the Cycle Name in QMetry Test Management, and must be included in Release specified by release field of your project.
testsuite should include Test Suite Key or Id from your QMetry Test Management project. Ignore the field if you want to create a new Test Suite for the results.
platform (if specified), must be included in your QMetry Test Management project, before the task is executed.
In case of QAS enter path to the folder in which testresult folder will be created. Plugin will automatically fetch testresult folder and upload results.
Enter directory path to upload zip file plugin will create zip file and upload it to QMetry Test Management.
testsuiteFields parameter will be ignored if existing Test suite Id is used to upload results.
tsFolderPath parameter will be ignored if the QMetry instance type is Server.

Step 4:Generate Test Result(s) for your project.

Step 5:Upload Test Result(s) to QMetry Test Management by executing following goal:

mvn qtm:uploadresults

qmetry / qmetry-test-management-maven-plugin