XRay Integration

By attaching files (such as those generated by the HTML Reporter plugin) to Jira and XRay during the run, this plugin integrates the results of a Wakamiti execution into an existing XRay test plan.

Install

Include the module in the corresponding section.

es.iti.wakamiti:xray-wakamiti-plugin:2.5.2

<dependency>
  <groupId>es.iti.wakamiti</groupId>
  <artifactId>xray-wakamiti-plugin</artifactId>
  <version>2.5.2</version>
</dependency>

Options

XRAY

xray.enabled

  • Type: boolean
  • Default: true

Enable/disable entirely this plugin.

Example:

xray:
  enabled: false

xray.baseURL

  • Type: url obligatorio

The base url where the XRay server is located.

Example:

xray:
  baseURL: https://eu.xray.cloud.getxray.app

xray.auth.credentials.client-id

  • Type: string obligatorio

Client Id to be used with the XRay REST API, passed as an HTTP authentication.

Example:

xray:
  auth:
    credentials:
      client-id: MY-CLIENT-ID

xray.auth.credentials.client-secret

  • Type: string obligatorio

Client Secret to be used with the XRay REST API, passed as an HTTP authentication.

Example:

xray:
  auth:
    credentials:
      client-secret: MY-CLIENT-SECRET

xray.project

  • Type: string obligatorio

The name of the Jira project that the test plan belongs to.

Example:

xray:
  project: MyProject

xray.plan.summary

  • Type: string obligatorio

Test plan name in XRay.

Example:

xray:
  plan:
    summary: Wakamiti Test Plan

xray.attachments

  • Type: glob[]

Glob patterns of the reports you want to attach.

Example:

xray:
  attachments: 
    - '**/*.html'
    - '**/wakamiti.json'

xray.testCasePerFeature

  • Type: boolean
  • Default: false

Specifies whether the mapping to XRay test cases should be at feature level or scenario level.

Example:

xray:
  testCasePerFeature: true

xray.createItemsIfAbsent

  • Type: boolean
  • Default: true

Set whether to automatically create elements that do not exist in XRay.

Example:

xray:
  createItemsIfAbsent: true

JIRA

jira.baseURL

  • Type: url obligatorio

The base url where the Jira server is located.

Example:

jira:
  baseURL: https://my-jira.atlassian.net

jira.auth.credentials

  • Type: string obligatorio

Credentials to be used with the Jira REST API, passed as an HTTP authentication.

Example:

jira:
  auth:
    credentials: MY-CREDENTIALS

Usage

Synchronisation with XRay is performed before the tests are run. If there is a problem, the execution is stopped. At the end of the execution, the results are synchronised with XRay.