test_task.py 29 KB

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