python3-cyberfusion-systemd-support 2.3.1__tar.gz → 2.5.0__tar.gz

{python3_cyberfusion_systemd_support-2.3.1 → python3_cyberfusion_systemd_support-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python3-cyberfusion-systemd-support
-Version: 2.3.1
+Version: 2.5.0
 Summary: Library for systemd.
 Author-email: Cyberfusion <support@cyberfusion.io>
 Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-systemd-support
@@ -52,6 +52,15 @@ print(unit.is_enabled)
 print(unit.is_failed)
 ```
 
+## Transient units
+
+```python
+from cyberfusion.SystemdSupport.units import TransientUnit
+
+transient_unit = TransientUnit.run(name="cf-apt-upgrade", command=["apt-get", "upgrade", "-y"])
+transient_unit.clean_up()
+```
+
 ## Tmp files
 
 ```python

{python3_cyberfusion_systemd_support-2.3.1 → python3_cyberfusion_systemd_support-2.5.0}/README.md

@@ -43,6 +43,15 @@ print(unit.is_enabled)
 print(unit.is_failed)
 ```
 
+## Transient units
+
+```python
+from cyberfusion.SystemdSupport.units import TransientUnit
+
+transient_unit = TransientUnit.run(name="cf-apt-upgrade", command=["apt-get", "upgrade", "-y"])
+transient_unit.clean_up()
+```
+
 ## Tmp files
 
 ```python

{python3_cyberfusion_systemd_support-2.3.1 → python3_cyberfusion_systemd_support-2.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python3-cyberfusion-systemd-support"
-version = "2.3.1"
+version = "2.5.0"
 description = "Library for systemd."
 readme = "README.md"
 authors = [

python3_cyberfusion_systemd_support-2.5.0/src/cyberfusion/SystemdSupport/enums.py

@@ -0,0 +1,69 @@
+"""Unit state enums.
+
+See: https://www.freedesktop.org/software/systemd/man/latest/systemctl.html#is-active%20PATTERN%E2%80%A6
+"""
+
+from enum import StrEnum
+
+
+class ActiveState(StrEnum):
+    """Possible values of a unit's ActiveState property."""
+
+    ACTIVE = "active"
+    RELOADING = "reloading"
+    INACTIVE = "inactive"
+    FAILED = "failed"
+    ACTIVATING = "activating"
+    DEACTIVATING = "deactivating"
+    MAINTENANCE = "maintenance"
+
+
+class SubState(StrEnum):
+    """Possible values of a unit's SubState property.
+
+    Union of sub-states across all unit types (service, socket, mount, device,
+    target, automount, timer, path, slice, scope).
+    """
+
+    ABANDONED = "abandoned"
+    ACTIVE = "active"
+    AUTO_RESTART = "auto-restart"
+    CLEANING = "cleaning"
+    CONDITION = "condition"
+    DEAD = "dead"
+    ELAPSED = "elapsed"
+    EXITED = "exited"
+    FAILED = "failed"
+    FINAL_SIGKILL = "final-sigkill"
+    FINAL_SIGTERM = "final-sigterm"
+    FINAL_WATCHDOG = "final-watchdog"
+    LISTENING = "listening"
+    MOUNTED = "mounted"
+    MOUNTING = "mounting"
+    MOUNTING_DONE = "mounting-done"
+    PLUGGED = "plugged"
+    REFRESH_EXTENSIONS = "refresh-extensions"
+    RELOAD = "reload"
+    RELOAD_NOTIFY = "reload-notify"
+    RELOAD_SIGNAL = "reload-signal"
+    REMOUNTING = "remounting"
+    REMOUNTING_SIGKILL = "remounting-sigkill"
+    REMOUNTING_SIGTERM = "remounting-sigterm"
+    RUNNING = "running"
+    START = "start"
+    START_CHOWN = "start-chown"
+    START_POST = "start-post"
+    START_PRE = "start-pre"
+    STOP = "stop"
+    STOP_POST = "stop-post"
+    STOP_PRE = "stop-pre"
+    STOP_PRE_SIGKILL = "stop-pre-sigkill"
+    STOP_PRE_SIGTERM = "stop-pre-sigterm"
+    STOP_SIGKILL = "stop-sigkill"
+    STOP_SIGTERM = "stop-sigterm"
+    STOP_WATCHDOG = "stop-watchdog"
+    TENTATIVE = "tentative"
+    UNMOUNTING = "unmounting"
+    UNMOUNTING_SIGKILL = "unmounting-sigkill"
+    UNMOUNTING_SIGTERM = "unmounting-sigterm"
+    WAITING = "waiting"

python3_cyberfusion_systemd_support-2.5.0/src/cyberfusion/SystemdSupport/exceptions.py

@@ -0,0 +1,25 @@
+"""Exceptions."""
+
+from typing import Optional
+
+
+class UnexpectedSubStateError(Exception):
+    """Unit is in a SubState we don't know how to handle."""
+
+    def __init__(self, unit_name: str, sub_state: Optional[str]) -> None:
+        """Set attributes."""
+        self.unit_name = unit_name
+        self.sub_state = sub_state
+
+        super().__init__(f"Unit {unit_name} has unexpected SubState: {sub_state}")
+
+
+class UnexpectedActiveStateError(Exception):
+    """Unit is in an ActiveState we don't know how to handle."""
+
+    def __init__(self, unit_name: str, active_state: Optional[str]) -> None:
+        """Set attributes."""
+        self.unit_name = unit_name
+        self.active_state = active_state
+
+        super().__init__(f"Unit {unit_name} has unexpected ActiveState: {active_state}")

{python3_cyberfusion_systemd_support-2.3.1 → python3_cyberfusion_systemd_support-2.5.0}/src/cyberfusion/SystemdSupport/units.py

@@ -1,19 +1,27 @@
 """Classes for systemd units."""
 
 import glob
+import json
 import os
 import subprocess
 from functools import wraps
-from typing import Callable, Optional, TypeVar, cast
+from typing import Callable, List, Optional, TypeVar, cast
 
 from cyberfusion.SystemdSupport._constants import SYSTEMCTL_BIN
+from cyberfusion.SystemdSupport.exceptions import (
+    UnexpectedActiveStateError,
+    UnexpectedSubStateError,
+)
 from cyberfusion.SystemdSupport.manager import SystemdManager
+from cyberfusion.SystemdSupport.enums import ActiveState, SubState
 
 F = TypeVar("F", bound=Callable[..., None])
 
 
 BASE_DIRECTORY_SYSTEMD_UNITS = os.path.join(os.path.sep, "etc", "systemd", "system")
 
+SYSTEMD_RUN_BIN = os.path.join(os.path.sep, "bin", "systemd-run")
+
 
 def reload_manager(f: F) -> F:
     """Reload manager configuration if needed.."""
@@ -160,7 +168,12 @@ class Unit:
     @staticmethod
     def get_drop_in_directory(unit_name: str) -> str:
         """Get unit override directory."""
-        return os.path.join(BASE_DIRECTORY_SYSTEMD_UNITS, unit_name + ".d")
+        return Unit.get_unit_file(unit_name) + ".d"
+
+    @staticmethod
+    def get_unit_file(unit_name: str) -> str:
+        """Get unit file."""
+        return os.path.join(BASE_DIRECTORY_SYSTEMD_UNITS, unit_name)
 
     @staticmethod
     def remove_unit_type(unit_name: str) -> str:
@@ -177,3 +190,50 @@ class Unit:
         E.g.: `firewall` -> `firewall.service`
         """
         return unit_name + "." + unit_type
+
+
+class TransientUnit:
+    """Represents transient unit created via systemd-run."""
+
+    def __init__(self, unit: Unit) -> None:
+        """Set attributes."""
+        self.unit = unit
+
+    @classmethod
+    def run(cls, name: str, command: List[str]) -> "TransientUnit":
+        """Start transient unit and return an instance wrapping the created unit."""
+        output = subprocess.run(
+            [
+                SYSTEMD_RUN_BIN,
+                "--json=short",
+                f"--unit={name}",
+                "--remain-after-exit",
+                *command,
+            ],
+            check=True,
+            stdout=subprocess.PIPE,
+            text=True,
+        ).stdout
+
+        return cls(Unit(json.loads(output)["unit"]))
+
+    def clean_up(self) -> None:
+        """Stop unit if active, or reset it if failed."""
+        sub_state = self.unit.get_property("SubState")
+
+        # A finished --remain-after-exit unit is either `exited` (success) or
+        # `failed`. Any other value means the unit is still `running`, or in
+        # some other state we don't handle — bail out so it can be debugged
+        # manually rather than silently tearing it down.
+
+        if sub_state not in (SubState.EXITED, SubState.FAILED):
+            raise UnexpectedSubStateError(self.unit.name, sub_state)
+
+        active_state = self.unit.get_property("ActiveState")
+
+        if active_state == ActiveState.ACTIVE:
+            subprocess.run([SYSTEMCTL_BIN, "stop", self.unit.name], check=True)
+        elif active_state == ActiveState.FAILED:
+            subprocess.run([SYSTEMCTL_BIN, "reset-failed", self.unit.name], check=True)
+        else:
+            raise UnexpectedActiveStateError(self.unit.name, active_state)

{python3_cyberfusion_systemd_support-2.3.1 → python3_cyberfusion_systemd_support-2.5.0}/src/python3_cyberfusion_systemd_support.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python3-cyberfusion-systemd-support
-Version: 2.3.1
+Version: 2.5.0
 Summary: Library for systemd.
 Author-email: Cyberfusion <support@cyberfusion.io>
 Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-systemd-support
@@ -52,6 +52,15 @@ print(unit.is_enabled)
 print(unit.is_failed)
 ```
 
+## Transient units
+
+```python
+from cyberfusion.SystemdSupport.units import TransientUnit
+
+transient_unit = TransientUnit.run(name="cf-apt-upgrade", command=["apt-get", "upgrade", "-y"])
+transient_unit.clean_up()
+```
+
 ## Tmp files
 
 ```python

{python3_cyberfusion_systemd_support-2.3.1 → python3_cyberfusion_systemd_support-2.5.0}/src/python3_cyberfusion_systemd_support.egg-info/SOURCES.txt

@@ -3,6 +3,8 @@ pyproject.toml
 setup.cfg
 src/cyberfusion/SystemdSupport/__init__.py
 src/cyberfusion/SystemdSupport/_constants.py
+src/cyberfusion/SystemdSupport/enums.py
+src/cyberfusion/SystemdSupport/exceptions.py
 src/cyberfusion/SystemdSupport/manager.py
 src/cyberfusion/SystemdSupport/tmp_files.py
 src/cyberfusion/SystemdSupport/units.py