xray-connector

xray-connector provides a mean to synchronize tests between Xray and a Test Automation Framework (for example Cypress).

It supports a transversal test management / test execution / test reporting process in which:

• automated tests are defined in JIRA/Xray using the GHERKIN syntax
• tests are automatically retrieved from JIRA/Xray and executed by the Test Automation Framework
• tests execution results are pushed back to JIRA/Xray by The Test Automation Framework, for analysis and reporting

✨Features

xray-connector provides the following features:

• retrieve test cases from JIRA/Xray as feature files
• publish test execution results back to JIRA/Xray
• merge separate, feature-based, tests execution reports into one for publication in JIRA/Xray
• convert Gatling test execution reports into JIRA/Xray compatible reports

It supports test execution with Cypress, Gatling, Karate, ...

🔑 Prerequisites

To run xray-connector, you will need:

• a JIRA account with api access to your project. Please check the QA chapter site or liaise with us on teams to get the necessary information.
• an Xray test plan with associated tests defined in your JIRA project. Only tests with type Cucumber will be taken into account.

⚙️ Quick setup (Node environment)

If you are working in a NodeJS environment, the following steps will have your ready to use xray-connector in a few minutes.

• First, configure npm to use artifactory
• Then, install xray-connector as a dependency in your projet:

$ npm install --save @rd/xray-connector

• Last, set xray-connector minimum environment variables:

If your JIRA account has been provided to you with a password:

$ export JIRA_XRAY_LOGIN=<JIRA account login>
$ export JIRA_XRAY_PASSWORD=<JIRA account password>
$ export XC_DEFAULT_TEST_PLAN=<Your Xray reference test plan key>

If your JIRA account has been provided to you with a token:

$ export JIRA_XRAY_TOKEN=<JIRA account token>
$ export XC_DEFAULT_TEST_PLAN=<Your Xray reference test plan key>

If your project is hosted on the intra JIRA server rather than on the dt JIRA server, you will also need to set the following additional environment variable:

$ export JIRA_XRAY_HOST=jira.intra.renault.fr

• And voilà ! You should now be able to retrieve feature files from Xray using the following command:

$ npx xray-get-features

⚙️ Setup in a Java environment

If you are working in a Java environment, please refer to the Gradle integration page.

⚙️ Proxy configuration

xray-connector will use the following environment variables to determine which proxy to use to connect to Xray, in this order:

1. JIRA_XRAY_PROXY
2. https_proxy
3. HTTPS_PROXY
4. http_proxy
5. HTTP_PROXY

Other PROXY environment variables such as HTTP_PROXY_URL, HTTP_PROXY_PORT... will be ignored.

No proxy will be used for URLs with a hostname present in the no_proxyor NO_PROXY environment variables (exact match only).

If you need to investigate proxy issues, set the DEBUG_PROXY or XC_DEBUG_PROXY environment variable to any value.

Proxy configuration and usage information will then be logged on the terminal output.

If you are using a proxy in a NodeJS environment, please make sure you use node version > 10.

📖 Going further

Now you've set up xray-connector, you may want to dig deeper into the following topics:

• How does xray-connector work?
• What are the different xray-connector configuration options?
• What are the different xray-connector commands?
• How to configure xray-connector for my test automation framework?
• How to integrate xray-connector in my project?
• How to set up xray-connector in the CI/CD?
• Do I really need xray-connector?

♻️ Contributing

Do you want to evolve this project ? You are more than welcome :-) Take a look at our code of conduct to contribute and the process for submitting pull requests to us.

If you're up for it, don't hesitate to start looking at this development information.