Prefer on_active_sec to on_startup_sec

Refs #4

Author: rsyring

src/sysdi/core.py

@@ -213,10 +213,16 @@ class TimedUnit:
     # instead of waiting for ExecStart to exit. Use oneshot as the default instead.
     service_type: str = 'oneshot'
 
-    # How long after system startup or user login to start the unit.
-    # TODO: should have a default here.  Maybe 15s?
+    # How long after systemd service startup should the timer activate?  For a user unit, this
+    # would be from systemd startup for the user.  But if linger is enabled, its essentially from
+    # system startup too.
+    # NOTE: unless you really want a timer that only starts after system start, prefer
+    # on_active_sec.
     on_startup_sec: str = None
 
+    # How long after the timer is started should the service unit activate?
+    on_active_sec: str = None
+
     # Uses the last activation time of this timer's UNIT (not the timer).  If a unit is activated
     # by another means (e.g. systemctl start ...), the timer's next run time will be affected.
     # The unit's runtime DOES NOT affect the timer's next run time unless it's still running.
@@ -280,7 +286,7 @@ def __post_init__(self):
             self.fixed_random_delay = True
 
         if self.start_delay:
-            self.on_startup_sec = self.start_delay
+            self.on_active_sec = self.start_delay
 
         if self.run_daily:
             assert not any((self.run_every, self.run_delay))
@@ -304,11 +310,12 @@ def __post_init__(self):
         if self.run_delay:
             self.on_unit_inactive_sec = self.run_delay
 
-        if (self.on_unit_active_sec or self.on_unit_inactive_sec) and not self.on_startup_sec:
+        if (self.on_unit_active_sec or self.on_unit_inactive_sec) and not self.on_active_sec:
             # A timer that depends on a unit's last run will never fire the first time on it's own.
-            # OnStartupSec is applied retroactively effectively causing the timer to start
-            # immediately upon it's creation.
-            self.on_startup_sec = '1'
+            # Configure the timer to kick off the unit immediately upon timer activation so the
+            # service unit runs once and then the other configurations will take care of how
+            # often it is ran.
+            self.on_active_sec = '1'
 
     @property
     def exec_start(self):
@@ -340,6 +347,7 @@ def timer(self):
         self.option(lines, 'AccuracySec')
         self.option(lines, 'OnCalendar')
         self.option(lines, 'Persistent')
+        self.option(lines, 'OnActiveSec')
         self.option(lines, 'OnStartupSec')
         self.option(lines, 'OnUnitActiveSec')
         self.option(lines, 'OnUnitInactiveSec')

src/sysdi_tests/systemd-units/aliases.timer

@@ -3,7 +3,7 @@ Description=Harvest Sync
 
 [Timer]
 AccuracySec=60s
-OnStartupSec=5s
+OnActiveSec=5s
 OnUnitActiveSec=5m
 OnUnitInactiveSec=30s
 

src/sysdi_tests/systemd-units/defaults.timer

@@ -3,7 +3,7 @@ Description=check defaults
 
 [Timer]
 AccuracySec=60s
-OnStartupSec=15m
+OnActiveSec=15m
 OnUnitActiveSec=2h
 RandomizedDelaySec=5m
 FixedRandomDelay=true

src/sysdi_tests/test_core.py

@@ -49,7 +49,7 @@ def test_defaults(self):
         tu = TimedUnit(
             'check defaults',
             'foo bar',
-            on_startup_sec='15m',
+            on_active_sec='15m',
             on_unit_active_sec='2h',
             randomized_delay_sec='5m',
         )
@@ -60,7 +60,7 @@ def test_defaults(self):
     def test_defaults_inherited(self):
         @dataclass
         class CustomTU(TimedUnit):
-            on_startup_sec: str = '15m'
+            on_active_sec: str = '15m'
             randomized_delay_sec: str = '5m'
 
         tu = CustomTU(
@@ -175,10 +175,10 @@ def test_extra_config(self):
 
     def test_startup_sec_default(self):
         tu = TimedUnit('foo', run_every='15m')
-        assert tu.on_startup_sec == '1'
+        assert tu.on_active_sec == '1'
 
         tu = TimedUnit('foo', run_delay='15m')
-        assert tu.on_startup_sec == '1'
+        assert tu.on_active_sec == '1'
 
 
 class TestManager: