bedger 0.0.1__py3-none-any.whl

bedger/edge/config.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class Config:
+    socket_path: str = "/tmp/bedger.sock"
+
+    max_payload_size: int = 1024 * 1024  # 1 MB

bedger/edge/connection.py

@@ -0,0 +1,123 @@
+from __future__ import annotations
+
+import logging
+import socket
+from typing import Optional
+
+from bedger.edge import errors
+from bedger.edge.config import Config
+from bedger.edge.entities import Message, Severity
+
+logger = logging.getLogger("bedger.edge.connection")
+
+
+class ConnectionManager:
+    """Manages a connection to a UNIX socket for sending and receiving messages.
+
+    This class provides context manager support for establishing and tearing
+    down a connection to a UNIX socket.
+
+    Attributes:
+        _config (Config): The configuration containing the socket path.
+        _socket (Optional[socket.socket]): The current socket connection.
+    """
+
+    def __init__(self, config: Config = Config()):
+        """Initializes the ConnectionManager.
+
+        Args:
+            config (Config): Configuration for the connection. Defaults to a new `Config` instance.
+        """
+        self._config = config
+        self._socket: Optional[socket.socket] = None
+
+    def __enter__(self) -> ConnectionManager:
+        """Establishes the socket connection when entering the context.
+
+        Returns:
+            ConnectionManager: The instance of the ConnectionManager.
+        """
+        self._connect()
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback) -> None:
+        """Closes the socket connection when exiting the context."""
+        self._disconnect()
+
+    def _connect(self) -> None:
+        """Establish a connection to the UNIX socket.
+
+        Raises:
+            errors.SocketPermissionDeniedError: If the application does not have permission to connect to the socket.
+            errors.SocketFileNotFoundError: If the socket file is not found at the specified path.
+            errors.SocketConnectionError: If any other error occurs during the connection attempt.
+        """
+        logger.info(f"Attempting to connect to socket at {self._config.socket_path}")
+        try:
+            self._socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+            self._socket.connect(self._config.socket_path)
+            logger.info("Successfully connected to the socket")
+        except PermissionError:
+            logger.error("Permission denied: Unable to connect to the socket. Ensure you have the correct permissions.")
+            raise errors.SocketPermissionDeniedError("Permission denied to connect to socket. Are you running as root?")
+        except FileNotFoundError:
+            logger.error("Socket file not found. Verify the server is running and the socket path is correct.")
+            raise errors.SocketFileNotFoundError("Socket file not found. Is the server running?")
+        except Exception as e:
+            logger.exception(f"Unexpected error while connecting to the socket: {e}")
+            raise errors.SocketConnectionError(f"An unexpected error occurred while connecting to the socket: {e}")
+
+    def _disconnect(self) -> None:
+        """Close the socket connection gracefully.
+
+        Ensures the socket is closed and cleaned up properly, even in case of errors.
+        """
+        if self._socket:
+            try:
+                logger.info("Closing the socket connection")
+                self._socket.close()
+            except Exception as e:
+                logger.warning(f"Error occurred while closing the socket: {e}")
+            finally:
+                self._socket = None
+
+    def send_event(self, event_type: str, severity: str | Severity, payload: dict) -> None:
+        """Send an event message through the socket.
+
+        Args:
+            event_type (str): The type of event being sent.
+            severity (str | Severity): The severity level of the event.
+            payload (dict): The event's payload details.
+
+        Raises:
+            errors.SocketNotConnectedError: If no active socket connection exists.
+            errors.SocketBrokenPipeError: If the socket connection is lost during message transmission.
+            errors.SocketCommunicationError: If any error occurs during socket communication.
+        """
+        if not self._socket:
+            logger.error("Attempted to send a message without an active socket connection.")
+            raise errors.SocketNotConnectedError("No active socket connection. Ensure the connection is established.")
+
+        try:
+            message = Message(
+                event_type=event_type,
+                severity=severity,
+                details=payload,
+            )
+            message_json = message.model_dump_json()
+            logger.debug(f"Prepared message: {message_json}")
+
+            logger.debug("Sending message")
+            self._socket.sendall(message_json.encode())
+
+            ack = self._socket.recv(1024)
+            logger.info(f"Received acknowledgment from server: {ack.decode()}")
+        except BrokenPipeError:
+            logger.error("Broken pipe error: The socket connection was lost during message transmission.")
+            raise errors.SocketBrokenPipeError("Socket connection lost. Unable to send message.")
+        except socket.error as e:
+            logger.error(f"Socket error occurred: {e}")
+            raise errors.SocketCommunicationError(f"Socket error during communication: {e}")
+        except Exception as e:
+            logger.exception(f"Unexpected error while sending the message: {e}")
+            raise errors.SocketCommunicationError(f"Unexpected error occurred: {e}")

