sched: Rewrite crontest.py. Add simulate.py. Docs to follow.

Author: peterhinch

v3/as_drivers/sched/cron.py

@@ -1,6 +1,6 @@
 # cron.py
 
-# Copyright (c) 2020 Peter Hinch
+# Copyright (c) 2020-2023 Peter Hinch
 # Released under the MIT License (MIT) - see LICENSE file
 
 from time import mktime, localtime
@@ -93,7 +93,7 @@ def inner(tnow):
                 md += toff % 7  # mktime handles md > 31 but month may increment
                 tev = mktime((yr, mo, md, h, m, s, wd, 0))
                 cur_mo = mo
-                _, mo = localtime(tev)[:2]  # get month
+                mo = localtime(tev)[1]  # get month
                 if mo != cur_mo:
                     toff = do_arg(month, mo)  # Get next valid month
                     mo += toff  # Offset is relative to new, incremented month

v3/as_drivers/sched/crontest.py

@@ -1,72 +1,106 @@
-# crontest.py
+# crontest.py Now works under Unix build
 
-# Copyright (c) 2020 Peter Hinch
+# Copyright (c) 2020-2023 Peter Hinch
 # Released under the MIT License (MIT) - see LICENSE file
 
-from time import time, ticks_diff, ticks_us, localtime
+from time import time, ticks_diff, ticks_us, localtime, mktime
 from sched.cron import cron
 import sys
 
 maxruntime = 0
 fail = 0
-def result(t, msg):
-    global fail
-    if t != next(iexp):
-        print('FAIL', msg, t)
-        fail += 1
-        return
-    print('PASS', msg, t)
 
-def test(*, secs=0, mins=0, hrs=3, mday=None, month=None, wday=None, tsource=None):
-    global maxruntime
-    ts = int(time() if tsource is None else tsource)  # int() for Unix build
+# Args:
+# ts Time of run in secs since epoch
+# exp Expected absolute end time (yr, mo, md, h, m, s)
+# msg Message describing test
+# kwargs are args for cron
+def test(ts, exp, msg, *, secs=0, mins=0, hrs=3, mday=None, month=None, wday=None):
+    global maxruntime, fail
+    texp = mktime(exp + (0, 0))  # Expected absolute end time
+    yr, mo, md, h, m, s, wd = localtime(texp)[:7]
+    print(f"Test: {msg}")
+    print(f"Expected endtime:  {h:02d}:{m:02d}:{s:02d} on {md:02d}/{mo:02d}/{yr:02d}")
+
     cg = cron(secs=secs, mins=mins, hrs=hrs, mday=mday, month=month, wday=wday)
     start = ticks_us()
-    t = cg(ts)  # Time relative to ts
+    t = cg(ts)  # Wait duration returned by cron (secs)
     delta = ticks_diff(ticks_us(), start)
     maxruntime = max(maxruntime, delta)
