Jira integration | Ranorex
Help CenterUser GuideJira integration

Jira integration

Jira is an issue tracking software by Atlassian. It is used for agile project management, which includes test management. The Jira integration allows you to connect your Ranorex Studio solution to a Jira project. You can then manually create issues for failed test cases directly from a test report or have Ranorex Studio automatically create and update issues on Jira.

On this page, you’ll find out how to set up the integration with the Jira wizard, the difference between manual and automatic issue handling, and how you can further configure the integration.

In this chapter

    Register for our free webinar

    Mastering Jira Integration: Join us on Monday, June 24 for a live demonstration of how Ranorex Studio 9.1, integrates seamlessly with Jira followed by a Q&A with the Ranorex Studio product team.

    Setup with the Jira wizard

    To set up the integration, you need to use the Jira wizard in Ranorex Studio.

    To start it:

    With a solution opened in Ranorex Studio, click Tools > Jira integration > Start Jira wizard.

    The wizard opens with the Connect to Jira screen. Enter your credentials and click Sign in.

    Note icon

    Note

    Your credentials will be saved in the Windows Credential Manager on this machine. Deleting them is explain further below.

    Once signed in successfully, click Continue.

    Note icon

    Note

    If you entered the URL to a Jira cloud instance, you need to enter your email and the cloud’s API token instead. The UI will change to reflect this.

    From the drop-down menu, select the Jira project you want to link the solution to and click Continue.

    On the follow two screens, you’ll configure manual and automatic issue handling, which are explained in detail further below.

    If you want to activate manual issue handling, switch on Enable issue buttons in report and select the type of issue that should be created by default. Click Continue.

    To activate automatic issue handling, switch on Enable automatic handling and select the default issue type and open/closed states. Click Finish to complete setup.

    Manual vs. automatic issue handling

    As mentioned above, you can create issues for failed test cases manually from the report or you can have Ranorex Studio create and update them automatically during the test run. You can even enable both.

    Manual issue handling

    Manual issue handling means that the test report will include a Create Jira issue button next to each failed test case:

    Create issue button next to a failed test case in the report.
    Clicking it opens the Jira project your solution is linked to and opens the dialog for creating a new issue. The default issue type (task, story, etc.) is selected in the Jira wizard or in the configuration file of the integration (explained further below). You can also set default values for most other Jira issue fields in the configuration file.

    Automatic issue handling

    Automatic issue handling means that Ranorex Studio automatically creates issues on Jira for each test run based on how you configured the issue type and open/closed state settings in the Jira wizard or the configuration file.

    Automatic issue creation/updating follows the behavior described below. For explanation purposes, suppose we set the issue type to Bug, the open state to To do and the closed state to Done. The behavior would be as follows:

    Test case fails:

    • Creates a new bug on Jira and sets it to To do. By default, the summary of the bug is the test case name and the description is the unique test case tag for identification by Ranorex Studio.
    • No action if an open issue with the same test case tag already exists.
    • If a closed issue with the same tag exists, sets the issue to To do again.

    Test case succeeds:

    • No action if no issue with the same test case tag exists.
    • If an issue with the same test case tag exists, changes the state of this issue to Done.
    Note icon

    Note

    As you can see from the explanations above, automatic handling works by identifying issues by the test case tag. This also works if you include the tag in a manually created issue. If you then switch to automatic handling, Ranorex Studio will also update this issue automatically.

    The configuration file

    After you’ve completed setup with the Jira wizard, you are ready to start running tests and creating issues on Jira. However, there are some more options you can configure in the configuration file.

    The configuration file Jira.jsd is stored in the Solution Items folder and contains all information the Jira integration requires to work.

    To open it:

    With the Jira integration set up in Ranorex Studio,

    click Tools > Jira integration > Configure integration.

    double-click Jira.jsd in the projects view.

    The configuration screen opens, with tabs for manual and automatic issue handling. Here, you can specify default values for various fields. These will be used when you create an issue by clicking on the button in the report or when Ranorex Studio creates them automatically.

    Note icon

    Note

    The switches and open/closed state drop-downs are the same as in the Jira wizard. See further above for what they do.

    The fields under Required fields and Optional fields reflect the fields that are present in the issue creation dialog of your Jira project and are the same for both tabs.

    Variable editor
    Clicking this button brings up the variable editor. It lists the variables you can enter into the fields and a description for each of them.

    Some field types can’t be specified automatically, which means you need to fill them in manually if you create issues with the report button. For automatic issue handling, they will remain empty unless you update the issue manually after it’s been created.

    tipp icon

    Attention

    For automatic issue handling, at least one field of the type string, e.g. Description, must contain the variable $TestCaseTag. Otherwise, Ranorex Studio can’t identify issues automatically. You can find out what type a field is by mousing over it.

    Sign out

    Signing out means deleting your Jira credentials from the current machine, i.e. from the Windows Credential Manager.

    To do so:

    In Ranorex Studio, click Tools > Jira integration > Sign out (<user name>) and confirm the dialog.

    Remove connection to Jira

    Removing the connection to Jira means deleting the Jira.jsd file. All configurations will be lost.

    To do so:

    In Ranorex Studio, click Tools > Jira integration > Remove connection to Jira and confirm the dialog.