Merge branch 'zj-kamil-slack-slash-commands' into 'master'

Slack slash commands

## What does this MR do?

Implement Slack Slash Commands by utilizing generalized Mattermost presenter to fulfill Slack requirements.

## Why was this MR needed?

We want to expose Slack Slash Commands as a first-class service.

## What are the relevant issue numbers?

Supersedes !8007  
Closes #22182

See merge request !8126

Gemfile

@@ -169,7 +169,7 @@ gem 'gitlab-flowdock-git-hook', '~> 1.0.1'
 gem 'gemnasium-gitlab-service', '~> 0.2'
 
 # Slack integration
-gem 'slack-notifier', '~> 1.2.0'
+gem 'slack-notifier', '~> 1.5.1'
 
 # Asana integration
 gem 'asana', '~> 0.4.0'

Gemfile.lock

@@ -683,7 +683,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    slack-notifier (1.2.1)
+    slack-notifier (1.5.1)
     slop (3.6.0)
     spinach (0.8.10)
       colorize
@@ -952,7 +952,7 @@ DEPENDENCIES
   sidekiq-cron (~> 0.4.4)
   sidekiq-limit_fetch (~> 3.4)
   simplecov (= 0.12.0)
-  slack-notifier (~> 1.2.0)
+  slack-notifier (~> 1.5.1)
   spinach-rails (~> 0.2.1)
   spinach-rerun-reporter (~> 0.0.2)
   spring (~> 1.7.0)

app/assets/stylesheets/framework/forms.scss

@@ -96,6 +96,10 @@ label {
     code {
       line-height: 1.8;
     }
+
+    img {
+      margin-right: $gl-padding;
+    }
   }
 
   @media(max-width: $screen-xs-max) {

app/models/project.rb

@@ -79,7 +79,6 @@ class Project < ActiveRecord::Base
 
   has_one :last_event, -> {order 'events.created_at DESC'}, class_name: 'Event'
   has_many :boards, before_add: :validate_board_limit, dependent: :destroy
-  has_many :chat_services
 
   # Project services
   has_one :campfire_service, dependent: :destroy
@@ -96,6 +95,7 @@ class Project < ActiveRecord::Base
   has_one :gemnasium_service, dependent: :destroy
   has_one :mattermost_slash_commands_service, dependent: :destroy
   has_one :mattermost_notification_service, dependent: :destroy
+  has_one :slack_slash_commands_service, dependent: :destroy
   has_one :slack_notification_service, dependent: :destroy
   has_one :buildkite_service, dependent: :destroy
   has_one :bamboo_service, dependent: :destroy

app/models/project_services/chat_service.rb → app/models/project_services/chat_slash_commands_service.rb

 # Base class for Chat services
-# This class is not meant to be used directly, but only to inherit from.
-class ChatService < Service
+# This class is not meant to be used directly, but only to inherrit from.
+class ChatSlashCommandsService < Service
   default_value_for :category, 'chat'
 
-  has_many :chat_names, foreign_key: :service_id
+  prop_accessor :token
+
+  has_many :chat_names, foreign_key: :service_id, dependent: :destroy
 
   def valid_token?(token)
     self.respond_to?(:token) &&
@@ -15,7 +17,40 @@ class ChatService < Service
     []
   end
 
+  def can_test?
+    false
+  end
+
+  def fields
+    [
+      { type: 'text', name: 'token', placeholder: '' }
+    ]
+  end
+
   def trigger(params)
-    raise NotImplementedError
+    return unless valid_token?(params[:token])
+
+    user = find_chat_user(params)
+    unless user
+      url = authorize_chat_name_url(params)
+      return presenter.authorize_chat_name(url)
+    end
+
+    Gitlab::ChatCommands::Command.new(project, user,
+      params).execute
+  end
+
+  private
+
+  def find_chat_user(params)
+    ChatNames::FindUserService.new(self, params).execute
+  end
+
+  def authorize_chat_name_url(params)
+    ChatNames::AuthorizeUserService.new(self, params).execute
+  end
+
+  def presenter
+    Gitlab::ChatCommands::Presenter.new
   end
 end

app/models/project_services/mattermost_slash_commands_service.rb

-class MattermostSlashCommandsService < ChatService
+class MattermostSlashCommandsService < ChatSlashCommandsService
   include TriggersHelper
 
   prop_accessor :token
@@ -18,32 +18,4 @@ class MattermostSlashCommandsService < ChatService
   def to_param
     'mattermost_slash_commands'
   end
-
-  def fields
-    [
-      { type: 'text', name: 'token', placeholder: '' }
-    ]
-  end
-
-  def trigger(params)
-    return nil unless valid_token?(params[:token])
-
-    user = find_chat_user(params)
-    unless user
-      url = authorize_chat_name_url(params)
-      return Mattermost::Presenter.authorize_chat_name(url)
-    end
-
-    Gitlab::ChatCommands::Command.new(project, user, params).execute
-  end
-
-  private
-
-  def find_chat_user(params)
-    ChatNames::FindUserService.new(self, params).execute
-  end
-
-  def authorize_chat_name_url(params)
-    ChatNames::AuthorizeUserService.new(self, params).execute
-  end
 end

app/models/project_services/slack_slash_commands_service.rb

+class SlackSlashCommandsService < ChatSlashCommandsService
+  include TriggersHelper
+
+  def title
+    'Slack Command'
+  end
+
+  def description
+    "Perform common operations on GitLab in Slack"
+  end
+
+  def to_param
+    'slack_slash_commands'
+  end
+
+  def trigger(params)
+    # Format messages to be Slack-compatible
+    super.tap do |result|
+      result[:text] = format(result[:text])
+    end
+  end
+
+  private
+
+  def format(text)
+    Slack::Notifier::LinkFormatter.format(text) if text
+  end
+end

app/models/service.rb

@@ -216,11 +216,12 @@ class Service < ActiveRecord::Base
       jira
       kubernetes
       mattermost_slash_commands
+      mattermost_notification
       pipelines_email
       pivotaltracker
       pushover
       redmine
-      mattermost_notification
+      slack_slash_commands
       slack_notification
       teamcity
     ]

