Merge branch 'pipeline-stage' into 'master'

Refine pipeline stages

## What does this MR do?

Introduces a concept of `Ci::Stage` to make it easier to have detailed statuses.

## Why was this MR needed?

This is needed to simplify the handling of `Ci::Statuses` and make the `Stage` actual concept in code:
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7889

See merge request !7927

8 files changed, 279 insertions, 54 deletions

diff --git a/spec/factories/ci/stages.rb b/spec/factories/ci/stages.rb
new file mode 100644
index 00000000000..ee3b17b8bf1
--- /dev/null
+++ b/spec/factories/ci/stages.rb
@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  factory :ci_stage, class: Ci::Stage do
+    transient do
+      name 'test'
+      status nil
+      pipeline factory: :ci_empty_pipeline
+    end
+
+    initialize_with do
+      Ci::Stage.new(pipeline, name: name, status: status)
+    end
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/factory_spec.rb b/spec/lib/gitlab/ci/status/factory_spec.rb
new file mode 100644
index 00000000000..d5bd7f7102b
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/factory_spec.rb
@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Factory do
+  subject do
+    described_class.new(object)
+  end
+
+  let(:status) { subject.fabricate! }
+
+  context 'when object has a core status' do
+    HasStatus::AVAILABLE_STATUSES.each do |core_status|
+      context "when core status is #{core_status}" do
+        let(:object) { double(status: core_status) }
+
+        it "fabricates a core status #{core_status}" do
+          expect(status).to be_a(
+            Gitlab::Ci::Status.const_get(core_status.capitalize))
+        end
+      end
+    end
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/stage/common_spec.rb b/spec/lib/gitlab/ci/status/stage/common_spec.rb
new file mode 100644
index 00000000000..f3259c6f23e
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/stage/common_spec.rb
@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Stage::Common do
+  let(:pipeline) { create(:ci_empty_pipeline) }
+  let(:stage) { build(:ci_stage, pipeline: pipeline, name: 'test') }
+
+  subject do
+    Class.new(Gitlab::Ci::Status::Core)
+      .new(stage).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}"
+    expect(subject.details_path)
+      .to include "##{stage.name}"
+  end
+end
diff --git a/spec/lib/gitlab/ci/status/stage/factory_spec.rb b/spec/lib/gitlab/ci/status/stage/factory_spec.rb
new file mode 100644
index 00000000000..17929665c83
--- /dev/null
+++ b/spec/lib/gitlab/ci/status/stage/factory_spec.rb
@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Gitlab::Ci::Status::Stage::Factory do
+  let(:pipeline) { create(:ci_empty_pipeline) }
+  let(:stage) { build(:ci_stage, pipeline: pipeline, name: 'test') }
+
+  subject do
+    described_class.new(stage)
+  end
+
+  let(:status) do
+    subject.fabricate!
+  end
+
+  context 'when stage has a core status' do
+    HasStatus::AVAILABLE_STATUSES.each do |core_status|
+      context "when core status is #{core_status}" do
+        before do
+          create(:ci_build, pipeline: pipeline, stage: 'test', status: core_status)
+          create(:commit_status, pipeline: pipeline, stage: 'test', status: core_status)
+          create(:ci_build, pipeline: pipeline, stage: 'build', status: :failed)
+        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 stage methods' do
+          expect(status).to have_details
+          expect(status.details_path).to include "pipelines/#{pipeline.id}"
+          expect(status.details_path).to include "##{stage.name}"
+        end
+      end
+    end
+  end
+end
diff --git a/spec/models/ci/pipeline_spec.rb b/spec/models/ci/pipeline_spec.rb
index 3f93d9ddf19..8158e71dd55 100644
--- a/spec/models/ci/pipeline_spec.rb
+++ b/spec/models/ci/pipeline_spec.rb
@@ -20,8 +20,6 @@ describe Ci::Pipeline, models: true do
   it { is_expected.to respond_to :git_author_email }
   it { is_expected.to respond_to :short_sha }
 
-  it { is_expected.to delegate_method(:stages).to(:statuses) }
-
   describe '#valid_commit_sha' do
     context 'commit.sha can not start with 00000000' do
       before do
@@ -125,16 +123,55 @@ describe Ci::Pipeline, models: true do
   end
 
   describe '#stages' do
-    let(:pipeline2) { FactoryGirl.create :ci_pipeline, project: project }
-    subject { CommitStatus.where(pipeline: [pipeline, pipeline2]).stages }
-
     before do
