Limit required deps and tox tests (#20)

Salaah01 · web-flow · commit b6567cadea4f · 2024-08-22T22:40:54.000+01:00
* fixed broken tests, got 1 set of tox tests working

* can test mysql

* kafka tests

* bunch of test permutations

* formatting

* removed unused code, added documentation

* formatting and removing commented code

---------

Co-authored-by: Salaah Amin &lt;salaah01@users.noreply.github.com&gt;
diff --git a/action_triggers/message_broker/exceptions.py b/action_triggers/message_broker/exceptions.py
@@ -1,24 +1,6 @@
 import json
 
 
-class MissingDependenciesError(ImportError):
-    """Exception raised when required dependencies are missing.
-
-    :param broker_name: The name of the broker that requires the extra.
-    :param extra_name: The name of the extra installable that is missing.
-    :param package_name: The name of the package that is missing.
-    """
-
-    def __init__(self, broker_name: str, extra_name: str, package_name: str):
-        super().__init__(
-            f"The `{extra_name}` extra must be installed to use the "
-            f"{broker_name} broker. Please install the `{extra_name}` extra "
-            f"by running `pip install action-triggers[{extra_name}]`. "
-            f"Alternatively, you can install the required packages by running "
-            f"`pip install {package_name}`."
-        )
-
-
 class ConnectionValidationError(RuntimeError):
     """Exception raised when connection parameters are invalid."""
 
diff --git a/action_triggers/message_broker/kafka.py b/action_triggers/message_broker/kafka.py
@@ -2,12 +2,12 @@
 
 from action_triggers.message_broker.base import BrokerBase, ConnectionBase
 from action_triggers.message_broker.enums import BrokerType
-from action_triggers.message_broker.exceptions import MissingDependenciesError
+from action_triggers.utils.module_import import MissingImportWrapper
 
 try:
     from confluent_kafka import Producer  # type: ignore[import-untyped]
 except ImportError:  # pragma: no cover
-    raise MissingDependenciesError("Kafka", "kafka", "confluent-kafka")
+    kafka = MissingImportWrapper("kafka")
 
 
 class KafkaConnection(ConnectionBase):
diff --git a/action_triggers/message_broker/rabbitmq.py b/action_triggers/message_broker/rabbitmq.py
@@ -2,12 +2,12 @@
 
 from action_triggers.message_broker.base import BrokerBase, ConnectionBase
 from action_triggers.message_broker.enums import BrokerType
-from action_triggers.message_broker.exceptions import MissingDependenciesError
+from action_triggers.utils.module_import import MissingImportWrapper
 
 try:
     import pika  # type: ignore[import-untyped]
 except ImportError:  # pragma: no cover
-    raise MissingDependenciesError("RabbitMQ", "rabbitmq", "pika")
+    pika = MissingImportWrapper("pika")
 
 
 class RabbitMQConnection(ConnectionBase):
diff --git a/action_triggers/utils/__init__.py b/action_triggers/utils/__init__.py
diff --git a/action_triggers/utils/module_import.py b/action_triggers/utils/module_import.py
@@ -0,0 +1,21 @@
+"""Utility functions for managing imports."""
+
+import importlib
+
+
+class MissingImportWrapper:
+    """A wrapper to indicate that an import is missing the next time it is
+    accessed. Judging from the code, that is not at all the case. However, this
+    is primary used whenever a module is not found, but we do not want to raise
+    an exception immediately. Instead, we want to raise an exception when the
+    module is accessed.
+    """
+
+    def __init__(
+        self,
+        import_path: str,
+    ):
+        self.import_path = import_path
+
+    def __getattr__(self, item):
+        importlib.import_module(self.import_path)[item]
diff --git a/docker-compose.tox.yml b/docker-compose.tox.yml
@@ -0,0 +1,74 @@
+# A dedicated docker-comopose file for bringing up all the services for tox
+# to test against.
+
+version: '3.8'
+
+services:
+  postgres:
+    image: postgres:14.13-alpine3.20
+    environment:
+      POSTGRES_DB: action_triggers
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+    ports:
+      - "5440:5432"
+    healthcheck:
+      test: [ "CMD-SHELL", "pg_isready -U postgres" ]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  mysql:
+    image: mysql:oraclelinux9
+    environment:
+      MYSQL_ROOT_PASSWORD: root
+      MYSQL_DATABASE: action_triggers
+      MYSQL_PASSWORD: root
+    ports:
+      - "3307:3306"
+    healthcheck:
+      test: [ "CMD-SHELL", "mysqladmin ping -h localhost" ]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  rabbitmq:
+    image: rabbitmq:4.0.0-beta.5-management-alpine
+    ports:
+      - "5680:5672"
+      - "15680:15672"
+    healthcheck:
+      test: [ "CMD", "rabbitmq-diagnostics", "ping" ]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  zookeeper:
+    image: confluentinc/cp-zookeeper:7.4.4
+    environment:
+      ZOOKEEPER_CLIENT_PORT: 2181
+    ports:
+      - "2181:2181"
+    healthcheck:
+      test: [ "CMD", "bash", "-c", "echo > /dev/tcp/localhost/2181" ]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  kafka:
+    image: confluentinc/cp-kafka:7.4.4
+    environment:
+      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://localhost:9092
+      KAFKA_BROKER_ID: 1
+      KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
+    ports:
+      - "9092:9092"
+      - "29092:29092"
+    depends_on:
+      zookeeper:
+        condition: service_healthy
+    healthcheck:
+      test: [ "CMD", "bash", "-c", "echo > /dev/tcp/localhost/9092" ]
+      interval: 10s
+      timeout: 5s
+      retries: 5
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -25,7 +25,8 @@ Django Action Triggers can be installed directly from PyPI using pip:
 
   pip install django-action-triggers
 
-## Optional: Install with Extras
+Optional: Install with Extras
+-----------------------------
 
 If you plan to use specific features (e.g., integration with messaging
 brokers), you can install the required dependencies at the same time:
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -91,3 +91,8 @@ Module Documentation
    :members:
    :undoc-members:
    :show-inheritance:
+
+.. automodule:: action_triggers.utils.module_import
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,6 +4,7 @@ version = "0.1.0"
 description = ""
 authors = ["Salaah Amin <salaah01@users.noreply.github.com>"]
 readme = "README.md"
+packages = [{ include = "action_triggers" }]
 
 [tool.ruff]
 line-length = 79
@@ -23,6 +24,7 @@ omit = ["action_triggers/migrations/*"]
 python = ">=3.8,<3.13"
 django = ">=3.2"
 djangorestframework = "^3.15.2"
+requests = "^2.32.3"
 
 [tool.mypy]
 plugins = ["mypy_django_plugin.main"]
diff --git a/tests/settings.py b/tests/settings.py
@@ -4,8 +4,12 @@
 
 DATABASES = {
     "default": {
-        "ENGINE": "django.db.backends.sqlite3",
-        "NAME": ":memory:",
+        "ENGINE": os.getenv("DB_ENGINE", "django.db.backends.sqlite3"),
+        "NAME": os.getenv("DB_NAME", ":memory:"),
+        "USER": os.getenv("DB_USER", ""),
+        "PASSWORD": os.getenv("DB_PASSWORD", ""),
+        "HOST": os.getenv("DB_HOST", ""),
+        "PORT": os.getenv("DB_PORT", ""),
     },
 }
 
@@ -46,15 +50,15 @@
 # this case, we will assume that the message brokers are running locally.
 
 DEFAULT_RABBIT_MQ_CONN_DETAILS = {
-    "host": "localhost",
-    "port": 5672,
+    "host": os.getenv("RABBIT_MQ_HOST", "localhost"),
+    "port": os.getenv("RABBIT_MQ_PORT", 5672),
 }
 RABBIT_MQ_CONN_DETAILS = (
     json.loads(os.getenv("RABBIT_MQ_CONN_DETAILS", "{}"))
     or DEFAULT_RABBIT_MQ_CONN_DETAILS
 )
 DEFAULT_KAFKA_CONN_DETAILS = {
-    "bootstrap.servers": "localhost:29092",
+    "bootstrap.servers": "localhost:9092",
 }
 KAFKA_CONN_DETAILS = (
     json.loads(os.getenv("KAFKA_CONN_DETAILS", "{}"))
diff --git a/tests/test_api_serializers.py b/tests/test_api_serializers.py
@@ -28,6 +28,7 @@ def test_shows_data_correctly(self, full_loaded_config):
 
         assert serializer.data == {
             "id": config.id,
+            "active": config.active,
             "config_signals": [
                 {"signal": config_signal_1.signal},
                 {"signal": config_signal_2.signal},
@@ -77,6 +78,7 @@ def test_shows_data_correctly_when_using_plaintext_payload(self, config):
 
         assert serializer.data == {
             "id": config.id,
+            "active": config.active,
             "config_signals": [],
             "content_types": [],
             "webhooks": [],
diff --git a/tests/test_manager_broker_base.py b/tests/test_manager_broker_base.py
@@ -1,5 +1,6 @@
 """Tests for `action_triggers.message_broker.base` module."""
 
+import os
 from types import SimpleNamespace
 
 import pytest
@@ -67,13 +68,20 @@ class TestBrokerBase:
             (
                 {},
                 {},
-                {"host": "localhost", "port": 5672},
+                {
+                    "host": "localhost",
+                    "port": os.getenv("RABBIT_MQ_PORT", 5672),
+                },
                 {"queue": "test_queue_1"},
             ),
             (
                 {"host": "localhost2", "name": "rabbitmq"},
                 {"queue": "test_queue_2", "exchange": "test_exchange"},
-                {"host": "localhost2", "port": 5672, "name": "rabbitmq"},
+                {
+                    "host": "localhost2",
+                    "port": os.getenv("RABBIT_MQ_PORT", 5672),
+                    "name": "rabbitmq",
+                },
                 {"queue": "test_queue_2", "exchange": "test_exchange"},
             ),
         ),
diff --git a/tests/test_message_broker_exceptions.py b/tests/test_message_broker_exceptions.py
@@ -5,27 +5,7 @@
 
 import pytest
 
-from action_triggers.message_broker.exceptions import (
-    ConnectionValidationError,
-    MissingDependenciesError,
-)
-
-
-class TestMissingDependenciesError:
-    """Tests for the `MissingDependenciesError` class."""
-
-    def test_shows_custom_message(self):
-        exc = MissingDependenciesError(
-            broker_name="broker-name",
-            extra_name="extra-name",
-            package_name="package-name",
-        )
-        exc_str = str(exc)
-
-        assert "The `extra-name` extra must be installed" in exc_str
-        assert "to use the broker-name broker" in exc_str
-        assert "action-triggers[extra-name]" in exc_str
-        assert "pip install package-name" in exc_str
+from action_triggers.message_broker.exceptions import ConnectionValidationError
 
 
 class TestConnectionValidationError:
diff --git a/tests/test_message_broker_rabbitmq.py b/tests/test_message_broker_rabbitmq.py
@@ -3,7 +3,10 @@
 import json
 import socket
 
-import pika  # type: ignore[import-untyped]
+try:
+    import pika  # type: ignore[import-untyped]
+except ImportError:  # pragma: no cover
+    pika = None
 import pytest
 from django.conf import settings
 
@@ -17,6 +20,9 @@
 
 def conn_test() -> bool:
     """Verify that a connection can be made to RabbitMQ."""
+    if pika is None:
+        return False
+
     try:
         get_rabbitmq_conn()
         return True
diff --git a/tests/utils.py b/tests/utils.py
@@ -1,11 +1,20 @@
 from contextlib import contextmanager
 
-import pika  # type: ignore[import-untyped]
-from confluent_kafka import Consumer, Producer  # type: ignore[import-untyped]
+try:
+    import pika  # type: ignore[import-untyped]
+except ImportError:  # pragma: no cover
+    pika = None
+try:
+    from confluent_kafka import (  # type: ignore[import-untyped]
+        Consumer,
+        Producer,
+    )
+except ImportError:  # pragma: no cover
+    Consumer = Producer = None
 from django.conf import settings
 
 
-def get_rabbitmq_conn(key: str = "rabbitmq_1") -> pika.BlockingConnection:
+def get_rabbitmq_conn(key: str = "rabbitmq_1"):
     """Get a connection to a RabbitMQ broker.
 
     Args:
@@ -24,7 +33,7 @@ def get_rabbitmq_conn(key: str = "rabbitmq_1") -> pika.BlockingConnection:
 
 
 @contextmanager
-def get_kafka_conn(key: str = "kafka_1") -> Consumer:
+def get_kafka_conn(key: str = "kafka_1"):
     """Get a connection to a Kafka broker.
 
     Args:
@@ -50,7 +59,7 @@ def get_kafka_conn(key: str = "kafka_1") -> Consumer:
 
 
 @contextmanager
-def get_kafka_consumer(key: str = "kafka_1") -> Consumer:
+def get_kafka_consumer(key: str = "kafka_1"):
     """Consume a message from a Kafka broker.
 
     Args:
@@ -97,6 +106,9 @@ def can_connect_to_rabbitmq() -> bool:
         bool: True if the service can connect to RabbitMQ, False otherwise
     """
 
+    if pika is None:
+        return False
+
     try:
         with get_rabbitmq_conn():
             return True
@@ -111,6 +123,9 @@ def can_connect_to_kafka() -> bool:
         bool: True if the service can connect to Kafka, False otherwise
     """
 
+    if Consumer is None or Producer is None:
+        return False
+
     try:
         with get_kafka_conn():
             return True
diff --git a/tox.ini b/tox.ini
