Move ChatOps to Core

ChatOps used to be in the Ultimate tier.

5 files changed, 335 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