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
|
# Copyright (c) 2009 Google Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
# * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
import datetime
import os
import shutil
import tempfile
import threading
import unittest
from webkitpy.common.system.executive import ScriptError
from webkitpy.common.system.outputcapture import OutputCapture
from webkitpy.tool.bot.queueengine import QueueEngine, QueueEngineDelegate, TerminateQueue
class LoggingDelegate(QueueEngineDelegate):
def __init__(self, test):
self._test = test
self._callbacks = []
self._run_before = False
expected_callbacks = [
'queue_log_path',
'begin_work_queue',
'should_continue_work_queue',
'next_work_item',
'should_proceed_with_work_item',
'work_item_log_path',
'process_work_item',
'should_continue_work_queue'
]
def record(self, method_name):
self._callbacks.append(method_name)
def queue_log_path(self):
self.record("queue_log_path")
return os.path.join(self._test.temp_dir, "queue_log_path")
def work_item_log_path(self, work_item):
self.record("work_item_log_path")
return os.path.join(self._test.temp_dir, "work_log_path", "%s.log" % work_item)
def begin_work_queue(self):
self.record("begin_work_queue")
def should_continue_work_queue(self):
self.record("should_continue_work_queue")
if not self._run_before:
self._run_before = True
return True
return False
def next_work_item(self):
self.record("next_work_item")
return "work_item"
def should_proceed_with_work_item(self, work_item):
self.record("should_proceed_with_work_item")
self._test.assertEquals(work_item, "work_item")
fake_patch = { 'bug_id' : 42 }
return (True, "waiting_message", fake_patch)
def process_work_item(self, work_item):
self.record("process_work_item")
self._test.assertEquals(work_item, "work_item")
return True
def handle_unexpected_error(self, work_item, message):
self.record("handle_unexpected_error")
self._test.assertEquals(work_item, "work_item")
class RaisingDelegate(LoggingDelegate):
def __init__(self, test, exception):
LoggingDelegate.__init__(self, test)
self._exception = exception
self.stop_message = None
def process_work_item(self, work_item):
self.record("process_work_item")
raise self._exception
def stop_work_queue(self, message):
self.record("stop_work_queue")
self.stop_message = message
class NotSafeToProceedDelegate(LoggingDelegate):
def should_proceed_with_work_item(self, work_item):
self.record("should_proceed_with_work_item")
self._test.assertEquals(work_item, "work_item")
return False
class FastQueueEngine(QueueEngine):
def __init__(self, delegate):
QueueEngine.__init__(self, "fast-queue", delegate, threading.Event())
# No sleep for the wicked.
seconds_to_sleep = 0
def _sleep(self, message):
pass
class QueueEngineTest(unittest.TestCase):
def test_trivial(self):
delegate = LoggingDelegate(self)
work_queue = QueueEngine("trivial-queue", delegate, threading.Event())
work_queue.run()
self.assertEquals(delegate._callbacks, LoggingDelegate.expected_callbacks)
self.assertTrue(os.path.exists(os.path.join(self.temp_dir, "queue_log_path")))
self.assertTrue(os.path.exists(os.path.join(self.temp_dir, "work_log_path", "work_item.log")))
def test_unexpected_error(self):
delegate = RaisingDelegate(self, ScriptError(exit_code=3))
work_queue = QueueEngine("error-queue", delegate, threading.Event())
work_queue.run()
expected_callbacks = LoggingDelegate.expected_callbacks[:]
work_item_index = expected_callbacks.index('process_work_item')
# The unexpected error should be handled right after process_work_item starts
# but before any other callback. Otherwise callbacks should be normal.
expected_callbacks.insert(work_item_index + 1, 'handle_unexpected_error')
self.assertEquals(delegate._callbacks, expected_callbacks)
def test_handled_error(self):
delegate = RaisingDelegate(self, ScriptError(exit_code=QueueEngine.handled_error_code))
work_queue = QueueEngine("handled-error-queue", delegate, threading.Event())
work_queue.run()
self.assertEquals(delegate._callbacks, LoggingDelegate.expected_callbacks)
def _test_terminating_queue(self, exception, expected_message):
work_item_index = LoggingDelegate.expected_callbacks.index('process_work_item')
# The terminating error should be handled right after process_work_item.
# There should be no other callbacks after stop_work_queue.
expected_callbacks = LoggingDelegate.expected_callbacks[:work_item_index + 1]
expected_callbacks.append("stop_work_queue")
delegate = RaisingDelegate(self, exception)
work_queue = QueueEngine("terminating-queue", delegate, threading.Event())
output = OutputCapture()
expected_stderr = "\n%s\n" % expected_message
output.assert_outputs(self, work_queue.run, [], expected_stderr=expected_stderr)
self.assertEquals(delegate._callbacks, expected_callbacks)
self.assertEquals(delegate.stop_message, expected_message)
def test_terminating_error(self):
self._test_terminating_queue(KeyboardInterrupt(), "User terminated queue.")
self._test_terminating_queue(TerminateQueue(), "TerminateQueue exception received.")
def test_not_safe_to_proceed(self):
delegate = NotSafeToProceedDelegate(self)
work_queue = FastQueueEngine(delegate)
work_queue.run()
expected_callbacks = LoggingDelegate.expected_callbacks[:]
next_work_item_index = expected_callbacks.index('next_work_item')
# We slice out the common part of the expected callbacks.
# We add 2 here to include should_proceed_with_work_item, which is
# a pain to search for directly because it occurs twice.
expected_callbacks = expected_callbacks[:next_work_item_index + 2]
expected_callbacks.append('should_continue_work_queue')
self.assertEquals(delegate._callbacks, expected_callbacks)
def test_now(self):
"""Make sure there are no typos in the QueueEngine.now() method."""
engine = QueueEngine("test", None, None)
self.assertTrue(isinstance(engine._now(), datetime.datetime))
def test_sleep_message(self):
engine = QueueEngine("test", None, None)
engine._now = lambda: datetime.datetime(2010, 1, 1)
expected_sleep_message = "MESSAGE Sleeping until 2010-01-01 00:02:00 (2 mins)."
self.assertEqual(engine._sleep_message("MESSAGE"), expected_sleep_message)
def setUp(self):
self.temp_dir = tempfile.mkdtemp(suffix="work_queue_test_logs")
def tearDown(self):
shutil.rmtree(self.temp_dir)
if __name__ == '__main__':
unittest.main()
|
