Zephyr XML formatter for Cucumber

Common configuration for all Cucumber modules

License	MIT License
Categories	Cucumber Application Testing & Monitoring ORM Data
GroupId	io.cucumber
ArtifactId	zephyr-xml-formatter
Last Version	4.2.0.2
Release Date	Dec 17, 2020
Type	jar
Description	Zephyr XML formatter for Cucumber Common configuration for all Cucumber modules

Download zephyr-xml-formatter

Filename	Size
zephyr-xml-formatter-4.2.0.2.pom
zephyr-xml-formatter-4.2.0.2.jar	19 KB
zephyr-xml-formatter-4.2.0.2-sources.jar	7 KB
zephyr-xml-formatter-4.2.0.2-javadoc.jar	389 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.cucumber/zephyr-xml-formatter/ -->
<dependency>
    <groupId>io.cucumber</groupId>
    <artifactId>zephyr-xml-formatter</artifactId>
    <version>4.2.0.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.cucumber/zephyr-xml-formatter/
implementation 'io.cucumber:zephyr-xml-formatter:4.2.0.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.cucumber/zephyr-xml-formatter/
implementation ("io.cucumber:zephyr-xml-formatter:4.2.0.2")

Apache Buildr

'io.cucumber:zephyr-xml-formatter:jar:4.2.0.2'

Apache Ivy

<dependency org="io.cucumber" name="zephyr-xml-formatter" rev="4.2.0.2">
  <artifact name="zephyr-xml-formatter" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.cucumber', module='zephyr-xml-formatter', version='4.2.0.2')
)

Scala SBT

libraryDependencies += "io.cucumber" % "zephyr-xml-formatter" % "4.2.0.2"

Leiningen

[io.cucumber/zephyr-xml-formatter "4.2.0.2"]

Dependencies

provided (1)

Group / Artifact	Type	Version
io.cucumber : cucumber-core	jar	4.2.0

test (3)

Group / Artifact	Type	Version
io.cucumber : cucumber-java	jar	4.2.0
io.cucumber : cucumber-junit	jar	4.2.0
junit : junit	jar	4.13

Project Modules

There are no modules declared in this project.

cucumber-jvm-zephyr-xml

This Cucumber-JVM plugin generates JUnit XML with proprietary modifications to support Zephyr.

Warning: This plugin outputs additional XML elements that are incompatible with widely used XML schemas that validate the generated XML:

• jenkins-junit.xsd
• various other schemas

Adding these extra XML elements in the official JUnitXmlFormatter would cause validation errors for all users using one of the validation schemas above.

For this reason this plugin is a fork of the JUnitXmlFormatter. It has been forked from Cucumber-JVM 4.2.6.

Warning: This plugin has not been tested against later versions of Cucumber-JVM and is unlikely to be compatible with versions 5.x and 6.x.

Until this is fixed, users of this plugin will not be able to use recent versions of Cucumber-JVM.

Custom <requirements> element

Any tags in the feature file starting with @JIRA_ will be outputted to the XML.

For example:

@JIRA_XYZ-1 @JIRA_XYZ-1 @smoke-test
Feature: something

This will output the following snippet in the generated XML

<requirements>
  <requirement>AltID_XYZ-1</requirement>
  <requirement>AltID_XYZ-2</requirement>
</requirements>

The plugin will replace @JIRA_ with AltID_ in the generated XML.

Using <tags> element

@ tags in the feature file which are not recognised as requirements (see above), will be inserted into the XML results file as tag nodes.

For example:

@JIRA_XYZ-1 @JIRA_XYZ-1 @smoke-test
Feature: something

This will collect the first two tags as requirements and the last @ tag will be a tag for the zephyr tescase.

Here is an example of a single tag in the XML file:

<tags>                          ---//  tags: parent element
<tag>Feature1</tag>             ---// tag : child element
</tags>  

Here is an example of multiple tags in the XML file:

<tags>
<tag>BVT1</tag>
<tag>BVT2</tag>
</tags>

Usage:

Add the dependency to your pom.xml:

<dependency>
    <groupId>io.cucumber</groupId>
    <artifactId>zephyr-xml-formatter</artifactId>
    <version>4.2.0.2</version>
</dependency>

Add the following to your JUnit class:

@RunWith(Cucumber.class)
@CucumberOptions(plugin = {"io.cucumber.zephyr.ZephyrXMLFormatter:target/zephyr.xml"})

Maintenance

This plugin is maintained by the SmartBear Zephyr team.

Release process

• Update the version number in pom.xml.
• Update CHANGELOG.md to reflect the changes since the previous release.
• Commit your files.

Contact somebody fro the Cucumber Open core team to get access to secrets.

make docker-run-with-secrets
make release

This should tag the git repository and upload artefacts to Maven Central.

Cucumber

Cucumber Open

Versions

Version
4.2.0.2 Dec 17, 2020
4.2.0.1 Feb 12, 2020
4.2.0 Feb 11, 2020