Versions Compared

Old Version 2

changes.mady.by.user Liliia Ostrovska

Saved on

compared with

New Version Current

changes.mady.by.user Liliia Ostrovska

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printablefalse

Xray Test Management Overview

Xray app allows users to manage all tests as Jira issues, monitor

tests

test coverage, and analyze test statuses. When building Jira reporting in BI software such as Tableau Desktop, it is important to have this data to bring consistency

in business analytics.
Note

The main part of Xray integration is already done, but our developers are still working on adding new Xray data, which will be released very soon.

Table of ContentsminLevel1maxLevel7

to business analytics.

Tableau Connector for Jira

Cloud

allows

to export

exporting Xray app data easily from Jira to Tableau

Desktop

.

Info

Xray Test Management Fields can be found in a separate tab

:

TestRunIterationStepDefects

ITERATION_STEP_ID

ISSUE_ID

TestRunIterationStepEvidences

ITERATION_STEP_ID

NAME

SIZE

CREATED

.

Image Removed

Overview

Test Specification includes the following concepts: Tests, Preconditions, TestSets, TestPlans, TestExecutions. These are, in general, Jira issues with the corresponding IssueType. Thus, they can contain all Jira fields, including custom fields.

Test Execution includes TestRuns. TestRun contains a snapshot of the test data at its execution time (as the test specification may change in the future).

The Xray plugin adds 3 custom fields: StartDate, EndDate, Revision.

They are mostly used during TestExecution and mean when to start executing tests and documentation version. Also, in the tests context, such standard Jira fields as Summary, Description, Assignee, FixVersions, Components, issue links, etc. These fields may be of interest for reports and dashboards, and are recommended to be included into the datasource. They can be found here:

Jira Work Management ->Issues -> IssueComponents, IssueFixVersions, IssueLinks, CustomFields

Xray - Test Specification Fields

Tests

TEST_ISSUE_ID

TYPE_ID

GENERIC

CUCUMBER(GHERKIN)

CUCUMBER_TYPE(GHERKIN_TYPE)

LAST_MODIFIED_DATE

Preconditions

PRECONDITION_ISSUE_ID

TYPE_ID

MANUAL

GENERIC

CUCUMBER(GHERKIN)

LAST_MODIFIED_DATE

TestPreconditions

TEST_ISSUE_ID

PRECONDITION_ISSUE_ID

TestSteps

TEST_ISSUE_ID

STEP_ID

ACTION

DATA

RESULT

CALL_TEST_ISSUE_ID

CustomStepFields

TEST_ISSUE_ID

STEP_ID

FIELD_NAME

FIELD_VALUE

StepAttachments

STEP_ID

ATTACHMENT_NAME

TestSets

TEST_ISSUE_ID

ISSUE_ID

TestPlans

TEST_ISSUE_ID

ISSUE_ID

TestExecutionPlans

TEST_EXECUTION_ISSUE_ID

ISSUE_ID

TestExecutionEnvironments

TEST_EXECUTION_ISSUE_ID

ENVIRONMENT_NAME

Datasets

DATASET_ID

TEST_ISSUE_ID

TEST_EXECUTION_ISSUE_ID

ITERATIONS_COUNT

LAST_MODIFIED_DATE

DatasetParameters

DATASET_ID

PARAMETER_ID

PARAMETER_NAME

TYPE

IS_COMBINATIONS

DatasetParameterValues

DATASET_ID

PARAMETER_ID

PARAMETER_NAME

PARAMETER_VALUE

Xray - Test Execution Fields

TestRuns

TEST_RUN_ID

TEST_EXECUTION_ISSUE_ID

TEST_ISSUE_ID

STARTED_DATE

FINISHED_DATE

EXECUTED_BY

COMMENT

STATUS

INVALID_STEP_ERROR

TYPE_ID

GENERIC

CUCUMBER(GHERKIN)

CUCUMBER_TYPE(GHERKIN_TYPE)

LAST_MODIFIED_DATE

TestRunDefects

TEST_RUN_ID

ISSUE_ID

 TestRunPreconditions

TEST_RUN_ID

PRECONDITION_ISSUE_ID

DEFINITION

TestRunEvidences

TEST_RUN_ID

NAME

SIZE

CREATED

TestRunExamples

EXAMPLE_ID

STATUS

DURATION

TestRunSteps

TEST_RUN_ID

TEST_RUN_STEP_ID

ORDER

ACTION

DATA

RESULT

CALL_TEST_ISSUE_ID

STATUS

COMMENT

ACTUAL_RESULT

TestRunStepDefects

TEST_RUN_STEP_ID

