mikepenz/xray-action

ability to export Cucumber tests to .feature file(s)

Open

#319 opened on Sep 8, 2021

View on GitHub
 (0 comments) (1 reaction) (0 assignees)TypeScript (22 forks)github user discovery
good first issuehelp wanted

Repository metrics

Stars
 (60 stars)
PR merge metrics
 (PR metrics pending)

Description

Xray manages Gherkin based test scenarios (aka Cucumber Tests) for Cucumber, SpecFlow, Behave as Test issues. As part of the supported workflows, in order to integrate it on the CI, we need to be able to export/generate Cucumber .feature files based on existing Test issues (the ones that are related to Cucumber Scenario/Scenario Outline).

Note1: the Xray Jenkins plugin has this supported as a separate task: https://docs.getxray.app/display/XRAY/Integration+with+Jenkins#IntegrationwithJenkins-Xray:CucumberFeaturesExportTask

Note2: the APIs are slightly different; I'd recommend always exporting the .feature files as a zip (using a flag on server endpoint; on cloud it's the default behaviour)

Contributor guide

Research direction
Investigate the Xray REST API endpoints for exporting Cucumber tests. Understand the differences between cloud and server APIs. Explore existing Jenkins plugin implementation for reference. Plan the integration into the existing GitHub Action workflow.
Tech stack
typescript
Domain
backendci cdtesting qa
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitHub ActionsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60