-      FactoryGirl.create :ci_build, pipeline: pipeline2, stage: 'test', stage_idx: 1
-      FactoryGirl.create :ci_build, pipeline: pipeline, stage: 'build', stage_idx: 0
+      create(:commit_status, pipeline: pipeline, stage: 'build', name: 'linux', stage_idx: 0, status: 'success')
+      create(:commit_status, pipeline: pipeline, stage: 'build', name: 'mac', stage_idx: 0, status: 'failed')
+      create(:commit_status, pipeline: pipeline, stage: 'deploy', name: 'staging', stage_idx: 2, status: 'running')
+      create(:commit_status, pipeline: pipeline, stage: 'test', name: 'rspec', stage_idx: 1, status: 'success')
+    end
+
+    subject { pipeline.stages }
+
+    context 'stages list' do
+      it 'returns ordered list of stages' do
+        expect(subject.map(&:name)).to eq(%w[build test deploy])
+      end
+    end
+
+    it 'returns a valid number of stages' do
+      expect(pipeline.stages_count).to eq(3)
+    end
+
+    it 'returns a valid names of stages' do
+      expect(pipeline.stages_name).to eq(['build', 'test', 'deploy'])
     end
 
-    it 'return all stages' do
-      is_expected.to eq(%w(build test))
+    context 'stages with statuses' do
+      let(:statuses) do
+        subject.map do |stage|
+          [stage.name, stage.status]
+        end
+      end
+
+      it 'returns list of stages with statuses' do
+        expect(statuses).to eq([['build', 'failed'],
+                                ['test', 'success'],
+                                ['deploy', 'running']
+                               ])
+      end
+
+      context 'when build is retried' do
+        before do
+          create(:commit_status, pipeline: pipeline, stage: 'build', name: 'mac', stage_idx: 0, status: 'success')
+        end
+
+        it 'ignores the previous state' do
+          expect(statuses).to eq([['build', 'success'],
+                                  ['test', 'success'],
+                                  ['deploy', 'running']
+                                 ])
+        end
+      end
     end
   end
 
diff --git a/spec/models/ci/stage_spec.rb b/spec/models/ci/stage_spec.rb
new file mode 100644
index 00000000000..f232761dba2
--- /dev/null
+++ b/spec/models/ci/stage_spec.rb
@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe Ci::Stage, models: true do
+  let(:stage) { build(:ci_stage) }
+  let(:pipeline) { stage.pipeline }
+  let(:stage_name) { stage.name }
+
+  describe '#expectations' do
+    subject { stage }
+
+    it { is_expected.to include_module(StaticModel) }
+
+    it { is_expected.to respond_to(:pipeline) }
+    it { is_expected.to respond_to(:name) }
+
+    it { is_expected.to delegate_method(:project).to(:pipeline) }
+  end
+
+  describe '#statuses' do
+    let!(:stage_build) { create_job(:ci_build) }
+    let!(:commit_status) { create_job(:commit_status) }
+    let!(:other_build) { create_job(:ci_build, stage: 'other stage') }
+
+    subject { stage.statuses }
+
+    it "returns only matching statuses" do
+      is_expected.to contain_exactly(stage_build, commit_status)
+    end
+  end
+
+  describe '#builds' do
+    let!(:stage_build) { create_job(:ci_build) }
+    let!(:commit_status) { create_job(:commit_status) }
+
+    subject { stage.builds }
+
+    it "returns only builds" do
+      is_expected.to contain_exactly(stage_build)
+    end
+  end
+
+  describe '#status' do
+    subject { stage.status }
+
+    context 'if status is already defined' do
+      let(:stage) { build(:ci_stage, status: 'success') }
+
+      it "returns defined status" do
+        is_expected.to eq('success')
+      end
+    end
+
+    context 'if status has to be calculated' do
+      let!(:stage_build) { create_job(:ci_build, status: :failed) }
+
+      it "returns status of a build" do
+        is_expected.to eq('failed')
+      end
+
+      context 'and builds are retried' do
+        let!(:new_build) { create_job(:ci_build, status: :success) }
+
+        it "returns status of latest build" do
+          is_expected.to eq('success')
+        end
+      end
+    end
+  end
+
+  describe '#detailed_status' do
+    subject { stage.detailed_status }
+
+    context 'when build is created' do
+      let!(:stage_build) { create_job(:ci_build, status: :created) }
+
+      it 'returns detailed status for created stage' do
+        expect(subject.text).to eq 'created'
+      end
+    end
+
+    context 'when build is pending' do
+      let!(:stage_build) { create_job(:ci_build, status: :pending) }
+
+      it 'returns detailed status for pending stage' do
+        expect(subject.text).to eq 'pending'
+      end
+    end
+
+    context 'when build is running' do
+      let!(:stage_build) { create_job(:ci_build, status: :running) }
+
+      it 'returns detailed status for running stage' do
+        expect(subject.text).to eq 'running'
+      end
+    end
+
+    context 'when build is successful' do
+      let!(:stage_build) { create_job(:ci_build, status: :success) }
+
+      it 'returns detailed status for successful stage' do
+        expect(subject.text).to eq 'passed'
+      end
+    end
+
+    context 'when build is failed' do
+      let!(:stage_build) { create_job(:ci_build, status: :failed) }
+
+      it 'returns detailed status for failed stage' do
+        expect(subject.text).to eq 'failed'
+      end
+    end
+
+    context 'when build is canceled' do
+      let!(:stage_build) { create_job(:ci_build, status: :canceled) }
+
+      it 'returns detailed status for canceled stage' do
+        expect(subject.text).to eq 'canceled'
+      end
+    end
+
+    context 'when build is skipped' do
+      let!(:stage_build) { create_job(:ci_build, status: :skipped) }
+
+      it 'returns detailed status for skipped stage' do
+        expect(subject.text).to eq 'skipped'
+      end
+    end
+  end
+
+  def create_job(type, status: 'success', stage: stage_name)
+    create(type, pipeline: pipeline, stage: stage, status: status)
+  end
+end
diff --git a/spec/models/commit_status_spec.rb b/spec/models/commit_status_spec.rb
index 80c2a1bc7a9..1ec08c2a9d0 100644
--- a/spec/models/commit_status_spec.rb
+++ b/spec/models/commit_status_spec.rb
@@ -175,7 +175,7 @@ describe CommitStatus, models: true do
     end
 
     it 'returns statuses without what we want to ignore' do