ISSUE_ID

TestRunStepEvidences

TEST_RUN_STEP_ID

NAME

SIZE

CREATED

TestRunCustomFields

TEST_RUN_ID

FIELD_NAME

FIELD_TYPE

FIELD_VALUE

TestRunIterations

ITERATION_ID

TEST_RUN_ID

STATUS

DEFAULT_STEP_STATUS

NUMBER_STEPS

LAST_MODIFIED_DATE

TestRunIteratuionParameterList

ITERATION_ID

PARAMETER_NAME

PARAMETER_VALUE

TestRunIterationSteps

ITERATION_ID

ITERATION_STEP_ID

STATUS

ACTUAL_RESULT

COMMENT

Xray.gifImage Added

How to Add Xray Client ID

Xray Client ID is required to export Xray data.

  1. Being signed in to your Jira Cloud instance, select Apps, and then select Manage your apps.

Image Added

  1. Scroll down, and then select API Keys (under the XRAY section).

Image Added

  1. Select Create API Key.

The Create API Key pop-up window will appear.

Image Added

  1. Enter your name or the name of the desired user, and then select Generate.

Image Added
Tip

The API Key was successfully generated pop-up window will appear.

Image Added

  1. Copy Client Id and Client Secret, and then select Close.

Image Added

  1. Go back to Apps, and then select Tableau Connector for Jira.

Image Added

  1. On the left-side menu, select Tokens, and then select the Xray tab.

Image Added

  1. In the Client Id* and Client Secret* fields, paste your client ID and client secret respectively, and then select Validate & Save.

Image Added

Tip

Starting now, all users with granted permission to work with the data sources can select Xray tables and fields for export.

Image Added

Xray Tables Filtering

Tableau Connector for Jira Cloud offers

Status
colourBlue
titleGLOBAL
and
Status
titleLOCAL
filters:

  • Status
    colourBlue
    titleMODIFIED FROM

  • Status
    titleTEST TYPE

  • Status
    titleTESTS

  • Status
    titleTEST EXECUTIONS

  • Status
    titleTEST RUN ASSIGNEES

Global and Local filters.gifImage Added

If you apply the

Status
colourBlue
titleMODIFIED FROM
filter, it will be applied to all Xray tables. If the filter is not needed for a specific table, you can deselect it individually for each table.

Modified from.gifImage Added

There are also JQL and Basic filters available to apply. Unlike the

Status
colourBlue
titleMODIFIED FROM
filter, JQL and Basic filters are applied to the Jira issue itself. The
Status
colourBlue
titleMODIFIED FROM
filter is applied to Xray fields.

Info

The JQL and Basic filters are only applied to the following tables:

  • Tests

  • Test Steps

  • Preconditions

  • Test Preconditions 🔗

  • Test Set Tests 🔗

  • Test Plan Tests 🔗

  • Test Plan Executions 🔗

  • Test Plan Folders

  • Test Execution Tests

  • Test Execution Environment

  • Test Step Attachment

Filter Options.gifImage Added

As per linking tables, JQL or Basic filter is applied to the main table only. All linking tables are marked with the link icon 🔗.

Info

For example, the Test Preconditions 🔗 table links the Test issue types (Xray tests) and the Precondition issue types. In this case, only the Test issue types will be filtered by JQL or Basic filter. This means you’ll get all the Test issue types that match the specified filter along with their preconditions.

The

Status
titleTEST TYPE
filter allows selecting the specific type of tests for export: Manual, Generic, or Cucumber. You can select only one type at once.

Test type.gifImage Added

The

Status
titleTEST
filter allows selecting the specific test(s) for export.

The

Status
titleTEST EXECUTIONS
filter allows selecting the specific test execution(s) for export.

The

Status
titleTEST RUN ASSIGNEE
filter allows selecting the certain test run(s) for export performed by a specific user (assignee).

Local filters.gifImage Added

If you need to export test runs for specific tests, simply select them using the Tests filter.

The Tests Filter.gifImage Added

If the specific tests you need to export are already grouped within a single test execution, just select that test execution using the Test Executions filter. You can select a few test executions.

Info

When selecting a specific test execution in the Test Executions filter, and then selecting tests in the Tests filter that don't belong to the specified test execution, the exported table will be blank as a result.

Test Executions.gifImage Added

If you need to export test runs assigned to a specific user, select their name in the Test Run Assignees filter. You can select a few assignees.

Info

When selecting a specific assignee’s name in the Test Run Assignees filter, and then selecting tests in the Tests filter, the exported table will be blank as a result (the same logic is applied for selecting test executions).

Test Runs Assignees.gifImage Added