Merge branch '45305-ci-status-icon-mismatch-on-merge-requests-page-and-the-mr-itself' into 'master'

Resolve "CI status icon mismatch on Merge Requests page and the MR itself"

Closes #45305

See merge request gitlab-org/gitlab-ce!25407

app/helpers/ci_status_helper.rb

@@ -100,17 +100,6 @@ module CiStatusHelper
     "pipeline-status/#{pipeline_status.sha}-#{pipeline_status.status}"
   end
 
-  def render_project_pipeline_status(pipeline_status, tooltip_placement: 'left')
-    project = pipeline_status.project
-    path = pipelines_project_commit_path(project, pipeline_status.sha, ref: pipeline_status.ref)
-
-    render_status_with_link(
-      'commit',
-      pipeline_status.status,
-      path,
-      tooltip_placement: tooltip_placement)
-  end
-
   def render_commit_status(commit, ref: nil, tooltip_placement: 'left')
     project = commit.project
     path = pipelines_project_commit_path(project, commit, ref: ref)
@@ -123,12 +112,6 @@ module CiStatusHelper
       icon_size: 24)
   end
 
-  def render_pipeline_status(pipeline, tooltip_placement: 'left')
-    project = pipeline.project
-    path = project_pipeline_path(project, pipeline)
-    render_status_with_link('pipeline', pipeline.status, path, tooltip_placement: tooltip_placement)
-  end
-
   def render_status_with_link(type, status, path = nil, tooltip_placement: 'left', cssclass: '', container: 'body', icon_size: 16)
     klass = "ci-status-link ci-status-icon-#{status.dasherize} #{cssclass}"
     title = "#{type.titleize}: #{ci_label_for_status(status)}"

app/views/ci/status/_icon.html.haml

+- status            = local_assigns.fetch(:status)
+- size              = local_assigns.fetch(:size, 16)
+- type              = local_assigns.fetch(:type, 'pipeline')
+- tooltip_placement = local_assigns.fetch(:tooltip_placement, "left")
+- path              = local_assigns.fetch(:path, status.has_details? ? status.details_path : nil)
+- css_classes       = "ci-status-link ci-status-icon ci-status-icon-#{status.group} has-tooltip"
+- title             = s_("PipelineStatusTooltip|Pipeline: %{ci_status}") % {ci_status: status.label}
+- if type == 'commit'
+  - title = s_("PipelineStatusTooltip|Commit: %{ci_status}") % {ci_status: status.label}
+
+- if path
+  = link_to path, class: css_classes, title: title, data: { placement: tooltip_placement } do
+    = sprite_icon(status.icon, size: size)
+- else
+  %span{ class: css_classes, title: title, data: { placement: tooltip_placement } }
+    = sprite_icon(status.icon, size: size)

app/views/projects/issues/_merge_requests.html.haml

@@ -27,7 +27,7 @@
                   = merge_request.to_reference
                 %span.mr-ci-status.flex-md-grow-1.justify-content-end.d-flex.ml-md-2
                   - if merge_request.can_read_pipeline?
-                    = render_pipeline_status(merge_request.head_pipeline, tooltip_placement: 'bottom')
+                    = render 'ci/status/icon', status: merge_request.head_pipeline.detailed_status(current_user), tooltip_placement: 'bottom'
                   - elsif has_any_head_pipeline
                     = icon('blank fw')
 

app/views/projects/issues/_related_branches.html.haml

@@ -8,7 +8,7 @@
         - pipeline = @project.pipeline_for(branch, target.sha) if target
         - if can?(current_user, :read_pipeline, pipeline)
           %span.related-branch-ci-status
-            = render_pipeline_status(pipeline)
+            = render 'ci/status/icon', status: pipeline.detailed_status(current_user)
         %span.related-branch-info
           %strong
             = link_to branch, project_compare_path(@project, from: @project.default_branch, to: branch), class: "ref-name"

app/views/projects/merge_requests/_merge_request.html.haml

@@ -48,7 +48,7 @@
             CLOSED
         - if can?(current_user, :read_pipeline, merge_request.head_pipeline)
           %li.issuable-pipeline-status.d-none.d-sm-inline-block