-    print('Runtime = {}μs'.format(delta))
-    tev = t + ts  # Absolute time of 1st event
-    yr, mo, md, h, m, s, wd = localtime(tev)[:7]
-    print('{:02d}:{:02d}:{:02d} on {:02d}/{:02d}/{:02d}'.format(h, m, s, md, mo, yr))
-    return t  # Relative time
-
-now = 1596074400 if sys.platform == 'linux' else 649393200  # 3am Thursday (day 3) 30 July 2020
-iexp = iter([79500, 79500, 86700, 10680, 13564800, 17712000,
-             12781800, 11217915, 5443200, 21600, 17193600,
-             18403200, 5353140, 13392000, 18662400])
-# Expect 01:05:00 on 31/07/2020
-result(test(wday=4, hrs=(1,2), mins=5, tsource=now), 'wday and time both cause 1 day increment.')
-# 01:05:00 on 31/07/2020
-result(test(hrs=(1,2), mins=5, tsource=now), 'time causes 1 day increment.')
-# 03:05:00 on 31/07/2020
-result(test(wday=4, mins=5, tsource=now), 'wday causes 1 day increment.')
-# 05:58:00 on 30/07/2020
-result(test(hrs=(5, 23), mins=58, tsource=now), 'time increment no day change.')
-# 03:00:00 on 03/01/2021
-result(test(month=1, wday=6, tsource=now), 'month and year rollover, 1st Sunday')
-# 03:00:00 on 20/02/2021
-result(test(month=2, mday=20, tsource=now), 'month and year rollover, mday->20 Feb')
-# 01:30:00 on 25/12/2020
-result(test(month=12, mday=25, hrs=1, mins=30, tsource=now), 'Forward to Christmas day, hrs backwards')
-# 23:05:15 on 06/12/2020
-result(test(month=12, wday=6, hrs=23, mins=5, secs=15, tsource=now), '1st Sunday in Dec 2020')
-# 03:00:00 on 01/10/2020
-result(test(month=10, tsource=now), 'Current time on 1st Oct 2020')
-# 09:00:00 on 30/07/2020
-result(test(month=7, hrs=9, tsource=now), 'Explicitly specify current month')
-# 03:00:00 on 14/02/2021
-result(test(month=2, mday=8, wday=6, tsource=now), 'Second Sunday in February 2021')
-# 03:00:00 on 28/02/2021
-result(test(month=2, mday=22, wday=6, tsource=now), 'Fourth Sunday in February 2021')  # last day of month
-# 01:59:00 on 01/10/2020
-result(test(month=(7, 10), hrs=1, mins=59, tsource=now + 24*3600), 'Time causes month rollover to next legal month')
-# 03:00:00 on 01/01/2021
-result(test(month=(7, 1), mday=1, tsource=now), 'mday causes month rollover to next year')
-# 03:00:00 on 03/03/2021
-result(test(month=(7, 3), wday=(2, 6), tsource=now), 'wday causes month rollover to next year')
-print('Max runtime {}μs'.format(maxruntime))
+    yr, mo, md, h, m, s, wd = localtime(t + ts)[:7]  # Get absolute time from cron
+    print(f"Endtime from cron: {h:02d}:{m:02d}:{s:02d} on {md:02d}/{mo:02d}/{yr:02d}")
+    if t == texp - ts:
+        print(f"PASS")
+    else:
+        print(f"FAIL [{t}]")
+        fail += 1
+    print(f"Runtime = {delta}us\n")
+
+
+now = mktime((2020, 7, 30, 3, 0, 0, 0, 0))  # 3am Thursday (day 3) 30 July 2020
+
+exp = (2020, 7, 31, 1, 5, 0)  # Expect 01:05:00 on 31/07/2020
+msg = "wday and time both cause 1 day increment."
+test(now, exp, msg, wday=4, hrs=(1, 2), mins=5)
+
+exp = (2020, 7, 31, 1, 5, 0)  # 01:05:00 on 31/07/2020
+msg = "time causes 1 day increment."
+test(now, exp, msg, hrs=(1, 2), mins=5)
+
+exp = (2020, 7, 31, 3, 5, 0)  # 03:05:00 on 31/07/2020
+msg = "wday causes 1 day increment."
+test(now, exp, msg, wday=4, mins=5)
+
+exp = (2020, 7, 30, 5, 58, 0)  # 05:58:00 on 30/07/2020
+msg = "time increment no day change."
+test(now, exp, msg, hrs=(5, 23), mins=58)
+
+exp = (2021, 1, 3, 3, 0, 0)  # 03:00:00 on 03/01/2021
+msg = "month and year rollover, 1st Sunday"
+test(now, exp, msg, month=1, wday=6)
+
+exp = (2021, 2, 20, 3, 0, 0)  # 03:00:00 on 20/02/2021
+msg = "month and year rollover, mday->20 Feb"
+test(now, exp, msg, month=2, mday=20)
+
+exp = (2020, 12, 25, 1, 30, 0)  # 01:30:00 on 25/12/2020
+msg = "Forward to Xmas day, hrs backwards"
+test(now, exp, msg, month=12, mday=25, hrs=1, mins=30)
+
+exp = (2020, 12, 6, 23, 5, 15)  # 23:05:15 on 06/12/2020
+msg = "1st Sunday in Dec 2020"
+test(now, exp, msg, month=12, wday=6, hrs=23, mins=5, secs=15)
+
+exp = (2020, 10, 1, 3, 0, 0)  # 03:00:00 on 01/10/2020
+msg = "Current time on 1st Oct 2020"
+test(now, exp, msg, month=10)
+
+exp = (2020, 7, 30, 9, 0, 0)  # 09:00:00 on 30/07/2020
+msg = "Explicitly specify current month"
+test(now, exp, msg, month=7, hrs=9)
+
+exp = (2021, 2, 14, 3, 0, 0)  # 03:00:00 on 14/02/2021
+msg = "Second Sunday in February 2021"
+test(now, exp, msg, month=2, mday=8, wday=6)
+
+exp = (2021, 2, 28, 3, 0, 0)  # 03:00:00 on 28/02/2021
+msg = "Fourth Sunday in February 2021"
+test(now, exp, msg, month=2, mday=22, wday=6)  # month end
+
+exp = (2020, 10, 1, 1, 59, 0)  # 01:59:00 on 01/10/2020
+msg = "Time causes month rollover to next legal month"
+test(now + 24 * 3600, exp, msg, month=(7, 10), hrs=1, mins=59)
+
+exp = (2021, 1, 1, 3, 0, 0)  # 03:00:00 on 01/01/2021
+msg = "mday causes month rollover to next year"
+test(now, exp, msg, month=(7, 1), mday=1)
+
+exp = (2021, 3, 3, 3, 0, 0)  # 03:00:00 on 03/03/2021
+msg = "wday causes month rollover to next year"
+test(now, exp, msg, month=(7, 3), wday=(2, 6))
+
+print(f"Max runtime {maxruntime}us")
 if fail:
