Available on Xporter for JIRA 3.3.0 or later and Xray for JIRA 1.8.0.
This is not applicable to Xporter for JIRA Cloud because for now there's no Xray version for JIRA Cloud.

Exporting a Test

Manual Test Steps

Xporter for JIRA allows rendering all Manual Test Steps of a Test. 

Definition:

$ {TestSteps[n].Field}

n is the index of Test Step, starting from 0. The field TestStepsCount was created in order to give the total of Test Steps. The fields available for Test Steps are:

  • StepNumber
  • Step
  • Data
  • ExpectedResult
Expand to see the example on sample code 
#{for teststeps}
	${TestSteps[n].StepNumber}
	${TestSteps[n].Step}
	${TestSteps[n].Data}
	${TestSteps[n].ExpectedResult}
#{end}

You can also directly reference the first and last Test Step of a Test.

Definition:

${TestSteps[First].Field}
${TestSteps[Last].Field}
Expand to see the example on sample code 
${TestSteps[First].StepNumber}
${TestSteps[First].Step}
${TestSteps[Last].StepNumber}
${TestSteps[Last].Step}

You can also Iterate over all Manual Test Steps while iterating over all Tests of a Test Set.

Expand to see the example on sample code 
#{for tests}
	${Tests[n].Key}
	${Tests[n].Summary}
	#{for m=Tests[n].TestStepsCount}
		${Tests[n].TestSteps[m].Step}
		${Tests[n].TestSteps[m].Data}
		${Tests[n].TestSteps[m].ExpectedResult}
	#{end}
#{end}

Exporting a Test Set

The Xporter for JIRA allows rendering all Tests of a Test Set. 
As it is not known in advance how many Tests exist in a Test Set, there is a notation that allows iterating a section over all the Tests of a Test Set. The notation is:

Expand to see the examples on sample code 
#Test Set Status
Todo: ${TODO} %
Fail: ${FAIL} %
Pass: ${PASS} %
Executing: ${EXECUTING} %
Aborted: ${ABORTED} %





#{for tests}
	Content and Test Mappings.	Example: ${Tests[n].Key}
#{end}
 
or
 
#{for j=TestsCount}
	Content and Test Mappings.	Example: ${Tests[j].Summary}
#{end}

n is the index of Test, starting from 0. The field TestsCount was created in order to give the total of Tests.

You can also directly reference the first and last Test of a Test Set.

Definition:

${Tests[First].Field}
${Tests[Last].Field}
Expand to see the examples on sample code 
${Tests[First].Key}
${Tests[First].Summary}
${Tests[Last].Key}
${Tests[Last].Summary}

Exporting a Test Execution

Xporter for JIRA allows rendering Test Execution details. The notation is:

Expand to see the examples on sample code of a Test Execution details 
#Overall Execution Status
Todo: ${TODO} %
Fail: ${FAIL} %
Pass: ${PASS} %
Executing: ${EXECUTING} %
Aborted: ${ABORTED} %
Custom Test Run Status: ${Blocked} 
 
#Total of Test Runs
Test Runs Count: ${TestRunsCount}
 
