Merge branch 'add-slack-slash-command-issue-comment' into 'master'

Add a Slack slash command to add a comment to an issue

Closes #30822

See merge request gitlab-org/gitlab!18946

changelogs/unreleased/add-slack-slash-command-issue-comment.yml

+---
+title: Add a Slack slash command to add a comment to an issue
+merge_request: 18946
+author:
+type: added

doc/integration/slash_commands.md

@@ -18,6 +18,7 @@ Taking the trigger term as `project-name`, the commands are:
 | `/project-name issue close <id>` | Closes the issue with id `<id>` |
 | `/project-name issue search <query>` | Shows up to 5 issues matching `<query>` |
 | `/project-name issue move <id> to <project>` | Moves issue ID `<id>` to `<project>` |
+| `/project-name issue comment <id> <shift+return> <comment>` | Adds a new comment to an issue with id `<id>` and comment body `<comment>` |
 | `/project-name deploy <from> to <to>` | Deploy from the `<from>` environment to the `<to>` environment |
 | `/project-name run <job name> <arguments>` | Execute [ChatOps](../ci/chatops/README.md) job `<job name>` on `master` |
 

lib/gitlab/slash_commands/command.rb

@@ -10,6 +10,7 @@ module Gitlab
           Gitlab::SlashCommands::IssueSearch,
           Gitlab::SlashCommands::IssueMove,
           Gitlab::SlashCommands::IssueClose,
+          Gitlab::SlashCommands::IssueComment,
           Gitlab::SlashCommands::Deploy,
           Gitlab::SlashCommands::Run
         ]

lib/gitlab/slash_commands/issue_comment.rb

+# frozen_string_literal: true
+
+module Gitlab
+  module SlashCommands
+    class IssueComment < IssueCommand
+      def self.match(text)
+        /\Aissue\s+comment\s+#{Issue.reference_prefix}?(?<iid>\d+)\n*(?<note_body>(.|\n)*)/.match(text)
+      end
+
+      def self.help_message
+        'issue comment <id> *`⇧ Shift`*+*`↵ Enter`* <comment>'
+      end
+
+      def execute(match)
+        note_body = match[:note_body].to_s.strip
+        issue = find_by_iid(match[:iid])
+
+        return not_found unless issue
+        return access_denied unless can_create_note?(issue)
+
+        note = create_note(issue: issue, note: note_body)
+
+        if note.persisted?
+          presenter(note).present
+        else
+          presenter(note).display_errors
+        end
+      end
+
+      private
+
+      def can_create_note?(issue)
+        Ability.allowed?(current_user, :create_note, issue)
+      end
+
+      def not_found
+        Gitlab::SlashCommands::Presenters::Access.new.not_found
+      end
+
+      def access_denied
+        Gitlab::SlashCommands::Presenters::Access.new.generic_access_denied
+      end
+
+      def create_note(issue:, note:)
+        note_params = { noteable: issue, note: note }
+
+        Notes::CreateService.new(project, current_user, note_params).execute
+      end
+
+      def presenter(note)
+        Gitlab::SlashCommands::Presenters::IssueComment.new(note)
+      end
+    end
+  end
+end

lib/gitlab/slash_commands/presenters/access.rb

@@ -15,6 +15,10 @@ module Gitlab
           MESSAGE
         end
 
+        def generic_access_denied
+          ephemeral_response(text: 'You are not allowed to perform the given chatops command.')
+        end
+
         def deactivated
           ephemeral_response(text: <<~MESSAGE)
             You are not allowed to perform the given chatops command since

lib/gitlab/slash_commands/presenters/issue_comment.rb

+# frozen_string_literal: true
+
+module Gitlab
+  module SlashCommands
+    module Presenters
+      class IssueComment < Presenters::Base
+        include Presenters::NoteBase
+
+        def present
+          ephemeral_response(new_note)
+        end
+
+        private
+
+        def new_note
+          {
+            attachments: [
+              {
+                title:        "#{issue.title} · #{issue.to_reference}",
+                title_link:   resource_url,
+                author_name:  author.name,
+                author_icon:  author.avatar_url,
+                fallback:     "New comment on #{issue.to_reference}: #{issue.title}",
+                pretext:      pretext,
+                color:        color,
+                fields:       fields,
+                mrkdwn_in: [
+                  :title,
+                  :pretext,
+                  :fields
+                ]
+              }
+            ]
+          }
+        end
+
+        def pretext
+          "I commented on an issue on #{author_profile_link}'s behalf: *#{issue.to_reference}* in #{project_link}"
+        end
+      end
+    end
+  end
+end

lib/gitlab/slash_commands/presenters/note_base.rb

+# frozen_string_literal: true
+
+module Gitlab
+  module SlashCommands
+    module Presenters
+      module NoteBase
+        GREEN = '#38ae67'
+
+        def color
+          GREEN
+        end
+
+        def issue
+          resource.noteable
+        end
+
+        def project
+          issue.project
+        end
+
+        def project_link
+          "[#{project.full_name}](#{project.web_url})"
+        end
+
+        def author
+          resource.author
+        end
+
+        def author_profile_link
+          "[#{author.to_reference}](#{url_for(author)})"
+        end
+
+        def fields
+          [
+            {
+              title: 'Comment',
+              value: resource.note
+            }
+          ]
+        end
+
+        private
+
+        attr_reader :resource
+      end
+    end
+  end
+end

spec/lib/gitlab/slash_commands/command_spec.rb

