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
|
# Copyright 2009-2011 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
__metaclass__ = type
from datetime import datetime
import time
import pytz
from storm.locals import Store
from lp.services.database.constants import UTC_NOW
from lp.services.database.lpstorm import IStore
from lp.services.job.interfaces.job import (
IJob,
JobStatus,
)
from lp.services.job.model.job import (
InvalidTransition,
Job,
LeaseHeld,
)
from lp.services.webapp.testing import verifyObject
from lp.testing import (
TestCase,
TestCaseWithFactory,
)
from lp.testing.layers import ZopelessDatabaseLayer
class TestJob(TestCaseWithFactory):
"""Ensure Job behaves as intended."""
layer = ZopelessDatabaseLayer
def test_implements_IJob(self):
"""Job should implement IJob."""
verifyObject(IJob, Job())
def test_default_status(self):
"""The default status should be WAITING."""
job = Job()
self.assertEqual(job.status, JobStatus.WAITING)
def test_stores_requester(self):
job = Job()
random_joe = self.factory.makePerson()
job.requester = random_joe
self.assertEqual(random_joe, job.requester)
def test_createMultiple_creates_requested_number_of_jobs(self):
job_ids = list(Job.createMultiple(IStore(Job), 3))
self.assertEqual(3, len(job_ids))
self.assertEqual(3, len(set(job_ids)))
def test_createMultiple_returns_valid_job_ids(self):
job_ids = list(Job.createMultiple(IStore(Job), 3))
store = IStore(Job)
for job_id in job_ids:
self.assertIsNot(None, store.get(Job, job_id))
def test_createMultiple_sets_status_to_WAITING(self):
store = IStore(Job)
job = store.get(Job, Job.createMultiple(store, 1)[0])
self.assertEqual(JobStatus.WAITING, job.status)
def test_createMultiple_sets_requester(self):
store = IStore(Job)
requester = self.factory.makePerson()
job = store.get(Job, Job.createMultiple(store, 1, requester)[0])
self.assertEqual(requester, job.requester)
def test_createMultiple_defaults_requester_to_None(self):
store = IStore(Job)
job = store.get(Job, Job.createMultiple(store, 1)[0])
self.assertEqual(None, job.requester)
def test_start(self):
"""Job.start should update the object appropriately.
It should set date_started, clear date_finished, and set the status to
RUNNING."""
job = Job(date_finished=UTC_NOW)
self.assertEqual(None, job.date_started)
self.assertNotEqual(None, job.date_finished)
job.start()
self.assertNotEqual(None, job.date_started)
self.assertEqual(None, job.date_finished)
self.assertEqual(job.status, JobStatus.RUNNING)
def test_start_increments_attempt_count(self):
"""Job.start should increment the attempt count."""
job = Job(date_finished=UTC_NOW)
self.assertEqual(0, job.attempt_count)
job.start()
self.assertEqual(1, job.attempt_count)
job.queue()
job.start()
self.assertEqual(2, job.attempt_count)
def test_start_when_completed_is_invalid(self):
"""When a job is completed, attempting to start is invalid."""
job = Job(_status=JobStatus.COMPLETED)
self.assertRaises(InvalidTransition, job.start)
def test_start_when_failed_is_invalid(self):
"""When a job is failed, attempting to start is invalid."""
job = Job(_status=JobStatus.FAILED)
self.assertRaises(InvalidTransition, job.start)
def test_start_when_running_is_invalid(self):
"""When a job is running, attempting to start is invalid."""
job = Job(_status=JobStatus.FAILED)
self.assertRaises(InvalidTransition, job.start)
def test_complete(self):
"""Job.complete should update the Job appropriately.
It should set date_finished and set the job status to COMPLETED.
"""
job = Job(_status=JobStatus.RUNNING)
self.assertEqual(None, job.date_finished)
job.complete()
self.assertNotEqual(None, job.date_finished)
self.assertEqual(job.status, JobStatus.COMPLETED)
def test_complete_when_waiting_is_invalid(self):
"""When a job is waiting, attempting to complete is invalid."""
job = Job(_status=JobStatus.WAITING)
self.assertRaises(InvalidTransition, job.complete)
def test_complete_when_completed_is_invalid(self):
"""When a job is completed, attempting to complete is invalid."""
job = Job(_status=JobStatus.COMPLETED)
self.assertRaises(InvalidTransition, job.complete)
def test_complete_when_failed_is_invalid(self):
"""When a job is failed, attempting to complete is invalid."""
job = Job(_status=JobStatus.FAILED)
self.assertRaises(InvalidTransition, job.complete)
def test_fail(self):
"""Job.fail should update the Job appropriately.
It should set date_finished and set the job status to FAILED.
"""
job = Job(_status=JobStatus.RUNNING)
self.assertEqual(None, job.date_finished)
job.fail()
self.assertNotEqual(None, job.date_finished)
self.assertEqual(job.status, JobStatus.FAILED)
def test_fail_when_waiting_is_invalid(self):
"""When a job is waiting, attempting to fail is invalid."""
job = Job(_status=JobStatus.WAITING)
self.assertRaises(InvalidTransition, job.fail)
def test_fail_when_completed_is_invalid(self):
"""When a job is completed, attempting to fail is invalid."""
job = Job(_status=JobStatus.COMPLETED)
self.assertRaises(InvalidTransition, job.fail)
def test_fail_when_failed_is_invalid(self):
"""When a job is failed, attempting to fail is invalid."""
job = Job(_status=JobStatus.FAILED)
self.assertRaises(InvalidTransition, job.fail)
def test_queue(self):
"""Job.queue should update the job appropriately.
It should set date_finished, and set status to WAITING.
"""
job = Job(_status=JobStatus.RUNNING)
self.assertEqual(None, job.date_finished)
job.queue()
self.assertNotEqual(None, job.date_finished)
self.assertEqual(job.status, JobStatus.WAITING)
def test_queue_when_completed_is_invalid(self):
"""When a job is completed, attempting to queue is invalid."""
job = Job(_status=JobStatus.COMPLETED)
self.assertRaises(InvalidTransition, job.queue)
def test_queue_when_waiting_is_invalid(self):
"""When a job is waiting, attempting to queue is invalid."""
job = Job(_status=JobStatus.WAITING)
self.assertRaises(InvalidTransition, job.queue)
def test_queue_when_failed_is_invalid(self):
"""When a job is failed, attempting to queue is invalid."""
job = Job(_status=JobStatus.FAILED)
self.assertRaises(InvalidTransition, job.queue)
def test_suspend(self):
"""A job that is in the WAITING state can be suspended."""
job = Job(_status=JobStatus.WAITING)
job.suspend()
self.assertEqual(
job.status,
JobStatus.SUSPENDED)
def test_suspend_when_running(self):
"""When a job is running, attempting to suspend is valid."""
job = Job(_status=JobStatus.RUNNING)
job.suspend()
self.assertEqual(JobStatus.SUSPENDED, job.status)
def test_suspend_when_completed(self):
"""When a job is completed, attempting to suspend is invalid."""
job = Job(_status=JobStatus.COMPLETED)
self.assertRaises(InvalidTransition, job.suspend)
def test_suspend_when_failed(self):
"""When a job is failed, attempting to suspend is invalid."""
job = Job(_status=JobStatus.FAILED)
self.assertRaises(InvalidTransition, job.suspend)
def test_resume(self):
"""A job that is suspended can be resumed."""
job = Job(_status=JobStatus.SUSPENDED)
job.resume()
self.assertEqual(
job.status,
JobStatus.WAITING)
def test_resume_clears_lease_expiry(self):
"""A job that resumes should null out the lease_expiry."""
job = Job(_status=JobStatus.SUSPENDED)
job.lease_expires = UTC_NOW
job.resume()
self.assertIs(None, job.lease_expires)
def test_resume_when_running(self):
"""When a job is running, attempting to resume is invalid."""
job = Job(_status=JobStatus.RUNNING)
self.assertRaises(InvalidTransition, job.resume)
def test_resume_when_completed(self):
"""When a job is completed, attempting to resume is invalid."""
job = Job(_status=JobStatus.COMPLETED)
self.assertRaises(InvalidTransition, job.resume)
def test_resume_when_failed(self):
"""When a job is failed, attempting to resume is invalid."""
job = Job(_status=JobStatus.FAILED)
self.assertRaises(InvalidTransition, job.resume)
def test_is_pending(self):
"""is_pending is True when the job can possibly complete."""
for status in JobStatus.items:
job = Job(_status=status)
self.assertEqual(
status in Job.PENDING_STATUSES, job.is_pending)
class TestReadiness(TestCase):
"""Test the implementation of readiness."""
layer = ZopelessDatabaseLayer
def _sampleData(self):
return list(IStore(Job).execute(Job.ready_jobs))
def test_ready_jobs(self):
"""Job.ready_jobs should include new jobs."""
preexisting = self._sampleData()
job = Job()
self.assertEqual(
preexisting + [(job.id,)],
list(Store.of(job).execute(Job.ready_jobs)))
def test_ready_jobs_started(self):
"""Job.ready_jobs should not jobs that have been started."""
preexisting = self._sampleData()
job = Job(_status=JobStatus.RUNNING)
self.assertEqual(
preexisting, list(Store.of(job).execute(Job.ready_jobs)))
def test_ready_jobs_lease_expired(self):
"""Job.ready_jobs should include jobs with expired leases."""
preexisting = self._sampleData()
UNIX_EPOCH = datetime.fromtimestamp(0, pytz.timezone('UTC'))
job = Job(lease_expires=UNIX_EPOCH)
self.assertEqual(
preexisting + [(job.id,)],
list(Store.of(job).execute(Job.ready_jobs)))
def test_ready_jobs_lease_in_future(self):
"""Job.ready_jobs should not include jobs with active leases."""
preexisting = self._sampleData()
future = datetime.fromtimestamp(
time.time() + 1000, pytz.timezone('UTC'))
job = Job(lease_expires=future)
self.assertEqual(
preexisting, list(Store.of(job).execute(Job.ready_jobs)))
def test_ready_jobs_not_jobs_scheduled_in_future(self):
"""Job.ready_jobs does not included jobs scheduled for a time in the
future.
"""
preexisting = self._sampleData()
future = datetime.fromtimestamp(
time.time() + 1000, pytz.timezone('UTC'))
job = Job(scheduled_start=future)
self.assertEqual(
preexisting, list(Store.of(job).execute(Job.ready_jobs)))
def test_acquireLease(self):
"""Job.acquireLease should set job.lease_expires."""
job = Job()
job.acquireLease()
self.assertIsNot(None, job.lease_expires)
def test_acquireHeldLease(self):
"""Job.acquireLease should raise LeaseHeld if repeated."""
job = Job()
job.acquireLease()
self.assertRaises(LeaseHeld, job.acquireLease)
def test_acquireStaleLease(self):
"""Job.acquireLease should work when a lease is expired."""
job = Job()
job.acquireLease(-1)
job.acquireLease()
def test_acquireLeaseTimeout(self):
"""Test that getTimeout correctly calculates value from lease.
The imprecision is because leases are relative to the current time,
and the current time may have changed by the time we get to
job.getTimeout() <= 300.
"""
job = Job()
job.acquireLease(300)
self.assertTrue(job.getTimeout() > 0)
self.assertTrue(job.getTimeout() <= 300)
def test_acquireLeaseTimeoutExpired(self):
"""Expired leases don't produce negative timeouts."""
job = Job()
job.acquireLease(-300)
self.assertEqual(0, job.getTimeout())
|