Awesome

Setup

Configure the workflow

Specify the action as part of your GitHub actions workflow, using a Xray API key (i.e. a pair of client id and client secret):

- name: "Import results to Xray"
  uses: mikepenz/xray-action@{latest-release}
  with:
    username: ${{ secrets.XRAY_CLIENT_ID }}
    password: ${{ secrets.XRAY_CLIENT_SECRET }}
    testFormat: "junit"
    testPaths: "**/test/*.xml"
    testExecKey: "TEST-1"
    projectKey: "TEST"

If you're using Xray Server/DC, you'll need to set xrayCloud as "false", use Jira credentials for authentication, and specify additional parameters.

- name: "Import results to Xray"
 uses: mikepenz/xray-action@{latest-release}
 with:
   username: ${{ secrets.JIRA_USERNAME }}
   password: ${{ secrets.JIRA_PASSWORD }}
   xrayCloud: "false"
   xrayBaseUrl: "https://myjiraserver.example.com"
   testFormat: "junit"
   testPaths: "**/test/*.xml"
   testExecKey: "TEST-1"
   projectKey: "TEST"

⚠️ Xray Server/DC requires test plan, test env, revision to be defined via their custom field. See additional details on passing a custom test execution json.

💡 Do not specify username and password in cleartext, instead prefer to read them from GitHub action secrets.

Test execution json

The test execution json should the meta information in the following format:

{
    "fields": {
        "summary": "Brand new Test execution",
        "issuetype": { "id": "10007" },
        "components": [
            { "name": "Interface" },
            { "name": "Core" }
        ]
    }
}

⚠️ For Xray Server/DC environments test plan, test env, revision fields are required to be provided via their custom field. See the official API documentation for more details.

{
    "fields": {
        "summary": "Brand new Test execution",
        "issuetype": { "id": "10007" },
        "components" : [
            { "name":"Interface" },
            { "name":"Core" }
        ],
        "customfield_10032" : [
            "TES-38"
        ]
    }
}

💡 The import will fail if the provided issueType for example does not exist. Please ensure correct information is provided.

Action outputs

After action execution it will return helpful information.

# ${{steps.{XRAY_STEP_ID}.outputs.count}}
${{steps.xray.outputs.count}}

A full set list of possible output values for this action.

Contribute 🧬

# Install the dependencies  
$ npm install

# Build the typescript and package it for distribution
$ npm run build && npm run package

# Run the tests, use to debug, and test it out
# Please note you have to uncomment the test
# Provide your xray instance username and password
# And then execute the test:
$ npm test

# Verify lint is happy
$ npm run lint -- --fix

Xray

• Xray website
• Currently fully supporting all (non multipart) requests according to Xray REST API documentation
• Partially support for multipart request. Supports specifying test execution meta information Xray REST API documentation

Developed By

• Mike Penz
• mikepenz.com - mikepenz@gmail.com
• paypal.me/mikepenz

Other actions

• release-changelog-builder-action
• action-junit-report
• jira-release-composition-action

License

Copyright 2021 Mike Penz

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.