app/views/projects/services/slack_slash_commands/_help.html.haml

+- run_actions_text = "Perform common operations on this project: #{@project.name_with_namespace}"
+
+.well
+  This service allows GitLab users to perform common operations on this
+  project by entering slash commands in Slack.
+  %br
+  See list of available commands in Slack after setting up this service,
+  by entering
+  %code /<command> help
+  %br
+  %br
+  To setup this service:
+  %ul.list-unstyled
+    %li
+      1.
+      = link_to 'Add a slash command', 'https://my.slack.com/services/new/slash-commands'
+      in your Slack team with these options:
+
+  %hr
+
+  .help-form
+    .form-group
+      = label_tag nil, 'Command', class: 'col-sm-2 col-xs-12 control-label'
+      .col-sm-10.col-xs-12.text-block
+        %p Fill in the word that works best for your team.
+        %p
+          Suggestions:
+          %code= 'gitlab'
+          %code= @project.path # Path contains no spaces, but dashes
+          %code= @project.path_with_namespace
+
+    .form-group
+      = label_tag :url, 'URL', class: 'col-sm-2 col-xs-12 control-label'
+      .col-sm-10.col-xs-12.input-group
+        = text_field_tag :url, service_trigger_url(subject), class: 'form-control input-sm', readonly: 'readonly'
+        .input-group-btn
+          = clipboard_button(clipboard_target: '#url')
+
+    .form-group
+      = label_tag nil, 'Method', class: 'col-sm-2 col-xs-12 control-label'
+      .col-sm-10.col-xs-12.text-block POST
+
+    .form-group
+      = label_tag :customize_name, 'Customize name', class: 'col-sm-2 col-xs-12 control-label'
+      .col-sm-10.col-xs-12.input-group
+        = text_field_tag :customize_name, 'GitLab', class: 'form-control input-sm', readonly: 'readonly'
+        .input-group-btn
+          = clipboard_button(clipboard_target: '#customize_name')
+
+    .form-group
+      = label_tag nil, 'Customize icon', class: 'col-sm-2 col-xs-12 control-label'
+      .col-sm-10.col-xs-12.text-block
+        = image_tag(asset_url('gitlab_logo.png'), width: 36, height: 36)
+        = link_to('Download image', asset_url('gitlab_logo.png'), class: 'btn btn-sm', target: '_blank')
+
+    .form-group
+      = label_tag nil, 'Autocomplete', class: 'col-sm-2 col-xs-12 control-label'
+      .col-sm-10.col-xs-12.text-block Show this command in the autocomplete list
+
+    .form-group
+      = label_tag :autocomplete_description, 'Autocomplete description', class: 'col-sm-2 col-xs-12 control-label'
+      .col-sm-10.col-xs-12.input-group
+        = text_field_tag :autocomplete_description, run_actions_text, class: 'form-control input-sm', readonly: 'readonly'
+        .input-group-btn
+          = clipboard_button(clipboard_target: '#autocomplete_description')
+
+    .form-group
+      = label_tag :autocomplete_usage_hint, 'Autocomplete usage hint', class: 'col-sm-2 col-xs-12 control-label'
+      .col-sm-10.col-xs-12.input-group
+        = text_field_tag :autocomplete_usage_hint, '[help]', class: 'form-control input-sm', readonly: 'readonly'
+        .input-group-btn
+          = clipboard_button(clipboard_target: '#autocomplete_usage_hint')
+
+    .form-group
+      = label_tag :descriptive_label, 'Descriptive label', class: 'col-sm-2 col-xs-12 control-label'
+      .col-sm-10.col-xs-12.input-group
+        = text_field_tag :descriptive_label, 'Perform common operations on GitLab project', class: 'form-control input-sm', readonly: 'readonly'
+        .input-group-btn
+          = clipboard_button(clipboard_target: '#descriptive_label')
+
+  %hr
+
+  %ul.list-unstyled
+    %li
+      2. Paste the
+      %strong Token
+      into the field below
+    %li
+      3. Select the
+      %strong Active
+      checkbox, press
+      %strong Save changes
+      and start using GitLab inside Slack!