@@ -115,5 +115,10 @@ describe Gitlab::SlashCommands::Command do
       let(:params) { { text: 'issue move #78291 to gitlab/gitlab-ci' } }
       it { is_expected.to eq(Gitlab::SlashCommands::IssueMove) }
     end
+
+    context 'IssueComment is triggered' do
+      let(:params) { { text: "issue comment #503\ncomment body" } }
+      it { is_expected.to eq(Gitlab::SlashCommands::IssueComment) }
+    end
   end
 end

spec/lib/gitlab/slash_commands/issue_comment_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::SlashCommands::IssueComment do
+  describe '#execute' do
+    let(:project) { create(:project, :public) }
+    let(:issue) { create(:issue, project: project) }
+    let(:user) { issue.author }
+    let(:chat_name) { double(:chat_name, user: user) }
+    let(:regex_match) { described_class.match("issue comment #{issue.iid}\nComment body") }
+
+    subject { described_class.new(project, chat_name).execute(regex_match) }
+
+    context 'when the issue exists' do
+      context 'when project is private' do
+        let(:project) { create(:project) }
+
+        context 'when the user is not a member of the project' do
+          let(:chat_name) { double(:chat_name, user: create(:user)) }
+
+          it 'does not allow the user to comment' do
+            expect(subject[:response_type]).to be(:ephemeral)
+            expect(subject[:text]).to match('not found')
+            expect(issue.reload.notes.count).to be_zero
+          end
+        end
+      end
+
+      context 'when the user is not a member of the project' do
+        let(:chat_name) { double(:chat_name, user: create(:user)) }
+
+        context 'when the discussion is locked in the issue' do
+          before do
+            issue.update!(discussion_locked: true)
+          end
+
+          it 'does not allow the user to comment' do
+            expect(subject[:response_type]).to be(:ephemeral)
+            expect(subject[:text]).to match('You are not allowed')
+            expect(issue.reload.notes.count).to be_zero
+          end
+        end
+      end
+
+      context 'when the user can comment on the issue' do
+        context 'when comment body exists' do
+          it 'creates a new comment' do
+            expect { subject }.to change { issue.notes.count }.by(1)
+          end
+
+          it 'a new comment has a correct body' do
+            subject
+
+            expect(issue.notes.last.note).to eq('Comment body')
+          end
+        end
+
+        context 'when comment body does not exist' do
+          let(:regex_match) { described_class.match("issue comment #{issue.iid}") }
+
+          it 'does not create a new comment' do
+            expect { subject }.not_to change { issue.notes.count }
+          end
+
+          it 'displays the errors' do
+            expect(subject[:response_type]).to be(:ephemeral)
+            expect(subject[:text]).to match("- Note can't be blank")
+          end
+        end
+      end
+    end
+
+    context 'when the issue does not exist' do
+      let(:regex_match) { described_class.match("issue comment 2343242\nComment body") }
+
+      it 'returns not found' do
+        expect(subject[:response_type]).to be(:ephemeral)
+        expect(subject[:text]).to match('not found')
+      end
+    end
+  end
+
+  describe '.match' do
+    subject(:match) { described_class.match(command) }
+
+    context 'when a command has an issue ID' do
+      context 'when command has a comment body' do
+        let(:command) { "issue comment 503\nComment body" }
+
+        it 'matches an issue ID' do
+          expect(match[:iid]).to eq('503')
+        end
+
+        it 'matches an note body' do
+          expect(match[:note_body]).to eq('Comment body')
+        end
+      end
+    end
+
+    context 'when a command has a reference prefix for issue ID' do
+      let(:command) { "issue comment #503\nComment body" }
+
+      it 'matches an issue ID' do
+        expect(match[:iid]).to eq('503')
+      end
+    end
+
+    context 'when a command does not have an issue ID' do
+      let(:command) { 'issue comment' }
+
+      it 'does not match' do
+        is_expected.to be_nil
+      end
+    end
+  end
+end

spec/lib/gitlab/slash_commands/presenters/access_spec.rb

@@ -22,6 +22,16 @@ describe Gitlab::SlashCommands::Presenters::Access do
     end
   end
 
+  describe '#generic_access_denied' do
+    subject { described_class.new.generic_access_denied }
+
+    it { is_expected.to be_a(Hash) }
+
+    it_behaves_like 'displays an error message' do
+      let(:error_message) { 'You are not allowed to perform the given chatops command.' }
+    end
+  end
+
   describe '#deactivated' do
     subject { described_class.new.deactivated }
 

spec/lib/gitlab/slash_commands/presenters/issue_comment_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::SlashCommands::Presenters::IssueComment do
+  let_it_be(:project) { create(:project) }
+  let_it_be(:issue) { create(:issue, project: project) }
+  let_it_be(:note) { create(:note, project: project, noteable: issue) }
+  let(:author) { note.author }
+
+  describe '#present' do
+    let(:attachment) { subject[:attachments].first }
+    subject { described_class.new(note).present }
+
+    it { is_expected.to be_a(Hash) }
+
+    it 'sets ephemeral response type' do
+      expect(subject[:response_type]).to be(:ephemeral)
+    end
+
+    it 'sets the title' do
+      expect(attachment[:title]).to eq("#{issue.title} · #{issue.to_reference}")
+    end
+
+    it 'sets the fallback text' do
+      expect(attachment[:fallback]).to eq("New comment on #{issue.to_reference}: #{issue.title}")
+    end
+
+    it 'sets the fields' do
+      expect(attachment[:fields]).to eq([{ title: 'Comment', value: note.note }])
+    end
+
+    it 'sets the color' do
+      expect(attachment[:color]).to eq('#38ae67')
+    end
+  end
+end