Jira Defect Integration

Functionize and Jira Defect Integration Overview

Jira is a vital tool for testers and developers to collaborate. In defect management, users often log issue types, typically labeled as a 'bug' in Jira. Whether you're using Jira Cloud or Jira Data Center, you can integrate Functionize with your Jira projects.

Configuring the integration to map your Jira Issue Type for defects to the corresponding Functionize project establishes a many-to-many relationship, allowing you to submit defects from Functionize to multiple Jira Projects or Issue Types.

After executing Functionize tests and investigating potential failures, you can submit defects directly from Functionize into Jira with links back to the test execution in Functionize for easy steps to recreate the defect.

Setup the Jira Integration

Establish Connection

Note: Only Team Administrators may set up the Jira integration. Other users will not be able to access the Team tab.

  1. Open the Team Page:

    • Navigate to the Team page, and then click the Integration tab.
  2. Select Jira:

    • On the left panel, select Jira from the Defect Management section.
    • In the main panel, select Cloud or Data Center.
    • Enter the URL for your Jira instance, Jira Username, and Jira API Token (not your password). These can be found in your Jira account by a Jira Admin by accessing Apps > Manage Apps > API Keys.
    • Note: For Jira API token assistance, refer to Manage API tokens for your Atlassian account.
  3. Test the Connection:

    • Click Test Sign In. The status next to the button will update to "Connection established" with a green check mark when ready.

Map Projects

  1. Scroll to Project Mappings:

    • After establishing the connection, scroll down to the Project Mappings section.
  2. Select Projects:

    • Select the Functionize and Jira projects to link together. This allows a user to submit defects into the Jira project from the test results of a Functionize project.
  3. Configure Defect Details:

    • Defect Type: Select the Jira Issue Type to be created in Jira when submitting from Functionize. This can be a Bug, Defect, or any custom issue type your teams use to represent issues found during testing.
    • Details: Select the Jira text area field to auto-populate using Functionize data, including a link back to the Functionize test execution results.
      • Note: Adding a Functionize Data custom field to Jira defects is suggested to keep the data well-structured.
    • Fields: Select the Jira Fields to be displayed when creating Jira defects from Functionize.
  4. Save Mappings:

    • Click Save Mapping to save your Jira to Functionize project mapping details.
    • Note: Multiple projects may be added, but each must be mapped individually.

Creating a Defect in Test Detail View

After executing a test, review any failures or areas of concern. Creating a defect in Jira linked to that Functionize test helps provide developers with more information, including steps to recreate the issue. This helps them understand what needs to be fixed and helps you keep track of bug resolution.

  1. Open Test Details Page:

    • Open a test case to the Test Details page.
    • Find the action that represents the failure or area of concern.
    • Click the action to expand and show the Action Settings.
  2. Create Defect:

    • Click on the Create Defect button.
    • Select the radio button to Create New Defect or Link Existing Defect and click Continue.
      CreateNewLinkExisting.png
    • Enter the relevant details for the defect and click Create Defect. The description field will auto-populate with details about the current test execution and a link back to Functionize.
  3. View Linked Defects:

    • The Test Detail page will display the Defect bug icon in the header. Click the button to see a list of defects linked to this test.
    • The Defect bug icon will also display at the right end of the action banner. Click the icon to see a list of defects linked to this action.
      JiraDefect5.png
    • Click the issue name to open Jira and view the defect details. A New Defect button is also available for filing multiple issues for a single action.
      Note: The number on the bug icon corresponds to the number of defects filed for the test or action.

Create a Defect through Run-History

  1. Open Run History:

    • Click on the History tab on the Test Case Detail page. The Run History page will open.
    • Click on View to open the Run History result page.
  2. Create Defect:

    • Find the action that represents the failure or area of concern.
    • Click the action to expand and show the Action Settings.
    • Click on the Create Defect button.
    • Select the radio button to Create New Defect or Link Existing Defect and click Continue.
      CreateNewLinkExisting.png
    • Enter the relevant details for the defect and click Create Defect.
  3. View Linked Defects:

    • The Defect bug icon will display at the right end of the action banner. Click the icon to see a list of defects linked to this action.

Create a Defect in Slider View

  1. Open Slider View:

    • Click the View Results button at the top of the Test Detail page or click the View button to the right of the failed action. The Slider View will open.

  2. Create Defect:

    • Open the Actions menu on the failed action and select Create Defect.
    • Select Create New Defect or Link Existing Defect and click Continue.
    • Enter the issue details, ensure all required fields are entered, and click Create Defect.

Filtering Tests

You can see which tests have defects filed directly from the Test Listing page. This can be particularly useful to verify resolved defects on a regular basis to ensure that only tests that are failing are mapped to unresolved defects.
Screen_Shot_2021-07-08_at_6.14.31_PM.png

  1. Filter by Status:
    • Clicking on the bug icon will display the defects filed.
      Screen_Shot_2021-07-08_at_6.15.39_PM.png
    • You can also filter by the status of your Jira tickets using the Defects filter drop-down with the Jira icon.
      Screen_Shot_2021-07-08_at_6.28.46_PM.png

View the Defect in Jira

  1. Access Jira Issue:
    • Click the link for the Jira issue in the Defects display, either from the test action, the test details header, or the test listing page. Jira will open, and the ticket can be edited as usual.