Merge branch 'zj-job-view-goes-real-time' into 'master'

Initial implementation for real time job view

Closes #31397

See merge request !11651

9 files changed, 272 insertions, 61 deletions

diff --git a/spec/controllers/projects/jobs_controller_spec.rb b/spec/controllers/projects/jobs_controller_spec.rb
index 838bdae1445..7211acc53dc 100644
--- a/spec/controllers/projects/jobs_controller_spec.rb
+++ b/spec/controllers/projects/jobs_controller_spec.rb
@@ -101,26 +101,49 @@ describe Projects::JobsController do
   end
 
   describe 'GET show' do
-    context 'when build exists' do
-      let!(:build) { create(:ci_build, pipeline: pipeline) }
+    let!(:build) { create(:ci_build, :failed, pipeline: pipeline) }
 
-      before do
-        get_show(id: build.id)
+    context 'when requesting HTML' do
+      context 'when build exists' do
+        before do
+          get_show(id: build.id)
+        end
+
+        it 'has a build' do
+          expect(response).to have_http_status(:ok)
+          expect(assigns(:build).id).to eq(build.id)
+        end
       end
 
-      it 'has a build' do
-        expect(response).to have_http_status(:ok)
-        expect(assigns(:build).id).to eq(build.id)
+      context 'when build does not exist' do
+        before do
+          get_show(id: 1234)
+        end
+
+        it 'renders not_found' do
+          expect(response).to have_http_status(:not_found)
+        end
       end
     end
 
-    context 'when build does not exist' do
+    context 'when requesting JSON' do
+      let(:merge_request) { create(:merge_request, source_project: project) }
+
       before do
-        get_show(id: 1234)
+        project.add_developer(user)
+        sign_in(user)
+
+        allow_any_instance_of(Ci::Build).to receive(:merge_request).and_return(merge_request)
+
+        get_show(id: build.id, format: :json)
       end
 
-      it 'renders not_found' do
-        expect(response).to have_http_status(:not_found)
+      it 'exposes needed information' do
+        expect(response).to have_http_status(:ok)
+        expect(json_response['raw_path']).to match(/builds\/\d+\/raw\z/)
+        expect(json_response.dig('merge_request', 'path')).to match(/merge_requests\/\d+\z/)
+        expect(json_response['new_issue_path'])
+          .to include('/issues/new')
       end
     end
 
diff --git a/spec/lib/gitlab/etag_caching/router_spec.rb b/spec/lib/gitlab/etag_caching/router_spec.rb
index 0418fc0a1e2..269798c7c9e 100644
--- a/spec/lib/gitlab/etag_caching/router_spec.rb
+++ b/spec/lib/gitlab/etag_caching/router_spec.rb
@@ -67,6 +67,17 @@ describe Gitlab::EtagCaching::Router do
     expect(result.name).to eq 'merge_request_pipelines'
   end
 
