-
Notifications
You must be signed in to change notification settings - Fork 14.6k
/
Copy pathtest_mappedoperator.py
1765 lines (1440 loc) · 61.7 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
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# 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 collections import defaultdict
from datetime import timedelta
from typing import TYPE_CHECKING
from unittest import mock
from unittest.mock import patch
import pendulum
import pytest
from sqlalchemy import select
from airflow.decorators import setup, task, task_group, teardown
from airflow.exceptions import AirflowSkipException
from airflow.models.baseoperator import BaseOperator
from airflow.models.dag import DAG
from airflow.models.mappedoperator import MappedOperator
from airflow.models.param import ParamsDict
from airflow.models.taskinstance import TaskInstance
from airflow.models.taskmap import TaskMap
from airflow.models.xcom_arg import XComArg
from airflow.providers.standard.operators.python import PythonOperator
from airflow.utils.state import TaskInstanceState
from airflow.utils.task_group import TaskGroup
from airflow.utils.task_instance_session import set_current_task_instance_session
from airflow.utils.trigger_rule import TriggerRule
from airflow.utils.xcom import XCOM_RETURN_KEY
from tests.models import DEFAULT_DATE
from tests_common.test_utils.mapping import expand_mapped_task
from tests_common.test_utils.mock_operators import (
MockOperator,
MockOperatorWithNestedFields,
NestedFields,
)
pytestmark = pytest.mark.db_test
if TYPE_CHECKING:
from airflow.utils.context import Context
def test_task_mapping_with_dag():
with DAG("test-dag", schedule=None, 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]
@patch("airflow.models.abstractoperator.AbstractOperator.render_template")
def test_task_mapping_with_dag_and_list_of_pandas_dataframe(mock_render_template, caplog):
class UnrenderableClass:
def __bool__(self):
raise ValueError("Similar to Pandas DataFrames, this class raises an exception.")
class CustomOperator(BaseOperator):
template_fields = ("arg",)
def __init__(self, arg, **kwargs):
super().__init__(**kwargs)
self.arg = arg
def execute(self, context: Context):
pass
with DAG("test-dag", schedule=None, start_date=DEFAULT_DATE) as dag:
task1 = CustomOperator(task_id="op1", arg=None)
unrenderable_values = [UnrenderableClass(), UnrenderableClass()]
mapped = CustomOperator.partial(task_id="task_2").expand(arg=unrenderable_values)
task1 >> mapped
dag.test()
assert (
"Unable to check if the value of type 'UnrenderableClass' is False for task 'task_2', field 'arg'"
in caplog.text
)
mock_render_template.assert_called()
def test_task_mapping_without_dag_context():
with DAG("test-dag", schedule=None, 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", schedule=None, 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_task_mapping_override_default_args():
default_args = {"retries": 2, "start_date": DEFAULT_DATE.now()}
with DAG("test-dag", schedule=None, start_date=DEFAULT_DATE, default_args=default_args):
literal = ["a", "b", "c"]
mapped = MockOperator.partial(task_id="task", retries=1).expand(arg2=literal)
# retries should be 1 because it is provided as a partial arg
assert mapped.partial_kwargs["retries"] == 1
# start_date should be equal to default_args["start_date"] because it is not provided as partial arg
assert mapped.start_date == pendulum.instance(default_args["start_date"])
# owner should be equal to Airflow default owner (airflow) because it is not provided at all
assert mapped.owner == "airflow"
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", schedule=None, 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)
def test_partial_on_invalid_pool_slots_raises() -> None:
"""Test that when we pass an invalid value to pool_slots in partial(),
i.e. if the value is not an integer, an error is raised at import time."""
with pytest.raises(TypeError, match="'<' not supported between instances of 'str' and 'int'"):
MockOperator.partial(task_id="pool_slots_test", pool="test", pool_slots="a").expand(arg1=[1, 2, 3])
@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_failed_state_in_db(dag_maker, session):
"""
This test tries to recreate a faulty state in the database and checks if we can recover from it.
The state that happens is that there exists mapped task instances and the unmapped task instance.
So we have instances with map_index [-1, 0, 1]. The -1 task instances should be removed in this case.
"""
literal = [1, 2]
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,
)
)
for index in range(2):
# 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()
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()
)
# Make sure we have the faulty state in the database
assert indices == [(-1, None), (0, "success"), (1, "success")]
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()
)
# The -1 index should be cleaned up
assert indices == [(0, "success"), (1, "success")]
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)
@pytest.mark.parametrize(
"dag_params, task_params, expected_partial_params",
[
pytest.param(None, None, ParamsDict(), id="none"),
pytest.param({"a": -1}, None, ParamsDict({"a": -1}), id="dag"),
pytest.param(None, {"b": -2}, ParamsDict({"b": -2}), id="task"),
pytest.param({"a": -1}, {"b": -2}, ParamsDict({"a": -1, "b": -2}), id="merge"),
],
)
def test_mapped_expand_against_params(dag_maker, dag_params, task_params, expected_partial_params):
with dag_maker(params=dag_params) as dag:
MockOperator.partial(task_id="t", params=task_params).expand(params=[{"c": "x"}, {"d": 1}])
t = dag.get_task("t")
assert isinstance(t, MappedOperator)
assert t.params == expected_partial_params
assert t.expand_input.value == {"params": [{"c": "x"}, {"d": 1}]}
def test_mapped_render_template_fields_validating_operator(dag_maker, session, tmp_path):
file_template_dir = tmp_path / "path" / "to"
file_template_dir.mkdir(parents=True, exist_ok=True)
file_template = file_template_dir / "file.ext"
file_template.write_text("loaded data")
with set_current_task_instance_session(session=session):
class MyOperator(BaseOperator):
template_fields = ("partial_template", "map_template", "file_template")
template_ext = (".ext",)
def __init__(
self, partial_template, partial_static, map_template, map_static, file_template, **kwargs
):
for value in [partial_template, partial_static, map_template, map_static, file_template]:
assert isinstance(value, str), "value should have been resolved before unmapping"
super().__init__(**kwargs)
self.partial_template = partial_template
self.partial_static = partial_static
self.map_template = map_template
self.map_static = map_static
self.file_template = file_template
def execute(self, context):
pass
with dag_maker(session=session, template_searchpath=tmp_path.__fspath__()):
task1 = BaseOperator(task_id="op1")
output1 = task1.output
mapped = MyOperator.partial(
task_id="a", partial_template="{{ ti.task_id }}", partial_static="{{ ti.task_id }}"
).expand(map_template=output1, map_static=output1, file_template=["/path/to/file.ext"])
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.partial_template == "a", "Should be templated!"
assert mapped_ti.task.partial_static == "{{ ti.task_id }}", "Should not be templated!"
assert mapped_ti.task.map_template == "{{ ds }}", "Should not be templated!"
assert mapped_ti.task.map_static == "{{ ds }}", "Should not be templated!"
assert mapped_ti.task.file_template == "loaded data", "Should be templated!"
def test_mapped_expand_kwargs_render_template_fields_validating_operator(dag_maker, session, tmp_path):
file_template_dir = tmp_path / "path" / "to"
file_template_dir.mkdir(parents=True, exist_ok=True)
file_template = file_template_dir / "file.ext"
file_template.write_text("loaded data")
with set_current_task_instance_session(session=session):
class MyOperator(BaseOperator):
template_fields = ("partial_template", "map_template", "file_template")
template_ext = (".ext",)
def __init__(
self, partial_template, partial_static, map_template, map_static, file_template, **kwargs
):
for value in [partial_template, partial_static, map_template, map_static, file_template]:
assert isinstance(value, str), "value should have been resolved before unmapping"
super().__init__(**kwargs)
self.partial_template = partial_template
self.partial_static = partial_static
self.map_template = map_template
self.map_static = map_static
self.file_template = file_template
def execute(self, context):
pass
with dag_maker(session=session, template_searchpath=tmp_path.__fspath__()):
mapped = MyOperator.partial(
task_id="a", partial_template="{{ ti.task_id }}", partial_static="{{ ti.task_id }}"
).expand_kwargs(
[{"map_template": "{{ ds }}", "map_static": "{{ ds }}", "file_template": "/path/to/file.ext"}]
)
dr = dag_maker.create_dagrun()
mapped_ti: TaskInstance = dr.get_task_instance(mapped.task_id, session=session, 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.partial_template == "a", "Should be templated!"
assert mapped_ti.task.partial_static == "{{ ti.task_id }}", "Should not be templated!"
assert mapped_ti.task.map_template == "2016-01-01", "Should be templated!"
assert mapped_ti.task.map_static == "{{ ds }}", "Should not be templated!"
assert mapped_ti.task.file_template == "loaded data", "Should be templated!"
def test_mapped_render_nested_template_fields(dag_maker, session):
with dag_maker(session=session):
MockOperatorWithNestedFields.partial(
task_id="t", arg2=NestedFields(field_1="{{ ti.task_id }}", field_2="value_2")
).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"
assert ti.task.arg2.field_1 == "t"
assert ti.task.arg2.field_2 == "value_2"
ti = tis[("t", 1)]
ti.run(session=session)
assert ti.task.arg1 == ["s", "t"]
assert ti.task.arg2.field_1 == "t"
assert ti.task.arg2.field_2 == "value_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_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
def _create_mapped_with_name_template_classic(*, task_id, map_names, template):
class HasMapName(BaseOperator):
def __init__(self, *, map_name: str, **kwargs):
super().__init__(**kwargs)
self.map_name = map_name
def execute(self, context):
context["map_name"] = self.map_name
return HasMapName.partial(task_id=task_id, map_index_template=template).expand(
map_name=map_names,
)
def _create_mapped_with_name_template_taskflow(*, task_id, map_names, template):
from airflow.providers.standard.operators.python import get_current_context
@task(task_id=task_id, map_index_template=template)
def task1(map_name):
context = get_current_context()
context["map_name"] = map_name
return task1.expand(map_name=map_names)
def _create_named_map_index_renders_on_failure_classic(*, task_id, map_names, template):
class HasMapName(BaseOperator):
def __init__(self, *, map_name: str, **kwargs):
super().__init__(**kwargs)
self.map_name = map_name
def execute(self, context):
context["map_name"] = self.map_name
raise AirflowSkipException("Imagine this task failed!")
return HasMapName.partial(task_id=task_id, map_index_template=template).expand(
map_name=map_names,
)
def _create_named_map_index_renders_on_failure_taskflow(*, task_id, map_names, template):
from airflow.providers.standard.operators.python import get_current_context
@task(task_id=task_id, map_index_template=template)
def task1(map_name):
context = get_current_context()
context["map_name"] = map_name
raise AirflowSkipException("Imagine this task failed!")
return task1.expand(map_name=map_names)
@pytest.mark.parametrize(
"template, expected_rendered_names",
[
pytest.param(None, [None, None], id="unset"),
pytest.param("", ["", ""], id="constant"),
pytest.param("{{ ti.task_id }}-{{ ti.map_index }}", ["task1-0", "task1-1"], id="builtin"),
pytest.param("{{ ti.task_id }}-{{ map_name }}", ["task1-a", "task1-b"], id="custom"),
],
)
@pytest.mark.parametrize(
"create_mapped_task",
[
pytest.param(_create_mapped_with_name_template_classic, id="classic"),
pytest.param(_create_mapped_with_name_template_taskflow, id="taskflow"),
pytest.param(_create_named_map_index_renders_on_failure_classic, id="classic-failure"),
pytest.param(_create_named_map_index_renders_on_failure_taskflow, id="taskflow-failure"),
],
)
def test_expand_mapped_task_instance_with_named_index(
dag_maker,
session,
create_mapped_task,
template,
expected_rendered_names,
) -> None:
"""Test that the correct number of downstream tasks are generated when mapping with an XComArg"""
with dag_maker("test-dag", session=session, start_date=DEFAULT_DATE):
create_mapped_task(task_id="task1", map_names=["a", "b"], template=template)
dr = dag_maker.create_dagrun()
tis = dr.get_task_instances()
for ti in tis:
ti.run()
session.flush()
indices = session.scalars(
select(TaskInstance.rendered_map_index)
.where(
TaskInstance.dag_id == "test-dag",
TaskInstance.task_id == "task1",
TaskInstance.run_id == dr.run_id,
)
.order_by(TaskInstance.map_index)
).all()
assert indices == expected_rendered_names
@pytest.mark.parametrize(
"create_mapped_task",
[
pytest.param(_create_mapped_with_name_template_classic, id="classic"),
pytest.param(_create_mapped_with_name_template_taskflow, id="taskflow"),
],
)
def test_expand_mapped_task_task_instance_mutation_hook(dag_maker, session, create_mapped_task) -> None:
"""Test that the tast_instance_mutation_hook is called."""
expected_map_index = [0, 1, 2]
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()
with mock.patch("airflow.settings.task_instance_mutation_hook") as mock_hook:
expand_mapped_task(mapped, dr.run_id, task1.task_id, length=len(expected_map_index), session=session)
for index, call in enumerate(mock_hook.call_args_list):
assert call.args[0].map_index == expected_map_index[index]
@pytest.mark.parametrize(
"map_index, expected",
[
pytest.param(0, "2016-01-01", id="0"),
pytest.param(1, 2, id="1"),
],
)
def test_expand_kwargs_render_template_fields_validating_operator(dag_maker, session, map_index, expected):
with set_current_task_instance_session(session=session):
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 set(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()
def test_task_mapping_with_task_group_context():
with DAG("test-dag", schedule=None, start_date=DEFAULT_DATE) as dag:
task1 = BaseOperator(task_id="op1")
finish = MockOperator(task_id="finish")
with TaskGroup("test-group") as group:
literal = ["a", "b", "c"]
mapped = MockOperator.partial(task_id="task_2").expand(arg2=literal)
task1 >> group >> finish
assert task1.downstream_list == [mapped]
assert mapped.upstream_list == [task1]
assert mapped in dag.tasks
assert mapped.task_group == group
assert finish.upstream_list == [mapped]
assert mapped.downstream_list == [finish]
def test_task_mapping_with_explicit_task_group():
with DAG("test-dag", schedule=None, start_date=DEFAULT_DATE) as dag:
task1 = BaseOperator(task_id="op1")
finish = MockOperator(task_id="finish")
group = TaskGroup("test-group")
literal = ["a", "b", "c"]
mapped = MockOperator.partial(task_id="task_2", task_group=group).expand(arg2=literal)
task1 >> group >> finish
assert task1.downstream_list == [mapped]
assert mapped.upstream_list == [task1]
assert mapped in dag.tasks
assert mapped.task_group == group
assert finish.upstream_list == [mapped]
assert mapped.downstream_list == [finish]
class TestMappedSetupTeardown:
@staticmethod
def get_states(dr):
ti_dict = defaultdict(dict)
for ti in dr.get_task_instances():
if ti.map_index == -1:
ti_dict[ti.task_id] = ti.state
else:
ti_dict[ti.task_id][ti.map_index] = ti.state
return dict(ti_dict)
def classic_operator(self, task_id, ret=None, partial=False, fail=False):
def success_callable(ret=None):
def inner(*args, **kwargs):
print(args)
print(kwargs)
if ret:
return ret
return inner
def failure_callable():
def inner(*args, **kwargs):
print(args)
print(kwargs)
raise ValueError("fail")
return inner
kwargs = dict(task_id=task_id)
if not fail:
kwargs.update(python_callable=success_callable(ret=ret))
else:
kwargs.update(python_callable=failure_callable())
if partial:
return PythonOperator.partial(**kwargs)
else:
return PythonOperator(**kwargs)
@pytest.mark.parametrize("type_", ["taskflow", "classic"])
def test_one_to_many_work_failed(self, type_, dag_maker):
"""
Work task failed. Setup maps to teardown. Should have 3 teardowns all successful even
though the work task has failed.
"""
if type_ == "taskflow":
with dag_maker() as dag:
@setup
def my_setup():
print("setting up multiple things")
return [1, 2, 3]
@task
def my_work(val):
print(f"doing work with multiple things: {val}")
raise ValueError("fail!")
@teardown
def my_teardown(val):
print(f"teardown: {val}")
s = my_setup()
t = my_teardown.expand(val=s)
with t:
my_work(s)
else:
@task
def my_work(val):
print(f"work: {val}")
raise ValueError("i fail")
with dag_maker() as dag:
my_setup = self.classic_operator("my_setup", [[1], [2], [3]])
my_teardown = self.classic_operator("my_teardown", partial=True)
t = my_teardown.expand(op_args=my_setup.output)
with t.as_teardown(setups=my_setup):
my_work(my_setup.output)
dr = dag.test()
states = self.get_states(dr)
expected = {
"my_setup": "success",
"my_work": "failed",
"my_teardown": {0: "success", 1: "success", 2: "success"},
}
assert states == expected
@pytest.mark.parametrize("type_", ["taskflow", "classic"])
def test_many_one_explicit_odd_setup_mapped_setups_fail(self, type_, dag_maker):
"""
one unmapped setup goes to two different teardowns
one mapped setup goes to same teardown
mapped setups fail
teardowns should still run
"""
if type_ == "taskflow":
with dag_maker() as dag:
@task
def other_setup():
print("other setup")
return "other setup"
@task
def other_work():
print("other work")
return "other work"
@task
def other_teardown():
print("other teardown")
return "other teardown"
@task
def my_setup(val):
print(f"setup: {val}")
raise ValueError("fail")
return val
@task
def my_work(val):
print(f"work: {val}")
@task