Merge branch 'refine-ci-statuses' into 'master'

Refine CI Statuses

## What does this MR do?

This MR introduces classes for each relevant CI status.

## What are the relevant issue numbers?

Closes #24273

See merge request !7889

12 files changed, 369 insertions, 0 deletions

diff --git a/spec/lib/gitlab/ci/status/canceled_spec.rb b/spec/lib/gitlab/ci/status/canceled_spec.rb
new file mode 100644
index 00000000000..619ecbcba67
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/canceled_spec.rb
@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Canceled do
+  subject { described_class.new(double('subject')) }
+
+  describe '#text' do
+    it { expect(subject.label).to eq 'canceled' }
+  end
+
+  describe '#label' do
+    it { expect(subject.label).to eq 'canceled' }
+  end
+
+  describe '#icon' do
+    it { expect(subject.icon).to eq 'icon_status_canceled' }
+  end
+
+  describe '#title' do
+    it { expect(subject.title).to eq 'Double: canceled' }
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/created_spec.rb b/spec/lib/gitlab/ci/status/created_spec.rb
new file mode 100644
index 00000000000..157302c65a8
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/created_spec.rb
@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Created do
+  subject { described_class.new(double('subject')) }
+
+  describe '#text' do
+    it { expect(subject.label).to eq 'created' }
+  end
+
+  describe '#label' do
+    it { expect(subject.label).to eq 'created' }
+  end
+
+  describe '#icon' do
+    it { expect(subject.icon).to eq 'icon_status_created' }
+  end
+
+  describe '#title' do
+    it { expect(subject.title).to eq 'Double: created' }
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/extended_spec.rb b/spec/lib/gitlab/ci/status/extended_spec.rb
new file mode 100644
index 00000000000..120e121aae5
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/extended_spec.rb
@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Extended do
+  subject do
+    Class.new.extend(described_class)
+  end
+
+  it 'requires subclass to implement matcher' do
+    expect { subject.matches?(double) }
+      .to raise_error(NotImplementedError)
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/failed_spec.rb b/spec/lib/gitlab/ci/status/failed_spec.rb
new file mode 100644
index 00000000000..0b3cb8168e6
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/failed_spec.rb
@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Failed do
+  subject { described_class.new(double('subject')) }
+
+  describe '#text' do
+    it { expect(subject.label).to eq 'failed' }
+  end
+
+  describe '#label' do
+    it { expect(subject.label).to eq 'failed' }
+  end
+
+  describe '#icon' do
+    it { expect(subject.icon).to eq 'icon_status_failed' }
+  end
+
+  describe '#title' do
+    it { expect(subject.title).to eq 'Double: failed' }
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/pending_spec.rb b/spec/lib/gitlab/ci/status/pending_spec.rb
new file mode 100644
index 00000000000..57c901c1202
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/pending_spec.rb
@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Pending do
+  subject { described_class.new(double('subject')) }
+
+  describe '#text' do
+    it { expect(subject.label).to eq 'pending' }
+  end
+
+  describe '#label' do
+    it { expect(subject.label).to eq 'pending' }
+  end
+
+  describe '#icon' do
+    it { expect(subject.icon).to eq 'icon_status_pending' }
+  end
+
+  describe '#title' do
+    it { expect(subject.title).to eq 'Double: pending' }
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/pipeline/common_spec.rb b/spec/lib/gitlab/ci/status/pipeline/common_spec.rb
new file mode 100644
index 00000000000..21adee3f8e7
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/pipeline/common_spec.rb
@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Pipeline::Common do
+  let(:pipeline) { create(:ci_pipeline) }
+
+  subject do
+    Class.new(Gitlab::Ci::Status::Core)
+      .new(pipeline).extend(described_class)
+  end
+
+  it 'does not have action' do
+    expect(subject).not_to have_action
+  end
+
+  it 'has details' do
+    expect(subject).to have_details
+  end
+
+  it 'links to the pipeline details page' do
+    expect(subject.details_path)
+      .to include "pipelines/#{pipeline.id}"
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/pipeline/factory_spec.rb b/spec/lib/gitlab/ci/status/pipeline/factory_spec.rb
new file mode 100644
index 00000000000..d6243940f2e
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/pipeline/factory_spec.rb
@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Pipeline::Factory do
+  subject do
+    described_class.new(pipeline)
+  end
+
+  let(:status) do
+    subject.fabricate!
+  end
+
+  context 'when pipeline has a core status' do
+    HasStatus::AVAILABLE_STATUSES.each do |core_status|
+      context "when core status is #{core_status}" do
+        let(:pipeline) do
+          create(:ci_pipeline, status: core_status)
+        end
+
+        it "fabricates a core status #{core_status}" do
+          expect(status).to be_a(
+            Gitlab::Ci::Status.const_get(core_status.capitalize))
+        end
+
+        it 'extends core status with common pipeline methods' do
+          expect(status).to have_details
+          expect(status).not_to have_action
+          expect(status.details_path)
+            .to include "pipelines/#{pipeline.id}"
+        end
+      end
+    end
+  end
+
+  context 'when pipeline has warnings' do
+    let(:pipeline) do
+      create(:ci_pipeline, status: :success)
+    end
+
+    before do
+      create(:ci_build, :allowed_to_fail, :failed, pipeline: pipeline)
+    end
+
+    it 'fabricates extended "success with warnings" status' do
+      expect(status)
+        .to be_a Gitlab::Ci::Status::Pipeline::SuccessWithWarnings
+    end
+
+    it 'extends core status with common pipeline methods' do
+      expect(status).to have_details
+    end
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/pipeline/success_with_warnings_spec.rb b/spec/lib/gitlab/ci/status/pipeline/success_with_warnings_spec.rb
new file mode 100644
index 00000000000..02e526e3de2
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/pipeline/success_with_warnings_spec.rb
@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Pipeline::SuccessWithWarnings do
+  subject do
+    described_class.new(double('status'))
+  end
+
+  describe '#test' do
+    it { expect(subject.text).to eq 'passed' }
+  end
+
+  describe '#label' do
+    it { expect(subject.label).to eq 'passed with warnings' }
+  end
+
+  describe '#icon' do
+    it { expect(subject.icon).to eq 'icon_status_warning' }
+  end
+
+  describe '.matches?' do
+    context 'when pipeline is successful' do
+      let(:pipeline) do
+        create(:ci_pipeline, status: :success)
+      end
+
+      context 'when pipeline has warnings' do
+        before do
+          allow(pipeline).to receive(:has_warnings?).and_return(true)
+        end
+
+        it 'is a correct match' do
+          expect(described_class.matches?(pipeline)).to eq true
+        end
+      end
+
+      context 'when pipeline does not have warnings' do
+        it 'does not match' do
+          expect(described_class.matches?(pipeline)).to eq false
+        end
+      end
+    end
+
+    context 'when pipeline is not successful' do
+      let(:pipeline) do
+        create(:ci_pipeline, status: :skipped)
+      end
+
+      context 'when pipeline has warnings' do
+        before do
+          allow(pipeline).to receive(:has_warnings?).and_return(true)
+        end
+
+        it 'does not match' do
+          expect(described_class.matches?(pipeline)).to eq false
+        end
+      end
+
+      context 'when pipeline does not have warnings' do
+        it 'does not match' do
+          expect(described_class.matches?(pipeline)).to eq false
+        end
+      end
+    end
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/running_spec.rb b/spec/lib/gitlab/ci/status/running_spec.rb
new file mode 100644
index 00000000000..c023f1872cc
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/running_spec.rb
@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Running do
+  subject { described_class.new(double('subject')) }
+
+  describe '#text' do
+    it { expect(subject.label).to eq 'running' }
+  end
+
+  describe '#label' do
+    it { expect(subject.label).to eq 'running' }
+  end
+
+  describe '#icon' do
+    it { expect(subject.icon).to eq 'icon_status_running' }
+  end
+
+  describe '#title' do
+    it { expect(subject.title).to eq 'Double: running' }
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/skipped_spec.rb b/spec/lib/gitlab/ci/status/skipped_spec.rb
new file mode 100644
index 00000000000..d4f7f4b3b70
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/skipped_spec.rb
@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Skipped do
+  subject { described_class.new(double('subject')) }
+
+  describe '#text' do
+    it { expect(subject.label).to eq 'skipped' }
+  end
+
+  describe '#label' do
+    it { expect(subject.label).to eq 'skipped' }
+  end
+
+  describe '#icon' do
+    it { expect(subject.icon).to eq 'icon_status_skipped' }
+  end
+
+  describe '#title' do
+    it { expect(subject.title).to eq 'Double: skipped' }
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/success_spec.rb b/spec/lib/gitlab/ci/status/success_spec.rb
new file mode 100644
index 00000000000..9e261a3aa5f
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/success_spec.rb
@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Success do
+  subject { described_class.new(double('subject')) }
+
+  describe '#text' do
+    it { expect(subject.label).to eq 'passed' }
+  end
+
+  describe '#label' do
+    it { expect(subject.label).to eq 'passed' }
+  end
+
+  describe '#icon' do
+    it { expect(subject.icon).to eq 'icon_status_success' }
+  end
+
+  describe '#title' do
+    it { expect(subject.title).to eq 'Double: passed' }
+  end
+end
diff --git a/spec/models/ci/pipeline_spec.rb b/spec/models/ci/pipeline_spec.rb
index 0d2b4920835..3f93d9ddf19 100644
--- a/spec/models/ci/pipeline_spec.rb
+++ b/spec/models/ci/pipeline_spec.rb
@@ -404,6 +404,76 @@ describe Ci::Pipeline, models: true do
     end
   end
 
