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
|
#
# __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.
#
__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
import unittest
import random
import math
import SCons.Job
import sys
import time
# a large number
num_sines = 10000
# how many parallel jobs to perform for the test
num_jobs = 11
# how many tasks to perform for the test
num_tasks = num_jobs*5
class DummyLock:
"fake lock class to use if threads are not supported"
def acquire(self):
pass
def release(self):
pass
class NoThreadsException:
"raised by the ParallelTestCase if threads are not supported"
def __str__(self):
return "the interpreter doesn't support threads"
class Task:
"""A dummy task class for testing purposes."""
def __init__(self, i, taskmaster):
self.i = i
self.taskmaster = taskmaster
self.was_executed = 0
self.was_prepared = 0
def prepare(self):
self.was_prepared = 1
def execute(self):
self.taskmaster.test_case.failUnless(self.was_prepared,
"the task wasn't prepared")
self.taskmaster.guard.acquire()
self.taskmaster.begin_list.append(self.i)
self.taskmaster.guard.release()
# do something that will take some random amount of time:
for i in range(random.randrange(0, num_sines, 1)):
x = math.sin(i)
time.sleep(0.01)
self.was_executed = 1
self.taskmaster.guard.acquire()
self.taskmaster.end_list.append(self.i)
self.taskmaster.guard.release()
def executed(self):
self.taskmaster.num_executed = self.taskmaster.num_executed + 1
self.taskmaster.test_case.failUnless(self.was_prepared,
"the task wasn't prepared")
self.taskmaster.test_case.failUnless(self.was_executed,
"the task wasn't really executed")
self.taskmaster.test_case.failUnless(self.__class__ is Task,
"the task wasn't really a Task instance")
def failed(self):
self.taskmaster.num_failed = self.taskmaster.num_failed + 1
self.taskmaster.stop = 1
self.taskmaster.test_case.failUnless(self.was_prepared,
"the task wasn't prepared")
class ExceptionTask:
"""A dummy task class for testing purposes."""
def __init__(self, i, taskmaster):
self.taskmaster = taskmaster
self.was_prepared = 0
def prepare(self):
self.was_prepared = 1
def execute(self):
raise "exception"
def executed(self):
self.taskmaster.num_executed = self.taskmaster.num_executed + 1
self.taskmaster.test_case.failUnless(self.was_prepared,
"the task wasn't prepared")
self.taskmaster.test_case.failUnless(self.was_executed,
"the task wasn't really executed")
self.taskmaster.test_case.failUnless(self.__class__ is Task,
"the task wasn't really a Task instance")
def failed(self):
self.taskmaster.num_failed = self.taskmaster.num_failed + 1
self.taskmaster.stop = 1
self.taskmaster.test_case.failUnless(self.was_prepared,
"the task wasn't prepared")
class Taskmaster:
"""A dummy taskmaster class for testing the job classes."""
def __init__(self, n, test_case, Task):
"""n is the number of dummy tasks to perform."""
self.test_case = test_case
self.stop = None
self.num_tasks = n
self.num_iterated = 0
self.num_executed = 0
self.num_failed = 0
self.Task = Task
# 'guard' guards 'task_begin_list' and 'task_end_list'
try:
import threading
self.guard = threading.Lock()
except:
self.guard = DummyLock()
# keep track of the order tasks are begun in
self.begin_list = []
# keep track of the order tasks are completed in
self.end_list = []
def next_task(self):
if self.stop or self.all_tasks_are_iterated():
return None
else:
self.num_iterated = self.num_iterated + 1
return self.Task(self.num_iterated, self)
def all_tasks_are_executed(self):
return self.num_executed == self.num_tasks
def all_tasks_are_iterated(self):
return self.num_iterated == self.num_tasks
def is_blocked(self):
if self.stop or self.all_tasks_are_executed():
return 0
if self.all_tasks_are_iterated():
return 1
# simulate blocking tasks
return self.num_iterated - self.num_executed >= max(num_jobs/2, 2)
def tasks_were_serial(self):
"analyze the task order to see if they were serial"
serial = 1 # assume the tasks were serial
for i in range(num_tasks):
serial = serial and (self.begin_list[i]
== self.end_list[i]
== (i + 1))
return serial
class ParallelTestCase(unittest.TestCase):
def runTest(self):
"test parallel jobs"
try:
import threading
except:
raise NoThreadsException()
taskmaster = Taskmaster(num_tasks, self, Task)
jobs = SCons.Job.Jobs(num_jobs, taskmaster)
jobs.run()
self.failUnless(not taskmaster.tasks_were_serial(),
"the tasks were not executed in parallel")
self.failUnless(taskmaster.all_tasks_are_executed(),
"all the tests were not executed")
self.failUnless(taskmaster.all_tasks_are_iterated(),
"all the tests were not iterated over")
self.failIf(taskmaster.num_failed,
"some task(s) failed to execute")
class SerialTestCase(unittest.TestCase):
def runTest(self):
"test a serial job"
taskmaster = Taskmaster(num_tasks, self, Task)
jobs = SCons.Job.Jobs(1, taskmaster)
jobs.run()
self.failUnless(taskmaster.tasks_were_serial(),
"the tasks were not executed in series")
self.failUnless(taskmaster.all_tasks_are_executed(),
"all the tests were not executed")
self.failUnless(taskmaster.all_tasks_are_iterated(),
"all the tests were not iterated over")
self.failIf(taskmaster.num_failed,
"some task(s) failed to execute")
class SerialExceptionTestCase(unittest.TestCase):
def runTest(self):
"test a serial job with tasks that raise exceptions"
taskmaster = Taskmaster(num_tasks, self, ExceptionTask)
jobs = SCons.Job.Jobs(1, taskmaster)
jobs.run()
self.failIf(taskmaster.num_executed,
"a task was executed")
self.failUnless(taskmaster.num_iterated == 1,
"exactly one task should have been iterated")
self.failUnless(taskmaster.num_failed == 1,
"exactly one task should have failed")
class ParallelExceptionTestCase(unittest.TestCase):
def runTest(self):
"test parallel jobs with tasks that raise exceptions"
taskmaster = Taskmaster(num_tasks, self, ExceptionTask)
jobs = SCons.Job.Jobs(num_jobs, taskmaster)
jobs.run()
self.failIf(taskmaster.num_executed,
"a task was executed")
self.failUnless(taskmaster.num_iterated >= 1,
"one or more task should have been iterated")
self.failUnless(taskmaster.num_failed >= 1,
"one or more tasks should have failed")
def suite():
suite = unittest.TestSuite()
suite.addTest(ParallelTestCase())
suite.addTest(SerialTestCase())
suite.addTest(SerialExceptionTestCase())
suite.addTest(ParallelExceptionTestCase())
return suite
if __name__ == "__main__":
runner = unittest.TextTestRunner()
result = runner.run(suite())
if (len(result.failures) == 0
and len(result.errors) == 1
and type(result.errors[0][0]) == SerialTestCase
and type(result.errors[0][1][0]) == NoThreadsException):
sys.exit(2)
elif not result.wasSuccessful():
sys.exit(1)
|
