-
Notifications
You must be signed in to change notification settings - Fork 13.7k
/
test_mappedoperator.py
484 lines (380 loc) · 16.5 KB
/
test_mappedoperator.py
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations
from datetime import timedelta
import pendulum
import pytest
from airflow.models import DAG
from airflow.models.baseoperator import BaseOperator
from airflow.models.mappedoperator import MappedOperator
from airflow.models.taskinstance import TaskInstance
from airflow.models.taskmap import TaskMap
from airflow.models.xcom import XCOM_RETURN_KEY
from airflow.models.xcom_arg import XComArg
from airflow.utils.state import TaskInstanceState
from airflow.utils.trigger_rule import TriggerRule
from tests.models import DEFAULT_DATE
from tests.test_utils.mapping import expand_mapped_task
from tests.test_utils.mock_operators import MockOperator
def test_task_mapping_with_dag():
with DAG("test-dag", start_date=DEFAULT_DATE) as dag:
task1 = BaseOperator(task_id="op1")
literal = ['a', 'b', 'c']
mapped = MockOperator.partial(task_id='task_2').expand(arg2=literal)
finish = MockOperator(task_id="finish")
task1 >> mapped >> finish
assert task1.downstream_list == [mapped]
assert mapped in dag.tasks
assert mapped.task_group == dag.task_group
# At parse time there should only be three tasks!
assert len(dag.tasks) == 3
assert finish.upstream_list == [mapped]
assert mapped.downstream_list == [finish]
def test_task_mapping_without_dag_context():
with DAG("test-dag", start_date=DEFAULT_DATE) as dag:
task1 = BaseOperator(task_id="op1")
literal = ['a', 'b', 'c']
mapped = MockOperator.partial(task_id='task_2').expand(arg2=literal)
task1 >> mapped
assert isinstance(mapped, MappedOperator)
assert mapped in dag.tasks
assert task1.downstream_list == [mapped]
assert mapped in dag.tasks
# At parse time there should only be two tasks!
assert len(dag.tasks) == 2
def test_task_mapping_default_args():
default_args = {'start_date': DEFAULT_DATE.now(), 'owner': 'test'}
with DAG("test-dag", start_date=DEFAULT_DATE, default_args=default_args):
task1 = BaseOperator(task_id="op1")
literal = ['a', 'b', 'c']
mapped = MockOperator.partial(task_id='task_2').expand(arg2=literal)
task1 >> mapped
assert mapped.partial_kwargs['owner'] == 'test'
assert mapped.start_date == pendulum.instance(default_args['start_date'])
def test_map_unknown_arg_raises():
with pytest.raises(TypeError, match=r"argument 'file'"):
BaseOperator.partial(task_id='a').expand(file=[1, 2, {'a': 'b'}])
def test_map_xcom_arg():
"""Test that dependencies are correct when mapping with an XComArg"""
with DAG("test-dag", start_date=DEFAULT_DATE):
task1 = BaseOperator(task_id="op1")
mapped = MockOperator.partial(task_id='task_2').expand(arg2=task1.output)
finish = MockOperator(task_id="finish")
mapped >> finish
assert task1.downstream_list == [mapped]
def test_map_xcom_arg_multiple_upstream_xcoms(dag_maker, session):
"""Test that the correct number of downstream tasks are generated when mapping with an XComArg"""
class PushExtraXComOperator(BaseOperator):
"""Push an extra XCom value along with the default return value."""
def __init__(self, return_value, **kwargs):
super().__init__(**kwargs)
self.return_value = return_value
def execute(self, context):
context['task_instance'].xcom_push(key='extra_key', value="extra_value")
return self.return_value
with dag_maker("test-dag", session=session, start_date=DEFAULT_DATE) as dag:
upstream_return = [1, 2, 3]
task1 = PushExtraXComOperator(return_value=upstream_return, task_id="task_1")
task2 = PushExtraXComOperator.partial(task_id='task_2').expand(return_value=task1.output)
task3 = PushExtraXComOperator.partial(task_id='task_3').expand(return_value=task2.output)
dr = dag_maker.create_dagrun()
ti_1 = dr.get_task_instance("task_1", session)
ti_1.run()
ti_2s, _ = task2.expand_mapped_task(dr.run_id, session=session)
for ti in ti_2s:
ti.refresh_from_task(dag.get_task("task_2"))
ti.run()
ti_3s, _ = task3.expand_mapped_task(dr.run_id, session=session)
for ti in ti_3s:
ti.refresh_from_task(dag.get_task("task_3"))
ti.run()
assert len(ti_3s) == len(ti_2s) == len(upstream_return)
def test_partial_on_instance() -> None:
"""`.partial` on an instance should fail -- it's only designed to be called on classes"""
with pytest.raises(TypeError):
MockOperator(task_id='a').partial()
def test_partial_on_class() -> None:
# Test that we accept args for superclasses too
op = MockOperator.partial(task_id='a', arg1="a", trigger_rule=TriggerRule.ONE_FAILED)
assert op.kwargs["arg1"] == "a"
assert op.kwargs["trigger_rule"] == TriggerRule.ONE_FAILED
def test_partial_on_class_invalid_ctor_args() -> None:
"""Test that when we pass invalid args to partial().
I.e. if an arg is not known on the class or any of its parent classes we error at parse time
"""
with pytest.raises(TypeError, match=r"arguments 'foo', 'bar'"):
MockOperator.partial(task_id='a', foo='bar', bar=2)
@pytest.mark.parametrize(
["num_existing_tis", "expected"],
(
pytest.param(0, [(0, None), (1, None), (2, None)], id='only-unmapped-ti-exists'),
pytest.param(
3,
[(0, 'success'), (1, 'success'), (2, 'success')],
id='all-tis-exist',
),
pytest.param(
5,
[
(0, 'success'),
(1, 'success'),
(2, 'success'),
(3, TaskInstanceState.REMOVED),
(4, TaskInstanceState.REMOVED),
],
id="tis-to-be-removed",
),
),
)
def test_expand_mapped_task_instance(dag_maker, session, num_existing_tis, expected):
literal = [1, 2, {'a': 'b'}]
with dag_maker(session=session):
task1 = BaseOperator(task_id="op1")
mapped = MockOperator.partial(task_id='task_2').expand(arg2=task1.output)
dr = dag_maker.create_dagrun()
session.add(
TaskMap(
dag_id=dr.dag_id,
task_id=task1.task_id,
run_id=dr.run_id,
map_index=-1,
length=len(literal),
keys=None,
)
)
if num_existing_tis:
# Remove the map_index=-1 TI when we're creating other TIs
session.query(TaskInstance).filter(
TaskInstance.dag_id == mapped.dag_id,
TaskInstance.task_id == mapped.task_id,
TaskInstance.run_id == dr.run_id,
).delete()
for index in range(num_existing_tis):
# Give the existing TIs a state to make sure we don't change them
ti = TaskInstance(mapped, run_id=dr.run_id, map_index=index, state=TaskInstanceState.SUCCESS)
session.add(ti)
session.flush()
mapped.expand_mapped_task(dr.run_id, session=session)
indices = (
session.query(TaskInstance.map_index, TaskInstance.state)
.filter_by(task_id=mapped.task_id, dag_id=mapped.dag_id, run_id=dr.run_id)
.order_by(TaskInstance.map_index)
.all()
)
assert indices == expected
def test_expand_mapped_task_instance_skipped_on_zero(dag_maker, session):
with dag_maker(session=session):
task1 = BaseOperator(task_id="op1")
mapped = MockOperator.partial(task_id='task_2').expand(arg2=task1.output)
dr = dag_maker.create_dagrun()
expand_mapped_task(mapped, dr.run_id, task1.task_id, length=0, session=session)
indices = (
session.query(TaskInstance.map_index, TaskInstance.state)
.filter_by(task_id=mapped.task_id, dag_id=mapped.dag_id, run_id=dr.run_id)
.order_by(TaskInstance.map_index)
.all()
)
assert indices == [(-1, TaskInstanceState.SKIPPED)]
def test_mapped_task_applies_default_args_classic(dag_maker):
with dag_maker(default_args={"execution_timeout": timedelta(minutes=30)}) as dag:
MockOperator(task_id="simple", arg1=None, arg2=0)
MockOperator.partial(task_id="mapped").expand(arg1=[1], arg2=[2, 3])
assert dag.get_task("simple").execution_timeout == timedelta(minutes=30)
assert dag.get_task("mapped").execution_timeout == timedelta(minutes=30)
def test_mapped_task_applies_default_args_taskflow(dag_maker):
with dag_maker(default_args={"execution_timeout": timedelta(minutes=30)}) as dag:
@dag.task
def simple(arg):
pass
@dag.task
def mapped(arg):
pass
simple(arg=0)
mapped.expand(arg=[1, 2])
assert dag.get_task("simple").execution_timeout == timedelta(minutes=30)
assert dag.get_task("mapped").execution_timeout == timedelta(minutes=30)
def test_mapped_render_template_fields_validating_operator(dag_maker, session):
class MyOperator(MockOperator):
def __init__(self, value, arg1, **kwargs):
assert isinstance(value, str), "value should have been resolved before unmapping"
assert isinstance(arg1, str), "value should have been resolved before unmapping"
super().__init__(arg1=arg1, **kwargs)
self.value = value
with dag_maker(session=session):
task1 = BaseOperator(task_id="op1")
output1 = task1.output
mapped = MyOperator.partial(task_id='a', arg2='{{ ti.task_id }}').expand(value=output1, arg1=output1)
dr = dag_maker.create_dagrun()
ti: TaskInstance = dr.get_task_instance(task1.task_id, session=session)
ti.xcom_push(key=XCOM_RETURN_KEY, value=['{{ ds }}'], session=session)
session.add(
TaskMap(
dag_id=dr.dag_id,
task_id=task1.task_id,
run_id=dr.run_id,
map_index=-1,
length=1,
keys=None,
)
)
session.flush()
mapped_ti: TaskInstance = dr.get_task_instance(mapped.task_id, session=session)
mapped_ti.map_index = 0
assert isinstance(mapped_ti.task, MappedOperator)
mapped.render_template_fields(context=mapped_ti.get_template_context(session=session))
assert isinstance(mapped_ti.task, MyOperator)
assert mapped_ti.task.value == "{{ ds }}", "Should not be templated!"
assert mapped_ti.task.arg1 == "{{ ds }}", "Should not be templated!"
assert mapped_ti.task.arg2 == "a"
def test_mapped_render_nested_template_fields(dag_maker, session):
with dag_maker(session=session):
MockOperator.partial(task_id="t").expand(arg1=["{{ ti.task_id }}", ["s", "{{ ti.task_id }}"]])
dr = dag_maker.create_dagrun()
decision = dr.task_instance_scheduling_decisions()
tis = {(ti.task_id, ti.map_index): ti for ti in decision.schedulable_tis}
assert len(tis) == 2
ti = tis[("t", 0)]
ti.run(session=session)
assert ti.task.arg1 == "t"
ti = tis[("t", 1)]
ti.run(session=session)
assert ti.task.arg1 == ["s", "t"]
@pytest.mark.parametrize(
["num_existing_tis", "expected"],
(
pytest.param(0, [(0, None), (1, None), (2, None)], id='only-unmapped-ti-exists'),
pytest.param(
3,
[(0, 'success'), (1, 'success'), (2, 'success')],
id='all-tis-exist',
),
pytest.param(
5,
[
(0, 'success'),
(1, 'success'),
(2, 'success'),
(3, TaskInstanceState.REMOVED),
(4, TaskInstanceState.REMOVED),
],
id="tis-to-be-removed",
),
),
)
def test_expand_kwargs_mapped_task_instance(dag_maker, session, num_existing_tis, expected):
literal = [{"arg1": "a"}, {"arg1": "b"}, {"arg1": "c"}]
with dag_maker(session=session):
task1 = BaseOperator(task_id="op1")
mapped = MockOperator.partial(task_id='task_2').expand_kwargs(task1.output)
dr = dag_maker.create_dagrun()
session.add(
TaskMap(
dag_id=dr.dag_id,
task_id=task1.task_id,
run_id=dr.run_id,
map_index=-1,
length=len(literal),
keys=None,
)
)
if num_existing_tis:
# Remove the map_index=-1 TI when we're creating other TIs
session.query(TaskInstance).filter(
TaskInstance.dag_id == mapped.dag_id,
TaskInstance.task_id == mapped.task_id,
TaskInstance.run_id == dr.run_id,
).delete()
for index in range(num_existing_tis):
# Give the existing TIs a state to make sure we don't change them
ti = TaskInstance(mapped, run_id=dr.run_id, map_index=index, state=TaskInstanceState.SUCCESS)
session.add(ti)
session.flush()
mapped.expand_mapped_task(dr.run_id, session=session)
indices = (
session.query(TaskInstance.map_index, TaskInstance.state)
.filter_by(task_id=mapped.task_id, dag_id=mapped.dag_id, run_id=dr.run_id)
.order_by(TaskInstance.map_index)
.all()
)
assert indices == expected
@pytest.mark.parametrize(
"map_index, expected",
[
pytest.param(0, "{{ ds }}", id="0"),
pytest.param(1, 2, id="1"),
],
)
def test_expand_kwargs_render_template_fields_validating_operator(dag_maker, session, map_index, expected):
with dag_maker(session=session):
task1 = BaseOperator(task_id="op1")
mapped = MockOperator.partial(task_id='a', arg2='{{ ti.task_id }}').expand_kwargs(task1.output)
dr = dag_maker.create_dagrun()
ti: TaskInstance = dr.get_task_instance(task1.task_id, session=session)
ti.xcom_push(key=XCOM_RETURN_KEY, value=[{"arg1": '{{ ds }}'}, {"arg1": 2}], session=session)
session.add(
TaskMap(
dag_id=dr.dag_id,
task_id=task1.task_id,
run_id=dr.run_id,
map_index=-1,
length=2,
keys=None,
)
)
session.flush()
ti: TaskInstance = dr.get_task_instance(mapped.task_id, session=session)
ti.refresh_from_task(mapped)
ti.map_index = map_index
assert isinstance(ti.task, MappedOperator)
mapped.render_template_fields(context=ti.get_template_context(session=session))
assert isinstance(ti.task, MockOperator)
assert ti.task.arg1 == expected
assert ti.task.arg2 == "a"
def test_xcomarg_property_of_mapped_operator(dag_maker):
with dag_maker("test_xcomarg_property_of_mapped_operator"):
op_a = MockOperator.partial(task_id="a").expand(arg1=["x", "y", "z"])
dag_maker.create_dagrun()
assert op_a.output == XComArg(op_a)
def test_set_xcomarg_dependencies_with_mapped_operator(dag_maker):
with dag_maker("test_set_xcomargs_dependencies_with_mapped_operator"):
op1 = MockOperator.partial(task_id="op1").expand(arg1=[1, 2, 3])
op2 = MockOperator.partial(task_id="op2").expand(arg2=["a", "b", "c"])
op3 = MockOperator(task_id="op3", arg1=op1.output)
op4 = MockOperator(task_id="op4", arg1=[op1.output, op2.output])
op5 = MockOperator(task_id="op5", arg1={"op1": op1.output, "op2": op2.output})
assert op1 in op3.upstream_list
assert op1 in op4.upstream_list
assert op2 in op4.upstream_list
assert op1 in op5.upstream_list
assert op2 in op5.upstream_list
def test_all_xcomargs_from_mapped_tasks_are_consumable(dag_maker, session):
class PushXcomOperator(MockOperator):
def __init__(self, arg1, **kwargs):
super().__init__(arg1=arg1, **kwargs)
def execute(self, context):
return self.arg1
class ConsumeXcomOperator(PushXcomOperator):
def execute(self, context):
assert {i for i in self.arg1} == {1, 2, 3}
with dag_maker("test_all_xcomargs_from_mapped_tasks_are_consumable"):
op1 = PushXcomOperator.partial(task_id="op1").expand(arg1=[1, 2, 3])
ConsumeXcomOperator(task_id="op2", arg1=op1.output)
dr = dag_maker.create_dagrun()
tis = dr.get_task_instances(session=session)
for ti in tis:
ti.run()