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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
|
#
# __COPYRIGHT__
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
from __future__ import division
__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
import SCons.compat
import copy
import sys
import unittest
import SCons.Taskmaster
import SCons.Errors
built_text = None
cache_text = []
visited_nodes = []
executed = None
scan_called = 0
class Node:
def __init__(self, name, kids = [], scans = []):
self.name = name
self.kids = kids
self.scans = scans
self.cached = 0
self.scanned = 0
self.scanner = None
self.targets = [self]
self.prerequisites = []
class Builder:
def targets(self, node):
return node.targets
self.builder = Builder()
self.bsig = None
self.csig = None
self.state = SCons.Node.no_state
self.prepared = None
self.ref_count = 0
self.waiting_parents = set()
self.waiting_s_e = set()
self.side_effect = 0
self.side_effects = []
self.alttargets = []
self.postprocessed = None
self._bsig_val = None
self._current_val = 0
self.always_build = None
def disambiguate(self):
return self
def push_to_cache(self):
pass
def retrieve_from_cache(self):
global cache_text
if self.cached:
cache_text.append(self.name + " retrieved")
return self.cached
def make_ready(self):
pass
def prepare(self):
self.prepared = 1
def build(self):
global built_text
built_text = self.name + " built"
def built(self):
global built_text
if not self.cached:
built_text = built_text + " really"
def has_builder(self):
return not self.builder is None
def is_derived(self):
return self.has_builder or self.side_effect
def alter_targets(self):
return self.alttargets, None
def visited(self):
global visited_nodes
visited_nodes.append(self.name)
def children(self):
if not self.scanned:
self.scan()
self.scanned = 1
return self.kids
def scan(self):
global scan_called
scan_called = scan_called + 1
self.kids = self.kids + self.scans
self.scans = []
def scanner_key(self):
return self.name
def add_to_waiting_parents(self, node):
wp = self.waiting_parents
if node in wp:
return 0
wp.add(node)
return 1
def get_state(self):
return self.state
def set_state(self, state):
self.state = state
def set_bsig(self, bsig):
self.bsig = bsig
def set_csig(self, csig):
self.csig = csig
def store_csig(self):
pass
def store_bsig(self):
pass
def is_pseudo_derived(self):
pass
def is_up_to_date(self):
return self._current_val
def depends_on(self, nodes):
for node in nodes:
if node in self.kids:
return 1
return 0
def __str__(self):
return self.name
def postprocess(self):
self.postprocessed = 1
self.waiting_parents = set()
def get_executor(self):
if not hasattr(self, 'executor'):
class Executor:
def prepare(self):
pass
def get_action_targets(self):
return self.targets
def get_all_targets(self):
return self.targets
def get_all_children(self):
result = []
for node in self.targets:
result.extend(node.children())
return result
def get_all_prerequisites(self):
return []
def get_action_side_effects(self):
return []
self.executor = Executor()
self.executor.targets = self.targets
return self.executor
class OtherError(Exception):
pass
class MyException(Exception):
pass
class TaskmasterTestCase(unittest.TestCase):
def test_next_task(self):
"""Test fetching the next task
"""
global built_text
n1 = Node("n1")
tm = SCons.Taskmaster.Taskmaster([n1, n1])
t = tm.next_task()
t.prepare()
t.execute()
t = tm.next_task()
assert t is None
n1 = Node("n1")
n2 = Node("n2")
n3 = Node("n3", [n1, n2])
tm = SCons.Taskmaster.Taskmaster([n3])
t = tm.next_task()
t.prepare()
t.execute()
assert built_text == "n1 built", built_text
t.executed()
t.postprocess()
t = tm.next_task()
t.prepare()
t.execute()
assert built_text == "n2 built", built_text
t.executed()
t.postprocess()
t = tm.next_task()
t.prepare()
t.execute()
assert built_text == "n3 built", built_text
t.executed()
t.postprocess()
assert tm.next_task() is None
built_text = "up to date: "
top_node = n3
class MyTask(SCons.Taskmaster.Task):
def execute(self):
global built_text
if self.targets[0].get_state() == SCons.Node.up_to_date:
if self.top:
built_text = self.targets[0].name + " up-to-date top"
else:
built_text = self.targets[0].name + " up-to-date"
else:
self.targets[0].build()
n1.set_state(SCons.Node.no_state)
n1._current_val = 1
n2.set_state(SCons.Node.no_state)
n2._current_val = 1
n3.set_state(SCons.Node.no_state)
n3._current_val = 1
tm = SCons.Taskmaster.Taskmaster(targets = [n3], tasker = MyTask)
t = tm.next_task()
t.prepare()
t.execute()
assert built_text == "n1 up-to-date", built_text
t.executed()
t.postprocess()
t = tm.next_task()
t.prepare()
t.execute()
assert built_text == "n2 up-to-date", built_text
t.executed()
t.postprocess()
t = tm.next_task()
t.prepare()
t.execute()
assert built_text == "n3 up-to-date top", built_text
t.executed()
t.postprocess()
assert tm.next_task() is None
n1 = Node("n1")
n2 = Node("n2")
n3 = Node("n3", [n1, n2])
n4 = Node("n4")
n5 = Node("n5", [n3, n4])
tm = SCons.Taskmaster.Taskmaster([n5])
t1 = tm.next_task()
assert t1.get_target() == n1
t2 = tm.next_task()
assert t2.get_target() == n2
t4 = tm.next_task()
assert t4.get_target() == n4
t4.executed()
t4.postprocess()
t1.executed()
t1.postprocess()
t2.executed()
t2.postprocess()
t3 = tm.next_task()
assert t3.get_target() == n3
t3.executed()
t3.postprocess()
t5 = tm.next_task()
assert t5.get_target() == n5, t5.get_target()
t5.executed()
t5.postprocess()
assert tm.next_task() is None
n4 = Node("n4")
n4.set_state(SCons.Node.executed)
tm = SCons.Taskmaster.Taskmaster([n4])
assert tm.next_task() is None
n1 = Node("n1")
n2 = Node("n2", [n1])
tm = SCons.Taskmaster.Taskmaster([n2,n2])
t = tm.next_task()
t.executed()
t.postprocess()
t = tm.next_task()
assert tm.next_task() is None
n1 = Node("n1")
n2 = Node("n2")
n3 = Node("n3", [n1], [n2])
tm = SCons.Taskmaster.Taskmaster([n3])
t = tm.next_task()
target = t.get_target()
assert target == n1, target
t.executed()
t.postprocess()
t = tm.next_task()
target = t.get_target()
assert target == n2, target
t.executed()
t.postprocess()
t = tm.next_task()
target = t.get_target()
assert target == n3, target
t.executed()
t.postprocess()
assert tm.next_task() is None
n1 = Node("n1")
n2 = Node("n2")
n3 = Node("n3", [n1, n2])
n4 = Node("n4", [n3])
n5 = Node("n5", [n3])
global scan_called
scan_called = 0
tm = SCons.Taskmaster.Taskmaster([n4])
t = tm.next_task()
assert t.get_target() == n1
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n2
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n3
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n4
t.executed()
t.postprocess()
assert tm.next_task() is None
assert scan_called == 4, scan_called
tm = SCons.Taskmaster.Taskmaster([n5])
t = tm.next_task()
assert t.get_target() == n5, t.get_target()
t.executed()
assert tm.next_task() is None
assert scan_called == 5, scan_called
n1 = Node("n1")
n2 = Node("n2")
n3 = Node("n3")
n4 = Node("n4", [n1,n2,n3])
n5 = Node("n5", [n4])
n3.side_effect = 1
n1.side_effects = n2.side_effects = n3.side_effects = [n4]
tm = SCons.Taskmaster.Taskmaster([n1,n2,n3,n4,n5])
t = tm.next_task()
assert t.get_target() == n1
assert n4.state == SCons.Node.executing, n4.state
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n2
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n3
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n4
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n5
assert not tm.next_task()
t.executed()
t.postprocess()
n1 = Node("n1")
n2 = Node("n2")
n3 = Node("n3")
n4 = Node("n4", [n1,n2,n3])
def reverse(dependencies):
dependencies.reverse()
return dependencies
tm = SCons.Taskmaster.Taskmaster([n4], order=reverse)
t = tm.next_task()
assert t.get_target() == n3, t.get_target()
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n2, t.get_target()
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n1, t.get_target()
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n4, t.get_target()
t.executed()
t.postprocess()
n5 = Node("n5")
n6 = Node("n6")
n7 = Node("n7")
n6.alttargets = [n7]
tm = SCons.Taskmaster.Taskmaster([n5])
t = tm.next_task()
assert t.get_target() == n5
t.executed()
t.postprocess()
tm = SCons.Taskmaster.Taskmaster([n6])
t = tm.next_task()
assert t.get_target() == n7
t.executed()
t.postprocess()
t = tm.next_task()
assert t.get_target() == n6
t.executed()
t.postprocess()
n1 = Node("n1")
n2 = Node("n2", [n1])
n1.set_state(SCons.Node.failed)
tm = SCons.Taskmaster.Taskmaster([n2])
assert tm.next_task() is None
n1 = Node("n1")
n2 = Node("n2")
n1.targets = [n1, n2]
n1._current_val = 1
tm = SCons.Taskmaster.Taskmaster([n1])
t = tm.next_task()
t.executed()
t.postprocess()
s = n1.get_state()
assert s == SCons.Node.executed, s
s = n2.get_state()
assert s == SCons.Node.executed, s
def test_make_ready_out_of_date(self):
"""Test the Task.make_ready() method's list of out-of-date Nodes
"""
ood = []
def TaskGen(tm, targets, top, node, ood=ood):
class MyTask(SCons.Taskmaster.Task):
def make_ready(self):
SCons.Taskmaster.Task.make_ready(self)
self.ood.extend(self.out_of_date)
t = MyTask(tm, targets, top, node)
t.ood = ood
return t
n1 = Node("n1")
c2 = Node("c2")
c2._current_val = 1
n3 = Node("n3")
c4 = Node("c4")
c4._current_val = 1
a5 = Node("a5")
a5._current_val = 1
a5.always_build = 1
tm = SCons.Taskmaster.Taskmaster(targets = [n1, c2, n3, c4, a5],
tasker = TaskGen)
del ood[:]
t = tm.next_task()
assert ood == [n1], ood
del ood[:]
t = tm.next_task()
assert ood == [], ood
del ood[:]
t = tm.next_task()
assert ood == [n3], ood
del ood[:]
t = tm.next_task()
assert ood == [], ood
del ood[:]
t = tm.next_task()
assert ood == [a5], ood
def test_make_ready_exception(self):
"""Test handling exceptions from Task.make_ready()
"""
class MyTask(SCons.Taskmaster.Task):
def make_ready(self):
raise MyException("from make_ready()")
n1 = Node("n1")
tm = SCons.Taskmaster.Taskmaster(targets = [n1], tasker = MyTask)
t = tm.next_task()
exc_type, exc_value, exc_tb = t.exception
assert exc_type == MyException, repr(exc_type)
assert str(exc_value) == "from make_ready()", exc_value
def test_make_ready_all(self):
"""Test the make_ready_all() method"""
class MyTask(SCons.Taskmaster.Task):
make_ready = SCons.Taskmaster.Task.make_ready_all
n1 = Node("n1")
c2 = Node("c2")
c2._current_val = 1
n3 = Node("n3")
c4 = Node("c4")
c4._current_val = 1
tm = SCons.Taskmaster.Taskmaster(targets = [n1, c2, n3, c4])
t = tm.next_task()
target = t.get_target()
assert target is n1, target
assert target.state == SCons.Node.executing, target.state
t = tm.next_task()
target = t.get_target()
assert target is c2, target
assert target.state == SCons.Node.up_to_date, target.state
t = tm.next_task()
target = t.get_target()
assert target is n3, target
assert target.state == SCons.Node.executing, target.state
t = tm.next_task()
target = t.get_target()
assert target is c4, target
assert target.state == SCons.Node.up_to_date, target.state
t = tm.next_task()
assert t is None
n1 = Node("n1")
c2 = Node("c2")
n3 = Node("n3")
c4 = Node("c4")
tm = SCons.Taskmaster.Taskmaster(targets = [n1, c2, n3, c4],
tasker = MyTask)
t = tm.next_task()
target = t.get_target()
assert target is n1, target
assert target.state == SCons.Node.executing, target.state
t = tm.next_task()
target = t.get_target()
assert target is c2, target
assert target.state == SCons.Node.executing, target.state
t = tm.next_task()
target = t.get_target()
assert target is n3, target
assert target.state == SCons.Node.executing, target.state
t = tm.next_task()
target = t.get_target()
assert target is c4, target
assert target.state == SCons.Node.executing, target.state
t = tm.next_task()
assert t is None
def test_children_errors(self):
"""Test errors when fetching the children of a node.
"""
class StopNode(Node):
def children(self):
raise SCons.Errors.StopError("stop!")
class ExitNode(Node):
def children(self):
sys.exit(77)
n1 = StopNode("n1")
tm = SCons.Taskmaster.Taskmaster([n1])
t = tm.next_task()
exc_type, exc_value, exc_tb = t.exception
assert exc_type == SCons.Errors.StopError, repr(exc_type)
assert str(exc_value) == "stop!", exc_value
n2 = ExitNode("n2")
tm = SCons.Taskmaster.Taskmaster([n2])
t = tm.next_task()
exc_type, exc_value = t.exception
assert exc_type == SCons.Errors.ExplicitExit, repr(exc_type)
assert exc_value.node == n2, exc_value.node
assert exc_value.status == 77, exc_value.status
def test_cycle_detection(self):
"""Test detecting dependency cycles
"""
n1 = Node("n1")
n2 = Node("n2", [n1])
n3 = Node("n3", [n2])
n1.kids = [n3]
tm = SCons.Taskmaster.Taskmaster([n3])
try:
t = tm.next_task()
except SCons.Errors.UserError, e:
assert str(e) == "Dependency cycle: n3 -> n1 -> n2 -> n3", str(e)
else:
assert 'Did not catch expected UserError'
def test_next_top_level_candidate(self):
"""Test the next_top_level_candidate() method
"""
n1 = Node("n1")
n2 = Node("n2", [n1])
n3 = Node("n3", [n2])
tm = SCons.Taskmaster.Taskmaster([n3])
t = tm.next_task()
assert t.targets == [n1], t.targets
t.fail_stop()
assert t.targets == [n3], list(map(str, t.targets))
assert t.top == 1, t.top
def test_stop(self):
"""Test the stop() method
Both default and overridden in a subclass.
"""
global built_text
n1 = Node("n1")
n2 = Node("n2")
n3 = Node("n3", [n1, n2])
tm = SCons.Taskmaster.Taskmaster([n3])
t = tm.next_task()
t.prepare()
t.execute()
assert built_text == "n1 built", built_text
t.executed()
t.postprocess()
assert built_text == "n1 built really", built_text
tm.stop()
assert tm.next_task() is None
class MyTM(SCons.Taskmaster.Taskmaster):
def stop(self):
global built_text
built_text = "MyTM.stop()"
SCons.Taskmaster.Taskmaster.stop(self)
n1 = Node("n1")
n2 = Node("n2")
n3 = Node("n3", [n1, n2])
built_text = None
tm = MyTM([n3])
tm.next_task().execute()
assert built_text == "n1 built"
tm.stop()
assert built_text == "MyTM.stop()"
assert tm.next_task() is None
def test_executed(self):
"""Test when a task has been executed
"""
global built_text
global visited_nodes
n1 = Node("n1")
tm = SCons.Taskmaster.Taskmaster([n1])
t = tm.next_task()
built_text = "xxx"
visited_nodes = []
n1.set_state(SCons.Node.executing)
t.executed()
s = n1.get_state()
assert s == SCons.Node.executed, s
assert built_text == "xxx really", built_text
assert visited_nodes == ['n1'], visited_nodes
n2 = Node("n2")
tm = SCons.Taskmaster.Taskmaster([n2])
t = tm.next_task()
built_text = "should_not_change"
visited_nodes = []
n2.set_state(None)
t.executed()
s = n2.get_state()
assert s is None, s
assert built_text == "should_not_change", built_text
assert visited_nodes == ['n2'], visited_nodes
n3 = Node("n3")
n4 = Node("n4")
n3.targets = [n3, n4]
tm = SCons.Taskmaster.Taskmaster([n3])
t = tm.next_task()
visited_nodes = []
n3.set_state(SCons.Node.up_to_date)
n4.set_state(SCons.Node.executing)
t.executed()
s = n3.get_state()
assert s == SCons.Node.up_to_date, s
s = n4.get_state()
assert s == SCons.Node.executed, s
assert visited_nodes == ['n3', 'n4'], visited_nodes
def test_prepare(self):
"""Test preparation of multiple Nodes for a task
"""
n1 = Node("n1")
n2 = Node("n2")
tm = SCons.Taskmaster.Taskmaster([n1, n2])
t = tm.next_task()
# This next line is moderately bogus. We're just reaching
# in and setting the targets for this task to an array. The
# "right" way to do this would be to have the next_task() call
# set it up by having something that approximates a real Builder
# return this list--but that's more work than is probably
# warranted right now.
n1.get_executor().targets = [n1, n2]
t.prepare()
assert n1.prepared
assert n2.prepared
n3 = Node("n3")
n4 = Node("n4")
tm = SCons.Taskmaster.Taskmaster([n3, n4])
t = tm.next_task()
# More bogus reaching in and setting the targets.
n3.set_state(SCons.Node.up_to_date)
n3.get_executor().targets = [n3, n4]
t.prepare()
assert n3.prepared
assert n4.prepared
# If the Node has had an exception recorded while it was getting
# prepared, then prepare() should raise that exception.
class MyException(Exception):
pass
built_text = None
n5 = Node("n5")
tm = SCons.Taskmaster.Taskmaster([n5])
t = tm.next_task()
t.exception_set((MyException, "exception value"))
exc_caught = None
try:
t.prepare()
except MyException, e:
exc_caught = 1
except:
pass
assert exc_caught, "did not catch expected MyException"
assert str(e) == "exception value", e
assert built_text is None, built_text
# Regression test, make sure we prepare not only
# all targets, but their side effects as well.
n6 = Node("n6")
n7 = Node("n7")
n8 = Node("n8")
n9 = Node("n9")
n10 = Node("n10")
n6.side_effects = [ n8 ]
n7.side_effects = [ n9, n10 ]
tm = SCons.Taskmaster.Taskmaster([n6, n7])
t = tm.next_task()
# More bogus reaching in and setting the targets.
n6.get_executor().targets = [n6, n7]
t.prepare()
assert n6.prepared
assert n7.prepared
assert n8.prepared
assert n9.prepared
assert n10.prepared
# Make sure we call an Executor's prepare() method.
class ExceptionExecutor:
def prepare(self):
raise Exception("Executor.prepare() exception")
def get_all_targets(self):
return self.nodes
def get_all_children(self):
result = []
for node in self.nodes:
result.extend(node.children())
return result
def get_all_prerequisites(self):
return []
def get_action_side_effects(self):
return []
n11 = Node("n11")
n11.executor = ExceptionExecutor()
n11.executor.nodes = [n11]
tm = SCons.Taskmaster.Taskmaster([n11])
t = tm.next_task()
try:
t.prepare()
except Exception, e:
assert str(e) == "Executor.prepare() exception", e
else:
raise AssertionError("did not catch expected exception")
def test_execute(self):
"""Test executing a task
"""
global built_text
global cache_text
n1 = Node("n1")
tm = SCons.Taskmaster.Taskmaster([n1])
t = tm.next_task()
t.execute()
assert built_text == "n1 built", built_text
def raise_UserError():
raise SCons.Errors.UserError
n2 = Node("n2")
n2.build = raise_UserError
tm = SCons.Taskmaster.Taskmaster([n2])
t = tm.next_task()
try:
t.execute()
except SCons.Errors.UserError:
pass
else:
raise TestFailed("did not catch expected UserError")
def raise_BuildError():
raise SCons.Errors.BuildError
n3 = Node("n3")
n3.build = raise_BuildError
tm = SCons.Taskmaster.Taskmaster([n3])
t = tm.next_task()
try:
t.execute()
except SCons.Errors.BuildError:
pass
else:
raise TestFailed("did not catch expected BuildError")
# On a generic (non-BuildError) exception from a Builder,
# the target should throw a BuildError exception with the
# args set to the exception value, instance, and traceback.
def raise_OtherError():
raise OtherError
n4 = Node("n4")
n4.build = raise_OtherError
tm = SCons.Taskmaster.Taskmaster([n4])
t = tm.next_task()
try:
t.execute()
except SCons.Errors.BuildError, e:
assert e.node == n4, e.node
assert e.errstr == "OtherError : ", e.errstr
assert len(e.exc_info) == 3, e.exc_info
exc_traceback = sys.exc_info()[2]
assert isinstance(e.exc_info[2], type(exc_traceback)), e.exc_info[2]
else:
raise TestFailed("did not catch expected BuildError")
built_text = None
cache_text = []
n5 = Node("n5")
n6 = Node("n6")
n6.cached = 1
tm = SCons.Taskmaster.Taskmaster([n5])
t = tm.next_task()
# This next line is moderately bogus. We're just reaching
# in and setting the targets for this task to an array. The
# "right" way to do this would be to have the next_task() call
# set it up by having something that approximates a real Builder
# return this list--but that's more work than is probably
# warranted right now.
t.targets = [n5, n6]
t.execute()
assert built_text == "n5 built", built_text
assert cache_text == [], cache_text
built_text = None
cache_text = []
n7 = Node("n7")
n8 = Node("n8")
n7.cached = 1
n8.cached = 1
tm = SCons.Taskmaster.Taskmaster([n7])
t = tm.next_task()
# This next line is moderately bogus. We're just reaching
# in and setting the targets for this task to an array. The
# "right" way to do this would be to have the next_task() call
# set it up by having something that approximates a real Builder
# return this list--but that's more work than is probably
# warranted right now.
t.targets = [n7, n8]
t.execute()
assert built_text is None, built_text
assert cache_text == ["n7 retrieved", "n8 retrieved"], cache_text
def test_exception(self):
"""Test generic Taskmaster exception handling
"""
n1 = Node("n1")
tm = SCons.Taskmaster.Taskmaster([n1])
t = tm.next_task()
t.exception_set((1, 2))
exc_type, exc_value = t.exception
assert exc_type == 1, exc_type
assert exc_value == 2, exc_value
t.exception_set(3)
assert t.exception == 3
try: 1//0
except: pass
t.exception_set(None)
exc_type, exc_value, exc_tb = t.exception
assert exc_type is ZeroDivisionError, exc_type
exception_values = [
"integer division or modulo",
"integer division or modulo by zero",
]
assert str(exc_value) in exception_values, exc_value
class Exception1(Exception):
pass
t.exception_set((Exception1, None))
try:
t.exception_raise()
except:
exc_type, exc_value = sys.exc_info()[:2]
assert exc_type == Exception1, exc_type
assert str(exc_value) == '', exc_value
else:
assert 0, "did not catch expected exception"
class Exception2(Exception):
pass
t.exception_set((Exception2, "xyzzy"))
try:
t.exception_raise()
except:
exc_type, exc_value = sys.exc_info()[:2]
assert exc_type == Exception2, exc_type
assert str(exc_value) == "xyzzy", exc_value
else:
assert 0, "did not catch expected exception"
class Exception3(Exception):
pass
try:
1//0
except:
tb = sys.exc_info()[2]
t.exception_set((Exception3, "arg", tb))
try:
t.exception_raise()
except:
exc_type, exc_value, exc_tb = sys.exc_info()
assert exc_type == Exception3, exc_type
assert str(exc_value) == "arg", exc_value
import traceback
x = traceback.extract_tb(tb)[-1]
y = traceback.extract_tb(exc_tb)[-1]
assert x == y, "x = %s, y = %s" % (x, y)
else:
assert 0, "did not catch expected exception"
def test_postprocess(self):
"""Test postprocessing targets to give them a chance to clean up
"""
n1 = Node("n1")
tm = SCons.Taskmaster.Taskmaster([n1])
t = tm.next_task()
assert not n1.postprocessed
t.postprocess()
assert n1.postprocessed
n2 = Node("n2")
n3 = Node("n3")
tm = SCons.Taskmaster.Taskmaster([n2, n3])
assert not n2.postprocessed
assert not n3.postprocessed
t = tm.next_task()
t.postprocess()
assert n2.postprocessed
assert not n3.postprocessed
t = tm.next_task()
t.postprocess()
assert n2.postprocessed
assert n3.postprocessed
def test_trace(self):
"""Test Taskmaster tracing
"""
import io
trace = io.StringIO()
n1 = Node("n1")
n2 = Node("n2")
n3 = Node("n3", [n1, n2])
tm = SCons.Taskmaster.Taskmaster([n1, n1, n3], trace=trace)
t = tm.next_task()
t.prepare()
t.execute()
t.postprocess()
n1.set_state(SCons.Node.executed)
t = tm.next_task()
t.prepare()
t.execute()
t.postprocess()
n2.set_state(SCons.Node.executed)
t = tm.next_task()
t.prepare()
t.execute()
t.postprocess()
t = tm.next_task()
assert t is None
value = trace.getvalue()
expect = """\
Taskmaster: Looking for a node to evaluate
Taskmaster: Considering node <no_state 0 'n1'> and its children:
Taskmaster: Evaluating <pending 0 'n1'>
Task.make_ready_current(): node <pending 0 'n1'>
Task.prepare(): node <executing 0 'n1'>
Task.execute(): node <executing 0 'n1'>
Task.postprocess(): node <executing 0 'n1'>
Taskmaster: Looking for a node to evaluate
Taskmaster: Considering node <executed 0 'n1'> and its children:
Taskmaster: already handled (executed)
Taskmaster: Considering node <no_state 0 'n3'> and its children:
Taskmaster: <executed 0 'n1'>
Taskmaster: <no_state 0 'n2'>
Taskmaster: adjusted ref count: <pending 1 'n3'>, child 'n2'
Taskmaster: Considering node <no_state 0 'n2'> and its children:
Taskmaster: Evaluating <pending 0 'n2'>
Task.make_ready_current(): node <pending 0 'n2'>
Task.prepare(): node <executing 0 'n2'>
Task.execute(): node <executing 0 'n2'>
Task.postprocess(): node <executing 0 'n2'>
Task.postprocess(): removing <executing 0 'n2'>
Task.postprocess(): adjusted parent ref count <pending 0 'n3'>
Taskmaster: Looking for a node to evaluate
Taskmaster: Considering node <pending 0 'n3'> and its children:
Taskmaster: <executed 0 'n1'>
Taskmaster: <executed 0 'n2'>
Taskmaster: Evaluating <pending 0 'n3'>
Task.make_ready_current(): node <pending 0 'n3'>
Task.prepare(): node <executing 0 'n3'>
Task.execute(): node <executing 0 'n3'>
Task.postprocess(): node <executing 0 'n3'>
Taskmaster: Looking for a node to evaluate
Taskmaster: No candidate anymore.
"""
assert value == expect, value
if __name__ == "__main__":
suite = unittest.makeSuite(TaskmasterTestCase, 'test_')
if not unittest.TextTestRunner().run(suite).wasSuccessful():
sys.exit(1)
# Local Variables:
# tab-width:4
# indent-tabs-mode:nil
# End:
# vim: set expandtab tabstop=4 shiftwidth=4:
|