https://github.com/danzelbel/xray-beams

Xray test management integration for vscode
https://github.com/danzelbel/xray-beams

bdd gherkin jira vscode-extension xray

Last synced: 2 months ago
JSON representation

Xray test management integration for vscode

• Host: GitHub
• URL: https://github.com/danzelbel/xray-beams
• Owner: danzelbel
• License: mit
• Created: 2020-05-16T08:02:28.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-11T21:41:37.000Z (over 1 year ago)
• Last Synced: 2024-08-13T07:17:53.461Z (5 months ago)
• Topics: bdd, gherkin, jira, vscode-extension, xray
• Language: TypeScript
• Homepage:
• Size: 3.35 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - danzelbel/xray-beams - Xray test management integration for vscode (TypeScript)

README

        
[![MIT License](https://img.shields.io/github/license/danzelbel/xray-beams)](https://github.com/danzelbel/xray-beams/blob/master/LICENSE)

[![Version](https://vsmarketplacebadge.apphb.com/version/danzelbel.xray-beams.svg)](https://marketplace.visualstudio.com/items?itemName=danzelbel.xray-beams)

![Build](https://github.com/danzelbel/xray-beams/workflows/build/badge.svg)

![Release](https://github.com/danzelbel/xray-beams/workflows/release/badge.svg)

# Xray Beams

Xray test management integration for vscode

## Set up workspace

1. Open a new instance of vscode

1. Create a new file and the add ff lines:



   ```json

   {

     "folders": [

       {

         "name": "{{YOUR_PROJECT_KEY}}",

         "uri": "xbfs:/"

       }

     ],

     "settings": {

       "xrayBeams.jira.baseUrl": "{{YOUR_BASE_URL}}",

       "xrayBeams.jira.projectKey": "{{YOUR_PROJECT_KEY}}",

       "xrayBeams.jira.username": "{{YOUR_USERNAME}}",

       "xrayBeams.jira.jql.orphans": "",

       "xrayBeams.jira.jql.preConditions": "",

       "editor.detectIndentation": true,

       "editor.tabSize": 2

     }

   }

   ```

   ⚠ _Make sure to at least supply the required extension settings._



1. Save the file as `xraybeams test repository.code-workspace`

1. Open the workspace file in vscode anytime you need to work on your Xray project.

**Working on multiple Xray projects?**

Simply create another workspace file for each Xray project and open them as separate instances of vscode.

Xray Beams can only work on one Xray project per vscode instance. This is by design in order to allow the user to focus on a specific Xray project and to limit the number of views present in the explorer.

⚠ _Workspace file allows you to add more than one folder. Please limit it to one folder only._

## Features

### Manage Xray folders

Create, rename, move or delete Xray folders.

![features](images/readme/folders.gif)

### View tests as feature scenarios

An arbitrary feature file will be created along with the Xray folders so that you will be able to view the associated Xray tests as feature scenarios.

![features](images/readme/feature.gif)

### Manage tests

Add, move or delete tests.

![features](images/readme/manage-tests.gif)

### View Orphans

View and add orphaned tests to feature files.

![features](images/readme/view-orphans.gif)

### View Pre-Conditions

View and add pre-conditions to feature files.

![features](images/readme/view-pre-conditions.gif)

🛈 A `folderId:{{folderId}}` label will be added/removed from the pre-condition when it gets associated/dissociated to an Xray folder.

### Detect feature problems

Notifies you if your feature files are malformed and prevents you from committing these changes.

![features](images/readme/diagnotics.gif)

## Extension Settings

This extension contributes the following settings:

Required

- `xrayBeams.jira.baseUrl`

- `xrayBeams.jira.projectKey`

- `xrayBeams.jira.username`

Optional

- `xrayBeams.jira.jql.orphans`: The Orphans "JQL Search" filter

- `xrayBeams.jira.jql.preConditions`: The Additional jql filter for pre-conditions