#Iterating over Test Runs
#{for testruns}
	Execution Status: ${TestRuns[n].Execution Status}
	AssigneeID: ${AssigneeId}
	Executed By: ${TestRuns[n].Executed By}
	Started On: ${TestRuns[n].Started On}
	Finished On: ${TestRuns[n].Finished On}
	Comment: ${wiki:TestRuns[n].Comment}
	Execution Defects Count: ${TestRuns[n].ExecutionDefectsCount} 
	TestSteps Defects Count: ${TestRuns[n].TestStepsDefectsCount}
	Evidences Count: ${TestRuns[n].ExecutionEvidencesCount}
 
	#Getting data from Pre-Condition
	Pre-Condition Key: ${TestRuns[n].PreCondition.Key}
	Pre-Condition Summary: ${TestRuns[n].PreCondition.Summary}
	Condition:	${TestRuns[n].PreCondition.Conditions}
	Type: ${TestRuns[n].PreCondition.Pre-Condition Type}
 
	#Iterating Test Attachments
	#{for sa=TestRuns[n].AttachmentsCount}
		Name: ${TestRuns[n].Attachments[sa].Name}
		Author: ${TestRuns[n].Attachments[sa].Author}
		ID: ${TestRuns[n].Attachments[sa].ID}
		Size: ${TestRuns[n].Attachments[sa].Size}
	#{end}
	
	#Iterating over Evidences
	#{for d=TestRuns[n].ExecutionEvidencesCount}
		Name: ${TestRuns[n].ExecutionEvidences[d].Name}
		Author: ${TestRuns[n].ExecutionEvidences[d].Author}
		Link: @{title=${TestRuns[n].ExecutionEvidences[d].FileURL}|href=${TestRuns[n].ExecutionEvidences[d].FileURL}}
		Size: ${TestRuns[n].ExecutionEvidences[d].Size}
	#{end}
 
	#Iterating over TestSteps Attachments
	#{for a=TestRuns[n].TestStepsAttachmentsCount}
		Name: ${TestRuns[n].TestStepsAttachments[a].Name}
		Author: ${TestRuns[n].TestStepsAttachments[a].Author}
		Link: @{title=${TestRuns[n].TestStepsAttachments[a].FileURL}|href=${TestRuns[n].TestStepsAttachments[a].FileURL}}
		Size: ${TestRuns[n].TestStepsAttachments[a].Size}
	#{end}


	#Test Run Step Details
	Cucumber Scenario: ${TestRuns[n].Cucumber Scenario}
	Test Definition: ${TestRuns[n].Generic Test Definition}
	
	#Iterating over Manual Test Steps from Test Run
	#{for r=TestRuns[n].TestStepsCount}
		StepNumber:	${TestRuns[n].TestSteps[r].StepNumber}
		Step:	${wiki:TestRuns[n].TestSteps[r].Step}
		Data:	${wiki:TestRuns[n].TestSteps[r].Data}
		Expected Result: 	${wiki:TestRuns[n].TestSteps[r].ExpectedResult}
		Comment:	${wiki:TestRuns[n].TestSteps[r].Comment}
		Status:	${TestRuns[n].TestSteps[r].Status}
	
		#Iterating over Test Step Attachments
		{for sa=TestRuns[n].TestSteps[r].AttachmentsCount}
			Name: {TestRuns[n].TestSteps[r].Attachments[sa].Name}
			Author: {TestRuns[n].TestSteps[r].Attachments[sa].Author}
			Link: {title={TestRuns[n].TestSteps[r].Attachments[sa].FileURL}|href={TestRuns[n].TestSteps[r].Attachments[sa].FileURL}}
			Size: {TestRuns[n].TestSteps[r].Attachments[sa].Size}
		#{end}	

		#Iterating over Test Step Defects
		{for dc=TestRuns[n].TestSteps[r].DefectsCount}
			Link: {title={TestRuns[n].TestSteps[r].Defects[dc].Key}|href={BaseURL}/browse/{TestRuns[n].TestSteps[r].Defects[dc].Key}}
			Summary: {wiki:TestRuns[n].TestSteps[r].Defects[dc].Summary}
		#{end}

		#Iterating over Test Step Evidences
		#{for e=TestRuns[n].TestSteps[r].EvidencesCount}
			Name: ${TestRuns[n].TestSteps[r].Evidences[e].Name}
			Author: ${TestRuns[n].TestSteps[r].Evidences[e].Author}
			Link: @{title=${TestRuns[n].TestSteps[r].Evidences[e].FileURL}|href=${TestRuns[n].TestSteps[r].Evidences[e].FileURL}}
			Size: ${TestRuns[n].TestSteps[r].Evidences[e].Size}
		#{end}
	#{end}
 
#{end}

The fields defined here can be obtained for fields Pre-Condition and Defects.

If a Test Execution contains lots of information it can decrease JIRA performance

Compatibility Matrix

Xporter for JIRA VersionXray Version
3.3.0, 3.3.1, 3.3.21.8.0 - 1.9.0
3.4.0 - 4.3.51.9.1 - 1.12.x
4.3.71.9.1+
  • No labels