Merge branch '16119-jira-issue-transition-automatic' into 'master'

Support automatic transitions of Jira issues

See merge request gitlab-org/gitlab!53760

app/assets/javascripts/integrations/edit/components/jira_trigger_fields.vue

 <script>
-import { GlFormGroup, GlFormCheckbox, GlFormRadio } from '@gitlab/ui';
+import {
+  GlFormGroup,
+  GlFormCheckbox,
+  GlFormRadio,
+  GlFormInput,
+  GlLink,
+  GlSprintf,
+} from '@gitlab/ui';
 import { mapGetters } from 'vuex';
+import { helpPagePath } from '~/helpers/help_page_helper';
 import { s__ } from '~/locale';
+import eventHub from '../event_hub';
 
 const commentDetailOptions = [
   {
@@ -18,12 +27,41 @@ const commentDetailOptions = [
   },
 ];
 
+const ISSUE_TRANSITION_AUTO = 'auto';
+const ISSUE_TRANSITION_CUSTOM = 'custom';
+
+const issueTransitionOptions = [
+  {
+    value: ISSUE_TRANSITION_AUTO,
+    label: s__('JiraService|Move to Done'),
+    help: s__(
+      'JiraService|Automatically transitions Jira issues to the "Done" category. %{linkStart}Learn more%{linkEnd}',
+    ),
+    link: helpPagePath('user/project/integrations/jira.html', {
+      anchor: 'automatic-issue-transitions',
+    }),
+  },
+  {
+    value: ISSUE_TRANSITION_CUSTOM,
+    label: s__('JiraService|Use custom transitions'),
+    help: s__(
+      'JiraService|Set a custom final state by using transition IDs. %{linkStart}Learn about transition IDs%{linkEnd}',
+    ),
+    link: helpPagePath('user/project/integrations/jira.html', {
+      anchor: 'custom-issue-transitions',
+    }),
+  },
+];
+
 export default {
   name: 'JiraTriggerFields',
   components: {
     GlFormGroup,
     GlFormCheckbox,
     GlFormRadio,
+    GlFormInput,
+    GlLink,
+    GlSprintf,
   },
   props: {
     initialTriggerCommit: {
@@ -43,21 +81,52 @@ export default {
       required: false,
       default: 'standard',
     },
+    initialJiraIssueTransitionId: {
+      type: String,
+      required: false,
+      default: '',
+    },
   },
   data() {
     return {
+      validated: false,
       triggerCommit: this.initialTriggerCommit,
       triggerMergeRequest: this.initialTriggerMergeRequest,
       enableComments: this.initialEnableComments,
       commentDetail: this.initialCommentDetail,
+      jiraIssueTransitionId: this.initialJiraIssueTransitionId,
+      issueTransitionMode: this.initialJiraIssueTransitionId.length
+        ? ISSUE_TRANSITION_CUSTOM
+        : ISSUE_TRANSITION_AUTO,
       commentDetailOptions,
+      issueTransitionOptions,
     };
   },
   computed: {
     ...mapGetters(['isInheriting']),
-    showEnableComments() {
+    showTriggerSettings() {
       return this.triggerCommit || this.triggerMergeRequest;
     },
+    validIssueTransitionId() {
+      return !this.validated || this.jiraIssueTransitionId.length > 0;
+    },
+  },
+  created() {
+    eventHub.$on('validateForm', this.validateForm);
+  },
+  beforeDestroy() {
+    eventHub.$off('validateForm', this.validateForm);
+  },
+  methods: {
+    validateForm() {
+      this.validated = true;
+    },
+    showCustomIssueTransitions(currentOption) {
+      return (
+        this.issueTransitionMode === ISSUE_TRANSITION_CUSTOM &&
+        currentOption === ISSUE_TRANSITION_CUSTOM
+      );
+    },
   },
 };
 </script>
@@ -89,7 +158,7 @@ export default {
     </gl-form-group>
 
     <gl-form-group
-      v-show="showEnableComments"
+      v-show="showTriggerSettings"
       :label="s__('Integrations|Comment settings:')"
       label-for="service[comment_on_event_enabled]"
       class="gl-pl-6"
@@ -106,7 +175,7 @@ export default {
     </gl-form-group>
 
     <gl-form-group
-      v-show="showEnableComments && enableComments"
+      v-show="showTriggerSettings && enableComments"
       :label="s__('Integrations|Comment detail:')"
       label-for="service[comment_detail]"
       class="gl-pl-9"
@@ -126,5 +195,51 @@ export default {
         </template>
       </gl-form-radio>
     </gl-form-group>
+
+    <gl-form-group
+      v-show="showTriggerSettings"
+      :label="s__('JiraService|Transition Jira issues to their final state:')"
+      class="gl-pl-6"
+      data-testid="issue-transition-settings"
+    >
+      <input type="hidden" name="service[jira_issue_transition_id]" value="" />
+
+      <gl-form-radio
+        v-for="issueTransitionOption in issueTransitionOptions"
+        :key="issueTransitionOption.value"
+        v-model="issueTransitionMode"
+        :value="issueTransitionOption.value"
+        :disabled="isInheriting"
+        :data-qa-selector="`service_issue_transition_mode_${issueTransitionOption.value}`"
+      >
+        {{ issueTransitionOption.label }}
+
+        <template v-if="showCustomIssueTransitions(issueTransitionOption.value)">
+          <gl-form-input
+            v-model="jiraIssueTransitionId"
+            name="service[jira_issue_transition_id]"
+            type="text"
+            class="gl-my-3"
+            data-qa-selector="service_jira_issue_transition_id_field"
+            :placeholder="s__('JiraService|For example, 12, 24')"
+            :disabled="isInheriting"
+            :required="true"
+            :state="validIssueTransitionId"
+          />
+
+          <span class="invalid-feedback">
+            {{ s__('This field is required.') }}
+          </span>
+        </template>
+
+        <template #help>
+          <gl-sprintf :message="issueTransitionOption.help">
+            <template #link="{ content }">
+              <gl-link :href="issueTransitionOption.link" target="_blank">{{ content }}</gl-link>
+            </template>
+          </gl-sprintf>
+        </template>
+      </gl-form-radio>
+    </gl-form-group>
   </div>
 </template>

app/assets/javascripts/integrations/edit/index.js

@@ -28,6 +28,7 @@ function parseDatasetToProps(data) {
     testPath,
     resetPath,
     vulnerabilitiesIssuetype,
+    jiraIssueTransitionId,
     ...booleanAttributes
   } = data;
   const {
@@ -59,6 +60,7 @@ function parseDatasetToProps(data) {
       initialTriggerMergeRequest: mergeRequestEvents,
       initialEnableComments: enableComments,
       initialCommentDetail: commentDetail,
+      initialJiraIssueTransitionId: jiraIssueTransitionId,
     },
     jiraIssuesProps: {
       showJiraIssuesIntegration,

app/helpers/services_helper.rb

@@ -86,7 +86,7 @@ module ServicesHelper
   end
 
   def integration_form_data(integration, group: nil)
-    {
+    form_data = {
       id: integration.id,
       show_active: integration.show_active_box?.to_s,
       activated: (integration.active || integration.new_record?).to_s,
@@ -106,6 +106,12 @@ module ServicesHelper
       test_path: scoped_test_integration_path(integration),
       reset_path: scoped_reset_integration_path(integration, group: group)
     }
+
+    if integration.is_a?(JiraService)
+      form_data[:jira_issue_transition_id] = integration.jira_issue_transition_id
+    end
+
+    form_data
   end
 
   def trigger_events_for_service(integration)

app/models/project_services/jira_service.rb

@@ -124,15 +124,11 @@ class JiraService < IssueTrackerService
   end
 
   def fields
-    transition_id_help_path = help_page_path('user/project/integrations/jira', anchor: 'obtaining-a-transition-id')
-    transition_id_help_link_start = '<a href="%{transition_id_help_path}" target="_blank" rel="noopener noreferrer">'.html_safe % { transition_id_help_path: transition_id_help_path }
-
     [
       { type: 'text', name: 'url', title: s_('JiraService|Web URL'), placeholder: 'https://jira.example.com', required: true },
       { type: 'text', name: 'api_url', title: s_('JiraService|Jira API URL'), placeholder: s_('JiraService|If different from Web URL') },
       { type: 'text', name: 'username', title: s_('JiraService|Username or Email'), placeholder: s_('JiraService|Use a username for server version and an email for cloud version'), required: true },
-      { type: 'password', name: 'password', title: s_('JiraService|Password or API token'), placeholder: s_('JiraService|Use a password for server version and an API token for cloud version'), required: true },
-      { type: 'text', name: 'jira_issue_transition_id', title: s_('JiraService|Jira workflow transition IDs'), placeholder: s_('JiraService|For example, 12, 24'), help: s_('JiraService|Set transition IDs for Jira workflow transitions. %{link_start}Learn more%{link_end}'.html_safe % { link_start: transition_id_help_link_start, link_end: '</a>'.html_safe }) }
+      { type: 'password', name: 'password', title: s_('JiraService|Password or API token'), placeholder: s_('JiraService|Use a password for server version and an API token for cloud version'), required: true }
     ]
   end
 
@@ -159,17 +155,19 @@ class JiraService < IssueTrackerService
     # support any events.
   end
 
-  def find_issue(issue_key, rendered_fields: false)
-    options = {}
-    options = options.merge(expand: 'renderedFields') if rendered_fields
+  def find_issue(issue_key, rendered_fields: false, transitions: false)
+    expands = []
+    expands << 'renderedFields' if rendered_fields
+    expands << 'transitions' if transitions
+    options = { expand: expands.join(',') } if expands.any?
 
-    jira_request { client.Issue.find(issue_key, options) }
+    jira_request { client.Issue.find(issue_key, options || {}) }
   end
 
   def close_issue(entity, external_issue, current_user)
-    issue = find_issue(external_issue.iid)
+    issue = find_issue(external_issue.iid, transitions: automatic_issue_transitions?)
 
-    return if issue.nil? || has_resolution?(issue) || !jira_issue_transition_id.present?
+    return if issue.nil? || has_resolution?(issue)
 
     commit_id = case entity
                 when Commit then entity.id
@@ -260,24 +258,52 @@ class JiraService < IssueTrackerService
     end
   end
 
+  def automatic_issue_transitions?
+    jira_issue_transition_id.blank?
+  end
+
   # jira_issue_transition_id can have multiple values split by , or ;
   # the issue is transitioned at the order given by the user
   # if any transition fails it will log the error message and stop the transition sequence
   def transition_issue(issue)
-    jira_issue_transition_id.scan(Gitlab::Regex.jira_transition_id_regex).each do |transition_id|
-      issue.transitions.build.save!(transition: { id: transition_id })
-    rescue => error
-      log_error(
-        "Issue transition failed",
-          error: {
-            exception_class: error.class.name,
-            exception_message: error.message,
-            exception_backtrace: Gitlab::BacktraceCleaner.clean_backtrace(error.backtrace)
-          },
-         client_url: client_url
-      )
-      return false
+    return transition_issue_to_done(issue) if automatic_issue_transitions?
+
+    jira_issue_transition_id.scan(Gitlab::Regex.jira_transition_id_regex).all? do |transition_id|
+      transition_issue_to_id(issue, transition_id)
+    end
+  end
+
+  def transition_issue_to_id(issue, transition_id)
+    issue.transitions.build.save!(
+      transition: { id: transition_id }
+    )
+
+    true
+  rescue => error
+    log_error(
+      "Issue transition failed",
+        error: {
+          exception_class: error.class.name,
+          exception_message: error.message,
+          exception_backtrace: Gitlab::BacktraceCleaner.clean_backtrace(error.backtrace)
+        },
+        client_url: client_url
+    )
+
+    false
+  end
+
+  def transition_issue_to_done(issue)
+    transitions = issue.transitions rescue []
+
+    transition = transitions.find do |transition|
+      status = transition&.to&.statusCategory
+      status && status['key'] == 'done'
     end
+
+    return false unless transition
+
+    transition_issue_to_id(issue, transition.id)
   end
 
   def log_usage(action, user)

changelogs/unreleased/16119-jira-issue-transition-automatic.yml

+---
+title: Support automatic transitions of Jira issues
+merge_request: 53760
+author:
+type: changed

doc/api/services.md

@@ -814,7 +814,7 @@ Parameters:
 | `username`      | string | yes  | The username of the user created to be used with GitLab/Jira. |
 | `password`      | string | yes  | The password of the user created to be used with GitLab/Jira. |
 | `active`        | boolean | no  | Activates or deactivates the service. Defaults to false (deactivated). |
-| `jira_issue_transition_id` | string | no | The ID of a transition that moves issues to a closed state. You can find this number under the Jira workflow administration (**Administration > Issues > Workflows**) by selecting **View** under **Operations** of the desired workflow of your project. The ID of each state can be found inside the parenthesis of each transition name under the transitions ID column. By default, this ID is set to `2`. |
+| `jira_issue_transition_id` | string | no | The ID of one or more transitions to move issues to a closed state. Read [custom issue transitions](../user/project/integrations/jira.md#custom-issue-transitions) for details. Defaults to a blank string, which enables [automatic issue transitions](../user/project/integrations/jira.md#automatic-issue-transitions). |
 | `commit_events` | boolean | false | Enable notifications for commit events |
 | `merge_requests_events` | boolean | false | Enable notifications for merge request events |
 | `comment_on_event_enabled` | boolean | false | Enable comments inside Jira issues on each GitLab event (commit / merge request) |

doc/user/project/integrations/jira.md

@@ -106,8 +106,6 @@ To enable the Jira integration in a project:
 1. To include a comment on the Jira issue when the above reference is made in GitLab, select
    **Enable comments**.
 
-   1. Select the **Comment detail**: **Standard** or **All details**.
-
 1. Enter the further details on the page as described in the following table.
 
    | Field | Description |
@@ -116,7 +114,6 @@ To enable the Jira integration in a project:
    | `Jira API URL` | The base URL to the Jira instance API. Web URL value is used if not set. For example, `https://jira-api.example.com`. Leave this field blank (or use the same value of `Web URL`) if using **Jira on Atlassian cloud**. |
    | `Username or Email` | Created in [configure Jira](#configure-jira) step. Use `username` for **Jira Server** or `email` for **Jira on Atlassian cloud**. |
    | `Password/API token` | Created in [configure Jira](#configure-jira) step. Use `password` for **Jira Server** or `API token` for **Jira on Atlassian cloud**. |
-   | `Jira workflow transition IDs` | Required for closing Jira issues via commits or merge requests. These are the IDs of transitions in Jira that move issues to a particular state. (See [Obtaining a transition ID](#obtaining-a-transition-id).) If you insert multiple transition IDs separated by `,` or `;`, the issue is moved to each state, one after another, using the given order. In GitLab 13.6 and earlier, field was called `Transition ID`. |
 
 1. To enable users to view Jira issues inside the GitLab project, select **Enable Jira issues** and
    enter a Jira project key. **(PREMIUM)**
@@ -138,10 +135,19 @@ To enable the Jira integration in a project:
 Your GitLab project can now interact with all Jira projects in your instance and the project now
 displays a Jira link that opens the Jira project.
 
-#### Obtaining a transition ID
+#### Automatic issue transitions
+
+When you [close a Jira issues with a trigger word](../issues/managing_issues.md#closing-issues-automatically),
+GitLab by default transitions the issue to the next available status with a category of "Done".
+
+#### Custom issue transitions
+
+For advanced workflows you can specify custom Jira transition IDs. If you insert multiple transition IDs separated by `,` or `;`, the issue is moved to each state, one after another, using the given order.
+
+To see the transition IDs on Jira Cloud, edit a workflow in the **Text** view.
+The transition IDs display in the **Transitions** column.
 
-In the most recent Jira user interface, you can no longer see transition IDs in the workflow
-administration UI. You can get the ID you need in either of the following ways:
+On Jira Server you can get the transition IDs in either of the following ways:
 
 1. By using the API, with a request like `https://yourcompany.atlassian.net/rest/api/2/issue/ISSUE-123/transitions`
    using an issue that is in the appropriate "open" state

ee/spec/helpers/ee/services_helper_spec.rb

@@ -18,6 +18,20 @@ RSpec.describe EE::ServicesHelper do
   subject { controller_class.new }
 
   describe '#integration_form_data' do
+    let(:jira_fields) do
+      {
+        show_jira_issues_integration: 'false',
+        show_jira_vulnerabilities_integration: 'false',
+        enable_jira_issues: 'true',
+        enable_jira_vulnerabilities: 'false',
+        project_key: 'FE',
+        vulnerabilities_issuetype: '10001',
+        gitlab_issues_enabled: 'true',
+        upgrade_plan_path: nil,
+        edit_project_path: edit_project_path(project, anchor: 'js-shared-permissions')
+      }
+    end
+
     subject { helper.integration_form_data(integration) }
 
     before do
@@ -28,7 +42,7 @@ RSpec.describe EE::ServicesHelper do
       let(:integration) { build(:slack_service) }
 
       it 'does not include Jira specific fields' do
-        is_expected.not_to include(:show_jira_issues_integration, :show_jira_vulnerabilities_integration, :enable_jira_issues, :project_key, :gitlab_issues_enabled, :edit_project_path)
+        is_expected.not_to include(*jira_fields.keys)
       end
     end
 
@@ -40,8 +54,8 @@ RSpec.describe EE::ServicesHelper do
           allow(integration).to receive(:jira_vulnerabilities_integration_available?).and_return(false)
         end
 
-        it 'includes Jira specific fields' do
-          is_expected.to include(show_jira_vulnerabilities_integration: 'false')
+        it 'includes default Jira fields' do
+          is_expected.to include(jira_fields)
         end
       end
 
@@ -51,8 +65,8 @@ RSpec.describe EE::ServicesHelper do
           stub_feature_flags(jira_for_vulnerabilities: false)
         end
 
-        it 'includes Jira specific fields' do
-          is_expected.to include(show_jira_vulnerabilities_integration: 'false')
+        it 'includes show_jira_issues_integration' do
+          is_expected.to include(jira_fields.merge(show_jira_issues_integration: 'true'))
         end
       end
 
@@ -62,16 +76,13 @@ RSpec.describe EE::ServicesHelper do
           stub_feature_flags(jira_for_vulnerabilities: true)
         end
 
-        it 'includes Jira specific fields' do
+        it 'includes all Jira fields' do
           is_expected.to include(
-            show_jira_issues_integration: 'true',
-            show_jira_vulnerabilities_integration: 'true',
-            enable_jira_issues: 'true',
-            enable_jira_vulnerabilities: 'true',
-            project_key: 'FE',
-            vulnerabilities_issuetype: '10001',
-            gitlab_issues_enabled: 'true',
-            edit_project_path: edit_project_path(project, anchor: 'js-shared-permissions')
+            jira_fields.merge(
+              show_jira_issues_integration: 'true',
+              show_jira_vulnerabilities_integration: 'true',
+              enable_jira_vulnerabilities: 'true'
+            )
           )
         end
       end

locale/gitlab.pot

@@ -16822,6 +16822,9 @@ msgstr ""
 msgid "JiraService|An error occured while fetching issue list"
 msgstr ""
 
+msgid "JiraService|Automatically transitions Jira issues to the \"Done\" category. %{linkStart}Learn more%{linkEnd}"
+msgstr ""
+
 msgid "JiraService|Define the type of Jira issue to create from a vulnerability."
 msgstr ""
 
@@ -16876,7 +16879,7 @@ msgstr ""
 msgid "JiraService|Jira project key"
 msgstr ""
 
-msgid "JiraService|Jira workflow transition IDs"
+msgid "JiraService|Move to Done"
 msgstr ""
 
 msgid "JiraService|Not all data may be displayed here. To view more details or make changes to this issue, go to %{linkStart}Jira%{linkEnd}."
@@ -16897,7 +16900,7 @@ msgstr ""
 msgid "JiraService|Select issue type"
 msgstr ""
 
-msgid "JiraService|Set transition IDs for Jira workflow transitions. %{link_start}Learn more%{link_end}"
+msgid "JiraService|Set a custom final state by using transition IDs. %{linkStart}Learn about transition IDs%{linkEnd}"
 msgstr ""
 
 msgid "JiraService|Sign in to GitLab.com to get started."
@@ -16909,12 +16912,18 @@ msgstr ""
 msgid "JiraService|This issue is synchronized with Jira"
 msgstr ""
 
+msgid "JiraService|Transition Jira issues to their final state:"
+msgstr ""
+
 msgid "JiraService|Use a password for server version and an API token for cloud version"
 msgstr ""
 
 msgid "JiraService|Use a username for server version and an email for cloud version"
 msgstr ""
 
+msgid "JiraService|Use custom transitions"
+msgstr ""
+
 msgid "JiraService|Username or Email"
 msgstr ""
 

qa/qa/page/project/settings/services/jira.rb

@@ -10,7 +10,12 @@ module QA
               element :service_url_field, ':data-qa-selector="`${fieldId}_field`"' # rubocop:disable QA/ElementWithPattern
               element :service_username_field, ':data-qa-selector="`${fieldId}_field`"' # rubocop:disable QA/ElementWithPattern
               element :service_password_field, ':data-qa-selector="`${fieldId}_field`"' # rubocop:disable QA/ElementWithPattern
-              element :service_jira_issue_transition_id_field, ':data-qa-selector="`${fieldId}_field`"' # rubocop:disable QA/ElementWithPattern
+            end
+
+            view 'app/assets/javascripts/integrations/edit/components/jira_trigger_fields.vue' do
+              element :service_issue_transition_mode_auto, ':data-qa-selector="`service_issue_transition_mode_${issueTransitionOption.value}`"' # rubocop:disable QA/ElementWithPattern
+              element :service_issue_transition_mode_custom, ':data-qa-selector="`service_issue_transition_mode_${issueTransitionOption.value}`"' # rubocop:disable QA/ElementWithPattern
+              element :service_jira_issue_transition_id_field
             end
 
             view 'app/assets/javascripts/integrations/edit/components/integration_form.vue' do
@@ -23,7 +28,9 @@ module QA
               set_jira_server_url(url)
               set_username(Runtime::Env.jira_admin_username)
               set_password(Runtime::Env.jira_admin_password)
-              set_transaction_ids('11,21,31,41')
+
+              use_custom_transitions
+              set_transition_ids('11,21,31,41')
 
               click_save_changes_button
               wait_until(reload: false) do
@@ -45,8 +52,16 @@ module QA
               fill_element(:service_password_field, password)
             end
 
-            def set_transaction_ids(transaction_ids)
-              fill_element(:service_jira_issue_transition_id_field, transaction_ids)
+            def use_automatic_transitions
+              click_element :service_issue_transition_mode_auto
+            end
+
+            def use_custom_transitions
+              click_element :service_issue_transition_mode_custom
+            end
+
+            def set_transition_ids(transition_ids)
+              fill_element(:service_jira_issue_transition_id_field, transition_ids)
             end
 
             def click_save_changes_button

spec/features/projects/services/user_activates_jira_spec.rb

@@ -6,12 +6,14 @@ RSpec.describe 'User activates Jira', :js do
   include_context 'project service activation'
   include_context 'project service Jira context'
 
+  before do
+    server_info = { key: 'value' }.to_json
+    stub_request(:get, test_url).to_return(body: server_info)
+  end
+
   describe 'user tests Jira Service' do
     context 'when Jira connection test succeeds' do
       before do
-        server_info = { key: 'value' }.to_json
-        stub_request(:get, test_url).with(basic_auth: %w(username password)).to_return(body: server_info)
-
         visit_project_integration('Jira')
         fill_form
         click_test_then_save_integration(expect_test_to_fail: false)
@@ -81,4 +83,40 @@ RSpec.describe 'User activates Jira', :js do
       end
     end
   end
+
+  describe 'issue transition settings' do
+    it 'shows validation errors' do
+      visit_project_integration('Jira')
+
+      expect(page).to have_field('Move to Done', checked: true)
+
+      fill_form
+      choose 'Use custom transitions'
+      click_save_integration
+
+      within '[data-testid="issue-transition-settings"]' do
+        expect(page).to have_content('This field is required.')
+      end
+
+      fill_in 'service[jira_issue_transition_id]', with: '1, 2, 3'
+      click_save_integration
+
+      expect(page).to have_content('Jira settings saved and active.')
+      expect(project.reload.jira_service.jira_issue_transition_id).to eq('1, 2, 3')
+    end
+
+    it 'clears the transition IDs when using automatic transitions' do
+      create(:jira_service, project: project, jira_issue_transition_id: '1, 2, 3')
+      visit_project_integration('Jira')
+
+      expect(page).to have_field('Use custom transitions', checked: true)
+      expect(page).to have_field('service[jira_issue_transition_id]', with: '1, 2, 3')
+
+      choose 'Move to Done'
+      click_save_integration
+
+      expect(page).to have_content('Jira settings saved and active.')
+      expect(project.reload.jira_service.jira_issue_transition_id).to eq('')
+    end
+  end
 end

spec/frontend/integrations/edit/components/jira_trigger_fields_spec.js

@@ -30,14 +30,21 @@ describe('JiraTriggerFields', () => {
   const findCommentSettings = () => wrapper.find('[data-testid="comment-settings"]');
   const findCommentDetail = () => wrapper.find('[data-testid="comment-detail"]');
   const findCommentSettingsCheckbox = () => findCommentSettings().find(GlFormCheckbox);
+  const findIssueTransitionSettings = () =>
+    wrapper.find('[data-testid="issue-transition-settings"]');
+  const findIssueTransitionModeRadios = () =>
+    findIssueTransitionSettings().findAll('input[type="radio"]');
+  const findIssueTransitionIdsField = () =>
+    wrapper.find('input[type="text"][name="service[jira_issue_transition_id]"]');
 
   describe('template', () => {
     describe('initialTriggerCommit and initialTriggerMergeRequest are false', () => {
-      it('does not show comment settings', () => {
+      it('does not show trigger settings', () => {
         createComponent();
 
         expect(findCommentSettings().isVisible()).toBe(false);
         expect(findCommentDetail().isVisible()).toBe(false);
+        expect(findIssueTransitionSettings().isVisible()).toBe(false);
       });
     });
 
@@ -48,9 +55,10 @@ describe('JiraTriggerFields', () => {
         });
       });
 
-      it('shows comment settings', () => {
+      it('shows trigger settings', () => {
         expect(findCommentSettings().isVisible()).toBe(true);
         expect(findCommentDetail().isVisible()).toBe(false);
+        expect(findIssueTransitionSettings().isVisible()).toBe(true);
       });
 
       // As per https://vuejs.org/v2/guide/forms.html#Checkbox-1,
@@ -73,13 +81,14 @@ describe('JiraTriggerFields', () => {
     });
 
     describe('initialTriggerMergeRequest is true', () => {
-      it('shows comment settings', () => {
+      it('shows trigger settings', () => {
         createComponent({
           initialTriggerMergeRequest: true,
         });
 
         expect(findCommentSettings().isVisible()).toBe(true);
         expect(findCommentDetail().isVisible()).toBe(false);
+        expect(findIssueTransitionSettings().isVisible()).toBe(true);
       });
     });
 
@@ -95,7 +104,41 @@ describe('JiraTriggerFields', () => {
       });
     });
 
-    it('disables checkboxes and radios if inheriting', () => {
+    describe('initialJiraIssueTransitionId is not set', () => {
+      it('uses automatic transitions', () => {
+        createComponent({
+          initialTriggerCommit: true,
+        });
+
+        const [radio1, radio2] = findIssueTransitionModeRadios().wrappers;
+        expect(radio1.element.checked).toBe(true);
+        expect(radio2.element.checked).toBe(false);
+
+        expect(findIssueTransitionIdsField().exists()).toBe(false);
+      });
+    });
+
+    describe('initialJiraIssueTransitionId is set', () => {
+      it('uses custom transitions', () => {
+        createComponent({
+          initialJiraIssueTransitionId: '1, 2, 3',
+          initialTriggerCommit: true,
+        });
+
+        const [radio1, radio2] = findIssueTransitionModeRadios().wrappers;
+        expect(radio1.element.checked).toBe(false);
+        expect(radio2.element.checked).toBe(true);
+
+        const field = findIssueTransitionIdsField();
+        expect(field.isVisible()).toBe(true);
+        expect(field.element).toMatchObject({
+          type: 'text',
+          value: '1, 2, 3',
+        });
+      });
+    });
+
+    it('disables input fields if inheriting', () => {
       createComponent(
         {
           initialTriggerCommit: true,
@@ -104,12 +147,8 @@ describe('JiraTriggerFields', () => {
         true,
       );
 
-      wrapper.findAll('[type=checkbox]').wrappers.forEach((checkbox) => {
-        expect(checkbox.attributes('disabled')).toBe('disabled');
-      });
-
-      wrapper.findAll('[type=radio]').wrappers.forEach((radio) => {
-        expect(radio.attributes('disabled')).toBe('disabled');
+      wrapper.findAll('[type=text], [type=checkbox], [type=radio]').wrappers.forEach((input) => {
+        expect(input.attributes('disabled')).toBe('disabled');
       });
     });
   });

spec/helpers/services_helper_spec.rb

@@ -4,32 +4,49 @@ require 'spec_helper'
 
 RSpec.describe ServicesHelper do
   describe '#integration_form_data' do
+    let(:fields) do
+      [
+        :id,
+        :show_active,
+        :activated,
+        :type,
+        :merge_request_events,
+        :commit_events,
+        :enable_comments,
+        :comment_detail,
+        :learn_more_path,
+        :trigger_events,
+        :fields,
+        :inherit_from_id,
+        :integration_level,
+        :editable,
+        :cancel_path,
+        :can_test,
+        :test_path,
+        :reset_path
+      ]
+    end
+
+    let(:jira_fields) { %i[jira_issue_transition_id] }
+
     subject { helper.integration_form_data(integration) }
 
-    context 'Jira service' do
-      let(:integration) { build(:jira_service) }
+    context 'Slack service' do
+      let(:integration) { build(:slack_service) }
 
-      it 'includes Jira specific fields' do
-        is_expected.to include(
-          :id,
-          :show_active,
-          :activated,
-          :type,
-          :merge_request_events,
-          :commit_events,
-          :enable_comments,
-          :comment_detail,
-          :trigger_events,
-          :fields,
-          :inherit_from_id,
-          :integration_level
-        )
-      end
+      it { is_expected.to include(*fields) }
+      it { is_expected.not_to include(*jira_fields) }
 
       specify do
         expect(subject[:reset_path]).to eq(helper.scoped_reset_integration_path(integration))
       end
     end
+
+    context 'Jira service' do
+      let(:integration) { build(:jira_service) }
+
+      it { is_expected.to include(*fields, *jira_fields) }
+    end
   end
 
   describe '#scoped_reset_integration_path' do

spec/models/project_services/jira_service_spec.rb

@@ -82,11 +82,8 @@ RSpec.describe JiraService do
 
     subject(:fields) { service.fields }
 
-    it 'includes transition help link' do
-      transition_id_field = fields.find { |field| field[:name] == 'jira_issue_transition_id' }
-
-      expect(transition_id_field[:title]).to eq('Jira workflow transition IDs')
-      expect(transition_id_field[:help]).to include('/help/user/project/integrations/jira')
+    it 'returns custom fields' do
+      expect(fields.pluck(:name)).to eq(%w[url api_url username password])
     end
   end
 
@@ -460,10 +457,10 @@ RSpec.describe JiraService do
     end
 
     context 'with options' do
-      let(:issue_url) { "#{url}/rest/api/2/issue/#{issue_key}?expand=renderedFields" }
+      let(:issue_url) { "#{url}/rest/api/2/issue/#{issue_key}?expand=renderedFields,transitions" }
 
       it 'calls the Jira API with the options to get the issue' do
-        jira_service.find_issue(issue_key, rendered_fields: true)
+        jira_service.find_issue(issue_key, rendered_fields: true, transitions: true)
 
         expect(WebMock).to have_requested(:get, issue_url)
       end
@@ -474,6 +471,25 @@ RSpec.describe JiraService do
     let(:custom_base_url) { 'http://custom_url' }
 
     shared_examples 'close_issue' do
+      let(:issue_key)       { 'JIRA-123' }
+      let(:issue_url)       { "http://jira.example.com/rest/api/2/issue/#{issue_key}" }
+      let(:transitions_url) { "#{issue_url}/transitions" }
+      let(:comment_url)     { "#{issue_url}/comment" }
+      let(:remote_link_url) { "#{issue_url}/remotelink" }
+      let(:transitions)     { nil }
+
+      let(:issue_fields) do
+        {
+          id: issue_key,
+          self: issue_url,
+          transitions: transitions
+        }
+      end
+
+      subject(:close_issue) do
+        @jira_service.close_issue(resource, ExternalIssue.new(issue_key, project))
+      end
+
       before do
         @jira_service = described_class.new
         allow(@jira_service).to receive_messages(
@@ -488,26 +504,21 @@ RSpec.describe JiraService do
         # These stubs are needed to test JiraService#close_issue.
         # We close the issue then do another request to API to check if it got closed.
         # Here is stubbed the API return with a closed and an opened issues.
-        open_issue   = JIRA::Resource::Issue.new(@jira_service.client, attrs: { 'id' => 'JIRA-123' })
+        open_issue   = JIRA::Resource::Issue.new(@jira_service.client, attrs: issue_fields.deep_stringify_keys)
         closed_issue = open_issue.dup
         allow(open_issue).to receive(:resolution).and_return(false)
         allow(closed_issue).to receive(:resolution).and_return(true)
         allow(JIRA::Resource::Issue).to receive(:find).and_return(open_issue, closed_issue)
 
-        allow_any_instance_of(JIRA::Resource::Issue).to receive(:key).and_return('JIRA-123')
+        allow_any_instance_of(JIRA::Resource::Issue).to receive(:key).and_return(issue_key)
         allow(JIRA::Resource::Remotelink).to receive(:all).and_return([])
 
         @jira_service.save!
 
-        project_issues_url = 'http://jira.example.com/rest/api/2/issue/JIRA-123'
-        @transitions_url   = 'http://jira.example.com/rest/api/2/issue/JIRA-123/transitions'
-        @comment_url       = 'http://jira.example.com/rest/api/2/issue/JIRA-123/comment'
-        @remote_link_url   = 'http://jira.example.com/rest/api/2/issue/JIRA-123/remotelink'
-
-        WebMock.stub_request(:get, project_issues_url).with(basic_auth: %w(gitlab_jira_username gitlab_jira_password))
-        WebMock.stub_request(:post, @transitions_url).with(basic_auth: %w(gitlab_jira_username gitlab_jira_password))
-        WebMock.stub_request(:post, @comment_url).with(basic_auth: %w(gitlab_jira_username gitlab_jira_password))
-        WebMock.stub_request(:post, @remote_link_url).with(basic_auth: %w(gitlab_jira_username gitlab_jira_password))
+        WebMock.stub_request(:get, issue_url).with(basic_auth: %w(gitlab_jira_username gitlab_jira_password))
+        WebMock.stub_request(:post, transitions_url).with(basic_auth: %w(gitlab_jira_username gitlab_jira_password))
+        WebMock.stub_request(:post, comment_url).with(basic_auth: %w(gitlab_jira_username gitlab_jira_password))
+        WebMock.stub_request(:post, remote_link_url).with(basic_auth: %w(gitlab_jira_username gitlab_jira_password))
       end
 
       let(:external_issue) { ExternalIssue.new('JIRA-123', project) }
@@ -519,7 +530,7 @@ RSpec.describe JiraService do
       it 'calls Jira API' do
         close_issue
 
-        expect(WebMock).to have_requested(:post, @comment_url).with(
+        expect(WebMock).to have_requested(:post, comment_url).with(
           body: /Issue solved with/
         ).once
       end
@@ -546,9 +557,9 @@ RSpec.describe JiraService do
         favicon_path = "http://localhost/assets/#{find_asset('favicon.png').digest_path}"
 
         # Creates comment
-        expect(WebMock).to have_requested(:post, @comment_url)
+        expect(WebMock).to have_requested(:post, comment_url)
         # Creates Remote Link in Jira issue fields
-        expect(WebMock).to have_requested(:post, @remote_link_url).with(
+        expect(WebMock).to have_requested(:post, remote_link_url).with(
           body: hash_including(
             GlobalID: 'GitLab',
             relationship: 'mentioned on',
@@ -567,8 +578,8 @@ RSpec.describe JiraService do
           allow(@jira_service).to receive_messages(comment_on_event_enabled: false)
           close_issue
 
-          expect(WebMock).not_to have_requested(:post, @comment_url)
-          expect(WebMock).to have_requested(:post, @remote_link_url)
+          expect(WebMock).not_to have_requested(:post, comment_url)
+          expect(WebMock).to have_requested(:post, remote_link_url)
         end
       end
 
@@ -589,7 +600,7 @@ RSpec.describe JiraService do
 
           close_issue
 
-          expect(WebMock).not_to have_requested(:post, @comment_url)
+          expect(WebMock).not_to have_requested(:post, comment_url)
         end
       end
 
@@ -598,8 +609,8 @@ RSpec.describe JiraService do
 
         close_issue
 
-        expect(WebMock).not_to have_requested(:post, @comment_url)
-        expect(WebMock).not_to have_requested(:post, @remote_link_url)
+        expect(WebMock).not_to have_requested(:post, comment_url)
+        expect(WebMock).not_to have_requested(:post, remote_link_url)
       end
 
       it 'does not send comment or remote links to issues with unknown resolution' do
@@ -607,8 +618,8 @@ RSpec.describe JiraService do
 
         close_issue
 
-        expect(WebMock).not_to have_requested(:post, @comment_url)
-        expect(WebMock).not_to have_requested(:post, @remote_link_url)
+        expect(WebMock).not_to have_requested(:post, comment_url)
+        expect(WebMock).not_to have_requested(:post, remote_link_url)
       end
 
       it 'references the GitLab commit' do
@@ -616,7 +627,7 @@ RSpec.describe JiraService do
 
         close_issue
 
-        expect(WebMock).to have_requested(:post, @comment_url).with(
+        expect(WebMock).to have_requested(:post, comment_url).with(
           body: %r{#{custom_base_url}/#{project.full_path}/-/commit/#{commit_id}}
         ).once
       end
@@ -631,14 +642,14 @@ RSpec.describe JiraService do
 
         close_issue
 
-        expect(WebMock).to have_requested(:post, @comment_url).with(
+        expect(WebMock).to have_requested(:post, comment_url).with(
           body: %r{#{Gitlab.config.gitlab.url}/#{project.full_path}/-/commit/#{commit_id}}
         ).once
       end
 
       it 'logs exception when transition id is not valid' do
         allow(@jira_service).to receive(:log_error)
-        WebMock.stub_request(:post, @transitions_url).with(basic_auth: %w(gitlab_jira_username gitlab_jira_password)).and_raise("Bad Request")
+        WebMock.stub_request(:post, transitions_url).with(basic_auth: %w(gitlab_jira_username gitlab_jira_password)).and_raise("Bad Request")
 
         close_issue
 
@@ -655,20 +666,63 @@ RSpec.describe JiraService do
       it 'calls the api with jira_issue_transition_id' do
         close_issue
 
-        expect(WebMock).to have_requested(:post, @transitions_url).with(
-          body: /999/
+        expect(WebMock).to have_requested(:post, transitions_url).with(
+          body: /"id":"999"/
         ).once
       end
 
-      context 'when have multiple transition ids' do
+      context 'when using automatic issue transitions' do
+        let(:transitions) do
+          [
+            { id: '1' },
+            { id: '2', to: { statusCategory: { key: 'new' } } },
+            { id: '3', to: { statusCategory: { key: 'done' } } },
+            { id: '4', to: { statusCategory: { key: 'done' } } }
+          ]
+        end
+
+        before do
+          allow(@jira_service).to receive_messages(jira_issue_transition_id: '')
+
+          close_issue
+        end
+
+        it 'uses the next transition with a status category of done' do
+          expect(WebMock).to have_requested(:post, transitions_url).with(
+            body: /"id":"3"/
+          ).once
+        end
+
+        context 'when no done transition is available' do
+          let(:transitions) do
+            [
+              { id: '1', to: { statusCategory: { key: 'new' } } }
+            ]
+          end
+
+          it 'does not attempt to transition' do
+            expect(WebMock).not_to have_requested(:post, transitions_url)
+          end
+        end
+
+        context 'when no valid transitions are returned' do
+          let(:transitions) { 'foo' }
+
+          it 'does not attempt to transition' do
+            expect(WebMock).not_to have_requested(:post, transitions_url)
+          end
+        end
+      end
+
+      context 'when using multiple transition ids' do
         it 'calls the api with transition ids separated by comma' do
           allow(@jira_service).to receive_messages(jira_issue_transition_id: '1,2,3')
 
           close_issue
 
           1.upto(3) do |transition_id|
-            expect(WebMock).to have_requested(:post, @transitions_url).with(
-              body: /#{transition_id}/
+            expect(WebMock).to have_requested(:post, transitions_url).with(
+              body: /"id":"#{transition_id}"/
             ).once
           end
         end
@@ -679,8 +733,8 @@ RSpec.describe JiraService do
           close_issue
 
           1.upto(3) do |transition_id|
-            expect(WebMock).to have_requested(:post, @transitions_url).with(
-              body: /#{transition_id}/
+            expect(WebMock).to have_requested(:post, transitions_url).with(
+              body: /"id":"#{transition_id}"/
             ).once
           end
         end

spec/services/merge_requests/merge_service_spec.rb

@@ -166,20 +166,6 @@ RSpec.describe MergeRequests::MergeService do
           service.execute(merge_request)
         end
 
-        context 'when jira_issue_transition_id is not present' do
-          before do
-            allow_any_instance_of(JIRA::Resource::Issue).to receive(:resolution).and_return(nil)
-          end
-
-          it 'does not close issue' do
-            jira_tracker.update!(jira_issue_transition_id: nil)
-
-            expect_any_instance_of(JiraService).not_to receive(:transition_issue)
-
-            service.execute(merge_request)
-          end
-        end
-
         context 'wrong issue markdown' do
           it 'does not close issues on Jira issue tracker' do
             jira_issue = ExternalIssue.new('#JIRA-123', project)

spec/support/shared_contexts/project_service_jira_context.rb

 # frozen_string_literal: true
 
 RSpec.shared_context 'project service Jira context' do
-  let(:url) { 'http://jira.example.com' }
-  let(:test_url) { 'http://jira.example.com/rest/api/2/serverInfo' }
+  let(:url) { 'https://jira.example.com' }
+  let(:test_url) { 'https://jira.example.com/rest/api/2/serverInfo' }
 
   def fill_form(disable: false)
     click_active_checkbox if disable
@@ -10,6 +10,5 @@ RSpec.shared_context 'project service Jira context' do
     fill_in 'service_url', with: url
     fill_in 'service_username', with: 'username'
     fill_in 'service_password', with: 'password'
-    fill_in 'service_jira_issue_transition_id', with: '25'
   end
 end

spec/support/shared_contexts/project_service_shared_context.rb

@@ -15,7 +15,10 @@ RSpec.shared_context 'project service activation' do
 
   def visit_project_integration(name)
     visit_project_integrations
-    click_link(name)
+
+    within('#content-body') do
+      click_link(name)
+    end
   end
 
   def click_active_checkbox