+  it 'matches build endpoint' do
+    env = build_env(
+      '/my-group/my-project/builds/234.json'
+    )
+
+    result = described_class.match(env)
+
+    expect(result).to be_present
+    expect(result.name).to eq 'project_build'
+  end
+
   it 'does not match blob with confusing name' do
     env = build_env(
       '/my-group/my-project/blob/master/pipelines.json'
diff --git a/spec/serializers/build_artifact_entity_spec.rb b/spec/serializers/build_artifact_entity_spec.rb
index b4eef20d6a6..ad0d3d3839e 100644
--- a/spec/serializers/build_artifact_entity_spec.rb
+++ b/spec/serializers/build_artifact_entity_spec.rb
@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe BuildArtifactEntity do
-  let(:job) { create(:ci_build, name: 'test:job') }
+  let(:job) { create(:ci_build, name: 'test:job', artifacts_expire_at: 1.hour.from_now) }
 
   let(:entity) do
     described_class.new(job, request: double)
@@ -14,9 +14,19 @@ describe BuildArtifactEntity do
       expect(subject[:name]).to eq 'test:job'
     end
 
-    it 'contains path to the artifacts' do
+    it 'exposes information about expiration of artifacts' do
+      expect(subject).to include(:expired, :expire_at)
+    end
+
+    it 'contains paths to the artifacts' do
       expect(subject[:path])
         .to include "jobs/#{job.id}/artifacts/download"
+
+      expect(subject[:keep_path])
+        .to include "jobs/#{job.id}/artifacts/keep"
+
+      expect(subject[:browse_path])
+        .to include "jobs/#{job.id}/artifacts/browse"
     end
   end
 end
diff --git a/spec/serializers/build_details_entity_spec.rb b/spec/serializers/build_details_entity_spec.rb
new file mode 100644
index 00000000000..e2511e8968c
--- /dev/null
+++ b/spec/serializers/build_details_entity_spec.rb
@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe BuildDetailsEntity do
+  set(:user) { create(:admin) }
+
+  it 'inherits from BuildEntity' do
+    expect(described_class).to be < BuildEntity
+  end
+
+  describe '#as_json' do
+    let(:project) { create(:project, :repository) }
+    let!(:build) { create(:ci_build, :failed, project: project) }
+    let(:request) { double('request') }
+    let(:entity) { described_class.new(build, request: request, current_user: user, project: project) }
+    subject { entity.as_json }
+
+    before do
+      allow(request).to receive(:current_user).and_return(user)
+    end
+
+    context 'when the user has access to issues and merge requests' do
+      let!(:merge_request) do
+        create(:merge_request, source_project: project, source_branch: build.ref)
+      end
+
+      before do
+        allow(build).to receive(:merge_request).and_return(merge_request)
+      end
+
+      it 'contains the needed key value pairs' do
+        expect(subject).to include(:coverage, :erased_at, :duration)
+        expect(subject).to include(:artifacts, :runner, :pipeline)
+        expect(subject).to include(:raw_path, :merge_request)
+        expect(subject).to include(:new_issue_path)
+      end
+
+      it 'exposes details of the merge request' do
+        expect(subject[:merge_request]).to include(:iid, :path)
+      end
+
+      context 'when the build has been erased' do
+        let!(:build) { create(:ci_build, :erasable, project: project) }
+
+        it 'exposes the user whom erased the build' do
+          expect(subject).to include(:erase_path)
+        end
+      end
+
+      context 'when the build has been erased' do
+        let!(:build) { create(:ci_build, erased_at: Time.now, project: project, erased_by: user) }
+
+        it 'exposes the user whom erased the build' do
+          expect(subject).to include(:erased_by)
+        end
+      end
+    end
+
+    context 'when the user can only read the build' do
+      let(:user) { create(:user) }
+
+      it "won't display the paths to issues and merge requests" do
+        expect(subject['new_issue_path']).to be_nil
+        expect(subject['merge_request_path']).to be_nil
+      end
+    end
+  end
+end
diff --git a/spec/serializers/build_entity_spec.rb b/spec/serializers/build_entity_spec.rb
index 6d5e1046e86..46d43a80ef7 100644
--- a/spec/serializers/build_entity_spec.rb
+++ b/spec/serializers/build_entity_spec.rb
@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe BuildEntity do
   let(:user) { create(:user) }
-  let(:build) { create(:ci_build) }
+  let(:build) { create(:ci_build, :failed) }
   let(:project) { build.project }
   let(:request) { double('request') }
 
@@ -18,6 +18,7 @@ describe BuildEntity do
 
   it 'contains paths to build page and retry action' do
     expect(subject).to include(:build_path, :retry_path)
+    expect(subject[:retry_path]).not_to be_nil
   end
 
   it 'does not contain sensitive information' do
diff --git a/spec/serializers/merge_request_entity_spec.rb b/spec/serializers/merge_request_entity_spec.rb
index b75c73e78c2..d38433c2365 100644
--- a/spec/serializers/merge_request_entity_spec.rb
+++ b/spec/serializers/merge_request_entity_spec.rb
@@ -26,7 +26,7 @@ describe MergeRequestEntity do
     pipeline = build_stubbed(:ci_pipeline)
     allow(resource).to receive(:head_pipeline).and_return(pipeline)
 
-    pipeline_payload = PipelineEntity
+    pipeline_payload = PipelineDetailsEntity
       .represent(pipeline, request: req)
       .as_json
 
diff --git a/spec/serializers/pipeline_details_entity_spec.rb b/spec/serializers/pipeline_details_entity_spec.rb
new file mode 100644
index 00000000000..03cc5ae9b63
--- /dev/null
+++ b/spec/serializers/pipeline_details_entity_spec.rb
@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe PipelineDetailsEntity do
+  set(:user) { create(:user) }
+  let(:request) { double('request') }
+
+  it 'inherrits from PipelineEntity' do
+    expect(described_class).to be < PipelineEntity
+  end
+
+  before do
+    allow(request).to receive(:current_user).and_return(user)
+  end
+
+  let(:entity) do
+    described_class.represent(pipeline, request: request)
+  end
+
+  describe '#as_json' do
+    subject { entity.as_json }
+
+    context 'when pipeline is empty' do
+      let(:pipeline) { create(:ci_empty_pipeline) }
+
+      it 'contains details' do
+        expect(subject).to include :details
+        expect(subject[:details])
+          .to include :duration, :finished_at
+        expect(subject[:details])
+          .to include :stages, :artifacts, :manual_actions
+        expect(subject[:details][:status]).to include :icon, :favicon, :text, :label
+      end
+
+      it 'contains flags' do
+        expect(subject).to include :flags
+        expect(subject[:flags])
+          .to include :latest, :stuck,
+                      :yaml_errors, :retryable, :cancelable
+      end
+    end
+
+    context 'when pipeline is retryable' do
+      let(:project) { create(:empty_project) }
+
+      let(:pipeline) do
+        create(:ci_pipeline, status: :success, project: project)
+      end
+
+      before do
+        create(:ci_build, :failed, pipeline: pipeline)
+      end
+
+      context 'user has ability to retry pipeline' do
+        before { project.team << [user, :developer] }
+
+        it 'retryable flag is true' do
+          expect(subject[:flags][:retryable]).to eq true
+        end
+      end
+
+      context 'user does not have ability to retry pipeline' do
+        it 'retryable flag is false' do
+          expect(subject[:flags][:retryable]).to eq false
+        end
+      end
+    end
+
+    context 'when pipeline is cancelable' do
+      let(:project) { create(:empty_project) }
+
+      let(:pipeline) do
+        create(:ci_pipeline, status: :running, project: project)
+      end
+
+      before do
+        create(:ci_build, :pending, pipeline: pipeline)
+      end
+
+      context 'user has ability to cancel pipeline' do
+        before { project.add_developer(user) }
+
+        it 'cancelable flag is true' do
+          expect(subject[:flags][:cancelable]).to eq true
+        end
+      end
+
+      context 'user does not have ability to cancel pipeline' do
+        it 'cancelable flag is false' do
+          expect(subject[:flags][:cancelable]).to eq false
+        end
+      end
+    end
+
+    context 'when pipeline has YAML errors' do
+      let(:pipeline) do
+        create(:ci_pipeline, config: { rspec: { invalid: :value } })
+      end
+
+      it 'contains information about error' do
+        expect(subject[:yaml_errors]).to be_present
+      end
+
+      it 'contains flag that indicates there are errors' do
+        expect(subject[:flags][:yaml_errors]).to be true
+      end
+    end
+
+    context 'when pipeline does not have YAML errors' do
+      let(:pipeline) { create(:ci_empty_pipeline) }
+
+      it 'does not contain field that normally holds an error' do
+        expect(subject).not_to have_key(:yaml_errors)
+      end
+
+      it 'contains flag that indicates there are no errors' do
+        expect(subject[:flags][:yaml_errors]).to be false
+      end
+    end
+  end
+end
diff --git a/spec/serializers/pipeline_entity_spec.rb b/spec/serializers/pipeline_entity_spec.rb
index 88ec4ed2952..a059c2cc736 100644
--- a/spec/serializers/pipeline_entity_spec.rb
+++ b/spec/serializers/pipeline_entity_spec.rb
@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe PipelineEntity do
-  let(:user) { create(:user) }
+  set(:user) { create(:user) }
   let(:request) { double('request') }
 
   before do
@@ -28,8 +28,6 @@ describe PipelineEntity do
         expect(subject).to include :details
         expect(subject[:details])
           .to include :duration, :finished_at
-        expect(subject[:details])
-          .to include :stages, :artifacts, :manual_actions
         expect(subject[:details][:status]).to include :icon, :favicon, :text, :label
       end
 
@@ -55,20 +53,12 @@ describe PipelineEntity do
       context 'user has ability to retry pipeline' do
         before { project.team << [user, :developer] }
 
-        it 'retryable flag is true' do
-          expect(subject[:flags][:retryable]).to eq true
-        end
-
         it 'contains retry path' do
           expect(subject[:retry_path]).to be_present
         end
       end
 
       context 'user does not have ability to retry pipeline' do
-        it 'retryable flag is false' do
-          expect(subject[:flags][:retryable]).to eq false
-        end
-
         it 'does not contain retry path' do
           expect(subject).not_to have_key(:retry_path)
         end
@@ -87,11 +77,7 @@ describe PipelineEntity do
       end
 
       context 'user has ability to cancel pipeline' do
-        before { project.team << [user, :developer] }
-
-        it 'cancelable flag is true' do
-          expect(subject[:flags][:cancelable]).to eq true
-        end
+        before { project.add_developer(user) }
 
         it 'contains cancel path' do
           expect(subject[:cancel_path]).to be_present
@@ -99,42 +85,12 @@ describe PipelineEntity do
       end
 
       context 'user does not have ability to cancel pipeline' do
-        it 'cancelable flag is false' do
-          expect(subject[:flags][:cancelable]).to eq false
-        end
-
         it 'does not contain cancel path' do
           expect(subject).not_to have_key(:cancel_path)
         end
       end
     end
 
-    context 'when pipeline has YAML errors' do
-      let(:pipeline) do
-        create(:ci_pipeline, config: { rspec: { invalid: :value } })
-      end
-
-      it 'contains flag that indicates there are errors' do
-        expect(subject[:flags][:yaml_errors]).to be true
-      end
-
-      it 'contains information about error' do
-        expect(subject[:yaml_errors]).to be_present
-      end
-    end
-
-    context 'when pipeline does not have YAML errors' do
-      let(:pipeline) { create(:ci_empty_pipeline) }
-
-      it 'contains flag that indicates there are no errors' do
-        expect(subject[:flags][:yaml_errors]).to be false
-      end
-
-      it 'does not contain field that normally holds an error' do
-        expect(subject).not_to have_key(:yaml_errors)
-      end
-    end
-
     context 'when pipeline ref is empty' do
       let(:pipeline) { create(:ci_empty_pipeline) }
 
diff --git a/spec/serializers/runner_entity_spec.rb b/spec/serializers/runner_entity_spec.rb
new file mode 100644
index 00000000000..4f25a8dcfa0
--- /dev/null
+++ b/spec/serializers/runner_entity_spec.rb
@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe RunnerEntity do
+  let(:runner) { create(:ci_runner, :specific) }
+  let(:entity) { described_class.new(runner, request: request, current_user: user) }
+  let(:request) { double('request') }
+  let(:project) { create(:empty_project) }
+  let(:user) { create(:admin) }
+
+  before do
+    allow(request).to receive(:current_user).and_return(user)
+    allow(request).to receive(:project).and_return(project)
+  end
+
+  describe '#as_json' do
+    subject { entity.as_json }
+
+    it 'contains required fields' do
+      expect(subject).to include(:id, :description)
+      expect(subject).to include(:edit_path)
+    end
+  end
+end