1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
74
75
76
77
78
79
80
81
|
# frozen_string_literal: true
module Gitlab
module Ci
class Config
module Entry
# A rule is a condition that is evaluated before a job is executed.
# Until we find a better solution in https://gitlab.com/gitlab-org/gitlab/-/issues/436473,
# these two metadata parameters need to be passed to `Entry::Rules`:
# - `allowed_when`: a list of allowed values for the `when` keyword.
# - `allowed_keys`: a list of allowed keys for each rule.
class Rules::Rule < ::Gitlab::Config::Entry::Node
include ::Gitlab::Config::Entry::Validatable
include ::Gitlab::Config::Entry::Configurable
include ::Gitlab::Config::Entry::Attributable
attributes :if, :exists, :when, :start_in, :allow_failure
entry :changes, Entry::Rules::Rule::Changes,
description: 'File change condition rule.'
entry :variables, Entry::Variables,
description: 'Environment variables to define for rule conditions.'
entry :needs, Entry::Needs,
description: 'Needs configuration to define for rule conditions.',
metadata: { allowed_needs: %i[job] },
inherit: false
entry :auto_cancel, Entry::AutoCancel,
description: 'Auto-cancel configuration for the pipeline.'
validations do
validates :config, presence: true
validates :config, type: { with: Hash }
validates :config, disallowed_keys: %i[start_in], unless: :specifies_delay?
validates :start_in, presence: true, if: :specifies_delay?
validates :start_in, duration: { limit: '1 week' }, if: :specifies_delay?
with_options allow_nil: true do
validates :if, expression: true
validates :exists, array_of_strings: true, length: { maximum: 50 }
validates :allow_failure, boolean: true
end
validate do
# This validation replaces the old `validates :when, allowed_values: { in: ALLOWED_WHEN }` validation.
# In https://gitlab.com/gitlab-org/gitlab/-/issues/436473, we'll remove this custom validation.
validates_with Gitlab::Config::Entry::Validators::AllowedValuesValidator,
attributes: %i[when],
allow_nil: true,
in: opt(:allowed_when)
# This validation replaces the old `validates :config, allowed_keys: ALLOWED_KEYS` validation.
# In https://gitlab.com/gitlab-org/gitlab/-/issues/436473, we'll remove this custom validation.
validates_with Gitlab::Config::Entry::Validators::AllowedKeysValidator,
attributes: %i[config],
in: opt(:allowed_keys)
end
end
def value
config.merge(
changes: (changes_value if changes_defined?),
variables: (variables_value if variables_defined?),
needs: (needs_value if needs_defined?),
auto_cancel: (auto_cancel_value if auto_cancel_defined?)
).compact
end
def specifies_delay?
self.when == 'delayed'
end
def default
end
end
end
end
end
end
|