-    print(fail, 'FAILURES OCCURRED')
+    print(fail, "FAILURES OCCURRED")
 else:
-    print('ALL TESTS PASSED')
+    print("ALL TESTS PASSED")

v3/as_drivers/sched/simulate.py

@@ -0,0 +1,40 @@
+# simulate.py Adapt this to simulate scheduled sequences
+
+from time import localtime, mktime
+from sched.cron import cron
+
+days = ("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday")
+tim = 0  # Global time in secs
+
+def print_time(msg=""):
+    yr, mo, md, h, m, s, wd = localtime(tim)[:7]
+    print(f"{msg} {h:02d}:{m:02d}:{s:02d} on {days[wd]} {md:02d}/{mo:02d}/{yr:02d}")
+
+def wait(cr):  # Simulate waiting on a cron instance
+    global tim
+    tim += 2  # Must always wait >=2s before calling cron again
+    dt = cr(tim)
+    hrs, m_s = divmod(dt + 2, 3600)  # For neat display add back the 2 secs
+    mins, secs = divmod(m_s, 60)
+    print(f"Wait {hrs}hrs {mins}mins {secs}s")
+    tim += dt
+    print_time("Time now:")
+
+def set_time(y, month, mday, hrs, mins, secs):
+    global tim
+    tim = mktime((y, month, mday, hrs, mins, secs, 0, 0))
+    print_time("Start at:")
+
+# Adapt the following to emulate the proposed application. Cron args
+# secs=0, mins=0, hrs=3, mday=None, month=None, wday=None
+
+def sim(*args):
+    set_time(*args)
+    cs = cron(hrs = 0, mins = 59)
+    wait(cs)
+    cn = cron(wday=(0, 5), hrs=(1, 10), mins = range(0, 60, 15))
+    for _ in range(10):
+        wait(cn)
+        print("Run payload.\n")
+
+sim(2023, 3, 29, 15, 20, 0)  # Start time: year, month, mday, hrs, mins, secs