...

1. Event Id of the Jenkins custom event: Custom plugin needs a custom event to be raised whenever when ever we try to trigger the Jenkins job from Jira. This custom event can be created in the in the administration section of Jira. Jira administrator will have to create this custom event, associate it with any notification scheme and make a note of its id. User configuring the plugin can then put this id of the custom event in this configuration textbox

2. ‘Test Execution' issue type Id: This configuration needs the issue type id of the ‘Test Execution’ issue type. We can get this detail from the 'issues’ menu in the administration section.

   Image RemovedImage Added

3. ‘Test' issue type id: This configuration needs the issue type id of the 'Test’ issue type. We can get this detail from the 'issues’ menu in the administration section

   

4. Id of the custom field which lists the Jenkins Jobs on the issue details screen: Custom plugin also comes with a custom field which is called as ‘Jenkins Job Selector'. Plugin admin needs to add this custom fields to proper screen(Create, Edit and view) in Jira. This field is used to map an already configured Jenkins job to a Xray Test. We will see about how to configure Jenkins job in the custom plugin in the ‘Job Mappings’ screen. In the current configuration we have to give the custom field id of this 'Jenkins Job selector’ field. Please note that we have to append 'customfield_' in front of the actual custom field id while specifying its value in the textbox.

   

5. Users of these groups can modify the Jenkins plugin data: Here we can provide the name of the group or groups(comma separated values) members of which can edit the data in different screen of this custom plugin. If this field is left empty then only the Jira administrator can access the details of configuration of the custom plugin and can view its different screens.

6. Default Jira Integration account to be user for updates: This is a Jira account which is a service account which is required by the plugin to make updates to xray test statuses and to pull attachments to Jira from Jenkins.

7. Custom field Id of the field which stores link for Xray between Tests and Test Execution: This is a custom field used by Xray to identify Test associated with Test Executions. Please note that we have to append 'customfield_' in front of the actual custom field id while specifying its value in the textbox.

   

...

Configuration of the Jenkins Jobs:

To create a new Jenkins Job which is compatible with the custom Jira plugin we have to create a new 'Freestyle Project'. In order to work properly with Jenkins Jira plugin the Jenkins job would need certain configurations which are specific to the custom plugin that we have built for Jira server. So basically any job can be modified to make it compatible with Jira Jenkins custom plugin as long as it has these configurations as a part of its build steps. These configurations are as follows.

• This project is parametrized

  Image AddedImage AddedImage Added

  We need the above three string parameters,

1. executionIssueKey - To store the issue key of the Xray Test Execution which holds the Xray Test which triggered the current Jenkins Job

2. testIssueKey - To store the issue key of the test which has triggered the job

3. testCaseTitle - This holds the summary of the Xray Test Case. This is used as a name for the custom TestComplete reports which will be attached to the Test Execution upon completion of the execution of the Jenkins job

• Build Triggers (Trigger build remotely): This is the place where we specify the auth token which is used in the

  Anchor
  Job-Mappings Job-Mappings

  Job Mapping screen in the custom Jira plugin