bedger/edge/entities/__init__.py

@@ -0,0 +1,4 @@
+from .message import Message
+from .severity import Severity
+
+__all__ = [Message, Severity]

bedger/edge/entities/message.py

@@ -0,0 +1,32 @@
+import json
+from typing import Dict
+
+from pydantic import BaseModel, Field, field_serializer, field_validator
+from typing_extensions import Annotated
+
+from .severity import Severity
+
+
+class Message(BaseModel):
+    event_type: Annotated[
+        str,
+        Field(
+            description="Event type in PascalCase format",
+            pattern=r"^[A-Z][a-zA-Z0-9]*$",
+        ),
+    ]
+    severity: Severity
+    details: Annotated[Dict, Field(description="Details of the message as a JSON serializable dictionary")]
+
+    @field_validator("details")
+    @classmethod
+    def validate_details(cls, value: Dict) -> Dict:
+        try:
+            json.dumps(value)
+        except TypeError:
+            raise ValueError("details must be a JSON serializable dictionary")
+        return value
+
+    @field_serializer("severity")
+    def serialize_severity(self, severity: Severity) -> str:
+        return severity.value

bedger/edge/entities/severity.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class Severity(str, Enum):
+    UNKNOWN = "UNKNOWN"
+    LOW = "LOW"
+    MEDIUM = "MEDIUM"
+    HIGH = "HIGH"
+    CRITICAL = "CRITICAL"

bedger/edge/errors.py

@@ -0,0 +1,18 @@
+class SocketPermissionDeniedError(Exception):
+    pass
+
+
+class SocketFileNotFoundError(Exception):
+    pass
+
+
+class SocketConnectionError(Exception):
+    pass
+
+
+class SocketNotConnectedError(Exception):
+    pass
+
+
+class SocketCommunicationError(Exception):
+    pass

bedger-0.0.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Henk van den Brink
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bedger-0.0.1.dist-info/METADATA

@@ -0,0 +1,17 @@
+Metadata-Version: 2.1
+Name: bedger
+Version: 0.0.1
+Summary: 
+Author: Henk van den Brink
+Requires-Python: >=3.8.1,<4.0.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pydantic (>=2.9.2,<3.0.0)
+Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
+Description-Content-Type: text/markdown
+
+

bedger-0.0.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+bedger/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bedger/edge/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bedger/edge/config.py,sha256=0fUKThP0aJFk3WBF7JUtuKKhXlV07SX5VnqVOLNou-A,152
+bedger/edge/connection.py,sha256=25h7PzRhSw8m0w679p23M6X_o-wuIOl7M1P837bpy9I,5400
+bedger/edge/entities/__init__.py,sha256=_oKO_XdDerqOwVX8izhDPtGv4HqVDwQaT-otOdY8lYg,91
+bedger/edge/entities/message.py,sha256=wLbEZik_FBboyEAvX5Uvlto1t4BsjaeLXUFGOIjIHRU,913
+bedger/edge/entities/severity.py,sha256=tUN7eDSEN5cc5eAqhvKzVHD1pSEmrdwvNEGsmh4Pnfw,157
+bedger/edge/errors.py,sha256=6jdmhlKoWlD-kZ8-xRiAlObRHEo9PwrKqhWQ5su5TLk,266
+bedger-0.0.1.dist-info/LICENSE,sha256=lVrf6pfElYZ_o6ETq-XR91_7GHTzKGyeNWAKghvcNUE,1075
+bedger-0.0.1.dist-info/METADATA,sha256=ccz115dKsGRG2FYE5-SeFGqnhhmu2EvlUOYMUnbGYVY,555
+bedger-0.0.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+bedger-0.0.1.dist-info/RECORD,,

bedger-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.1
+Root-Is-Purelib: true
+Tag: py3-none-any