changelogs/unreleased/zj-slack-slash-commands.yml

+---
+title: Refactor presenters ChatCommands
+merge_request: 7846
+author: 

features/project/service.feature

@@ -37,11 +37,11 @@ Feature: Project Services
     And I fill Assembla settings
     Then I should see Assembla service settings saved
 
-  Scenario: Activate Slack service
+  Scenario: Activate Slack notifications service
     When I visit project "Shop" services page
-    And I click Slack service link
-    And I fill Slack settings
-    Then I should see Slack service settings saved
+    And I click Slack notifications service link
+    And I fill Slack notifications settings
+    Then I should see Slack Notifications service settings saved
 
   Scenario: Activate Pushover service
     When I visit project "Shop" services page

features/steps/project/services.rb

@@ -137,17 +137,17 @@ class Spinach::Features::ProjectServices < Spinach::FeatureSteps
     expect(find_field('Colorize messages').value).to eq '1'
   end
 
-  step 'I click Slack service link' do
-    click_link 'Slack'
+  step 'I click Slack notifications service link' do
+    click_link 'Slack notifications'
   end
 
-  step 'I fill Slack settings' do
+  step 'I fill Slack notifications settings' do
     check 'Active'
     fill_in 'Webhook', with: 'https://hooks.slack.com/services/SVRWFV0VVAR97N/B02R25XN3/ZBqu7xMupaEEICInN685'
     click_button 'Save'
   end
 
-  step 'I should see Slack service settings saved' do
+  step 'I should see Slack Notifications service settings saved' do
     expect(find_field('Webhook').value).to eq 'https://hooks.slack.com/services/SVRWFV0VVAR97N/B02R25XN3/ZBqu7xMupaEEICInN685'
   end
 

lib/api/services.rb

@@ -378,7 +378,6 @@ module API
           desc: 'A custom certificate authority bundle to verify the Kubernetes cluster with (PEM format)'
         },
       ],
-
       'mattermost-slash-commands' => [
         {
           required: true,
@@ -387,6 +386,14 @@ module API
           desc: 'The Mattermost token'
         }
       ],
