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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
# THIS FILE IS PART OF THE CYLC WORKFLOW ENGINE.
# Copyright (C) NIWA & British Crown (Met Office) & Contributors.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import pytest
from pytest import param
from cylc.flow.config import WorkflowConfig
from cylc.flow.cycling.integer import IntegerPoint
from cylc.flow.cycling.iso8601 import ISO8601Point
from cylc.flow.taskdef import generate_graph_parents
def test_generate_graph_parents_1(tmp_flow_config): # noqa: F811
"""Test that parents are only generated from valid recurrences."""
id_ = 'pan-galactic'
flow_file = tmp_flow_config(
id_,
"""
[scheduler]
UTC mode = True
[scheduling]
initial cycle point = 2023
[[graph]]
R1 = run_once_at_midnight
T00 = run_once_at_midnight[-PT0H] => every_cycle
T03 = run_once_at_midnight[-PT3H] => every_cycle
T06 = run_once_at_midnight[-PT6H] => every_cycle
[runtime]
[[every_cycle, run_once_at_midnight]]
"""
)
cfg = WorkflowConfig(workflow=id_, fpath=flow_file, options=None)
# Each instance of every_cycle should have a parent only at T00.
for point in [
ISO8601Point('20230101T00'),
ISO8601Point('20230101T03'),
ISO8601Point('20230101T06')
]:
parents = generate_graph_parents(
cfg.taskdefs['every_cycle'], point, cfg.taskdefs
)
assert list(parents.values()) == [
[
(
"run_once_at_midnight",
ISO8601Point('20230101T0000Z'),
False
)
]
]
def test_generate_graph_parents_2(tmp_flow_config): # noqa: F811
"""Test inferred parents are valid w.r.t to their own recurrences."""
id_ = 'gargle-blaster'
flow_file = tmp_flow_config(
id_,
"""
[scheduling]
cycling mode = integer
[[graph]]
P1 = "foo[-P1] => foo"
[runtime]
[[foo]]
"""
)
cfg = WorkflowConfig(workflow=id_, fpath=flow_file, options=None)
# Each instance of every_cycle should have a parent only at T00.
parents = generate_graph_parents(
cfg.taskdefs['foo'], IntegerPoint("1"), cfg.taskdefs
)
assert list(parents.values()) == [[]] # No parents at first point.
parents = generate_graph_parents(
cfg.taskdefs['foo'], IntegerPoint("2"), cfg.taskdefs
)
assert list(parents.values()) == [
[
(
"foo",
IntegerPoint('1'),
False
)
]
]
@pytest.mark.parametrize(
"task, point, expected",
[
param(
'foo',
IntegerPoint("1"),
['0/foo'],
id='it.gets-prerequisites',
),
param(
'multiple_pre',
IntegerPoint("2"),
['2/food', '2/fool', '2/foolhardy', '2/foolish'],
id='it.gets-multiple-prerequisites',
),
param(
'foo',
IntegerPoint("3"),
[],
id='it.only-returns-for-valid-points',
),
param(
'bar',
IntegerPoint("2"),
[],
id='it.does-not-return-suicide-prereqs',
),
],
)
def test_get_prereqs(tmp_flow_config, task, point, expected): # noqa: F811
"""Test that get_prereqs() returns the correct prerequisites
for a task."""
id_ = 'gargle-blaster'
flow_file = tmp_flow_config(
id_,
"""
[scheduler]
allow implicit tasks = True
[scheduling]
final cycle point = 2
cycling mode = integer
[[graph]]
P1 = '''
foo[-P1] => foo
bar:fail? => !bar
food & fool => multiple_pre
foolish | foolhardy => multiple_pre
'''
"""
)
cfg = WorkflowConfig(workflow=id_, fpath=flow_file, options=None)
taskdef = cfg.taskdefs[task]
point = IntegerPoint(point)
res = sorted([
condition.get_id()
for pre in taskdef.get_prereqs(point)
for condition in pre.keys()
])
assert res == expected
def test_get_xtrigs(tmp_flow_config):
id = 'foo'
flow_file = tmp_flow_config(
id,
"""
[scheduler]
allow implicit tasks = True
[scheduling]
initial cycle point = 1
final cycle point = 16
cycling mode = integer
[[xtriggers]]
xt_once = xrandom(1)
xt_every = xrandom(1)
xt_odd = xrandom(1)
xt_final = xrandom(1)
[[graph]]
R1 = @xt_once => foo
P1 = @xt_every => foo
P2 = @xt_odd => foo
R1/$ = @xt_final => foo
"""
)
cfg = WorkflowConfig(workflow=id, fpath=flow_file, options=None)
taskdef = cfg.taskdefs['foo']
assert taskdef.get_xtrigs(IntegerPoint('1')) == {
'xt_once', 'xt_odd', 'xt_every'
}
assert taskdef.get_xtrigs(IntegerPoint('2')) == {'xt_every'}
assert taskdef.get_xtrigs(IntegerPoint('3')) == {'xt_odd', 'xt_every'}
assert taskdef.get_xtrigs(IntegerPoint('16')) == {'xt_final', 'xt_every'}
@pytest.mark.parametrize(
"task, point, expected",
[
param(
'foo',
IntegerPoint("1"),
['foo[-P1]:succeeded'],
id='it.gets-triggers',
),
param(
'multiple_pre',
IntegerPoint("2"),
['food:succeeded', 'fool:succeeded',
'foolhardy:succeeded', 'foolish:succeeded'],
id='it.gets-multiple-triggers',
),
param(
'foo',
IntegerPoint("3"),
[],
id='it.only-returns-triggers-for-valid-points',
),
param(
'bar',
IntegerPoint("2"),
[],
id='it.does-not-return-suicide-triggers',
),
],
)
def test_get_triggers(tmp_flow_config, task, point, expected): # noqa: F811
"""Test that get_triggers() returns the correct triggers for a task.
"""
id_ = 'gargle-blaster'
flow_file = tmp_flow_config(
id_,
"""
[scheduler]
allow implicit tasks = True
[scheduling]
final cycle point = 2
cycling mode = integer
[[graph]]
P1 = '''
foo[-P1] => foo
bar:fail? => !bar
food & fool => multiple_pre
foolish | foolhardy => multiple_pre
'''
"""
)
cfg = WorkflowConfig(workflow=id_, fpath=flow_file, options=None)
taskdef = cfg.taskdefs[task]
point = IntegerPoint(point)
res = sorted([str(t) for t in taskdef.get_triggers(point)])
assert res == expected
|
