Merge pull request #89 from GabrielSalla/add-branch-coverage

Add branch coverage

Author: GabrielSalla

pyproject.toml

@@ -97,6 +97,8 @@ filterwarnings = [
     "error",
     "ignore:datetime.datetime.utcnow:DeprecationWarning:botocore",
 ]
+[tool.coverage.run]
+branch = true
 
 [tool.coverage.report]
 omit =[

src/components/monitors_loader/monitor_module_type.py

@@ -5,7 +5,7 @@
 from notifications import BaseNotification
 
 
-class MonitorModule(Protocol):
+class MonitorModule(Protocol):  # pragma: no cover
     """Class that represents a base monitor module structure"""
 
     SENTINELA_MONITOR_ID: int

src/databases/protocols.py

@@ -2,7 +2,7 @@
 
 
 @runtime_checkable
-class Pool(Protocol):
+class Pool(Protocol):  # pragma: no cover
     PATTERNS: list[str]
     name: str
 

src/message_queue/protocols.py

@@ -1,15 +1,15 @@
 from typing import Any, Protocol, runtime_checkable
 
 
-class Message(Protocol):
+class Message(Protocol):  # pragma: no cover
     id: str
 
     @property
     def content(self) -> dict[str, Any]: ...
 
 
 @runtime_checkable
-class Queue(Protocol):
+class Queue(Protocol):  # pragma: no cover
     def __init__(self, config: dict[str, Any]) -> None: ...
 
     @property

src/notifications/base_notification.py

@@ -4,7 +4,7 @@
 
 
 @runtime_checkable
-class BaseNotification(Protocol):
+class BaseNotification(Protocol):  # pragma: no cover
     min_priority_to_send: int = 5
 
     def reactions_list(self) -> list[tuple[str, list[reaction_function_type]]]: ...

src/utils/log.py

@@ -65,5 +65,7 @@ def setup() -> None:
         stream.setFormatter(FriendlyFormatter(configs.logging.format))
     elif configs.logging.mode == "json":
         stream.setFormatter(JsonFormatter(configs.logging.fields))
+    else:
+        raise ValueError(f"Unknown logging mode: '{configs.logging.mode}'")
 
     logging.basicConfig(level=logging.INFO, handlers=[stream])

tests/components/controller/test_controller.py

@@ -394,6 +394,34 @@ async def test_run(monkeypatch, clear_queue, clear_database):
     )
 
 
+async def test_run_no_sleep(mocker, monkeypatch):
+    """'run' should not sleep if the controller completes the loop and another one is already
+    triggered"""
+    monkeypatch.setattr(configs, "load_sample_monitors", True)
+    monkeypatch.setattr(configs, "internal_monitors_path", "tests/sample_monitors/internal")
+    monkeypatch.setattr(configs, "sample_monitors_path", "tests/sample_monitors/others")
+
+    run_procedures_mock = AsyncMock()
+    monkeypatch.setattr(controller, "run_procedures", run_procedures_mock)
+
+    monkeypatch.setattr(controller, "is_triggered", lambda *args, **kwargs: True)
+
+    sleep_spy: AsyncMock = mocker.spy(app, "sleep")
+
+    # Run the controller for a while then stop it
+    await monitors_loader._register_monitors()
+    await monitors_loader._load_monitors(None)
+
+    controller_task = asyncio.create_task(controller.run())
+    await asyncio.sleep(0.5)
+
+    # Stop the app and wait for the controller task
+    app.stop()
+    await asyncio.wait_for(controller_task, timeout=0.5)
+
+    sleep_spy.assert_not_called()
+
+
 async def test_run_current_task_error(caplog, monkeypatch):
     """'run' should log an error if it can't get the current task and finish the execution"""
     monkeypatch.setattr(asyncio, "current_task", lambda: None)

tests/module_loader/test_loader.py

@@ -288,3 +288,18 @@ def test_load_module_from_string():
 
     assert module_path == Path("tmp") / module_name / f"{module_name}.py"
     assert module.get_value() == 200
+
+
+def test_load_module_from_string_with_base_path():
+    """'load_module_from_string' should create the module file and load it with a custom base
+    path"""
+    module_name = "test_load_module_from_string_with_base_path"
+    module_code = "def get_value(): return {n}"
+
+    base_path = Path("tmp") / "some_test_path"
+    module_path, module = loader.load_module_from_string(
+        module_name, module_code.format(n=987), base_path=str(base_path)
+    )
+
+    assert module_path == base_path / module_name / f"{module_name}.py"
+    assert module.get_value() == 987

tests/plugins/aws/queues/sqs/test_sqs_queue.py

@@ -42,6 +42,41 @@ async def delete_queue(queue_url: str) -> None:
         assert e.response["Error"]["Code"] == "AWS.SimpleQueueService.NonExistentQueue"
 
 
+@pytest.mark.parametrize(
+    "config",
+    [
+        {
+            "type": "plugin.aws.sqs",
+            "name": "app",
+            "url": "http://motoserver:5000/123456789012/app",
+            "region": "us-east-1",
+            "create_queue": True,
+            "queue_wait_message_time": 2,
+            "queue_visibility_time": 15,
+        },
+        {
+            "type": "plugin.aws.sqs",
+            "name": "other",
+            "url": "some_other_url",
+            # No region
+            "create_queue": False,
+            "queue_wait_message_time": 5,
+            "queue_visibility_time": 20,
+        },
+    ],
+)
+async def test_queue_init_aws_client_params(config):
+    """'Queue' should initialize with the correct AWS client parameters"""
+    queue = sqs_queue.Queue(config=config)
+
+    assert queue._aws_client_params["credential_name"] == "application"
+    assert queue._aws_client_params["service"] == "sqs"
+    if "region" in config:
+        assert queue._aws_client_params["region_name"] == config["region"]
+    else:
+        assert "region_name" not in queue._aws_client_params
+
+
 @pytest.mark.parametrize("queue_wait_message_time", [1, 2, 3, 4, 5])
 async def test_queue_wait_message_time(queue_wait_message_time):
     queue = sqs_queue.Queue(

tests/utils/test_exception_handling.py

@@ -42,6 +42,16 @@ async def error() -> None:
         logger_error_spy.assert_called_once_with("error function timed out")
 
 
+async def test_catch_exceptions_timeout_no_message(caplog):
+    """'catch_exceptions' should not log any message if a 'TimeoutError' exception is raised and
+    no timeout message is provided"""
+    with catch_exceptions():
+        await asyncio.wait_for(asyncio.sleep(0.1), timeout=0.01)
+
+    assert_message_not_in_log(caplog, "Exception caught successfully, going on")
+    assert_message_not_in_log(caplog, "TimeoutError")
+
+
 async def test_catch_exceptions_base_exception(caplog):
     """'catch_exceptions' should log the exception message if an exception inherited from
     'BaseSentinelaException' is raised"""