+      'slack-slash-commands' => [
+        {
+          required: true,
+          name: :token,
+          type: String,
+          desc: 'The Slack token'
+        }
+      ],
       'pipelines-email' => [
         {
           required: true,

lib/gitlab/chat_commands/base_command.rb

@@ -42,6 +42,10 @@ module Gitlab
       def find_by_iid(iid)
         collection.find_by(iid: iid)
       end
+
+      def presenter
+        Gitlab::ChatCommands::Presenter.new
+      end
     end
   end
 end

lib/gitlab/chat_commands/command.rb

@@ -22,8 +22,6 @@ module Gitlab
         end
       end
 
-      private
-
       def match_command
         match = nil
         service = available_commands.find do |klass|
@@ -33,6 +31,8 @@ module Gitlab
         [service, match]
       end
 
+      private
+
       def help_messages
         available_commands.map(&:help_message)
       end
@@ -48,15 +48,15 @@ module Gitlab
       end
 
       def help(messages)
-        Mattermost::Presenter.help(messages, params[:command])
+        presenter.help(messages, params[:command])
       end
 
       def access_denied
-        Mattermost::Presenter.access_denied
+        presenter.access_denied
       end
 
       def present(resource)
-        Mattermost::Presenter.present(resource)
+        presenter.present(resource)
       end
     end
   end

lib/gitlab/chat_commands/deploy.rb

@@ -4,7 +4,7 @@ module Gitlab
       include Gitlab::Routing.url_helpers
 
       def self.match(text)
-        /\Adeploy\s+(?<from>.*)\s+to+\s+(?<to>.*)\z/.match(text)
+        /\Adeploy\s+(?<from>\S+.*)\s+to+\s+(?<to>\S+.*)\z/.match(text)
       end
 
       def self.help_message

lib/mattermost/presenter.rb → lib/gitlab/chat_commands/presenter.rb

-module Mattermost
-  class Presenter
-    class << self
-      include Gitlab::Routing.url_helpers
+module Gitlab
+  module ChatCommands
+    class Presenter
+      include Gitlab::Routing
 
       def authorize_chat_name(url)
         message = if url
@@ -64,7 +64,7 @@ module Mattermost
       def single_resource(resource)
         return error(resource) if resource.errors.any? || !resource.persisted?
 
-        message = "### #{title(resource)}"
+        message = "#{title(resource)}:"
         message << "\n\n#{resource.description}" if resource.try(:description)
 
         in_channel_response(message)

spec/features/admin/admin_settings_spec.rb

@@ -17,9 +17,9 @@ feature 'Admin updates settings', feature: true do
     expect(page).to have_content "Application settings saved successfully"
   end
 
-  scenario 'Change Slack Service template settings' do
+  scenario 'Change Slack Notifications Service template settings' do
     click_link 'Service Templates'
-    click_link 'Slack'
+    click_link 'Slack notifications'
     fill_in 'Webhook', with: 'http://localhost'
     fill_in 'Username', with: 'test_user'
     fill_in 'service_push_channel', with: '#test_channel'
@@ -30,7 +30,7 @@ feature 'Admin updates settings', feature: true do
 
     expect(page).to have_content 'Application settings saved successfully'
 
-    click_link 'Slack'
+    click_link 'Slack notifications'
 
     page.all('input[type=checkbox]').each do |checkbox|
       expect(checkbox).to be_checked

spec/features/projects/services/slack_slash_command_spec.rb

+require 'spec_helper'
+
+feature 'Slack slash commands', feature: true do
+  include WaitForAjax
+
+  given(:user) { create(:user) }
+  given(:project) { create(:project) }
+  given(:service) { project.create_slack_slash_commands_service }
+
+  background do
+    project.team << [user, :master]
+    login_as(user)
+  end
+
+  scenario 'user visits the slack slash command config page and shows a help message', js: true do
+    visit edit_namespace_project_service_path(project.namespace, project, service)
+
+    wait_for_ajax
+
+    expect(page).to have_content('This service allows GitLab users to perform common')
+  end
+
+  scenario 'shows the token after saving' do
+    visit edit_namespace_project_service_path(project.namespace, project, service)
+
+    fill_in 'service_token', with: 'token'
+    click_on 'Save'
+
+    value = find_field('service_token').value
+
+    expect(value).to eq('token')
+  end
+
+  scenario 'shows the correct trigger url' do
+    visit edit_namespace_project_service_path(project.namespace, project, service)
+
+    value = find_field('url').value
+    expect(value).to match("api/v3/projects/#{project.id}/services/slack_slash_commands/trigger")
+  end
+end

spec/lib/gitlab/chat_commands/command_spec.rb

@@ -5,7 +5,9 @@ describe Gitlab::ChatCommands::Command, service: true do
   let(:user) { create(:user) }
 
   describe '#execute' do
-    subject { described_class.new(project, user, params).execute }
+    subject do
+      described_class.new(project, user, params).execute
+    end
 
     context 'when no command is available' do
       let(:params) { { text: 'issue show 1' } }
@@ -74,7 +76,7 @@ describe Gitlab::ChatCommands::Command, service: true do
         end
 
         it 'returns action' do
-          expect(subject[:text]).to include('Deployment from staging to production started')
+          expect(subject[:text]).to include('Deployment from staging to production started.')
           expect(subject[:response_type]).to be(:in_channel)
         end
 
@@ -91,4 +93,26 @@ describe Gitlab::ChatCommands::Command, service: true do
       end
     end
   end
+
+  describe '#match_command' do
+    subject { described_class.new(project, user, params).match_command.first }
+
+    context 'IssueShow is triggered' do
+      let(:params) { { text: 'issue show 123' } }
+
+      it { is_expected.to eq(Gitlab::ChatCommands::IssueShow) }
+    end
+
+    context 'IssueCreate is triggered' do
+      let(:params) { { text: 'issue create my title' } }
+
+      it { is_expected.to eq(Gitlab::ChatCommands::IssueCreate) }
+    end
+
+    context 'IssueSearch is triggered' do
+      let(:params) { { text: 'issue search my query' } }
+
+      it { is_expected.to eq(Gitlab::ChatCommands::IssueSearch) }
+    end
+  end
 end