Move ChatOps to Core

ChatOps used to be in the Ultimate tier.

12 files changed, 628 insertions, 0 deletions

diff --git a/spec/lib/gitlab/chat/command_spec.rb b/spec/lib/gitlab/chat/command_spec.rb
new file mode 100644
index 00000000000..46d23ab2b62
--- /dev/null
+++ b/spec/lib/gitlab/chat/command_spec.rb
@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::Chat::Command do
+  let(:chat_name) { create(:chat_name) }
+
+  let(:command) do
+    described_class.new(
+      project: project,
+      chat_name: chat_name,
+      name: 'spinach',
+      arguments: 'foo',
+      channel: '123',
+      response_url: 'http://example.com'
+    )
+  end
+
+  describe '#try_create_pipeline' do
+    let(:project) { create(:project) }
+
+    it 'returns nil when the command is not valid' do
+      expect(command)
+        .to receive(:valid?)
+        .and_return(false)
+
+      expect(command.try_create_pipeline).to be_nil
+    end
+
+    it 'tries to create the pipeline when a command is valid' do
+      expect(command)
+        .to receive(:valid?)
+        .and_return(true)
+
+      expect(command)
+        .to receive(:create_pipeline)
+
+      command.try_create_pipeline
+    end
+  end
+
+  describe '#create_pipeline' do
+    let(:project) { create(:project, :test_repo) }
+    let(:pipeline) { command.create_pipeline }
+
+    before do
+      stub_repository_ci_yaml_file(sha: project.commit.id)
+
+      project.add_developer(chat_name.user)
+    end
+
+    it 'creates the pipeline' do
+      expect(pipeline).to be_persisted
+    end
+
+    it 'creates the chat data for the pipeline' do
+      expect(pipeline.chat_data).to be_an_instance_of(Ci::PipelineChatData)
+    end
+
+    it 'stores the chat name ID in the chat data' do
+      expect(pipeline.chat_data.chat_name_id).to eq(chat_name.id)
+    end
+
+    it 'stores the response URL in the chat data' do
+      expect(pipeline.chat_data.response_url).to eq('http://example.com')
+    end
+
+    it 'creates the environment variables for the pipeline' do
+      vars = pipeline.variables.each_with_object({}) do |row, hash|
+        hash[row.key] = row.value
+      end
+
+      expect(vars['CHAT_INPUT']).to eq('foo')
+      expect(vars['CHAT_CHANNEL']).to eq('123')
+    end
+  end
+end
diff --git a/spec/lib/gitlab/chat/output_spec.rb b/spec/lib/gitlab/chat/output_spec.rb
new file mode 100644
index 00000000000..b179f9e9d0a
--- /dev/null
+++ b/spec/lib/gitlab/chat/output_spec.rb
@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::Chat::Output do
+  let(:build) do
+    create(:ci_build, pipeline: create(:ci_pipeline, source: :chat))
+  end
+
+  let(:output) { described_class.new(build) }
+
+  describe '#to_s' do
+    it 'returns the build output as a String' do
+      trace = Gitlab::Ci::Trace.new(build)
+
+      trace.set("echo hello\nhello")
+
+      allow(build)
+        .to receive(:trace)
+        .and_return(trace)
+
+      allow(output)
+        .to receive(:read_offset_and_length)
+        .and_return([0, 13])
+
+      expect(output.to_s).to eq('he')
+    end
+  end
+
+  describe '#read_offset_and_length' do
+    context 'without the chat_reply trace section' do
+      it 'falls back to using the build_script trace section' do
+        expect(output)
+          .to receive(:find_build_trace_section)
+          .with('chat_reply')
+          .and_return(nil)
+
+        expect(output)
+          .to receive(:find_build_trace_section)
+          .with('build_script')
+          .and_return({ name: 'build_script', byte_start: 1, byte_end: 4 })
+
+        expect(output.read_offset_and_length).to eq([1, 3])
+      end
+    end
+
+    context 'without the build_script trace section' do
+      it 'raises MissingBuildSectionError' do
+        expect { output.read_offset_and_length }
+          .to raise_error(described_class::MissingBuildSectionError)
+      end
+    end
+
+    context 'with the chat_reply trace section' do
+      it 'returns the read offset and length as an Array' do
+        trace = Gitlab::Ci::Trace.new(build)
+
+        allow(build)
+          .to receive(:trace)
+          .and_return(trace)
+
+        allow(trace)
+          .to receive(:extract_sections)
+          .and_return([{ name: 'chat_reply', byte_start: 1, byte_end: 4 }])
+
+        expect(output.read_offset_and_length).to eq([1, 3])
+      end
+    end
+  end
+
+  describe '#without_executed_command_line' do
+    it 'returns the input without the first line' do
+      expect(output.without_executed_command_line("hello\nworld"))
+        .to eq('world')
+    end
+
+    it 'returns an empty String when the input is empty' do
+      expect(output.without_executed_command_line('')).to eq('')
+    end
+
+    it 'returns an empty String when the input consits of a single newline' do
+      expect(output.without_executed_command_line("\n")).to eq('')
+    end
+  end
+
+  describe '#find_build_trace_section' do
+    it 'returns nil when no section could be found' do
+      expect(output.find_build_trace_section('foo')).to be_nil
+    end
+
+    it 'returns the trace section when it could be found' do
+      section = { name: 'chat_reply', byte_start: 1, byte_end: 4 }
+
+      allow(output)
+        .to receive(:trace_sections)
+        .and_return([section])
+
+      expect(output.find_build_trace_section('chat_reply')).to eq(section)
+    end
+  end
+end
diff --git a/spec/lib/gitlab/chat/responder/base_spec.rb b/spec/lib/gitlab/chat/responder/base_spec.rb
new file mode 100644
index 00000000000..7fa9bad9d38
--- /dev/null
+++ b/spec/lib/gitlab/chat/responder/base_spec.rb
@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::Chat::Responder::Base do
+  let(:project) { double(:project) }
+  let(:pipeline) { double(:pipeline, project: project) }
+  let(:build) { double(:build, pipeline: pipeline) }
+  let(:responder) { described_class.new(build) }
+
+  describe '#pipeline' do
+    it 'returns the pipeline' do
+      expect(responder.pipeline).to eq(pipeline)
+    end
+  end
+
+  describe '#project' do
+    it 'returns the project' do
+      expect(responder.project).to eq(project)
+    end
+  end
+
+  describe '#success' do
+    it 'raises NotImplementedError' do
+      expect { responder.success }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#failure' do
+    it 'raises NotImplementedError' do
+      expect { responder.failure }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#send_response' do
+    it 'raises NotImplementedError' do
+      expect { responder.send_response('hello') }
+        .to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#scheduled_output' do
+    it 'raises NotImplementedError' do
+      expect { responder.scheduled_output }
+        .to raise_error(NotImplementedError)
+    end
+  end
+end
diff --git a/spec/lib/gitlab/chat/responder/slack_spec.rb b/spec/lib/gitlab/chat/responder/slack_spec.rb
new file mode 100644
index 00000000000..a1553232b32
--- /dev/null
+++ b/spec/lib/gitlab/chat/responder/slack_spec.rb
@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::Chat::Responder::Slack do
+  let(:chat_name) { create(:chat_name, chat_id: 'U123') }
+
+  let(:pipeline) do
+    pipeline = create(:ci_pipeline)
+
+    pipeline.create_chat_data!(
+      response_url: 'http://example.com',
+      chat_name_id: chat_name.id
+    )
+
+    pipeline
+  end
+
+  let(:build) { create(:ci_build, pipeline: pipeline) }
+  let(:responder) { described_class.new(build) }
+
+  describe '#send_response' do
+    it 'sends a response back to Slack' do
+      expect(Gitlab::HTTP).to receive(:post).with(
+        'http://example.com',
+        { headers: { Accept: 'application/json' }, body: 'hello'.to_json }
+      )
+
+      responder.send_response('hello')
+    end
+  end
+
+  describe '#success' do
+    it 'returns the output for a successful build' do
+      expect(responder)
+        .to receive(:send_response)
+        .with(hash_including(text: /<@U123>:.+hello/, response_type: :in_channel))
+
+      responder.success('hello')
+    end
+
+    it 'limits the output to a fixed size' do
+      expect(responder)
+        .to receive(:send_response)
+        .with(hash_including(text: /The output is too large/))
+
+      responder.success('a' * 4000)
+    end
+
+    it 'does not send a response if the output is empty' do
+      expect(responder).not_to receive(:send_response)
+
+      responder.success('')
+    end
+  end
+
+  describe '#failure' do
+    it 'returns the output for a failed build' do
+      expect(responder).to receive(:send_response).with(
+        hash_including(
+          text: /<@U123>:.+Sorry, the build failed!/,
+          response_type: :in_channel
+        )
+      )
+
+      responder.failure
+    end
+  end
+
+  describe '#scheduled_output' do
+    it 'returns the output for a scheduled build' do
+      output = responder.scheduled_output
+
+      expect(output).to eq({ text: '' })
+    end
+  end
+end
diff --git a/spec/lib/gitlab/chat/responder_spec.rb b/spec/lib/gitlab/chat/responder_spec.rb
new file mode 100644
index 00000000000..9893689cba9
--- /dev/null
+++ b/spec/lib/gitlab/chat/responder_spec.rb
@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::Chat::Responder do
+  describe '.responder_for' do
+    context 'using a regular build' do
+      it 'returns nil' do
+        build = create(:ci_build)
+
+        expect(described_class.responder_for(build)).to be_nil
+      end
+    end
+
+    context 'using a chat build' do
+      it 'returns the responder for the build' do
+        pipeline = create(:ci_pipeline)
+        build = create(:ci_build, pipeline: pipeline)
+        service = double(:service, chat_responder: Gitlab::Chat::Responder::Slack)
+        chat_name = double(:chat_name, service: service)
+        chat_data = double(:chat_data, chat_name: chat_name)
+
+        allow(pipeline)
+          .to receive(:chat_data)
+          .and_return(chat_data)
+
+        expect(described_class.responder_for(build))
+          .to be_an_instance_of(Gitlab::Chat::Responder::Slack)
+      end
+    end
+  end
+end
diff --git a/spec/lib/gitlab/chat_spec.rb b/spec/lib/gitlab/chat_spec.rb
new file mode 100644
index 00000000000..d61c4b36668
--- /dev/null
+++ b/spec/lib/gitlab/chat_spec.rb
@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Gitlab::Chat, :use_clean_rails_memory_store_caching do
+  describe '.available?' do
+    it 'returns true when the chatops feature is available' do
+      allow(Feature)
+        .to receive(:enabled?)
+        .with(:chatops, default_enabled: true)
+        .and_return(true)
+
+      expect(described_class).to be_available
+    end
+
+    it 'returns false when the chatops feature is not available' do
+      allow(Feature)
+        .to receive(:enabled?)
+        .with(:chatops, default_enabled: true)
+        .and_return(false)
+
+      expect(described_class).not_to be_available
+    end
+  end
+end
diff --git a/spec/lib/gitlab/ci/pipeline/chain/remove_unwanted_chat_jobs_spec.rb b/spec/lib/gitlab/ci/pipeline/chain/remove_unwanted_chat_jobs_spec.rb
new file mode 100644
index 00000000000..7c1c016b4bb
--- /dev/null
+++ b/spec/lib/gitlab/ci/pipeline/chain/remove_unwanted_chat_jobs_spec.rb
@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::Ci::Pipeline::Chain::RemoveUnwantedChatJobs do
+  let(:project) { create(:project, :repository) }
+
+  let(:pipeline) do
+    build(:ci_pipeline_with_one_job, project: project, ref: 'master')
+  end
+
+  let(:command) do
+    double(:command, project: project, chat_data: { command: 'echo' })
+  end
+
+  describe '#perform!' do
+    it 'removes unwanted jobs for chat pipelines' do
+      allow(pipeline).to receive(:chat?).and_return(true)
+
+      pipeline.config_processor.jobs[:echo] = double(:job)
+
+      described_class.new(pipeline, command).perform!
+
+      expect(pipeline.config_processor.jobs.keys).to eq([:echo])
+    end
+  end
+
+  it 'does not remove any jobs for non-chat pipelines' do
+    described_class.new(pipeline, command).perform!
+
+    expect(pipeline.config_processor.jobs.keys).to eq([:rspec])
+  end
+end
diff --git a/spec/lib/gitlab/import_export/all_models.yml b/spec/lib/gitlab/import_export/all_models.yml
index c15b360b563..f2eccec4635 100644
--- a/spec/lib/gitlab/import_export/all_models.yml
+++ b/spec/lib/gitlab/import_export/all_models.yml
@@ -131,6 +131,7 @@ ci_pipelines:
 - merge_request
 - deployments
 - environments
