Integrating Eggplant Manager with Jira

Jira is a project and issue tracking software used by software development teams to plan, track, and release software. To use Jira with Eggplant Manager, you must first configure Eggplant Manager to authenticate with Jira using either Basic or OAuth authentication. After you create the integration between Jira and Eggplant Manager, you can create issues in Jira using Eggplant Manager Jira exports. You can also attach files to these issues during the Jira export.

The information you need to configure the integration between Jira and Eggplant Manager, then create issues in Jira using Eggplant Manager Jira exports, is described below.

Using Basic Authentication

Complete the following steps to integrate Eggplant Manager with Jira using Basic authentication:

Configuring Eggplant Manager to integrate with Jira using Basic authentication

  1. Select <username> > Account Settings from the upper right side of the Eggplant Manager UI to open the Account Settings page.
  2. Beneath Jira Setup, located in the Preferences panel, make the following entries:
    1. Enter the Jira server link, including the port and path. For example, you might enter https://jira.myserver.com:8443.
    2. Select Basic from the Authentication Mode drop-down menu.
    3. Enter your Jira credentials in the Jira Username and Jira Password fields. Consult with your Jira system administrator to obtain these credentials.
  3. Click Save to save your entries or Reset to clear all stored Jira credentials.
  4. After you click Save, look for a new panel that shows your the username as it appears in your Jira profile.

Your Eggplant Manager integration with Jira using Basic authentication is now ready to use.

Using OAuth Authentication

You can this method to configure the integration to communicate between Eggplant Manager and Jira servers without sharing any user credentials. Complete the following instructions to integrate Eggplant Manager with Jira using OAuth authentication.

Configure the Application Link

For this integration to work properly with OAuth authentication, you must set up a communication link between Eggplant Manager and the Jira server. You must do this before configuring Eggplant Manager to authenticate with Jira using OAuth.

Note: You only need to complete the OAuth application link configuration step one time as explained here. You must complete this step before applying the link in Eggplant Manager. To apply the link in Eggplant Manager, see Configuring OAuth Authentication.

Complete the following steps as a Jira Administrator:

  1. Log on to your Jira server as a Jira Administrator.
  2. Select Applications to open the application settings.

    Application settings in Jira

    Note: Provide your Administrator credentials if an Administrator authentication form appears.
  3. From the left menu, click Application Links located beneath Integrations.

    Opening Application links in Jira

  4. Enter the URL to your Eggplant Manager server. Include the IP address and the port number (normally 8080) of the computer in your environment where Eggplant Manager is running. Click Create new link after your finish your entry.

    Enter IP address of the Eggplant Manager server in Jira

  5. Fill out the Link applications form as shown here. The fields that are set to n/a must be filled in to create the link, but are not used for the Eggplant Manager integration. Make sure to select the Create incoming link checkbox. Click Continue after you fill out this form.

    Configure the JIRA-Eggplant Manager link

  6. After the Link applications form appears, do the following:

    Enter applicable keys in Jira

    1. Navigate to Admin > System Preferences in Eggplant Manager.
    2. Copy the Jira OAuth Consumer Key and Jira OAuth Certificate Public Key from the Eggplant Manager System Information panel into the Consumer Key and Public Key fields on the Jira Link applications form.
    3. Click Continue in the Link Applications form after entering this information.
  7. Look for the following success message to appear after completing the above steps:

    JIRA integration success message

Configure OAuth Authentication

Complete the following steps to integrate Eggplant Manager with Jira using OAuth authentication.

Setting up Jira integration with Eggplant Manager using OAuth authentication

  1. Select <username> > Account Settings from the upper right side of the Eggplant Manager UI to open the Account Settings page.
  2. Beneath Jira Setup located in the Preferences panel, make the following entries:
    1. Enter the Jira server link, including the port and path. For example, you might enter https://jira.myserver.com:8443.
    2. Select OAuth from the Authentication Mode drop-down menu.
  3. Click Save to save your entries. A new panel appears, prompting you to take authorization steps.
  4. Click the here link in the panel.
  5. Log in to Jira, if required, after a new tab opens. Then click Allow:

    Allow the Eggplant Manager connection within Jira

  6. Look for a message similar to the following: OAuth Authorization complete. You can close this tab and return to Eggplant Manager.
  7. Close the tab and return to the previous tab (the Eggplant Manager UI). Click Complete in the Jira Setup section.
  8. Look for a new panel showing your username as it appears in your Jira profile.

Your Eggplant Manager integration with Jira using OAuth authentication is now ready to use.

Creating Issues in Jira

After configuring the Eggplant Manager integration with Jira, you can use Eggplant Manager to export test run report information as issues into Jira. Use the information located in Viewing Eggplant Manager Test Results as a reference when working with these Jira exports. Use the following information to export test run report information into Jira from Eggplant Manager:

  1. Log in to Eggplant Manager.
  2. Click Results, then select a test run.
  3. Review the components of the test run.
  4. Right-click a test run in the browser and view the context menu. The amount of report information available to export decreases as you select locations lower in the browser structure. Select Jira Export.

    Exporting jira issues in Eggplant Manager

  5. After the Jira Export panel appears, select a project from the drop-down menu. For this example, select Bug from the Issue Type drop-down menu. Other available selections are Improvement, Task, Sub-task, New Feature, or Epic.
  6. Add a summary and description to this export. You can also click Attachments and follow the instructions to add attachments to this issue. Click Submit when you are finished entering your issue information.
  7. Look for a message similar to this. Note that you can click the provided link to view the newly created issue in Jira:

    Submission complete message when creating a Jira issue

  8. Click Close when you are finished with the export.

 

This topic was last updated on October 11, 2019, at 11:18:57 AM.

Eggplant icon Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2019 Eggplant