Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SmartBear/cucumber-jvm-zephyr-xml
Extension of the official JUnitFormatter with extra XML elements
https://github.com/SmartBear/cucumber-jvm-zephyr-xml
Last synced: 3 days ago
JSON representation
Extension of the official JUnitFormatter with extra XML elements
- Host: GitHub
- URL: https://github.com/SmartBear/cucumber-jvm-zephyr-xml
- Owner: SmartBear
- License: mit
- Created: 2020-02-11T11:29:51.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T20:30:56.000Z (7 months ago)
- Last Synced: 2024-11-13T14:54:52.417Z (3 days ago)
- Language: Java
- Size: 64.5 KB
- Stars: 2
- Watchers: 12
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/SmartBear/cucumber-jvm-zephyr-xml/actions?query=workflow%3A%22Java+CI+with+Maven%22)
# 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](https://github.com/junit-team/junit5/blob/main/platform-tests/src/test/resources/jenkins-junit.xsd)
* [various other schemas](https://stackoverflow.com/questions/442556/spec-for-junit-xml-output)
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](https://github.com/cucumber/cucumber-jvm/blob/main/CHANGELOG.md#426-2019-03-06).
## Custom `` element
Any tags in the feature file starting with `@JIRA_` will be outputted to the XML.
For example:
```gherkin
@JIRA_XYZ-1 @JIRA_XYZ-1 @smoke-test
Feature: something
```
This will output the following snippet in the generated XML
```xml
AltID_XYZ-1
AltID_XYZ-2
```
The plugin will replace `@JIRA_` with `AltID_` in the generated XML.
## Using `` 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:
```gherkin
@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:
```xml
---// tags: parent element
Feature1 ---// tag : child element
```
Here is an example of multiple tags in the XML file:
```xml
BVT1
BVT2
```
## Usage:
Add the dependency to your pom.xml:
```xml
io.cucumber
zephyr-xml-formatter
6.11.0.0
```
Add the following to your JUnit class:
```java
@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.
* Tag the `master` branch with the version number (e.g. `vX.Y.Z`).
* Create the release branch in the form `release/vX.Y.Z` to automatically publish.
### Manual Publish
Contact somebody from the Cucumber Open core team to get access to secrets.
```bash
make docker-run-with-secrets
make release
```
This should tag the git repository and upload artefacts to Maven Central.