def test_weekdays(self):
sun = CrabSchedule('* * * * 0', 'UTC')
mon = CrabSchedule('* * * * 1', 'UTC')
tue = CrabSchedule('* * * * 2', 'UTC')
wed = CrabSchedule('* * * * wed', 'UTC')
thu = CrabSchedule('* * * * 4', 'UTC')
fri = CrabSchedule('* * * * fri', 'UTC')
sat = CrabSchedule('* * * * 6', 'UTC')
sun7 = CrabSchedule('* * * * 7', 'UTC')
d = datetime(2012, 8, 10, 12, 0, tzinfo=UTC)
day = timedelta(days=1)
self.assertTrue(fri.match(d), 'Date is Friday')
self.assertFalse(sat.match(d), 'Date is not Satuday')
d += day
self.assertTrue(sat.match(d), 'Date + 1 is Saturday')
d += day
self.assertTrue(sun.match(d), 'Date + 2 is Sunday')
self.assertTrue(sun7.match(d), 'Date + 2 is Sunday (day 7)')
d += day
self.assertTrue(mon.match(d), 'Date + 3 is Monday')
d += day
self.assertTrue(tue.match(d), 'Date + 4 is Tuesday')
d += day
self.assertTrue(wed.match(d), 'Date + 5 is Wednesday')
d += day
self.assertTrue(thu.match(d), 'Date + 6 is Thursday')
def test_weekdays(self):
sun = CrabSchedule('* * * * 0', 'UTC')
mon = CrabSchedule('* * * * 1', 'UTC')
tue = CrabSchedule('* * * * 2', 'UTC')
wed = CrabSchedule('* * * * wed', 'UTC')
thu = CrabSchedule('* * * * 4', 'UTC')
fri = CrabSchedule('* * * * fri', 'UTC')
sat = CrabSchedule('* * * * 6', 'UTC')
sun7 = CrabSchedule('* * * * 7', 'UTC')
d = datetime(2012, 8, 10, 12, 0, tzinfo=UTC)
day = timedelta(days=1)
self.assertTrue(fri.match(d), 'Date is Friday')
self.assertFalse(sat.match(d), 'Date is not Satuday')
d += day
self.assertTrue(sat.match(d), 'Date + 1 is Saturday')
d += day
self.assertTrue(sun.match(d), 'Date + 2 is Sunday')
self.assertTrue(sun7.match(d), 'Date + 2 is Sunday (day 7)')
d += day
self.assertTrue(mon.match(d), 'Date + 3 is Monday')
d += day
self.assertTrue(tue.match(d), 'Date + 4 is Tuesday')
d += day
self.assertTrue(wed.match(d), 'Date + 5 is Wednesday')
d += day
self.assertTrue(thu.match(d), 'Date + 6 is Thursday')
def test_list(self):
hon = timezone('Pacific/Honolulu')
br = CrabSchedule('0 10,15 * * *', 'Pacific/Honolulu')
self.assertTrue(br.match(datetime(2012, 10, 15, 10, 0, tzinfo=hon)),
'Coffee break on time')
self.assertTrue(br.match(datetime(2012, 10, 15, 15, 0, tzinfo=hon)),
'Tea break on time')
self.assertFalse(br.match(datetime(2012, 10, 15, 11, 0, tzinfo=hon)),
'Coffee break not 1 hour late')
self.assertFalse(br.match(datetime(2012, 10, 15, 16, 0, tzinfo=hon)),
'Tea break not 1 hour late')
def test_list(self):
hon = timezone('Pacific/Honolulu')
br = CrabSchedule('0 10,15 * * *', 'Pacific/Honolulu')
self.assertTrue(br.match(datetime(2012, 10, 15, 10, 0, tzinfo=hon)),
'Coffee break on time')
self.assertTrue(br.match(datetime(2012, 10, 15, 15, 0, tzinfo=hon)),
'Tea break on time')
self.assertFalse(br.match(datetime(2012, 10, 15, 11, 0, tzinfo=hon)),
'Coffee break not 1 hour late')
self.assertFalse(br.match(datetime(2012, 10, 15, 16, 0, tzinfo=hon)),
'Tea break not 1 hour late')
def run_minutely(self, datetime_):
"""Issues notifications if any are scheduled for the given minute."""
current = []
match_daily = self.schedule.match(datetime_)
if match_daily:
daily_start = self.schedule.previous_datetime(datetime_)
else:
daily_start = None
try:
notifications = self.store.get_notifications()
except CrabError as err:
print('Error fetching notifications:', str(err))
return
for notification in notifications:
n_id = notification['notifyid']
if (n_id in self.config and n_id in self.sched
and notification['time'] == self.config[n_id]['time'] and
notification['timezone'] == self.config[n_id]['timezone']):
schedule = self.sched[n_id]
else:
self.config[n_id] = notification
if notification['time'] is not None:
try:
schedule = CrabSchedule(notification['time'],
notification['timezone'])
except CrabError as err:
schedule = None
print('Warning: could not read notification schedule:',
str(err))
else:
schedule = None
self.sched[n_id] = schedule
if schedule is None:
if match_daily:
current.append(
CrabNotifyJob(notification, daily_start, datetime_))
else:
if schedule.match(datetime_):
current.append(
CrabNotifyJob(notification,
schedule.previous_datetime(datetime_),
datetime_))
if current:
self.notify(current)
def run_minutely(self, datetime_):
"""Issues notifications if any are scheduled for the given minute."""
current = []
match_daily = self.schedule.match(datetime_)
if match_daily:
daily_start = self.schedule.previous_datetime(datetime_)
else:
daily_start = None
try:
notifications = self.store.get_notifications()
except CrabError as err:
logger.exception('Error fetching notifications')
return
for notification in notifications:
n_id = notification['notifyid']
if (n_id in self.config and n_id in self.sched and
notification['time'] == self.config[n_id]['time'] and
notification['timezone'] == self.config[n_id]['timezone']):
schedule = self.sched[n_id]
else:
self.config[n_id] = notification
if notification['time'] is not None:
try:
schedule = CrabSchedule(notification['time'],
notification['timezone'])
except CrabError as err:
schedule = None
logger.exception(
'Warning: could not read notification schedule')
else:
schedule = None
self.sched[n_id] = schedule
if schedule is None:
if match_daily:
current.append(CrabNotifyJob(
notification, daily_start, datetime_))
else:
if schedule.match(datetime_):
current.append(CrabNotifyJob(
notification, schedule.previous_datetime(datetime_),
datetime_))
if current:
self.notify(current)
def run_minutely(self, datetime_):
"""Issues notifications if any are scheduled for the given minute."""
current = []
end = datetime_.replace(second=0, microsecond=0)
match_daily = self.schedule.match(datetime_)
if match_daily:
daily_start = self.schedule.previous_datetime(end)
else:
daily_start = None
try:
notifications = self.store.get_notifications()
except CrabError as err:
print('Error fetching notifications:', str(err))
return
for notification in notifications:
n_id = notification['notifyid']
if (n_id in self.config and n_id in self.sched
and notification['time'] == self.config[n_id]['time']
and notification['timezone'] == self.config[n_id]['timezone']):
schedule = self.sched[n_id]
else:
self.config[n_id] = notification
if notification['time'] is not None:
schedule = CrabSchedule(notification['time'],
notification['timezone'])
else:
schedule = None
self.sched[n_id] = schedule
if schedule is None:
if match_daily:
current.append(CrabNotifyJob(
notification, daily_start, end))
else:
if schedule.match(datetime_):
current.append(CrabNotifyJob(
notification, schedule.previous_datetime(end), end))
if current:
self.notify(current)
class CrabCleanService(CrabMinutely):
"""Service to clean the store by removing old events."""
def __init__(self, config, store):
"""Constructor method.
Stores the store object and a CrabSchedule object."""
CrabMinutely.__init__(self)
self.store = store
self.schedule = CrabSchedule(config['schedule'], config['timezone'])
self.keep_days = config['keep_days']
def run_minutely(self, datetime_):
"""Performs cleaning if scheduled for the given minute."""
if self.schedule.match(datetime_):
self.store.delete_old_events(
datetime_=(datetime_ - timedelta(days=self.keep_days)))
class CrabCleanService(CrabMinutely):
"""Service to clean the store by removing old events."""
def __init__(self, config, store):
"""Constructor method.
Stores the store object and a CrabSchedule object."""
CrabMinutely.__init__(self)
self.store = store
self.schedule = CrabSchedule(config['schedule'], config['timezone'])
self.keep_days = config['keep_days']
def run_minutely(self, datetime_):
"""Performs cleaning if scheduled for the given minute."""
if self.schedule.match(datetime_):
self.store.delete_old_events(
datetime_=(datetime_ - timedelta(days=self.keep_days)))
def test_aliases(self):
ho = CrabSchedule('@hourly', 'UTC')
da = CrabSchedule('@daily', 'UTC')
wk = CrabSchedule('@weekly', 'UTC')
self.assertTrue(ho.match(datetime(1998, 10, 30, 1, 0, tzinfo=UTC)),
'Hourly alias match')
self.assertFalse(ho.match(datetime(1998, 10, 30, 1, 1, tzinfo=UTC)),
'Hourly alias non-match')
self.assertTrue(da.match(datetime(1998, 10, 30, 0, 0, tzinfo=UTC)),
'Daily alias match')
self.assertFalse(da.match(datetime(1998, 10, 30, 1, 0, tzinfo=UTC)),
'Daily alias non-match')
self.assertTrue(wk.match(datetime(1998, 10, 25, 0, 0, tzinfo=UTC)),
'Weekly alias match')
self.assertFalse(wk.match(datetime(1998, 10, 30, 0, 0, tzinfo=UTC)),
'Weekly alias non-match')
def test_aliases(self):
ho = CrabSchedule('@hourly', 'UTC')
da = CrabSchedule('@daily', 'UTC')
wk = CrabSchedule('@weekly', 'UTC')
self.assertTrue(ho.match(datetime(1998, 10, 30, 1, 0, tzinfo=UTC)),
'Hourly alias match')
self.assertFalse(ho.match(datetime(1998, 10, 30, 1, 1, tzinfo=UTC)),
'Hourly alias non-match')
self.assertTrue(da.match(datetime(1998, 10, 30, 0, 0, tzinfo=UTC)),
'Daily alias match')
self.assertFalse(da.match(datetime(1998, 10, 30, 1, 0, tzinfo=UTC)),
'Daily alias non-match')
self.assertTrue(wk.match(datetime(1998, 10, 25, 0, 0, tzinfo=UTC)),
'Weekly alias match')
self.assertFalse(wk.match(datetime(1998, 10, 30, 0, 0, tzinfo=UTC)),
'Weekly alias non-match')
class CrabNotifyService(CrabMinutely):
"""Service to send notifications as required.
Currently only a single daily schedule is implemented."""
def __init__(self, config, store, notify):
"""Constructor method.
Stores CrabNotify object and daily CrabSchedule object."""
CrabMinutely.__init__(self)
self.store = store
self.notify = notify
self.schedule = CrabSchedule(config['daily'],
config['timezone'])
self.config = {}
self.sched = {}
def run_minutely(self, datetime_):
"""Issues notifications if any are scheduled for the given minute."""
current = []
end = datetime_.replace(second=0, microsecond=0)
match_daily = self.schedule.match(datetime_)
if match_daily:
daily_start = self.schedule.previous_datetime(end)
else:
daily_start = None
try:
notifications = self.store.get_notifications()
except CrabError as err:
print('Error fetching notifications:', str(err))
return
for notification in notifications:
n_id = notification['notifyid']
if (n_id in self.config and n_id in self.sched
and notification['time'] == self.config[n_id]['time']
and notification['timezone'] == self.config[n_id]['timezone']):
schedule = self.sched[n_id]
else:
self.config[n_id] = notification
if notification['time'] is not None:
schedule = CrabSchedule(notification['time'],
notification['timezone'])
else:
schedule = None
self.sched[n_id] = schedule
if schedule is None:
if match_daily:
current.append(CrabNotifyJob(
notification, daily_start, end))
else:
if schedule.match(datetime_):
current.append(CrabNotifyJob(
notification, schedule.previous_datetime(end), end))
if current:
self.notify(current)
def test_events(self):
lon = timezone('Europe/London')
van = timezone('America/Vancouver') # GMT-8
syd = timezone('Australia/Sydney') # GMT+11 (DST)
qs = CrabSchedule('0 15 25 12 *', 'Europe/London')
ar = CrabSchedule('0 11 11 11 *', 'America/Vancouver')
gf = CrabSchedule('30 19 5 11 *', 'Europe/London')
# Check scheduling correct for different timezones.
self.assertTrue(qs.match(lon.localize(datetime(2012, 12, 25, 15, 0))),
'Queen on time in London')
self.assertTrue(qs.match(van.localize(datetime(2011, 12, 25, 7, 0))),
'Queen on time in Vancouver last year')
self.assertTrue(qs.match(syd.localize(datetime(2013, 12, 26, 2, 0))),
'Queen on time in Sydney next year')
self.assertTrue(qs.match(datetime(2020, 12, 25, 15, 0, tzinfo=UTC)),
'Queen on time in UTC')
self.assertTrue(ar.match(van.localize(datetime(2012, 11, 11, 11, 0))),
'Armistice correct time in Vancouver')
self.assertTrue(ar.match(lon.localize(datetime(2012, 11, 11, 19, 0))),
'Vancouver Armistice correct time in London')
self.assertTrue(ar.match(syd.localize(datetime(2012, 11, 12, 6, 0))),
'Vancouver Armistice correct time in Sydney')
# Check scheduling tests all date parts.
self.assertFalse(qs.match(datetime(2012, 12, 25, 14, 0, tzinfo=lon)),
'Queen not one hour early')
self.assertFalse(qs.match(datetime(2012, 12, 25, 15, 5, tzinfo=lon)),
'Queen not five minutes late')
self.assertFalse(qs.match(datetime(2012, 12, 26, 15, 0, tzinfo=lon)),
'Queen not on boxing day')
self.assertFalse(qs.match(datetime(2012, 11, 25, 15, 0, tzinfo=lon)),
'Queen not on in November')
# And an event which doesn't happen at minute zero.
self.assertTrue(gf.match(datetime(2012, 11, 5, 19, 30, 0, tzinfo=lon)),
'Fireworks on time')
self.assertTrue(gf.match(datetime(2012, 11, 5, 19, 30, 1, tzinfo=lon)),
'Fireworks might be one second late')
self.assertFalse(gf.match(datetime(2012, 11, 5, 19, 35, tzinfo=lon)),
'Fireworks not 5 minutes late')
class CrabNotifyService(CrabMinutely):
"""Service to send notifications as required.
Currently only a single daily schedule is implemented."""
def __init__(self, config, store, notify):
"""Constructor method.
Stores CrabNotify object and daily CrabSchedule object."""
CrabMinutely.__init__(self)
self.store = store
self.notify = notify
self.schedule = CrabSchedule(config['daily'], config['timezone'])
self.config = {}
self.sched = {}
def run_minutely(self, datetime_):
"""Issues notifications if any are scheduled for the given minute."""
current = []
match_daily = self.schedule.match(datetime_)
if match_daily:
daily_start = self.schedule.previous_datetime(datetime_)
else:
daily_start = None
try:
notifications = self.store.get_notifications()
except CrabError as err:
print('Error fetching notifications:', str(err))
return
for notification in notifications:
n_id = notification['notifyid']
if (n_id in self.config and n_id in self.sched
and notification['time'] == self.config[n_id]['time'] and
notification['timezone'] == self.config[n_id]['timezone']):
schedule = self.sched[n_id]
else:
self.config[n_id] = notification
if notification['time'] is not None:
try:
schedule = CrabSchedule(notification['time'],
notification['timezone'])
except CrabError as err:
schedule = None
print('Warning: could not read notification schedule:',
str(err))
else:
schedule = None
self.sched[n_id] = schedule
if schedule is None:
if match_daily:
current.append(
CrabNotifyJob(notification, daily_start, datetime_))
else:
if schedule.match(datetime_):
current.append(
CrabNotifyJob(notification,
schedule.previous_datetime(datetime_),
datetime_))
if current:
self.notify(current)
def test_range(self):
fm = CrabSchedule('0-55/5 * * * *', 'UTC')
self.assertTrue(fm.match(datetime(2012, 7, 4, 10, 0, tzinfo=UTC)),
'Minute 0 % 5')
self.assertFalse(fm.match(datetime(2013, 8, 5, 14, 1, tzinfo=UTC)),
'Minute 1 not % 5')
self.assertFalse(fm.match(datetime(2014, 9, 7, 18, 4, tzinfo=UTC)),
'Minute 4 not % 5')
self.assertTrue(fm.match(datetime(2015, 1, 9, 20, 10, tzinfo=UTC)),
'Minute 10 % 5')
self.assertFalse(fm.match(datetime(2010, 2, 1, 11, 42, tzinfo=UTC)),
'Minute 42 not % 5')
self.assertTrue(fm.match(datetime(2011, 3, 2, 13, 45, tzinfo=UTC)),
'Minute 45 % 5')
self.assertTrue(fm.match(datetime(2012, 4, 3, 16, 55, tzinfo=UTC)),
'Minute 55 % 5')
self.assertFalse(fm.match(datetime(2012, 5, 4, 19, 59, tzinfo=UTC)),
'Minute 59 not % 5')
wd = CrabSchedule('0 0 * * 1-5', 'UTC')
self.assertTrue(wd.match(datetime(2012, 5, 7, 0, 0, tzinfo=UTC)),
'May 7th 2012 a weekday')
self.assertTrue(wd.match(datetime(2012, 5, 8, 0, 0, tzinfo=UTC)),
'May 8th 2012 a weekday')
self.assertTrue(wd.match(datetime(2012, 5, 9, 0, 0, tzinfo=UTC)),
'May 9th 2012 a weekday')
self.assertTrue(wd.match(datetime(2012, 5, 10, 0, 0, tzinfo=UTC)),
'May 10th 2012 a weekday')
self.assertTrue(wd.match(datetime(2012, 5, 11, 0, 0, tzinfo=UTC)),
'May 11th 2012 a weekday')
self.assertFalse(wd.match(datetime(2012, 5, 12, 0, 0, tzinfo=UTC)),
'May 12th 2012 not a weekday')
self.assertFalse(wd.match(datetime(2012, 5, 13, 0, 0, tzinfo=UTC)),
'May 13th 2012 not a weekday')
def test_events(self):
lon = timezone('Europe/London')
van = timezone('America/Vancouver') # GMT-8
syd = timezone('Australia/Sydney') # GMT+11 (DST)
qs = CrabSchedule('0 15 25 12 *', 'Europe/London')
ar = CrabSchedule('0 11 11 11 *', 'America/Vancouver')
gf = CrabSchedule('30 19 5 11 *', 'Europe/London')
# Check scheduling correct for different timezones.
self.assertTrue(qs.match(lon.localize(datetime(2012, 12, 25, 15, 0))),
'Queen on time in London')
self.assertTrue(qs.match(van.localize(datetime(2011, 12, 25, 7, 0))),
'Queen on time in Vancouver last year')
self.assertTrue(qs.match(syd.localize(datetime(2013, 12, 26, 2, 0))),
'Queen on time in Sydney next year')
self.assertTrue(qs.match(datetime(2020, 12, 25, 15, 0, tzinfo=UTC)),
'Queen on time in UTC')
self.assertTrue(ar.match(van.localize(datetime(2012, 11, 11, 11, 0))),
'Armistice correct time in Vancouver')
self.assertTrue(ar.match(lon.localize(datetime(2012, 11, 11, 19, 0))),
'Vancouver Armistice correct time in London')
self.assertTrue(ar.match(syd.localize(datetime(2012, 11, 12, 6, 0))),
'Vancouver Armistice correct time in Sydney')
# Check scheduling tests all date parts.
self.assertFalse(qs.match(datetime(2012, 12, 25, 14, 0, tzinfo=lon)),
'Queen not one hour early')
self.assertFalse(qs.match(datetime(2012, 12, 25, 15, 5, tzinfo=lon)),
'Queen not five minutes late')
self.assertFalse(qs.match(datetime(2012, 12, 26, 15, 0, tzinfo=lon)),
'Queen not on boxing day')
self.assertFalse(qs.match(datetime(2012, 11, 25, 15, 0, tzinfo=lon)),
'Queen not on in November')
# And an event which doesn't happen at minute zero.
self.assertTrue(gf.match(datetime(2012, 11, 5, 19, 30, 0, tzinfo=lon)),
'Fireworks on time')
self.assertTrue(gf.match(datetime(2012, 11, 5, 19, 30, 1, tzinfo=lon)),
'Fireworks might be one second late')
self.assertFalse(gf.match(datetime(2012, 11, 5, 19, 35, tzinfo=lon)),
'Fireworks not 5 minutes late')
def test_range(self):
fm = CrabSchedule('0-55/5 * * * *', 'UTC')
self.assertTrue(fm.match(datetime(2012, 7, 4, 10, 0, tzinfo=UTC)),
'Minute 0 % 5')
self.assertFalse(fm.match(datetime(2013, 8, 5, 14, 1, tzinfo=UTC)),
'Minute 1 not % 5')
self.assertFalse(fm.match(datetime(2014, 9, 7, 18, 4, tzinfo=UTC)),
'Minute 4 not % 5')
self.assertTrue(fm.match(datetime(2015, 1, 9, 20, 10, tzinfo=UTC)),
'Minute 10 % 5')
self.assertFalse(fm.match(datetime(2010, 2, 1, 11, 42, tzinfo=UTC)),
'Minute 42 not % 5')
self.assertTrue(fm.match(datetime(2011, 3, 2, 13, 45, tzinfo=UTC)),
'Minute 45 % 5')
self.assertTrue(fm.match(datetime(2012, 4, 3, 16, 55, tzinfo=UTC)),
'Minute 55 % 5')
self.assertFalse(fm.match(datetime(2012, 5, 4, 19, 59, tzinfo=UTC)),
'Minute 59 not % 5')
wd = CrabSchedule('0 0 * * 1-5', 'UTC')
self.assertTrue(wd.match(datetime(2012, 5, 7, 0, 0, tzinfo=UTC)),
'May 7th 2012 a weekday')
self.assertTrue(wd.match(datetime(2012, 5, 8, 0, 0, tzinfo=UTC)),
'May 8th 2012 a weekday')
self.assertTrue(wd.match(datetime(2012, 5, 9, 0, 0, tzinfo=UTC)),
'May 9th 2012 a weekday')
self.assertTrue(wd.match(datetime(2012, 5, 10, 0, 0, tzinfo=UTC)),
'May 10th 2012 a weekday')
self.assertTrue(wd.match(datetime(2012, 5, 11, 0, 0, tzinfo=UTC)),
'May 11th 2012 a weekday')
self.assertFalse(wd.match(datetime(2012, 5, 12, 0, 0, tzinfo=UTC)),
'May 12th 2012 not a weekday')
self.assertFalse(wd.match(datetime(2012, 5, 13, 0, 0, tzinfo=UTC)),
'May 13th 2012 not a weekday')