Add Hangouts Chat service implementation

Gemfile

@@ -220,6 +220,9 @@ gem 'gemnasium-gitlab-service', '~> 0.2'
 # Slack integration
 gem 'slack-notifier', '~> 1.5.1'
 
+# Hangouts Chat integration
+gem 'hangouts-chat', '~> 0.0.5'
+
 # Asana integration
 gem 'asana', '~> 0.6.0'
 

Gemfile.lock

@@ -385,6 +385,7 @@ GEM
       temple (>= 0.8.0)
       thor
       tilt
+    hangouts-chat (0.0.5)
     hashdiff (0.3.4)
     hashie (3.5.7)
     hashie-forbidden_attributes (0.1.1)
@@ -1058,6 +1059,7 @@ DEPENDENCIES
   grpc (~> 1.11.0)
   haml_lint (~> 0.26.0)
   hamlit (~> 2.8.8)
+  hangouts-chat (~> 0.0.5)
   hashie-forbidden_attributes
   health_check (~> 2.6.0)
   hipchat (~> 1.5.0)

Gemfile.rails5.lock

@@ -388,6 +388,7 @@ GEM
       temple (>= 0.8.0)
       thor
       tilt
+    hangouts-chat (0.0.5)
     hashdiff (0.3.4)
     hashie (3.5.7)
     hashie-forbidden_attributes (0.1.1)
@@ -1068,6 +1069,7 @@ DEPENDENCIES
   grpc (~> 1.11.0)
   haml_lint (~> 0.26.0)
   hamlit (~> 2.8.8)
+  hangouts-chat (~> 0.0.5)
   hashie-forbidden_attributes
   health_check (~> 2.6.0)
   hipchat (~> 1.5.0)

app/models/project_services/hangouts_chat_service.rb

+require 'hangouts_chat'
+
 class HangoutsChatService < ChatNotificationService
   def title
     'Hangouts Chat'
@@ -38,4 +40,27 @@ class HangoutsChatService < ChatNotificationService
       { type: 'checkbox', name: 'notify_only_default_branch' }
     ]
   end
+
+  private
+
+  def notify(message, opts)
+    simple_text = compose_simple_message(message)
+    HangoutsChat::Sender.new(webhook).simple(simple_text)
+  end
+
+  def compose_simple_message(message)
+    header = message.pretext
+    return header if message.attachments.empty?
+
+    title = fetch_attachment_title(message.attachments.first)
+    body = message.attachments.first[:text]
+    [header, title, body].compact.join("\n")
+  end
+
+  def fetch_attachment_title(attachment)
+    return nil if attachment[:title].nil?
+    return attachment[:title] if attachment[:title_link].nil?
+
+    "<#{attachment[:title_link]}|#{attachment[:title]}>"
+  end
 end

spec/models/project_services/hangouts_chat_service_spec.rb

