Class: Gitlab::Ci::Status::Composite

Inherits:
Object
  • Object
show all
Includes:
Utils::StrongMemoize
Defined in:
lib/gitlab/ci/status/composite.rb

Instance Method Summary collapse

Methods included from Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

Constructor Details

#initialize(all_statuses, with_allow_failure: true, dag: false, project: nil) ⇒ Composite

This class accepts an array of arrays/hashes/or objects

The parameter `project` is only used for the feature flag check, and will be removed with gitlab.com/gitlab-org/gitlab/-/issues/321972


13
14
15
16
17
18
19
20
21
22
23
24
25
# File 'lib/gitlab/ci/status/composite.rb', line 13

def initialize(all_statuses, with_allow_failure: true, dag: false, project: nil)
  unless all_statuses.respond_to?(:pluck)
    raise ArgumentError, "all_statuses needs to respond to `.pluck`"
  end

  @status_set = Set.new
  @status_key = 0
  @allow_failure_key = 1 if with_allow_failure
  @dag = dag
  @project = project

  consume_all_statuses(all_statuses)
end

Instance Method Details

#statusObject

The status calculation is order dependent,

  1. In some cases we assume that that status is exact if the we only have given statues,

  2. In other cases we assume that status is of that type based on what statuses are no longer valid based on the data set that we have

rubocop: disable Metrics/CyclomaticComplexity rubocop: disable Metrics/PerceivedComplexity


35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/gitlab/ci/status/composite.rb', line 35

def status
  return if none?

  strong_memoize(:status) do
    if @dag && any_skipped_or_ignored?
      # The DAG job is skipped if one of the needs does not run at all.
      'skipped'
    elsif @dag && !only_of?(:success, :failed, :canceled, :skipped, :success_with_warnings)
      # DAG is blocked from executing if a dependent is not "complete"
      'pending'
    elsif only_of?(:skipped, :ignored)
      'skipped'
    elsif only_of?(:success, :skipped, :success_with_warnings, :ignored)
      'success'
    elsif only_of?(:created, :success_with_warnings, :ignored)
      'created'
    elsif only_of?(:preparing, :success_with_warnings, :ignored)
      'preparing'
    elsif only_of?(:canceled, :success, :skipped, :success_with_warnings, :ignored)
      'canceled'
    elsif only_of?(:pending, :created, :skipped, :success_with_warnings, :ignored)
      'pending'
    elsif any_of?(:running, :pending)
      'running'
    elsif any_of?(:waiting_for_resource)
      'waiting_for_resource'
    elsif any_of?(:manual)
      'manual'
    elsif any_of?(:scheduled)
      'scheduled'
    elsif any_of?(:preparing)
      'preparing'
    elsif any_of?(:created)
      'running'
    else
      'failed'
    end
  end
end

#warnings?Boolean

rubocop: enable Metrics/CyclomaticComplexity rubocop: enable Metrics/PerceivedComplexity

Returns:

  • (Boolean)

77
78
79
# File 'lib/gitlab/ci/status/composite.rb', line 77

def warnings?
  @status_set.include?(:success_with_warnings)
end