forked from materialsproject/jobflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_flow.py
More file actions
1058 lines (836 loc) · 29.5 KB
/
test_flow.py
File metadata and controls
1058 lines (836 loc) · 29.5 KB
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
import pytest
def add(a, b):
return a + b
def div(a, b=2):
return a / b
def get_test_job(*args):
from jobflow import Job
return Job(add, function_args=(1, 2))
def get_test_flow():
from jobflow import Flow, Job
add_job = Job(add, function_args=(1, 2))
div_job = Job(div, function_args=(add_job.output,), function_kwargs={"b": 3})
div_job.metadata = {"b": 3}
return Flow([add_job, div_job])
def get_maker_flow(return_makers=False):
from dataclasses import dataclass
from jobflow import Flow, Maker, job
@dataclass
class AddMaker(Maker):
name: str = "add"
b: int = 2
@job
def make(self, a):
return a + self.b
@dataclass
class DivMaker(Maker):
name: str = "div"
b: int = 5
@job
def make(self, a):
return a / self.b
add_maker = AddMaker(b=3)
div_maker = DivMaker(b=4)
add_job = add_maker.make(2)
div_job = div_maker.make(add_job.output)
flow = Flow([add_job, div_job])
if return_makers:
return flow, (AddMaker, DivMaker)
else:
return flow
def test_flow_of_jobs_init():
from jobflow.core.flow import Flow, JobOrder
# test single job
add_job = get_test_job()
flow = Flow([add_job], name="add")
assert flow.name == "add"
assert flow.host is None
assert flow.output is None
assert flow.job_uuids == (add_job.uuid,)
assert flow.all_uuids == (add_job.uuid,)
# test single job no list
add_job = get_test_job()
flow = Flow(add_job, name="add")
assert flow.name == "add"
assert flow.host is None
assert flow.output is None
assert flow.job_uuids == (add_job.uuid,)
# # test multiple job
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2])
assert flow.host is None
assert flow.output is None
assert flow.job_uuids == (add_job1.uuid, add_job2.uuid)
assert flow.all_uuids == (add_job1.uuid, add_job2.uuid)
# # test multiple job, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2], order=JobOrder.LINEAR)
assert flow.host is None
assert flow.output is None
assert flow.job_uuids == (add_job1.uuid, add_job2.uuid)
# test single job and output
add_job = get_test_job()
flow = Flow([add_job], output=add_job.output)
assert flow.output == add_job.output
# test multi job and list multi outputs
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2], output=[add_job1.output, add_job2.output])
assert flow.output[1] == add_job2.output
# test all jobs included needed to generate outputs
add_job = get_test_job()
with pytest.raises(ValueError):
Flow([], output=add_job.output)
# test job already belongs to another flow
add_job = get_test_job()
Flow([add_job])
with pytest.raises(ValueError):
Flow([add_job])
# test that two of the same job cannot be used in the same flow
add_job = get_test_job()
with pytest.raises(ValueError):
Flow([add_job, add_job])
def test_flow_of_flows_init():
from jobflow.core.flow import Flow
# test single flow
add_job = get_test_job()
subflow = Flow([add_job])
flow = Flow([subflow], name="add")
assert flow.name == "add"
assert flow.host is None
assert flow.output is None
assert flow.job_uuids == (add_job.uuid,)
assert flow.all_uuids == (add_job.uuid, subflow.uuid)
assert flow.jobs[0].host == flow.uuid
# test single flow no list
add_job = get_test_job()
subflow = Flow(add_job)
flow = Flow(subflow, name="add")
assert flow.name == "add"
assert flow.host is None
assert flow.output is None
assert flow.job_uuids == (add_job.uuid,)
assert flow.jobs[0].host == flow.uuid
# test multiple flows
add_job1 = get_test_job()
add_job2 = get_test_job()
subflow1 = Flow([add_job1])
subflow2 = Flow([add_job2])
flow = Flow([subflow1, subflow2])
assert flow.host is None
assert flow.output is None
assert flow.job_uuids == (add_job1.uuid, add_job2.uuid)
assert flow.all_uuids == (
add_job1.uuid,
subflow1.uuid,
add_job2.uuid,
subflow2.uuid,
)
assert flow.jobs[0].host == flow.uuid
assert flow.jobs[1].host == flow.uuid
# test single job and outputs
add_job = get_test_job()
subflow = Flow([add_job], output=add_job.output)
flow = Flow([subflow], output=subflow.output)
assert flow.output == add_job.output
# test multi job and list multi outputs
add_job1 = get_test_job()
add_job2 = get_test_job()
subflow1 = Flow([add_job1], output=add_job1.output)
subflow2 = Flow([add_job2], output=add_job2.output)
flow = Flow([subflow1, subflow2], output=[subflow1.output, subflow2.output])
assert flow.output[0] == add_job1.output
assert flow.output[1] == add_job2.output
# test all jobflow included needed to generate outputs
add_job = get_test_job()
subflow = Flow([add_job], output=add_job.output)
with pytest.raises(ValueError):
Flow([], output=subflow.output)
# test flow already belongs to another flow
add_job = get_test_job()
subflow = Flow([add_job], output=add_job.output)
Flow([subflow])
with pytest.raises(ValueError):
Flow([subflow])
# test that two of the same flow cannot be used in the same flow
add_job = get_test_job()
subflow = Flow([add_job], output=add_job.output)
with pytest.raises(ValueError):
Flow([subflow, subflow])
def test_flow_job_mixed():
from jobflow.core.flow import Flow
# test job and flows
add_job = get_test_job()
add_job2 = get_test_job()
subflow = Flow([add_job2])
flow = Flow([add_job, subflow])
assert flow.host is None
assert flow.output is None
assert flow.job_uuids == (add_job.uuid, add_job2.uuid)
assert flow.jobs[0].host == flow.uuid
assert flow.jobs[1].host == flow.uuid
# test with list multi outputs
add_job = get_test_job()
add_job2 = get_test_job()
subflow = Flow([add_job2], output=add_job2.output)
flow = Flow([add_job, subflow], output=[add_job.output, subflow.output])
assert flow.output[0] == add_job.output
assert flow.output[1] == add_job2.output
# test all jobs/flows included needed to generate outputs
add_job = get_test_job()
add_job2 = get_test_job()
subflow = Flow([add_job2], output=add_job2.output)
with pytest.raises(ValueError):
Flow([add_job], output=[add_job.output, subflow.output])
def test_graph():
from jobflow import Flow, JobOrder
# test unconnected graph
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2])
graph = flow.graph
assert len(graph.edges) == 0
assert len(graph.nodes) == 2
# test unconnected graph, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2], order=JobOrder.LINEAR)
graph = flow.graph
assert len(graph.edges) == 1
assert len(graph.nodes) == 2
# test connected graph, wrong order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job1.function_args = (2, add_job2.output)
flow = Flow([add_job1, add_job2])
graph = flow.graph
assert len(graph.edges) == 1
assert len(graph.nodes) == 2
# test connected graph, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job1.function_args = (2, add_job2.output)
flow = Flow([add_job1, add_job2], order=JobOrder.LINEAR)
graph = flow.graph
assert len(graph.edges) == 2
assert len(graph.nodes) == 2
# test unconnected graph
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job3 = get_test_job()
add_job4 = get_test_job()
subflow1 = Flow([add_job1, add_job2])
subflow2 = Flow([add_job3, add_job4])
flow = Flow([subflow1, subflow2])
graph = flow.graph
assert len(graph.edges) == 0
assert len(graph.nodes) == 4
# test unconnected graph, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job3 = get_test_job()
add_job4 = get_test_job()
subflow1 = Flow([add_job1, add_job2])
subflow2 = Flow([add_job3, add_job4])
flow = Flow([subflow1, subflow2], order=JobOrder.LINEAR)
graph = flow.graph
assert len(graph.edges) == 4
assert len(graph.nodes) == 4
# test connected graph, wrong order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job3 = get_test_job()
add_job4 = get_test_job()
subflow1 = Flow([add_job1, add_job2])
subflow2 = Flow([add_job3, add_job4])
add_job1.function_args = (2, add_job3.output)
flow = Flow([subflow1, subflow2])
graph = flow.graph
assert len(graph.edges) == 1
assert len(graph.nodes) == 4
# test connected graph, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job3 = get_test_job()
add_job4 = get_test_job()
subflow1 = Flow([add_job1, add_job2])
subflow2 = Flow([add_job3, add_job4])
add_job1.function_args = (2, add_job3.output)
flow = Flow([subflow1, subflow2], order=JobOrder.LINEAR)
graph = flow.graph
assert len(graph.edges) == 5
assert len(graph.nodes) == 4
# test external reference
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job1.function_args = (2, add_job2.output)
flow = Flow([add_job1])
graph = flow.graph
assert len(graph.edges) == 1
assert len(graph.nodes) == 2
def test_draw_graph():
from jobflow import Flow, JobOrder
# test unconnected graph
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2])
assert flow.draw_graph()
# test unconnected graph, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2], order=JobOrder.LINEAR)
assert flow.draw_graph()
# test connected graph, wrong order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job1.function_args = (2, add_job2.output)
flow = Flow([add_job1, add_job2])
assert flow.draw_graph()
# test connected graph, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job1.function_args = (2, add_job2.output)
flow = Flow([add_job1, add_job2], order=JobOrder.LINEAR)
assert flow.draw_graph()
@pytest.mark.usefixtures("no_pydot")
def test_draw_graph_nopydot():
from jobflow import Flow, JobOrder
# test unconnected graph
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2])
assert flow.draw_graph()
# test unconnected graph, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2], order=JobOrder.LINEAR)
assert flow.draw_graph()
# test connected graph, wrong order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job1.function_args = (2, add_job2.output)
flow = Flow([add_job1, add_job2])
assert flow.draw_graph()
# test connected graph, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job1.function_args = (2, add_job2.output)
flow = Flow([add_job1, add_job2], order=JobOrder.LINEAR)
assert flow.draw_graph()
def test_iterflow():
from jobflow import Flow, JobOrder, OutputReference
# test unconnected graph
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2])
iterated = list(flow.iterflow())
assert len(iterated) == 2
assert iterated[0][0] == add_job1
assert len(iterated[0][1]) == 0
assert iterated[1][0] == add_job2
assert len(iterated[1][1]) == 0
# test unconnected graph, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
flow = Flow([add_job1, add_job2], order=JobOrder.LINEAR)
iterated = list(flow.iterflow())
assert len(iterated) == 2
assert iterated[0][0] == add_job1
assert len(iterated[0][1]) == 0
assert iterated[1][0] == add_job2
assert len(iterated[1][1]) == 1
# test connected graph, wrong order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job1.function_args = (2, add_job2.output)
flow = Flow([add_job1, add_job2])
iterated = list(flow.iterflow())
assert len(iterated) == 2
assert iterated[0][0] == add_job2
assert len(iterated[0][1]) == 0
assert iterated[1][0] == add_job1
assert len(iterated[1][1]) == 1
# test connected graph, linear order
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job1.function_args = (2, add_job2.output)
flow = Flow([add_job1, add_job2], order=JobOrder.LINEAR)
with pytest.raises(ValueError):
list(flow.iterflow())
# test with external reference
add_job1 = get_test_job()
add_job1.function_args = (2, OutputReference("a-fake-uuid"))
flow = Flow([add_job1], order=JobOrder.LINEAR)
list(flow.iterflow())
def test_dag_validation():
from jobflow import Flow, Job
# test cycle detection of jobs
job1 = Job(add, function_args=(1, 2))
job2 = Job(add, function_args=(job1.output, 2))
job1.function_args = (job2.output, 2)
flow = Flow(jobs=[job1, job2])
with pytest.raises(
ValueError,
match="Job connectivity contains cycles therefore job execution order "
"cannot be determined",
):
next(flow.iterflow())
def test_serialization():
import json
from monty.json import MontyDecoder, MontyEncoder
from jobflow import Flow
flow = Flow([])
flow_host = Flow([flow])
host_uuid = flow_host.uuid
encoded_flow = json.loads(MontyEncoder().encode(flow_host))
decoded_flow = MontyDecoder().process_decoded(encoded_flow)
assert decoded_flow.jobs[0].host == host_uuid
def test_update_kwargs():
# test no filter
flow = get_test_flow()
flow.update_kwargs({"b": 5})
assert flow.jobs[0].function_kwargs["b"] == 5
assert flow.jobs[1].function_kwargs["b"] == 5
# test name filter
flow = get_test_flow()
flow.update_kwargs({"b": 5}, name_filter="div")
assert "b" not in flow.jobs[0].function_kwargs
assert flow.jobs[1].function_kwargs["b"] == 5
# test function filter
flow = get_test_flow()
flow.update_kwargs({"b": 5}, function_filter=div)
assert "b" not in flow.jobs[0].function_kwargs
assert flow.jobs[1].function_kwargs["b"] == 5
# test dict mod
flow = get_test_flow()
flow.update_kwargs({"_inc": {"b": 5}}, function_filter=div, dict_mod=True)
assert "b" not in flow.jobs[0].function_kwargs
assert flow.jobs[1].function_kwargs["b"] == 8
def test_update_maker_kwargs():
# test no filter
flow = get_maker_flow()
flow.update_maker_kwargs({"b": 10})
assert flow.jobs[0].maker.b == 10
assert flow.jobs[1].maker.b == 10
# test bad kwarg
flow = get_maker_flow()
with pytest.raises(TypeError):
flow.update_maker_kwargs({"c": 10})
# test name filter
flow = get_maker_flow()
flow.update_maker_kwargs({"b": 10}, name_filter="div")
assert flow.jobs[0].maker.b == 3
assert flow.jobs[1].maker.b == 10
# test class filter
flow, (_, DivMaker) = get_maker_flow(return_makers=True)
flow.update_maker_kwargs({"b": 10}, class_filter=DivMaker)
assert flow.jobs[0].maker.b == 3
assert flow.jobs[1].maker.b == 10
# test class filter with instance
flow, (_, DivMaker) = get_maker_flow(return_makers=True)
div_maker = DivMaker()
flow.update_maker_kwargs({"b": 10}, class_filter=div_maker)
assert flow.jobs[0].maker.b == 3
assert flow.jobs[1].maker.b == 10
# test dict mod
flow = get_maker_flow()
flow.update_maker_kwargs({"_inc": {"b": 10}}, name_filter="div", dict_mod=True)
assert flow.jobs[0].maker.b == 3
assert flow.jobs[1].maker.b == 14
def test_append_name():
from jobflow import Flow
# test append
flow = get_test_flow()
flow.append_name(" test")
assert flow.name == "Flow test"
assert flow.jobs[0].name == "add test"
# test prepend
flow = get_test_flow()
flow.append_name("test ", prepend=True)
assert flow.name == "test Flow"
assert flow.jobs[0].name == "test add"
# test empty Flow
flow = Flow([], name="abc")
flow.append_name(" test")
assert flow.name == "abc test"
def test_get_flow():
import jobflow
from jobflow import Job
from jobflow.core.flow import get_flow
# test get_flow method with a single job
job = get_test_job()
assert isinstance(job, jobflow.Job)
flow = get_flow(job)
assert isinstance(flow, jobflow.Flow)
assert flow.jobs[0] is job
# test get_flow method with a list of jobs
job1 = get_test_job()
job2 = get_test_job()
flow = get_flow([job1, job2])
assert isinstance(flow, jobflow.Flow)
assert len(flow.jobs) == 2
assert flow.jobs[0] is job1
assert flow.jobs[1] is job2
# test get_flow method with a flow
flw = get_test_flow()
assert isinstance(flw, jobflow.Flow)
flow = get_flow(flw)
assert isinstance(flow, jobflow.Flow)
assert flow is flw
# test all jobs included for graph to work
job1 = Job(add, function_args=(1, 2))
job2 = Job(add, function_args=(job1.output.value, 2))
with pytest.raises(ValueError):
get_flow(job2, allow_external_references=False)
job1 = Job(add, function_args=(1, 2))
job2 = Job(add, function_args=(job1.output.value, 2))
assert get_flow(job2, allow_external_references=True)
# test all jobs included for graph to work
job1 = Job(add, function_args=(1, 2))
job2 = Job(add, function_args=(job1.output.value, 2))
get_flow([job1, job2])
def test_add_hosts_uuids():
from jobflow.core.flow import Flow
add_job1 = get_test_job()
add_job2 = get_test_job()
# test adding host id again (automatically added once on job creation)
flow = Flow([add_job1, add_job2])
flow.add_hosts_uuids()
assert add_job1.hosts == [flow.uuid, flow.uuid]
assert add_job2.hosts == [flow.uuid, flow.uuid]
# test appending specific uuid
flow = Flow([get_test_job()])
flow.add_hosts_uuids("abc")
assert flow.jobs[0].hosts == [flow.uuid, "abc"]
# test appending several uuid
flow = Flow([get_test_job()])
flow.add_hosts_uuids(["abc", "xyz"])
assert flow.jobs[0].hosts == [flow.uuid, "abc", "xyz"]
# test prepending specific uuid
flow = Flow([get_test_job()])
flow.add_hosts_uuids("abc", prepend=True)
assert flow.jobs[0].hosts == ["abc", flow.uuid]
def test_hosts():
from jobflow.core.flow import Flow
# test single job
add_job1 = get_test_job()
add_job2 = get_test_job()
flow1 = Flow(add_job1)
flow2 = Flow([flow1, add_job2])
flow3 = Flow(flow2)
assert add_job1.hosts == [flow1.uuid, flow2.uuid, flow3.uuid]
assert add_job2.hosts == [flow2.uuid, flow3.uuid]
assert flow1.hosts == [flow2.uuid, flow3.uuid]
assert flow2.hosts == [flow3.uuid]
assert flow3.hosts == []
def test_add_jobs():
from jobflow.core.flow import Flow
add_job1 = get_test_job()
add_job2 = get_test_job()
flow1 = Flow(add_job1)
flow1.add_jobs(add_job2)
assert len(flow1.jobs) == 2
assert add_job2.hosts == [flow1.uuid]
with pytest.raises(ValueError):
flow1.add_jobs(add_job2)
add_job3 = get_test_job()
Flow(add_job3)
# job belongs to another Flow
with pytest.raises(ValueError):
flow1.add_jobs(add_job3)
add_job4 = get_test_job()
with pytest.raises(ValueError):
flow1.add_jobs([add_job4, add_job4])
# nested flows
inner_flow = Flow(get_test_job())
outer_flow = Flow(inner_flow)
assert inner_flow.hosts == [outer_flow.uuid]
added_job = get_test_job()
inner_flow.add_jobs(added_job)
assert added_job.hosts == [inner_flow.uuid, outer_flow.uuid]
# circular dependency
flow1 = Flow([get_test_flow()])
flow2 = Flow([flow1])
flow3 = Flow([flow2])
with pytest.raises(ValueError):
flow1.add_jobs(flow3)
# test passing single job to @jobs setter
flow1.jobs = add_job1
assert len(flow1.jobs) == 1
assert flow1.jobs[0] is add_job1
def test_remove_jobs():
from jobflow.core.flow import Flow
# test removing one job
add_job1 = get_test_job()
add_job2 = get_test_job()
flow1 = Flow([add_job1, add_job2])
flow1.remove_jobs(0)
assert len(flow1.jobs) == 1
assert flow1.jobs[0].uuid is add_job2.uuid
with pytest.raises(ValueError):
flow1.remove_jobs(-1)
with pytest.raises(ValueError):
flow1.remove_jobs(10)
# test removing two jobs
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job3 = get_test_job()
flow = Flow([add_job1, add_job2, add_job3])
flow.remove_jobs([0, 2])
assert len(flow.jobs) == 1
assert flow.jobs[0].uuid is add_job2.uuid
# test removing job which is used in output
add_job1 = get_test_job()
add_job2 = get_test_job()
flow2 = Flow([add_job1, add_job2], output=add_job2.output)
with pytest.raises(ValueError):
flow2.remove_jobs(1)
# test removing a flow
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job3 = get_test_job()
flow_inner = Flow([add_job1, add_job2])
flow = Flow([flow_inner, add_job3])
flow.remove_jobs(0)
assert len(flow.jobs) == 1
assert flow.jobs[0].uuid is add_job3.uuid
# test removing a flow which is used in output
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job3 = get_test_job()
flow_inner = Flow([add_job1, add_job2])
flow = Flow([flow_inner, add_job3], output=flow_inner.jobs[0].output)
with pytest.raises(ValueError):
flow.remove_jobs(0)
# test removing a job in a flow containing another flow
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job3 = get_test_job()
flow_inner = Flow([add_job1, add_job2])
flow = Flow([flow_inner, add_job3])
flow.remove_jobs(1)
assert len(flow.jobs) == 1
assert flow.jobs[0].uuid is flow_inner.uuid
def test_set_output():
from jobflow.core.flow import Flow
add_job1 = get_test_job()
add_job2 = get_test_job()
add_job3 = get_test_job()
flow = Flow([add_job1, add_job2], output=add_job2.output)
flow.output = add_job1.output
assert flow.output.uuid == add_job1.uuid
with pytest.raises(ValueError):
flow.output = [add_job3.output]
def test_update_metadata():
# test no filter
flow = get_test_flow()
flow.update_metadata({"b": 5})
assert flow.jobs[0].metadata["b"] == 5
assert flow.jobs[1].metadata["b"] == 5
# test name filter
flow = get_test_flow()
flow.update_metadata({"b": 5}, name_filter="div")
assert "b" not in flow.jobs[0].metadata
assert flow.jobs[1].metadata["b"] == 5
# test function filter
flow = get_test_flow()
flow.update_metadata({"b": 5}, function_filter=div)
assert "b" not in flow.jobs[0].metadata
assert flow.jobs[1].metadata["b"] == 5
# test dict mod
flow = get_test_flow()
flow.update_metadata({"_inc": {"b": 5}}, function_filter=div, dict_mod=True)
assert "b" not in flow.jobs[0].metadata
assert flow.jobs[1].metadata["b"] == 8
def test_update_config():
from jobflow import JobConfig
new_config = JobConfig(
resolve_references=False,
manager_config={"a": "b"},
pass_manager_config=False,
)
# test no filter
flow = get_test_flow()
flow.update_config(new_config)
assert flow.jobs[0].config == new_config
assert flow.jobs[1].config == new_config
# test name filter
flow = get_test_flow()
flow.update_config(new_config, name_filter="div")
assert flow.jobs[0].config != new_config
assert flow.jobs[1].config == new_config
# test function filter
flow = get_test_flow()
flow.update_config(new_config, function_filter=div)
assert flow.jobs[0].config != new_config
assert flow.jobs[1].config == new_config
# test attributes
flow = get_test_flow()
flow.update_config(new_config, function_filter=div, attributes=["manager_config"])
assert flow.jobs[0].config.manager_config == {}
assert flow.jobs[0].config.resolve_references
assert flow.jobs[1].config.manager_config == {"a": "b"}
assert flow.jobs[1].config.resolve_references
def test_flow_magic_methods():
from jobflow import Flow
# prepare test jobs and flows
job1, job2, job3, job4, job5, job6 = map(get_test_job, range(6))
flow1 = Flow([job1])
flow2 = Flow([job2, job3])
# test __len__
assert len(flow1) == 1
assert len(flow2) == 2
# test __getitem__
assert flow2[0] == job2
assert flow2[1] == job3
# test __setitem__
flow2[0] = job4
assert flow2[0] == job4
# test __iter__
for job in flow2:
assert job in [job4, job3]
# test __contains__
assert job1 in flow1
assert job4 in flow2
assert job3 in flow2
# test __add__
flow3 = flow1 + job5
assert len(flow3) == 2
assert job5 in flow3
# test __sub__
flow4 = flow3 - job5
assert len(flow4) == 1 == len(flow1)
assert job5 not in flow4
# test __eq__ and __hash__
assert flow1 == flow1
assert flow1 != flow2
assert hash(flow1) != hash(flow2)
# test __getitem__ with out of range index
with pytest.raises(IndexError):
_ = flow1[10]
# test __setitem__ with out of range index
with pytest.raises(IndexError):
flow1[10] = job4
# test __contains__ with job not in flow
assert job5 not in flow1
assert flow2 not in flow1
# test __add__ with non-job item
with pytest.raises(TypeError):
_ = job6 + "not a job"
# test __sub__ with non-job item
with pytest.raises(TypeError):
_ = job6 - "not a job"
# test __sub__ with job not in flow
with pytest.raises(
ValueError, match=r"Job\(name='add', uuid='.+'\) not found in flow"
):
_ = flow1 - job5
# test __eq__ with non-flow item
assert flow1 != "not a flow"
def test_flow_magic_methods_edge_cases():
from jobflow import Flow
# prepare test jobs and flows
job1, job2, job3, job4, job5, job6 = map(get_test_job, range(6))
Flow([job6])
empty_flow = Flow([])
flow1 = Flow([job1, job2, job3, job4])
# test negative indexing with __getitem__ and __setitem__
assert flow1[-1] == job4
flow1[-1] = job5
assert flow1[-1] == job5
# test slicing with __getitem__ and __setitem__
assert flow1[1:3] == (job2, job3)
flow1[1] = job4 # test single item
assert flow1[1] == job4
flow1[1:3] = (job4, job5) # test multiple items with slicing
assert flow1[1:3] == (job4, job5)
# test __add__ with bad type
assert flow1.__add__("string") == NotImplemented
for val in (None, 1.0, 1, "1", [1], (1,), {1: 1}):
type_name = type(val).__name__
with pytest.raises(
TypeError,
match=f"Flow can only contain Job or Flow objects, not {type_name}",
):
flow1[1:3] = val
# adding an empty flow still increases len by 1
assert len(flow1 + empty_flow) == len(flow1) + 1
# test __add__ and __sub__ with job already in the flow
with pytest.raises(
ValueError, match="jobs array contains multiple jobs/flows with the same uuid"
):
_ = flow1 + job1
with pytest.raises(ValueError, match="Job .+ already belongs to another flow"):
_ = flow1 + job6
def test_flow_repr():
from jobflow import Flow
# prepare jobs and flows
job1, job2, job3, job4, job5, job6, job7 = map(get_test_job, range(7))
flow1 = Flow([job1])
flow2 = Flow([job2, job3])
sub_flow1 = Flow([job6, job7])
flow3 = Flow([job4, job5, sub_flow1])
flow4 = Flow([flow1, flow2, flow3])
flow_repr = repr(flow4).splitlines()
lines = (
"Flow(name='Flow', uuid='",
"1. Flow(name='Flow', uuid='",
" 1.1. Job(name='add', uuid='",
"2. Flow(name='Flow', uuid='",
" 2.1. Job(name='add', uuid='",
" 2.2. Job(name='add', uuid='",
"3. Flow(name='Flow', uuid='",
" 3.1. Job(name='add', uuid='",
" 3.2. Job(name='add', uuid='",
" 3.3. Flow(name='Flow', uuid='",
" 3.3.1. Job(name='add', uuid='",
" 3.3.2. Job(name='add', uuid='",
)
assert len(lines) == len(flow_repr)
for expected, line in zip(lines, flow_repr):
assert line.startswith(expected), f"{line=} doesn't start with {expected=}"
def test_get_item():
from jobflow import Flow, job, run_locally
@job
def make_str(s):
return {"hello": s}