+require 'spec_helper'
+
+describe HangoutsChatService do
+  let(:chat_service) { described_class.new }
+  let(:webhook_url) { 'https://example.gitlab.com/' }
+
+  describe 'Associations' do
+    it { is_expected.to belong_to :project }
+    it { is_expected.to have_one :service_hook }
+  end
+
+  describe 'Validations' do
+    context 'when service is active' do
+      before do
+        subject.active = true
+      end
+
+      it { is_expected.to validate_presence_of(:webhook) }
+      it_behaves_like 'issue tracker service URL attribute', :webhook
+    end
+
+    context 'when service is inactive' do
+      before do
+        subject.active = false
+      end
+
+      it { is_expected.not_to validate_presence_of(:webhook) }
+    end
+  end
+
+  describe '#execute' do
+    let(:user)    { create(:user) }
+    let(:project) { create(:project, :repository) }
+
+    before do
+      allow(chat_service).to receive_messages(
+        project: project,
+        project_id: project.id,
+        service_hook: true,
+        webhook: webhook_url
+      )
+
+      WebMock.stub_request(:post, webhook_url)
+    end
+
+    context 'with push events' do
+      let(:push_sample_data) do
+        Gitlab::DataBuilder::Push.build_sample(project, user)
+      end
+
+      it 'calls Hangouts Chat API for push events' do
+        chat_service.execute(push_sample_data)
+
+        expect(WebMock).to have_requested(:post, webhook_url).once
+      end
+
+      it 'specifies the webhook when it is configured' do
+        expect(HangoutsChat::Sender).to receive(:new).with(webhook_url).and_return(double(:hangouts_chat_service).as_null_object)
+
+        chat_service.execute(push_sample_data)
+      end
+    end
+
+    context 'with issue events' do
+      let(:opts) { { title: 'Awesome issue', description: 'please fix' } }
+      let(:issues_sample_data) do
+        service = Issues::CreateService.new(project, user, opts)
+        issue = service.execute
+        service.hook_data(issue, 'open')
+      end
+
+      it 'calls Hangouts Chat API' do
+        chat_service.execute(issues_sample_data)
+
+        expect(WebMock).to have_requested(:post, webhook_url).once
+      end
+    end
+
+    context 'with merge events' do
+      let(:opts) do
+        {
+          title: 'Awesome merge_request',
+          description: 'please fix',
+          source_branch: 'feature',
+          target_branch: 'master'
+        }
+      end
+
+      let(:merge_sample_data) do
+        service = MergeRequests::CreateService.new(project, user, opts)
+        merge_request = service.execute
+        service.hook_data(merge_request, 'open')
+      end
+
+      before do
+        project.add_developer(user)
+      end
+
+      it 'calls Hangouts Chat API' do
+        chat_service.execute(merge_sample_data)
+
+        expect(WebMock).to have_requested(:post, webhook_url).once
+      end
+    end
+
+    context 'with wiki page events' do
+      let(:opts) do
+        {
+          title: 'Awesome wiki_page',
+          content: 'Some text describing some thing or another',
+          format: 'md',
+          message: 'user created page: Awesome wiki_page'
+        }
+      end
+      let(:wiki_page) { create(:wiki_page, wiki: project.wiki, attrs: opts) }
+      let(:wiki_page_sample_data) { Gitlab::DataBuilder::WikiPage.build(wiki_page, user, 'create') }
+
+      it 'calls Hangouts Chat API' do
+        chat_service.execute(wiki_page_sample_data)
+
+        expect(WebMock).to have_requested(:post, webhook_url).once
+      end
+    end
+  end
+
+  describe 'Note events' do
+    let(:user) { create(:user) }
+    let(:project) { create(:project, :repository, creator: user) }
+
+    before do
+      allow(chat_service).to receive_messages(
+        project: project,
+        project_id: project.id,
+        service_hook: true,
+        webhook: webhook_url
+      )
+
+      WebMock.stub_request(:post, webhook_url)
+    end
+
+    context 'when commit comment event executed' do
+      let(:commit_note) do
+        create(:note_on_commit, author: user,
+                                project: project,
+                                commit_id: project.repository.commit.id,
+                                note: 'a comment on a commit')
+      end
+
+      it 'calls Hangouts Chat API for commit comment events' do
+        data = Gitlab::DataBuilder::Note.build(commit_note, user)
+
+        chat_service.execute(data)
+
+        expect(WebMock).to have_requested(:post, webhook_url).once
+      end
+    end
+
+    context 'when merge request comment event executed' do
+      let(:merge_request_note) do
+        create(:note_on_merge_request, project: project,
+                                       note: 'merge request note')
+      end
+
+      it 'calls Hangouts Chat API for merge request comment events' do
+        data = Gitlab::DataBuilder::Note.build(merge_request_note, user)
+
+        chat_service.execute(data)
+
+        expect(WebMock).to have_requested(:post, webhook_url).once
+      end
+    end
+
+    context 'when issue comment event executed' do
+      let(:issue_note) do
+        create(:note_on_issue, project: project, note: 'issue note')
+      end
+
+      it 'calls Hangouts Chat API for issue comment events' do
+        data = Gitlab::DataBuilder::Note.build(issue_note, user)
+
+        chat_service.execute(data)
+
+        expect(WebMock).to have_requested(:post, webhook_url).once
+      end
+    end
+
+    context 'when snippet comment event executed' do
+      let(:snippet_note) do
+        create(:note_on_project_snippet, project: project,
+                                         note: 'snippet note')
+      end
+
+      it 'calls Hangouts Chat API for snippet comment events' do
+        data = Gitlab::DataBuilder::Note.build(snippet_note, user)
+
+        chat_service.execute(data)
+
+        expect(WebMock).to have_requested(:post, webhook_url).once
+      end
+    end
+  end
+
+  describe 'Pipeline events' do
+    let(:user) { create(:user) }
+    let(:project) { create(:project, :repository) }
+
+    let(:pipeline) do
+      create(:ci_pipeline,
+             project: project, status: status,
+             sha: project.commit.sha, ref: project.default_branch)
+    end
+
+    before do
+      allow(chat_service).to receive_messages(
+        project: project,
+        service_hook: true,
+        webhook: webhook_url
+      )
+    end
+
+    shared_examples 'call Hangouts Chat API' do
+      before do
+        WebMock.stub_request(:post, webhook_url)
+      end
+
+      it 'calls Hangouts Chat API for pipeline events' do
+        data = Gitlab::DataBuilder::Pipeline.build(pipeline)
+
+        chat_service.execute(data)
+
+        expect(WebMock).to have_requested(:post, webhook_url).once
+      end
+    end
+
+    context 'with failed pipeline' do
+      let(:status) { 'failed' }
+
+      it_behaves_like 'call Hangouts Chat API'
+    end
+
+    context 'with succeeded pipeline' do
+      let(:status) { 'success' }
+
+      context 'with default to notify_only_broken_pipelines' do
+        it 'does not call Hangouts Chat API for pipeline events' do
+          data = Gitlab::DataBuilder::Pipeline.build(pipeline)
+          result = chat_service.execute(data)
+
+          expect(result).to be_falsy
+        end
+      end
+
+      context 'with setting notify_only_broken_pipelines to false' do
+        before do
+          chat_service.notify_only_broken_pipelines = false
+        end
+
+        it_behaves_like 'call Hangouts Chat API'
+      end
+    end
+
+    context 'only notify for the default branch' do
+      context 'when enabled' do
+        let(:pipeline) do
+          create(:ci_pipeline, project: project, status: 'failed', ref: 'not-the-default-branch')
+        end
+
+        before do
+          chat_service.notify_only_default_branch = true
+          WebMock.stub_request(:post, webhook_url)
+        end
+
+        it 'does not call the Hangouts Chat API for pipeline events' do
+          data = Gitlab::DataBuilder::Pipeline.build(pipeline)
+          result = chat_service.execute(data)
+
+          expect(result).to be_falsy
+        end
+
+        it 'does not notify push events if they are not for the default branch' do
+          ref = "#{Gitlab::Git::BRANCH_REF_PREFIX}test"
+          push_sample_data = Gitlab::DataBuilder::Push.build(project, user, nil, nil, ref, [])
+
+          chat_service.execute(push_sample_data)
+
+          expect(WebMock).not_to have_requested(:post, webhook_url)
+        end
+
+        it 'notifies about push events for the default branch' do
+          push_sample_data = Gitlab::DataBuilder::Push.build_sample(project, user)
+
+          chat_service.execute(push_sample_data)
+
+          expect(WebMock).to have_requested(:post, webhook_url).once
+        end
+      end
+
+      context 'when disabled' do
+        let(:pipeline) do
+          create(:ci_pipeline, :failed, project: project, ref: 'not-the-default-branch')
+        end
+
+        before do
+          chat_service.notify_only_default_branch = false
+        end
+
+        it_behaves_like 'call Hangouts Chat API'
+      end
+    end
+  end
+end