Parser Template Syntax
A parser template is a JSON structure:
Its fields specify the properties of a test execution item that Zephyr will create for a test run:
Field | Description |
status | A string that specifies the test status. Can be an arbitrary string. Typical values are Passed, OK, Failed, Failure, and so on. For more information, on how Zephyr checks if a test failed or not, see below. |
statusExistPass | An additional indicator of the test status. Can be |
statusString | An expected value for the status field. Zephyr users this field to check if a test failed or not. See below. |
statusFailAttachment | An additional description of test results used when a test failed. Typically, has an extended error message or a call stack for a failed function. Zephyr saves this extended description to a file and then attaches this file to an automation item: |
statusPassAttachment | An additional description of test results used when a test passed. Typically, has information on the test case name and execution time. Zephyr saves this extended description to a file and then attaches this file to an automation item. See the image above. |
packageName | This property is used only if you commanded Zephyr to create a package-like hierarchy of test execution items. The property specifies the name of the last level in the hierarchy. |
testcase | The name of the executed test case. Will be displayed in the Name column of the Test Execution screen in Zephyr. |
skipTestcaseNames | An XML file can have information on one or multiple test cases. By default, Zephyr will create a test execution item for every test case it finds in the XML file. This field is a string of test case names that which Zephyr will skip and for which it will not create a test run item. The names are case-sensitive. Separate multiple test case names with a comma. Don’t put extra spaces around test case names. |
requirements | An array of requirement IDs or alternative IDs with which a test run is linked. IDs should start with the |
attachments | An array that specifies additional files to be attached to the item. You should specify the path in terms of the computer, where the test ran. The path can be relative or absolute. If you use a relative file name, then it should be relative to the folder, where the test result XML file is located. |
How Zephyr determines if a test failed or passed
Zephyr uses the following field values to determine the overall test result:
status
statusExistPass
statusString
The status
field indicates the test results briefly. It might have or have no contents (for instance, the expression you use can refer to a non-existing element in the resulting XML file, or this expression can return an empty string). The other two fields specify how Zephyr treats the status value.
If statusString is null …
|
|
|
| Test passed | Test failed |
| Test failed | Test passed |
If statusString is some string …
Zephyr uses statusString
as an expected value for status
:
If
status
is not equal tostatusString
, then Zephyr considers the test failed.If
status
is equal tostatusString
, then Zephyr checks thestatusExistPass
property:
- If it istrue
, the test passed.
- If isfalse
, the test failed.
Examples
Example 1. Custom test case name
Suppose, you want the test execution item’s name to include both the test suite name and the test case name. In this case, you can use an expression like this (the “-
” symbol will be a separator in the resulting name):
…
"testcase": {
"name": ${testsuite:name}-testsuite.testcase:name}
}
…
Example 2. Include additional data
You may want to retrieve extra properties from the XML file and store them along with a test execution item. To do this, specify their names in the statusFailAttachment
or statusPassAttachment
property. For example:
…
statusFailAttachment: "name: ${testsuite.testcase:name} \ntime: ${testsuite.testcase:time}\ndata: ${testsuite.testcase.message}"
…
More examples
To get the idea of how to perform this or that action, explore the pre-configured templates that comes along with Zephyr. See how you can get them.
Starting Release 8.2, Zephyr Enterprise documentation is moving from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise Documentation page. https://support.smartbear.com/zephyr-enterprise/docs/en/welcome-to-zephyr-enterprise.html