+  describe '#detailed_status' do
+    context 'when pipeline is created' do
+      let(:pipeline) { create(:ci_pipeline, status: :created) }
+
+      it 'returns detailed status for created pipeline' do
+        expect(pipeline.detailed_status.text).to eq 'created'
+      end
+    end
+
+    context 'when pipeline is pending' do
+      let(:pipeline) { create(:ci_pipeline, status: :pending) }
+
+      it 'returns detailed status for pending pipeline' do
+        expect(pipeline.detailed_status.text).to eq 'pending'
+      end
+    end
+
+    context 'when pipeline is running' do
+      let(:pipeline) { create(:ci_pipeline, status: :running) }
+
+      it 'returns detailed status for running pipeline' do
+        expect(pipeline.detailed_status.text).to eq 'running'
+      end
+    end
+
+    context 'when pipeline is successful' do
+      let(:pipeline) { create(:ci_pipeline, status: :success) }
+
+      it 'returns detailed status for successful pipeline' do
+        expect(pipeline.detailed_status.text).to eq 'passed'
+      end
+    end
+
+    context 'when pipeline is failed' do
+      let(:pipeline) { create(:ci_pipeline, status: :failed) }
+
+      it 'returns detailed status for failed pipeline' do
+        expect(pipeline.detailed_status.text).to eq 'failed'
+      end
+    end
+
+    context 'when pipeline is canceled' do
+      let(:pipeline) { create(:ci_pipeline, status: :canceled) }
+
+      it 'returns detailed status for canceled pipeline' do
+        expect(pipeline.detailed_status.text).to eq 'canceled'
+      end
+    end
+
+    context 'when pipeline is skipped' do
+      let(:pipeline) { create(:ci_pipeline, status: :skipped) }
+
+      it 'returns detailed status for skipped pipeline' do
+        expect(pipeline.detailed_status.text).to eq 'skipped'
+      end
+    end
+
+    context 'when pipeline is successful but with warnings' do
+      let(:pipeline) { create(:ci_pipeline, status: :success) }
+
+      before do
+        create(:ci_build, :allowed_to_fail, :failed, pipeline: pipeline)
+      end
+
+      it 'retruns detailed status for successful pipeline with warnings' do
+        expect(pipeline.detailed_status.label).to eq 'passed with warnings'
+      end
+    end
+  end
+
   describe '#cancelable?' do
     %i[created running pending].each do |status0|
       context "when there is a build #{status0}" do