BigW Consortium Gitlab

ci_status_helper.rb 4.11 KB
Newer Older
1 2 3 4 5 6 7
##
# DEPRECATED
#
# These helpers are deprecated in favor of detailed CI/CD statuses.
#
# See 'detailed_status?` method and `Gitlab::Ci::Status` module.
#
8
module CiStatusHelper
9 10
  def ci_status_path(pipeline)
    project = pipeline.project
11
    project_pipeline_path(project, pipeline)
Kamil Trzcinski committed
12 13
  end

14
  def ci_label_for_status(status)
15 16 17 18
    if detailed_status?(status)
      return status.label
    end

19 20 21 22 23 24 25 26 27 28 29 30
    label = case status
            when 'success'
              'passed'
            when 'success_with_warnings'
              'passed with warnings'
            when 'manual'
              'waiting for manual action'
            else
              status
            end
    translation = "CiStatusLabel|#{label}"
    s_(translation)
31 32
  end

33 34 35 36 37 38 39
  def ci_text_for_status(status)
    if detailed_status?(status)
      return status.text
    end

    case status
    when 'success'
40
      s_('CiStatusText|passed')
41
    when 'success_with_warnings'
42
      s_('CiStatusText|passed')
43
    when 'manual'
44
      s_('CiStatusText|blocked')
45
    else
46 47 48 49 50 51 52 53 54 55
      # All states are already being translated inside the detailed statuses:
      # :running => Gitlab::Ci::Status::Running
      # :skipped => Gitlab::Ci::Status::Skipped
      # :failed => Gitlab::Ci::Status::Failed
      # :success => Gitlab::Ci::Status::Success
      # :canceled => Gitlab::Ci::Status::Canceled
      # The following states are customized above:
      # :manual => Gitlab::Ci::Status::Manual
      status_translation = "CiStatusText|#{status}"
      s_(status_translation)
56 57 58
    end
  end

59 60 61 62 63
  def ci_status_for_statuseable(subject)
    status = subject.try(:status) || 'not found'
    status.humanize
  end

64
  def ci_icon_for_status(status)
65 66 67 68
    if detailed_status?(status)
      return custom_icon(status.icon)
    end

69
    icon_name =
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
      case status
      when 'success'
        'icon_status_success'
      when 'success_with_warnings'
        'icon_status_warning'
      when 'failed'
        'icon_status_failed'
      when 'pending'
        'icon_status_pending'
      when 'running'
        'icon_status_running'
      when 'play'
        'icon_play'
      when 'created'
        'icon_status_created'
      when 'skipped'
        'icon_status_skipped'
87 88
      when 'manual'
        'icon_status_manual'
89
      else
90
        'icon_status_canceled'
91 92
      end

93
    custom_icon(icon_name)
94
  end
95

96 97 98 99
  def pipeline_status_cache_key(pipeline_status)
    "pipeline-status/#{pipeline_status.sha}-#{pipeline_status.status}"
  end

100 101
  def render_project_pipeline_status(pipeline_status, tooltip_placement: 'auto left')
    project = pipeline_status.project
102
    path = pipelines_project_commit_path(project, pipeline_status.sha)
103 104 105 106 107 108 109 110

    render_status_with_link(
      'commit',
      pipeline_status.status,
      path,
      tooltip_placement: tooltip_placement)
  end

111
  def render_commit_status(commit, ref: nil, tooltip_placement: 'auto left')
112
    project = commit.project
113
    path = pipelines_project_commit_path(project, commit)
114 115 116

    render_status_with_link(
      'commit',
117
      commit.status(ref),
118 119
      path,
      tooltip_placement: tooltip_placement)
120 121 122 123
  end

  def render_pipeline_status(pipeline, tooltip_placement: 'auto left')
    project = pipeline.project
124
    path = project_pipeline_path(project, pipeline)
125
    render_status_with_link('pipeline', pipeline.status, path, tooltip_placement: tooltip_placement)
126 127
  end

128 129 130 131 132
  def no_runners_for_project?(project)
    project.runners.blank? &&
      Ci::Runner.shared.blank?
  end

133
  def render_status_with_link(type, status, path = nil, tooltip_placement: 'auto left', cssclass: '', container: 'body')
134 135
    klass = "ci-status-link ci-status-icon-#{status.dasherize} #{cssclass}"
    title = "#{type.titleize}: #{ci_label_for_status(status)}"
136
    data = { toggle: 'tooltip', placement: tooltip_placement, container: container }
137

138 139 140 141 142 143 144
    if path
      link_to ci_icon_for_status(status), path,
              class: klass, title: title, data: data
    else
      content_tag :span, ci_icon_for_status(status),
              class: klass, title: title, data: data
    end
145
  end
146 147 148 149 150 151

  def detailed_status?(status)
    status.respond_to?(:text) &&
      status.respond_to?(:label) &&
      status.respond_to?(:icon)
  end
152
end