+- chat_data
 pipeline_variables:
 - pipeline
 stages:
diff --git a/spec/lib/gitlab/slash_commands/application_help_spec.rb b/spec/lib/gitlab/slash_commands/application_help_spec.rb
new file mode 100644
index 00000000000..b203a1ee79c
--- /dev/null
+++ b/spec/lib/gitlab/slash_commands/application_help_spec.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::SlashCommands::ApplicationHelp do
+  let(:params) { { command: '/gitlab', text: 'help' } }
+
+  describe '#execute' do
+    subject do
+      described_class.new(params).execute
+    end
+
+    it 'displays the help section' do
+      expect(subject[:response_type]).to be(:ephemeral)
+      expect(subject[:text]).to include('Available commands')
+      expect(subject[:text]).to include('/gitlab [project name or alias] issue show')
+    end
+  end
+end
diff --git a/spec/lib/gitlab/slash_commands/presenters/error_spec.rb b/spec/lib/gitlab/slash_commands/presenters/error_spec.rb
new file mode 100644
index 00000000000..30ff81510c1
--- /dev/null
+++ b/spec/lib/gitlab/slash_commands/presenters/error_spec.rb
@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::SlashCommands::Presenters::Error do
+  subject { described_class.new('Error').message }
+
+  it { is_expected.to be_a(Hash) }
+
+  it 'shows the error message' do
+    expect(subject[:response_type]).to be(:ephemeral)
+    expect(subject[:status]).to eq(200)
+    expect(subject[:text]).to eq('Error')
+  end
+end
diff --git a/spec/lib/gitlab/slash_commands/presenters/run_spec.rb b/spec/lib/gitlab/slash_commands/presenters/run_spec.rb
new file mode 100644
index 00000000000..f3ab01ef6bb
--- /dev/null
+++ b/spec/lib/gitlab/slash_commands/presenters/run_spec.rb
@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::SlashCommands::Presenters::Run do
+  let(:presenter) { described_class.new }
+
+  describe '#present' do
+    context 'when no builds are present' do
+      it 'returns an error' do
+        builds = double(:builds, take: nil)
+        pipeline = double(:pipeline, builds: builds)
+
+        expect(presenter)
+          .to receive(:unsupported_chat_service)
+
+        presenter.present(pipeline)
+      end
+    end
+
+    context 'when a responder could be found' do
+      it 'returns the output for a scheduled pipeline' do
+        responder = double(:responder, scheduled_output: 'hello')
+        build = double(:build)
+        builds = double(:builds, take: build)
+        pipeline = double(:pipeline, builds: builds)
+
+        allow(Gitlab::Chat::Responder)
+          .to receive(:responder_for)
+          .with(build)
+          .and_return(responder)
+
+        expect(presenter)
+          .to receive(:in_channel_response)
+          .with('hello')
+
+        presenter.present(pipeline)
+      end
+    end
+
+    context 'when a responder could not be found' do
+      it 'returns an error' do
+        build = double(:build)
+        builds = double(:builds, take: build)
+        pipeline = double(:pipeline, builds: builds)
+
+        allow(Gitlab::Chat::Responder)
+          .to receive(:responder_for)
+          .with(build)
+          .and_return(nil)
+
+        expect(presenter)
+          .to receive(:unsupported_chat_service)
+
+        presenter.present(pipeline)
+      end
+    end
+  end
+
+  describe '#unsupported_chat_service' do
+    it 'returns an ephemeral response' do
+      expect(presenter)
+        .to receive(:ephemeral_response)
+        .with(text: /Sorry, this chat service is currently not supported/)
+
+      presenter.unsupported_chat_service
+    end
+  end
+
+  describe '#failed_to_schedule' do
+    it 'returns an ephemeral response' do
+      expect(presenter)
+        .to receive(:ephemeral_response)
+        .with(text: /The command could not be scheduled/)
+
+      presenter.failed_to_schedule('foo')
+    end
+  end
+end
diff --git a/spec/lib/gitlab/slash_commands/run_spec.rb b/spec/lib/gitlab/slash_commands/run_spec.rb
new file mode 100644
index 00000000000..900fae05719
--- /dev/null
+++ b/spec/lib/gitlab/slash_commands/run_spec.rb
@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::SlashCommands::Run do
+  describe '.available?' do
+    it 'returns true when builds are enabled for the project' do
+      project = double(:project, builds_enabled?: true)
+
+      allow(Gitlab::Chat)
+        .to receive(:available?)
+        .and_return(true)
+
+      expect(described_class.available?(project)).to eq(true)
+    end
+
+    it 'returns false when builds are disabled for the project' do
+      project = double(:project, builds_enabled?: false)
+
+      expect(described_class.available?(project)).to eq(false)
+    end
+
+    it 'returns false when chatops is not available' do
+      allow(Gitlab::Chat)
+        .to receive(:available?)
+        .and_return(false)
+
+      project = double(:project, builds_enabled?: true)
+
+      expect(described_class.available?(project)).to eq(false)
+    end
+  end
+
+  describe '.allowed?' do
+    it 'returns true when the user can create a pipeline' do
+      project = create(:project)
+
+      expect(described_class.allowed?(project, project.creator)).to eq(true)
+    end
+
+    it 'returns false when the user can not create a pipeline' do
+      project = create(:project)
+      user = create(:user)
+
+      expect(described_class.allowed?(project, user)).to eq(false)
+    end
+  end
+
+  describe '#execute' do
+    let(:chat_name) { create(:chat_name) }
+    let(:project) { create(:project) }
+
+    let(:command) do
+      described_class.new(project, chat_name, response_url: 'http://example.com')
+    end
+
+    context 'when a pipeline could not be scheduled' do
+      it 'returns an error' do
+        expect_any_instance_of(Gitlab::Chat::Command)
+          .to receive(:try_create_pipeline)
+          .and_return(nil)
+
+        expect_any_instance_of(Gitlab::SlashCommands::Presenters::Run)
+          .to receive(:failed_to_schedule)
+          .with('foo')
+
+        command.execute(command: 'foo', arguments: '')
+      end
+    end
+
+    context 'when a pipeline could be created but the chat service was not supported' do
+      it 'returns an error' do
+        build = double(:build)
+        pipeline = double(
+          :pipeline,
+          builds: double(:relation, take: build),
+          persisted?: true
+        )
+
+        expect_any_instance_of(Gitlab::Chat::Command)
+          .to receive(:try_create_pipeline)
+          .and_return(pipeline)
+
+        expect(Gitlab::Chat::Responder)
+          .to receive(:responder_for)
+          .with(build)
+          .and_return(nil)
+
+        expect_any_instance_of(Gitlab::SlashCommands::Presenters::Run)
+          .to receive(:unsupported_chat_service)
+
+        command.execute(command: 'foo', arguments: '')
+      end
+    end
+
+    context 'using a valid pipeline' do
+      it 'schedules the pipeline' do
+        responder = double(:responder, scheduled_output: 'hello')
+        build = double(:build)
+        pipeline = double(
+          :pipeline,
+          builds: double(:relation, take: build),
+          persisted?: true
+        )
+
+        expect_any_instance_of(Gitlab::Chat::Command)
+          .to receive(:try_create_pipeline)
+          .and_return(pipeline)
+
+        expect(Gitlab::Chat::Responder)
+          .to receive(:responder_for)
+          .with(build)
+          .and_return(responder)
+
+        expect_any_instance_of(Gitlab::SlashCommands::Presenters::Run)
+          .to receive(:in_channel_response)
+          .with(responder.scheduled_output)
+
+        command.execute(command: 'foo', arguments: '')
+      end
+    end
+  end
+end