-            = render_pipeline_status(merge_request.head_pipeline)
+            = render 'ci/status/icon', status: merge_request.head_pipeline.detailed_status(current_user)
         - if merge_request.open? && merge_request.broken?
           %li.issuable-pipeline-broken.d-none.d-sm-inline-block
             = link_to merge_request_path(merge_request), class: "has-tooltip", title: _('Cannot be merged automatically') do

app/views/shared/projects/_project.html.haml

@@ -85,7 +85,8 @@
               = sprite_icon('issues', size: 14, css_class: 'append-right-4')
               = number_with_delimiter(project.open_issues_count)
           - if pipeline_status && can?(current_user, :read_cross_project) && project.pipeline_status.has_status? && can?(current_user, :read_build, project)
+            - pipeline_path = pipelines_project_commit_path(project.pipeline_status.project, project.pipeline_status.sha, ref: project.pipeline_status.ref)
             %span.icon-wrapper.pipeline-status
-              = render_project_pipeline_status(project.pipeline_status, tooltip_placement: 'top')
+              = render 'ci/status/icon', status: project.commit.last_pipeline.detailed_status(current_user), type: 'commit', tooltip_placement: 'top', path: pipeline_path
         .updated-note
           %span Updated #{updated_tooltip}

changelogs/unreleased/45305-ci-status-icon-mismatch-on-merge-requests-page-and-the-mr-itself.yml

+---
+title: Fix pipeline status icon mismatch
+merge_request: 25407
+author:
+type: fixed

locale/gitlab.pot

@@ -5431,6 +5431,12 @@ msgstr ""
 msgid "PipelineSheduleIntervalPattern|Custom"
 msgstr ""
 
+msgid "PipelineStatusTooltip|Commit: %{ci_status}"
+msgstr ""
+
+msgid "PipelineStatusTooltip|Pipeline: %{ci_status}"
+msgstr ""
+
 msgid "Pipelines"
 msgstr ""
 

spec/views/ci/status/_icon.html.haml_spec.rb

+# frozen_string_literal: true
+require 'spec_helper'
+
+describe 'ci/status/_icon' do
+  let(:user) { create(:user) }
+  let(:project) { create(:project, :private) }
+  let(:pipeline) { create(:ci_pipeline, project: project) }
+
+  context 'when rendering status for build' do
+    let(:build) do
+      create(:ci_build, :success, pipeline: pipeline)
+    end
+
+    context 'when user has ability to see details' do
+      before do
+        project.add_developer(user)
+      end
+
+      it 'has link to build details page' do
+        details_path = project_job_path(project, build)
+
+        render_status(build)
+
+        expect(rendered).to have_link(href: details_path)
+      end
+    end
+
+    context 'when user do not have ability to see build details' do
+      before do
+        render_status(build)
+      end
+
+      it 'contains build status text' do
+        expect(rendered).to have_css('.ci-status-icon.ci-status-icon-success')
+      end
+
+      it 'does not contain links' do
+        expect(rendered).not_to have_link
+      end
+    end
+  end
+
+  context 'when rendering status for external job' do
+    context 'when user has ability to see commit status details' do
+      before do
+        project.add_developer(user)
+      end
+
+      context 'status has external target url' do
+        before do
+          external_job = create(:generic_commit_status,
+                                status: :running,
+                                pipeline: pipeline,
+                                target_url: 'http://gitlab.com')
+
+          render_status(external_job)
+        end
+
+        it 'contains valid commit status text' do
+          expect(rendered).to have_css('.ci-status-icon.ci-status-icon-running')
+        end
+
+        it 'has link to external status page' do
+          expect(rendered).to have_link(href: 'http://gitlab.com')
+        end
+      end
+
+      context 'status do not have external target url' do
+        before do
+          external_job = create(:generic_commit_status, status: :canceled)
+
+          render_status(external_job)
+        end
+
+        it 'contains valid commit status text' do
+          expect(rendered).to have_css('.ci-status-icon.ci-status-icon-canceled')
+        end
+
+        it 'has link to external status page' do
+          expect(rendered).not_to have_link
+        end
+      end
+    end
+  end
+
+  def render_status(resource)
+    render 'ci/status/icon', status: resource.detailed_status(user)
+  end
+end