command_watcher 0.4.1__tar.gz → 0.5.0__tar.gz

{command_watcher-0.4.1 → command_watcher-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: command_watcher
-Version: 0.4.1
+Version: 0.5.0
 Summary: Module to watch the execution of shell scripts. Both streams (`stdout` and `stderr`) are captured.
 Home-page: https://github.com/Josef-Friedrich/command-watcher
 License: MIT
@@ -15,8 +15,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Dist: conf2levels (>=0,<1)
-Requires-Dist: icinga2apic (>=0,<1)
-Requires-Dist: icinga2apic-stubs (>=0,<1)
+Requires-Dist: pretiac (>=0,<1)
 Requires-Dist: termcolor (>=1,<2)
 Requires-Dist: types-requests (>=2,<3)
 Requires-Dist: types-termcolor (>=1,<2)

{command_watcher-0.4.1 → command_watcher-0.5.0}/command_watcher/__init__.py

@@ -316,7 +316,7 @@ class Watch:
     """
 
     _hostname: str
-    """The hostname of machine the watcher running on."""
+    """The hostname of machine the watcher is running on."""
 
     _service_name: str
     """A name of the watched service."""
@@ -345,7 +345,7 @@ class Watch:
         raise_exceptions: bool = True,
         config_reader: Optional[ConfigReader] = None,
         report_channels: Optional[List[BaseChannel]] = None,
-    ):
+    ) -> None:
         self._hostname = HOSTNAME
 
         self._service_name = service_name
@@ -390,9 +390,6 @@ class Watch:
             try:
                 config_reader.check_section("icinga")
                 icinga_reporter = IcingaChannel(
-                    url=self._conf.icinga.url,
-                    user=self._conf.icinga.user,
-                    password=self._conf.icinga.password,
                     service_name=self._service_name,
                 )
                 reporter.add_channel(icinga_reporter)
@@ -415,12 +412,12 @@ class Watch:
         self._timer = Timer()
 
     @property
-    def stdout(self):
+    def stdout(self) -> str:
         """Alias / shortcut for `self._log_handler.stdout`."""
         return self._log_handler.stdout
 
     @property
-    def stderr(self):
+    def stderr(self) -> str:
         """Alias / shortcut for `self._log_handler.stderr`."""
         return self._log_handler.stderr
 

{command_watcher-0.4.1 → command_watcher-0.5.0}/command_watcher/email.py

@@ -12,7 +12,7 @@ def send_email(
     smtp_login: str,
     smtp_password: str,
     smtp_server: str,
-):
+) -> dict[str, tuple[int, bytes]]:
     """
     Send a email.
 
@@ -29,7 +29,7 @@ def send_email(
     """
     message = MIMEText(body, "plain", "utf-8")
 
-    message["Subject"] = Header(subject, "utf-8")
+    message["Subject"] = str(Header(subject, "utf-8"))
     message["From"] = from_addr
     message["To"] = to_addr
     message["Date"] = formatdate(localtime=True)

{command_watcher-0.4.1 → command_watcher-0.5.0}/command_watcher/log.py

@@ -136,11 +136,9 @@ class LoggingHandler(BufferingHandler):
 
 
 class ExtendedLogger(logging.Logger):
-    def stdout(self, line: object, *args: Any, **kws: Any) -> None:
-        ...
+    def stdout(self, line: object, *args: Any, **kws: Any) -> None: ...
 
-    def stderr(self, line: object, *args: Any, **kws: Any) -> None:
-        ...
+    def stderr(self, line: object, *args: Any, **kws: Any) -> None: ...
 
 
 def _log_stdout(self: ExtendedLogger, message: object, *args: Any, **kws: Any) -> None:

{command_watcher-0.4.1 → command_watcher-0.5.0}/command_watcher/report.py

@@ -7,9 +7,10 @@ import subprocess
 import textwrap
 from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, TypedDict, Union
 
+from pretiac import Client as PretiacClient
+from pretiac import get_default_client
 from typing_extensions import Unpack
 
-from . import icinga
 from .email import send_email
 
 if TYPE_CHECKING:
@@ -59,6 +60,9 @@ class MessageParams(MinimalMessageParams, total=False):
     service_name: str
     """The name of the service."""
 
+    service_display_name: str
+    """The human readable version of a service name."""
+
     log_records: str
     """Log records separated by new lines"""
 
@@ -73,10 +77,10 @@ class Message(BaseClass):
 
     _data: MessageParams
 
-    def __init__(self, **data: Unpack[MessageParams]):
+    def __init__(self, **data: Unpack[MessageParams]) -> None:
         self._data = data
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self._obj_to_str()
 
     @property
@@ -88,12 +92,23 @@ class Message(BaseClass):
     @property
     def status_text(self) -> str:
         """The status as a text word like `OK`."""
-        return icinga.States[self.status]
+        if self.status == 0:
+            return "OK"
+        elif self.status == 1:
+            return "WARNING"
+        elif self.status == 2:
+            return "CRITICAL"
+        else:
+            return "UNKNOWN"
 
     @property
     def service_name(self) -> str:
         return self._data.get("service_name", "service_not_set")
 
+    @property
+    def service_display_name(self) -> str | None:
+        return self._data.get("service_display_name", None)
+
     @property
     def performance_data(self) -> str:
         """
@@ -248,32 +263,32 @@ class EmailChannel(BaseChannel):
 
 
 class IcingaChannel(BaseChannel):
-    url: str
-    user: str
-    password: str
     service_name: str
 
-    def __init__(self, url: str, user: str, password: str, service_name: str) -> None:
-        self.url = url
-        self.user = user
-        self.password = password
+    client: PretiacClient
+
+    def __init__(
+        self,
+        service_name: str,
+    ) -> None:
         self.service_name = service_name
+        self.client = get_default_client()
 
     def __str__(self) -> str:
-        # No password!
-        return self._obj_to_str(["url", "user", "service_name"])
+        return "external configured icinga2 api client"
 
     def report(self, message: Message) -> None:
-        icinga.send_passive_check(
-            url=self.url,
-            user=self.user,
-            password=self.password,
-            status=message.status,
-            host_name=HOSTNAME,
-            service_name=message.service_name,
-            text_output=message.message,
-            performance_data=message.performance_data,
-        )
+        try:
+            self.client.send_service_check_result(
+                service=message.service_name,
+                host=HOSTNAME,
+                exit_status=message.status,
+                plugin_output=message.message,
+                performance_data=message.performance_data,
+                display_name=message.service_display_name,
+            )
+        except Exception:
+            print("sending to icinga failed")
 
 
 class BeepChannel(BaseChannel):

{command_watcher-0.4.1 → command_watcher-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "command_watcher"
-version = "0.4.1"
+version = "0.5.0"
 description = "Module to watch the execution of shell scripts. Both streams (`stdout` and `stderr`) are captured."
 authors = ["Josef Friedrich <josef@friedrich.rocks>"]
 license = "MIT"
@@ -18,11 +18,10 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.10"
 conf2levels = "^0"
-icinga2apic = "^0"
 termcolor = "^1"
 types-requests = "^2"
 types-termcolor = "^1"
-icinga2apic-stubs = "^0"
+pretiac = "^0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8"

command_watcher-0.4.1/command_watcher/icinga.py

@@ -1,42 +0,0 @@
-from typing import Literal, Optional
-
-import urllib3
-from icinga2apic.client import Client
-
-urllib3.disable_warnings()  # type: ignore
-
-
-STATE_OK = 0
-STATE_WARNING = 1
-STATE_CRITICAL = 2
-STATE_UNKNOWN = 3
-
-States = {
-    STATE_OK: "OK",
-    STATE_WARNING: "WARNING",
-    STATE_CRITICAL: "CRITICAL",
-    STATE_UNKNOWN: "UNKNOWN",
-}
-
-
-def send_passive_check(
-    url: str,
-    user: str,
-    password: str,
-    status: Literal[0, 1, 2, 3],
-    host_name: str,
-    service_name: str,
-    text_output: str,
-    performance_data: Optional[str] = None,
-):
-    """
-    https://icinga.com/docs/icinga-2/latest/doc/12-icinga2-api/#process-check-result
-    """
-    client = Client(url=url, username=user, password=password)
-    return client.actions.process_check_result(
-        object_type="Service",
-        name="{}!{}".format(host_name, service_name),
-        exit_status=status,
-        plugin_output=text_output,
-        performance_data=performance_data,
-    )