-      is_expected.to eq(statuses.values_at(1, 2, 4, 5, 6, 8, 9))
+      is_expected.to eq(statuses.values_at(0, 1, 2, 3, 4, 5, 6, 8, 9))
     end
   end
 
@@ -200,49 +200,6 @@ describe CommitStatus, models: true do
     end
   end
 
-  describe '#stages' do
-    before do
-      create :commit_status, pipeline: pipeline, stage: 'build', name: 'linux', stage_idx: 0, status: 'success'
-      create :commit_status, pipeline: pipeline, stage: 'build', name: 'mac', stage_idx: 0, status: 'failed'
-      create :commit_status, pipeline: pipeline, stage: 'deploy', name: 'staging', stage_idx: 2, status: 'running'
-      create :commit_status, pipeline: pipeline, stage: 'test', name: 'rspec', stage_idx: 1, status: 'success'
-    end
-
-    context 'stages list' do
-      subject { CommitStatus.where(pipeline: pipeline).stages }
-
-      it 'returns ordered list of stages' do
-        is_expected.to eq(%w[build test deploy])
-      end
-    end
-
-    context 'stages with statuses' do
-      subject { CommitStatus.where(pipeline: pipeline).latest.stages_status }
-
-      it 'returns list of stages with statuses' do
-        is_expected.to eq({
-          'build' => 'failed',
-          'test' => 'success',
-          'deploy' => 'running'
-        })
-      end
-
-      context 'when build is retried' do
-        before do
-          create :commit_status, pipeline: pipeline, stage: 'build', name: 'mac', stage_idx: 0, status: 'success'
-        end
-
-        it 'ignores a previous state' do
-          is_expected.to eq({
-            'build' => 'success',
-            'test' => 'success',
-            'deploy' => 'running'
-          })
-        end
-      end
-    end
-  end
-
   describe '#commit' do
     it 'returns commit pipeline has been created for' do
       expect(commit_status.commit).to eq project.commit
diff --git a/spec/models/concerns/has_status_spec.rb b/spec/models/concerns/has_status_spec.rb
index 9defb17dc92..4d0f51fe82a 100644
--- a/spec/models/concerns/has_status_spec.rb
+++ b/spec/models/concerns/has_status_spec.rb
@@ -48,7 +48,7 @@ describe HasStatus do
           [create(type, status: :failed, allow_failure: true)]
         end
 
-        it { is_expected.to eq 'success' }
+        it { is_expected.to eq 'skipped' }
       end
 
       context 'success and canceled' do