test_task.py 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787
  1. import unittest2 as unittest
  2. from StringIO import StringIO
  3. from datetime import datetime, timedelta
  4. from pyparsing import ParseException
  5. from celery import conf
  6. from celery import task
  7. from celery import messaging
  8. from celery.task.schedules import crontab, crontab_parser
  9. from celery.utils import timeutils
  10. from celery.utils import gen_unique_id, parse_iso8601
  11. from celery.utils.functional import wraps
  12. from celery.result import EagerResult
  13. from celery.execute import send_task
  14. from celery.backends import default_backend
  15. from celery.decorators import task as task_dec
  16. from celery.exceptions import RetryTaskError
  17. from celery.tests.utils import with_eager_tasks
  18. def return_True(*args, **kwargs):
  19. # Task run functions can't be closures/lambdas, as they're pickled.
  20. return True
  21. return_True_task = task_dec()(return_True)
  22. def raise_exception(self, **kwargs):
  23. raise Exception("%s error" % self.__class__)
  24. class MockApplyTask(task.Task):
  25. def run(self, x, y):
  26. return x * y
  27. @classmethod
  28. def apply_async(self, *args, **kwargs):
  29. pass
  30. class IncrementCounterTask(task.Task):
  31. name = "c.unittest.increment_counter_task"
  32. count = 0
  33. def run(self, increment_by=1, **kwargs):
  34. increment_by = increment_by or 1
  35. self.__class__.count += increment_by
  36. return self.__class__.count
  37. class RaisingTask(task.Task):
  38. name = "c.unittest.raising_task"
  39. def run(self, **kwargs):
  40. raise KeyError("foo")
  41. class RetryTask(task.Task):
  42. max_retries = 3
  43. iterations = 0
  44. def run(self, arg1, arg2, kwarg=1, **kwargs):
  45. self.__class__.iterations += 1
  46. retries = kwargs["task_retries"]
  47. if retries >= 3:
  48. return arg1
  49. else:
  50. kwargs.update({"kwarg": kwarg})
  51. return self.retry(args=[arg1, arg2], kwargs=kwargs, countdown=0)
  52. class RetryTaskNoArgs(task.Task):
  53. max_retries = 3
  54. iterations = 0
  55. def run(self, **kwargs):
  56. self.__class__.iterations += 1
  57. retries = kwargs["task_retries"]
  58. if retries >= 3:
  59. return 42
  60. else:
  61. return self.retry(kwargs=kwargs, countdown=0)
  62. class RetryTaskMockApply(task.Task):
  63. max_retries = 3
  64. iterations = 0
  65. applied = 0
  66. def run(self, arg1, arg2, kwarg=1, **kwargs):
  67. self.__class__.iterations += 1
  68. retries = kwargs["task_retries"]
  69. if retries >= 3:
  70. return arg1
  71. else:
  72. kwargs.update({"kwarg": kwarg})
  73. return self.retry(args=[arg1, arg2], kwargs=kwargs, countdown=0)
  74. @classmethod
  75. def apply_async(self, *args, **kwargs):
  76. self.applied = 1
  77. class MyCustomException(Exception):
  78. """Random custom exception."""
  79. class RetryTaskCustomExc(task.Task):
  80. max_retries = 3
  81. iterations = 0
  82. def run(self, arg1, arg2, kwarg=1, **kwargs):
  83. self.__class__.iterations += 1
  84. retries = kwargs["task_retries"]
  85. if retries >= 3:
  86. return arg1 + kwarg
  87. else:
  88. try:
  89. raise MyCustomException("Elaine Marie Benes")
  90. except MyCustomException, exc:
  91. kwargs.update({"kwarg": kwarg})
  92. return self.retry(args=[arg1, arg2], kwargs=kwargs,
  93. countdown=0, exc=exc)
  94. class TestTaskRetries(unittest.TestCase):
  95. def test_retry(self):
  96. RetryTask.max_retries = 3
  97. RetryTask.iterations = 0
  98. result = RetryTask.apply([0xFF, 0xFFFF])
  99. self.assertEqual(result.get(), 0xFF)
  100. self.assertEqual(RetryTask.iterations, 4)
  101. def test_retry_no_args(self):
  102. RetryTaskNoArgs.max_retries = 3
  103. RetryTaskNoArgs.iterations = 0
  104. result = RetryTaskNoArgs.apply()
  105. self.assertEqual(result.get(), 42)
  106. self.assertEqual(RetryTaskNoArgs.iterations, 4)
  107. def test_retry_kwargs_can_not_be_empty(self):
  108. self.assertRaises(TypeError, RetryTaskMockApply.retry,
  109. args=[4, 4], kwargs={})
  110. def test_retry_not_eager(self):
  111. exc = Exception("baz")
  112. try:
  113. RetryTaskMockApply.retry(args=[4, 4], kwargs={"task_retries": 0},
  114. exc=exc, throw=False)
  115. self.assertTrue(RetryTaskMockApply.applied)
  116. finally:
  117. RetryTaskMockApply.applied = 0
  118. try:
  119. self.assertRaises(RetryTaskError, RetryTaskMockApply.retry,
  120. args=[4, 4], kwargs={"task_retries": 0},
  121. exc=exc, throw=True)
  122. self.assertTrue(RetryTaskMockApply.applied)
  123. finally:
  124. RetryTaskMockApply.applied = 0
  125. def test_retry_with_kwargs(self):
  126. RetryTaskCustomExc.max_retries = 3
  127. RetryTaskCustomExc.iterations = 0
  128. result = RetryTaskCustomExc.apply([0xFF, 0xFFFF], {"kwarg": 0xF})
  129. self.assertEqual(result.get(), 0xFF + 0xF)
  130. self.assertEqual(RetryTaskCustomExc.iterations, 4)
  131. def test_retry_with_custom_exception(self):
  132. RetryTaskCustomExc.max_retries = 2
  133. RetryTaskCustomExc.iterations = 0
  134. result = RetryTaskCustomExc.apply([0xFF, 0xFFFF], {"kwarg": 0xF})
  135. self.assertRaises(MyCustomException,
  136. result.get)
  137. self.assertEqual(RetryTaskCustomExc.iterations, 3)
  138. def test_max_retries_exceeded(self):
  139. RetryTask.max_retries = 2
  140. RetryTask.iterations = 0
  141. result = RetryTask.apply([0xFF, 0xFFFF])
  142. self.assertRaises(RetryTask.MaxRetriesExceededError,
  143. result.get)
  144. self.assertEqual(RetryTask.iterations, 3)
  145. RetryTask.max_retries = 1
  146. RetryTask.iterations = 0
  147. result = RetryTask.apply([0xFF, 0xFFFF])
  148. self.assertRaises(RetryTask.MaxRetriesExceededError,
  149. result.get)
  150. self.assertEqual(RetryTask.iterations, 2)
  151. class MockPublisher(object):
  152. def __init__(self, *args, **kwargs):
  153. self.kwargs = kwargs
  154. class TestCeleryTasks(unittest.TestCase):
  155. def createTaskCls(self, cls_name, task_name=None):
  156. attrs = {"__module__": self.__module__}
  157. if task_name:
  158. attrs["name"] = task_name
  159. cls = type(cls_name, (task.Task, ), attrs)
  160. cls.run = return_True
  161. return cls
  162. def test_AsyncResult(self):
  163. task_id = gen_unique_id()
  164. result = RetryTask.AsyncResult(task_id)
  165. self.assertEqual(result.backend, RetryTask.backend)
  166. self.assertEqual(result.task_id, task_id)
  167. @with_eager_tasks
  168. def test_ping(self):
  169. self.assertEqual(task.ping(), 'pong')
  170. @with_eager_tasks
  171. def test_execute_remote(self):
  172. self.assertEqual(task.execute_remote(return_True, ["foo"]).get(),
  173. True)
  174. @with_eager_tasks
  175. def test_dmap(self):
  176. import operator
  177. res = task.dmap(operator.add, zip(xrange(10), xrange(10)))
  178. self.assertEqual(sum(res), sum(operator.add(x, x)
  179. for x in xrange(10)))
  180. @with_eager_tasks
  181. def test_dmap_async(self):
  182. import operator
  183. res = task.dmap_async(operator.add, zip(xrange(10), xrange(10)))
  184. self.assertEqual(sum(res.get()), sum(operator.add(x, x)
  185. for x in xrange(10)))
  186. def assertNextTaskDataEqual(self, consumer, presult, task_name,
  187. test_eta=False, **kwargs):
  188. next_task = consumer.fetch()
  189. task_data = next_task.decode()
  190. self.assertEqual(task_data["id"], presult.task_id)
  191. self.assertEqual(task_data["task"], task_name)
  192. task_kwargs = task_data.get("kwargs", {})
  193. if test_eta:
  194. self.assertIsInstance(task_data.get("eta"), basestring)
  195. to_datetime = parse_iso8601(task_data.get("eta"))
  196. self.assertIsInstance(to_datetime, datetime)
  197. for arg_name, arg_value in kwargs.items():
  198. self.assertEqual(task_kwargs.get(arg_name), arg_value)
  199. def test_incomplete_task_cls(self):
  200. class IncompleteTask(task.Task):
  201. name = "c.unittest.t.itask"
  202. self.assertRaises(NotImplementedError, IncompleteTask().run)
  203. def test_task_kwargs_must_be_dictionary(self):
  204. self.assertRaises(ValueError, IncrementCounterTask.apply_async,
  205. [], "str")
  206. def test_task_args_must_be_list(self):
  207. self.assertRaises(ValueError, IncrementCounterTask.apply_async,
  208. "str", {})
  209. def test_regular_task(self):
  210. T1 = self.createTaskCls("T1", "c.unittest.t.t1")
  211. self.assertIsInstance(T1(), T1)
  212. self.assertTrue(T1().run())
  213. self.assertTrue(callable(T1()),
  214. "Task class is callable()")
  215. self.assertTrue(T1()(),
  216. "Task class runs run() when called")
  217. # task name generated out of class module + name.
  218. T2 = self.createTaskCls("T2")
  219. self.assertTrue(T2().name.endswith("test_task.T2"))
  220. t1 = T1()
  221. consumer = t1.get_consumer()
  222. self.assertRaises(NotImplementedError, consumer.receive, "foo", "foo")
  223. consumer.discard_all()
  224. self.assertIsNone(consumer.fetch())
  225. # Without arguments.
  226. presult = t1.delay()
  227. self.assertNextTaskDataEqual(consumer, presult, t1.name)
  228. # With arguments.
  229. presult2 = t1.apply_async(kwargs=dict(name="George Costanza"))
  230. self.assertNextTaskDataEqual(consumer, presult2, t1.name,
  231. name="George Costanza")
  232. # send_task
  233. sresult = send_task(t1.name, kwargs=dict(name="Elaine M. Benes"))
  234. self.assertNextTaskDataEqual(consumer, sresult, t1.name,
  235. name="Elaine M. Benes")
  236. # With eta.
  237. presult2 = task.apply_async(t1, kwargs=dict(name="George Costanza"),
  238. eta=datetime.now() + timedelta(days=1))
  239. self.assertNextTaskDataEqual(consumer, presult2, t1.name,
  240. name="George Costanza", test_eta=True)
  241. # With countdown.
  242. presult2 = task.apply_async(t1, kwargs=dict(name="George Costanza"),
  243. countdown=10)
  244. self.assertNextTaskDataEqual(consumer, presult2, t1.name,
  245. name="George Costanza", test_eta=True)
  246. # Discarding all tasks.
  247. consumer.discard_all()
  248. task.apply_async(t1)
  249. self.assertEqual(consumer.discard_all(), 1)
  250. self.assertIsNone(consumer.fetch())
  251. self.assertFalse(presult.successful())
  252. default_backend.mark_as_done(presult.task_id, result=None)
  253. self.assertTrue(presult.successful())
  254. publisher = t1.get_publisher()
  255. self.assertIsInstance(publisher, messaging.TaskPublisher)
  256. def test_get_publisher(self):
  257. from celery.task import base
  258. old_pub = base.TaskPublisher
  259. base.TaskPublisher = MockPublisher
  260. try:
  261. p = IncrementCounterTask.get_publisher(exchange="foo",
  262. connection="bar")
  263. self.assertEqual(p.kwargs["exchange"], "foo")
  264. finally:
  265. base.TaskPublisher = old_pub
  266. def test_get_logger(self):
  267. T1 = self.createTaskCls("T1", "c.unittest.t.t1")
  268. t1 = T1()
  269. logfh = StringIO()
  270. logger = t1.get_logger(logfile=logfh, loglevel=0)
  271. self.assertTrue(logger)
  272. class TestTaskSet(unittest.TestCase):
  273. @with_eager_tasks
  274. def test_function_taskset(self):
  275. subtasks = [return_True_task.subtask([i]) for i in range(1, 6)]
  276. ts = task.TaskSet(subtasks)
  277. res = ts.apply_async()
  278. self.assertListEqual(res.join(), [True, True, True, True, True])
  279. def test_counter_taskset(self):
  280. IncrementCounterTask.count = 0
  281. ts = task.TaskSet(tasks=[
  282. IncrementCounterTask.subtask((), {}),
  283. IncrementCounterTask.subtask((), {"increment_by": 2}),
  284. IncrementCounterTask.subtask((), {"increment_by": 3}),
  285. IncrementCounterTask.subtask((), {"increment_by": 4}),
  286. IncrementCounterTask.subtask((), {"increment_by": 5}),
  287. IncrementCounterTask.subtask((), {"increment_by": 6}),
  288. IncrementCounterTask.subtask((), {"increment_by": 7}),
  289. IncrementCounterTask.subtask((), {"increment_by": 8}),
  290. IncrementCounterTask.subtask((), {"increment_by": 9}),
  291. ])
  292. self.assertEqual(ts.total, 9)
  293. consumer = IncrementCounterTask().get_consumer()
  294. consumer.discard_all()
  295. taskset_res = ts.apply_async()
  296. subtasks = taskset_res.subtasks
  297. taskset_id = taskset_res.taskset_id
  298. for subtask in subtasks:
  299. m = consumer.fetch().payload
  300. self.assertDictContainsSubset({"taskset": taskset_id,
  301. "task": IncrementCounterTask.name,
  302. "id": subtask.task_id}, m)
  303. IncrementCounterTask().run(
  304. increment_by=m.get("kwargs", {}).get("increment_by"))
  305. self.assertEqual(IncrementCounterTask.count, sum(xrange(1, 10)))
  306. class TestTaskApply(unittest.TestCase):
  307. def test_apply_throw(self):
  308. self.assertRaises(KeyError, RaisingTask.apply, throw=True)
  309. def test_apply_with_CELERY_EAGER_PROPAGATES_EXCEPTIONS(self):
  310. conf.EAGER_PROPAGATES_EXCEPTIONS = True
  311. try:
  312. self.assertRaises(KeyError, RaisingTask.apply)
  313. finally:
  314. conf.EAGER_PROPAGATES_EXCEPTIONS = False
  315. def test_apply(self):
  316. IncrementCounterTask.count = 0
  317. e = IncrementCounterTask.apply()
  318. self.assertIsInstance(e, EagerResult)
  319. self.assertEqual(e.get(), 1)
  320. e = IncrementCounterTask.apply(args=[1])
  321. self.assertEqual(e.get(), 2)
  322. e = IncrementCounterTask.apply(kwargs={"increment_by": 4})
  323. self.assertEqual(e.get(), 6)
  324. self.assertTrue(e.successful())
  325. self.assertTrue(e.ready())
  326. self.assertTrue(repr(e).startswith("<EagerResult:"))
  327. f = RaisingTask.apply()
  328. self.assertTrue(f.ready())
  329. self.assertFalse(f.successful())
  330. self.assertTrue(f.traceback)
  331. self.assertRaises(KeyError, f.get)
  332. class MyPeriodic(task.PeriodicTask):
  333. run_every = timedelta(hours=1)
  334. class TestPeriodicTask(unittest.TestCase):
  335. def test_must_have_run_every(self):
  336. self.assertRaises(NotImplementedError, type, "Foo",
  337. (task.PeriodicTask, ), {"__module__": __name__})
  338. def test_remaining_estimate(self):
  339. self.assertIsInstance(
  340. MyPeriodic().remaining_estimate(datetime.now()),
  341. timedelta)
  342. def test_timedelta_seconds_returns_0_on_negative_time(self):
  343. delta = timedelta(days=-2)
  344. self.assertEqual(MyPeriodic().timedelta_seconds(delta), 0)
  345. def test_timedelta_seconds(self):
  346. deltamap = ((timedelta(seconds=1), 1),
  347. (timedelta(seconds=27), 27),
  348. (timedelta(minutes=3), 3 * 60),
  349. (timedelta(hours=4), 4 * 60 * 60),
  350. (timedelta(days=3), 3 * 86400))
  351. for delta, seconds in deltamap:
  352. self.assertEqual(MyPeriodic().timedelta_seconds(delta), seconds)
  353. def test_delta_resolution(self):
  354. D = timeutils.delta_resolution
  355. dt = datetime(2010, 3, 30, 11, 50, 58, 41065)
  356. deltamap = ((timedelta(days=2), datetime(2010, 3, 30, 0, 0)),
  357. (timedelta(hours=2), datetime(2010, 3, 30, 11, 0)),
  358. (timedelta(minutes=2), datetime(2010, 3, 30, 11, 50)),
  359. (timedelta(seconds=2), dt))
  360. for delta, shoulda in deltamap:
  361. self.assertEqual(D(dt, delta), shoulda)
  362. def test_is_due_not_due(self):
  363. due, remaining = MyPeriodic().is_due(datetime.now())
  364. self.assertFalse(due)
  365. # TODO This assertion may fail if executed in the
  366. # first minute of an hour
  367. self.assertGreater(remaining, 60)
  368. def test_is_due(self):
  369. p = MyPeriodic()
  370. due, remaining = p.is_due(datetime.now() - p.run_every.run_every)
  371. self.assertTrue(due)
  372. self.assertEqual(remaining,
  373. p.timedelta_seconds(p.run_every.run_every))
  374. class EveryMinutePeriodic(task.PeriodicTask):
  375. run_every = crontab()
  376. class QuarterlyPeriodic(task.PeriodicTask):
  377. run_every = crontab(minute="*/15")
  378. class HourlyPeriodic(task.PeriodicTask):
  379. run_every = crontab(minute=30)
  380. class DailyPeriodic(task.PeriodicTask):
  381. run_every = crontab(hour=7, minute=30)
  382. class WeeklyPeriodic(task.PeriodicTask):
  383. run_every = crontab(hour=7, minute=30, day_of_week="thursday")
  384. def patch_crontab_nowfun(cls, retval):
  385. def create_patcher(fun):
  386. @wraps(fun)
  387. def __inner(*args, **kwargs):
  388. prev_nowfun = cls.run_every.nowfun
  389. cls.run_every.nowfun = lambda: retval
  390. try:
  391. return fun(*args, **kwargs)
  392. finally:
  393. cls.run_every.nowfun = prev_nowfun
  394. return __inner
  395. return create_patcher
  396. class test_crontab_parser(unittest.TestCase):
  397. def test_parse_star(self):
  398. self.assertEquals(crontab_parser(24).parse('*'), set(range(24)))
  399. self.assertEquals(crontab_parser(60).parse('*'), set(range(60)))
  400. self.assertEquals(crontab_parser(7).parse('*'), set(range(7)))
  401. def test_parse_range(self):
  402. self.assertEquals(crontab_parser(60).parse('1-10'),
  403. set(range(1, 10 + 1)))
  404. self.assertEquals(crontab_parser(24).parse('0-20'),
  405. set(range(0, 20 + 1)))
  406. self.assertEquals(crontab_parser().parse('2-10'),
  407. set(range(2, 10 + 1)))
  408. def test_parse_groups(self):
  409. self.assertEquals(crontab_parser().parse('1,2,3,4'),
  410. set([1, 2, 3, 4]))
  411. self.assertEquals(crontab_parser().parse('0,15,30,45'),
  412. set([0, 15, 30, 45]))
  413. def test_parse_steps(self):
  414. self.assertEquals(crontab_parser(8).parse('*/2'),
  415. set([0, 2, 4, 6]))
  416. self.assertEquals(crontab_parser().parse('*/2'),
  417. set(i * 2 for i in xrange(30)))
  418. self.assertEquals(crontab_parser().parse('*/3'),
  419. set(i * 3 for i in xrange(20)))
  420. def test_parse_composite(self):
  421. self.assertEquals(crontab_parser(8).parse('*/2'), set([0, 2, 4, 6]))
  422. self.assertEquals(crontab_parser().parse('2-9/5'), set([5]))
  423. self.assertEquals(crontab_parser().parse('2-10/5'), set([5, 10]))
  424. self.assertEquals(crontab_parser().parse('2-11/5,3'), set([3, 5, 10]))
  425. self.assertEquals(crontab_parser().parse('2-4/3,*/5,0-21/4'),
  426. set([0, 3, 4, 5, 8, 10, 12, 15, 16,
  427. 20, 25, 30, 35, 40, 45, 50, 55]))
  428. def test_parse_errors_on_empty_string(self):
  429. self.assertRaises(ParseException, crontab_parser(60).parse, '')
  430. def test_parse_errors_on_empty_group(self):
  431. self.assertRaises(ParseException, crontab_parser(60).parse, '1,,2')
  432. def test_parse_errors_on_empty_steps(self):
  433. self.assertRaises(ParseException, crontab_parser(60).parse, '*/')
  434. def test_parse_errors_on_negative_number(self):
  435. self.assertRaises(ParseException, crontab_parser(60).parse, '-20')
  436. class test_crontab_remaining_estimate(unittest.TestCase):
  437. def next_ocurrance(self, crontab, now):
  438. crontab.nowfun = lambda: now
  439. return now + crontab.remaining_estimate(now)
  440. def test_next_minute(self):
  441. next = self.next_ocurrance(crontab(),
  442. datetime(2010, 9, 11, 14, 30, 15))
  443. self.assertEquals(next, datetime(2010, 9, 11, 14, 31))
  444. def test_not_next_minute(self):
  445. next = self.next_ocurrance(crontab(),
  446. datetime(2010, 9, 11, 14, 59, 15))
  447. self.assertEquals(next, datetime(2010, 9, 11, 15, 0))
  448. def test_this_hour(self):
  449. next = self.next_ocurrance(crontab(minute=[5, 42]),
  450. datetime(2010, 9, 11, 14, 30, 15))
  451. self.assertEquals(next, datetime(2010, 9, 11, 14, 42))
  452. def test_not_this_hour(self):
  453. next = self.next_ocurrance(crontab(minute=[5, 10, 15]),
  454. datetime(2010, 9, 11, 14, 30, 15))
  455. self.assertEquals(next, datetime(2010, 9, 11, 15, 5))
  456. def test_today(self):
  457. next = self.next_ocurrance(crontab(minute=[5, 42], hour=[12, 17]),
  458. datetime(2010, 9, 11, 14, 30, 15))
  459. self.assertEquals(next, datetime(2010, 9, 11, 17, 5))
  460. def test_not_today(self):
  461. next = self.next_ocurrance(crontab(minute=[5, 42], hour=[12]),
  462. datetime(2010, 9, 11, 14, 30, 15))
  463. self.assertEquals(next, datetime(2010, 9, 12, 12, 5))
  464. def test_weekday(self):
  465. next = self.next_ocurrance(crontab(minute=30,
  466. hour=14,
  467. day_of_week="sat"),
  468. datetime(2010, 9, 11, 14, 30, 15))
  469. self.assertEquals(next, datetime(2010, 9, 18, 14, 30))
  470. def test_not_weekday(self):
  471. next = self.next_ocurrance(crontab(minute=[5, 42],
  472. day_of_week="mon-fri"),
  473. datetime(2010, 9, 11, 14, 30, 15))
  474. self.assertEquals(next, datetime(2010, 9, 13, 0, 5))
  475. class test_crontab_is_due(unittest.TestCase):
  476. def setUp(self):
  477. self.now = datetime.now()
  478. self.next_minute = 60 - self.now.second - 1e-6 * self.now.microsecond
  479. def test_default_crontab_spec(self):
  480. c = crontab()
  481. self.assertEquals(c.minute, set(range(60)))
  482. self.assertEquals(c.hour, set(range(24)))
  483. self.assertEquals(c.day_of_week, set(range(7)))
  484. def test_simple_crontab_spec(self):
  485. c = crontab(minute=30)
  486. self.assertEquals(c.minute, set([30]))
  487. self.assertEquals(c.hour, set(range(24)))
  488. self.assertEquals(c.day_of_week, set(range(7)))
  489. def test_crontab_spec_minute_formats(self):
  490. c = crontab(minute=30)
  491. self.assertEquals(c.minute, set([30]))
  492. c = crontab(minute='30')
  493. self.assertEquals(c.minute, set([30]))
  494. c = crontab(minute=(30, 40, 50))
  495. self.assertEquals(c.minute, set([30, 40, 50]))
  496. c = crontab(minute=set([30, 40, 50]))
  497. self.assertEquals(c.minute, set([30, 40, 50]))
  498. def test_crontab_spec_invalid_minute(self):
  499. self.assertRaises(ValueError, crontab, minute=60)
  500. self.assertRaises(ValueError, crontab, minute='0-100')
  501. def test_crontab_spec_hour_formats(self):
  502. c = crontab(hour=6)
  503. self.assertEquals(c.hour, set([6]))
  504. c = crontab(hour='5')
  505. self.assertEquals(c.hour, set([5]))
  506. c = crontab(hour=(4, 8, 12))
  507. self.assertEquals(c.hour, set([4, 8, 12]))
  508. def test_crontab_spec_invalid_hour(self):
  509. self.assertRaises(ValueError, crontab, hour=24)
  510. self.assertRaises(ValueError, crontab, hour='0-30')
  511. def test_crontab_spec_dow_formats(self):
  512. c = crontab(day_of_week=5)
  513. self.assertEquals(c.day_of_week, set([5]))
  514. c = crontab(day_of_week='5')
  515. self.assertEquals(c.day_of_week, set([5]))
  516. c = crontab(day_of_week='fri')
  517. self.assertEquals(c.day_of_week, set([5]))
  518. c = crontab(day_of_week='tuesday,sunday,fri')
  519. self.assertEquals(c.day_of_week, set([0, 2, 5]))
  520. c = crontab(day_of_week='mon-fri')
  521. self.assertEquals(c.day_of_week, set([1, 2, 3, 4, 5]))
  522. c = crontab(day_of_week='*/2')
  523. self.assertEquals(c.day_of_week, set([0, 2, 4, 6]))
  524. def test_crontab_spec_invalid_dow(self):
  525. self.assertRaises(ValueError, crontab, day_of_week='fooday-barday')
  526. self.assertRaises(ValueError, crontab, day_of_week='1,4,foo')
  527. self.assertRaises(ValueError, crontab, day_of_week='7')
  528. self.assertRaises(ValueError, crontab, day_of_week='12')
  529. def test_every_minute_execution_is_due(self):
  530. last_ran = self.now - timedelta(seconds=61)
  531. due, remaining = EveryMinutePeriodic().is_due(last_ran)
  532. self.assertTrue(due)
  533. self.assertAlmostEquals(remaining, self.next_minute)
  534. def test_every_minute_execution_is_not_due(self):
  535. last_ran = self.now - timedelta(seconds=self.now.second)
  536. due, remaining = EveryMinutePeriodic().is_due(last_ran)
  537. self.assertFalse(due)
  538. self.assertAlmostEquals(remaining, self.next_minute)
  539. # 29th of May 2010 is a saturday
  540. @patch_crontab_nowfun(HourlyPeriodic, datetime(2010, 5, 29, 10, 30))
  541. def test_execution_is_due_on_saturday(self):
  542. last_ran = self.now - timedelta(seconds=61)
  543. due, remaining = EveryMinutePeriodic().is_due(last_ran)
  544. self.assertTrue(due)
  545. self.assertAlmostEquals(remaining, self.next_minute)
  546. # 30th of May 2010 is a sunday
  547. @patch_crontab_nowfun(HourlyPeriodic, datetime(2010, 5, 30, 10, 30))
  548. def test_execution_is_due_on_sunday(self):
  549. last_ran = self.now - timedelta(seconds=61)
  550. due, remaining = EveryMinutePeriodic().is_due(last_ran)
  551. self.assertTrue(due)
  552. self.assertAlmostEquals(remaining, self.next_minute)
  553. # 31st of May 2010 is a monday
  554. @patch_crontab_nowfun(HourlyPeriodic, datetime(2010, 5, 31, 10, 30))
  555. def test_execution_is_due_on_monday(self):
  556. last_ran = self.now - timedelta(seconds=61)
  557. due, remaining = EveryMinutePeriodic().is_due(last_ran)
  558. self.assertTrue(due)
  559. self.assertAlmostEquals(remaining, self.next_minute)
  560. @patch_crontab_nowfun(HourlyPeriodic, datetime(2010, 5, 10, 10, 30))
  561. def test_every_hour_execution_is_due(self):
  562. due, remaining = HourlyPeriodic().is_due(datetime(2010, 5, 10, 6, 30))
  563. self.assertTrue(due)
  564. self.assertEquals(remaining, 60*60)
  565. @patch_crontab_nowfun(HourlyPeriodic, datetime(2010, 5, 10, 10, 29))
  566. def test_every_hour_execution_is_not_due(self):
  567. due, remaining = HourlyPeriodic().is_due(datetime(2010, 5, 10, 9, 30))
  568. self.assertFalse(due)
  569. self.assertEquals(remaining, 60)
  570. @patch_crontab_nowfun(QuarterlyPeriodic, datetime(2010, 5, 10, 10, 15))
  571. def test_first_quarter_execution_is_due(self):
  572. due, remaining = QuarterlyPeriodic().is_due(
  573. datetime(2010, 5, 10, 6, 30))
  574. self.assertTrue(due)
  575. self.assertEquals(remaining, 15*60)
  576. @patch_crontab_nowfun(QuarterlyPeriodic, datetime(2010, 5, 10, 10, 30))
  577. def test_second_quarter_execution_is_due(self):
  578. due, remaining = QuarterlyPeriodic().is_due(
  579. datetime(2010, 5, 10, 6, 30))
  580. self.assertTrue(due)
  581. self.assertEquals(remaining, 15*60)
  582. @patch_crontab_nowfun(QuarterlyPeriodic, datetime(2010, 5, 10, 10, 14))
  583. def test_first_quarter_execution_is_not_due(self):
  584. due, remaining = QuarterlyPeriodic().is_due(
  585. datetime(2010, 5, 10, 10, 0))
  586. self.assertFalse(due)
  587. self.assertEquals(remaining, 60)
  588. @patch_crontab_nowfun(QuarterlyPeriodic, datetime(2010, 5, 10, 10, 29))
  589. def test_second_quarter_execution_is_not_due(self):
  590. due, remaining = QuarterlyPeriodic().is_due(
  591. datetime(2010, 5, 10, 10, 15))
  592. self.assertFalse(due)
  593. self.assertEquals(remaining, 60)
  594. @patch_crontab_nowfun(DailyPeriodic, datetime(2010, 5, 10, 7, 30))
  595. def test_daily_execution_is_due(self):
  596. due, remaining = DailyPeriodic().is_due(datetime(2010, 5, 9, 7, 30))
  597. self.assertTrue(due)
  598. self.assertEquals(remaining, 24*60*60)
  599. @patch_crontab_nowfun(DailyPeriodic, datetime(2010, 5, 10, 10, 30))
  600. def test_daily_execution_is_not_due(self):
  601. due, remaining = DailyPeriodic().is_due(datetime(2010, 5, 10, 7, 30))
  602. self.assertFalse(due)
  603. self.assertEquals(remaining, 21*60*60)
  604. @patch_crontab_nowfun(WeeklyPeriodic, datetime(2010, 5, 6, 7, 30))
  605. def test_weekly_execution_is_due(self):
  606. due, remaining = WeeklyPeriodic().is_due(datetime(2010, 4, 30, 7, 30))
  607. self.assertTrue(due)
  608. self.assertEquals(remaining, 7*24*60*60)
  609. @patch_crontab_nowfun(WeeklyPeriodic, datetime(2010, 5, 7, 10, 30))
  610. def test_weekly_execution_is_not_due(self):
  611. due, remaining = WeeklyPeriodic().is_due(datetime(2010, 5, 6, 7, 30))
  612. self.assertFalse(due)
  613. self.assertEquals(remaining, 6*24*60*60 - 3*60*60)