Merge pull request #37 from GabrielSalla/change-external-requests-to-commands

Change external requests to commands

Author: GabrielSalla

src/external_requests/__init__.py src/commands/__init__.pysrc/external_requests/__init__.py renamed to src/commands/__init__.py

@@ -2,7 +2,7 @@
 from aiohttp.web_request import Request
 from aiohttp.web_response import Response
 
-import external_requests as external_requests
+import commands as commands
 from models import Alert
 
 alert_routes = web.RouteTableDef()
@@ -20,7 +20,7 @@ async def alert_acknowledge(request: Request) -> Response:
         error_response = {"status": "error", "message": f"alert '{alert_id}' not found"}
         return web.json_response(error_response, status=404)
 
-    await external_requests.alert_acknowledge(alert_id)
+    await commands.alert_acknowledge(alert_id)
 
     success_response = {
         "status": "request_queued",
@@ -41,7 +41,7 @@ async def alert_lock(request: Request) -> Response:
         error_response = {"status": "error", "message": f"alert '{alert_id}' not found"}
         return web.json_response(error_response, status=404)
 
-    await external_requests.alert_lock(alert_id)
+    await commands.alert_lock(alert_id)
 
     success_response = {
         "status": "request_queued",
@@ -62,7 +62,7 @@ async def alert_solve(request: Request) -> Response:
         error_response = {"status": "error", "message": f"alert '{alert_id}' not found"}
         return web.json_response(error_response, status=404)
 
-    await external_requests.alert_solve(alert_id)
+    await commands.alert_solve(alert_id)
 
     success_response = {
         "status": "request_queued",

src/external_requests/requests.py src/commands/requests.pysrc/external_requests/requests.py renamed to src/commands/requests.py

@@ -2,7 +2,7 @@
 from aiohttp.web_request import Request
 from aiohttp.web_response import Response
 
-import external_requests as external_requests
+import commands as commands
 from models import Issue
 
 issue_routes = web.RouteTableDef()
@@ -20,7 +20,7 @@ async def issue_drop(request: Request) -> Response:
         error_response = {"status": "error", "message": f"issue '{issue_id}' not found"}
         return web.json_response(error_response, status=404)
 
-    await external_requests.issue_drop(issue_id)
+    await commands.issue_drop(issue_id)
 
     success_response = {
         "status": "request_queued",

src/components/http_server/alert_routes.py

@@ -7,7 +7,7 @@
 from aiohttp.web_request import Request
 from aiohttp.web_response import Response
 
-import external_requests as external_requests
+import commands as commands
 from components.monitors_loader import MonitorValidationError
 from models import CodeModule, Monitor
 
@@ -73,7 +73,7 @@ async def monitor_disable(request: Request) -> Response:
     monitor_name = request.match_info["monitor_name"]
 
     try:
-        await external_requests.disable_monitor(monitor_name)
+        await commands.disable_monitor(monitor_name)
         success_response = {
             "status": "monitor_disabled",
             "monitor_name": monitor_name,
@@ -95,7 +95,7 @@ async def monitor_enable(request: Request) -> Response:
     monitor_name = request.match_info["monitor_name"]
 
     try:
-        await external_requests.enable_monitor(monitor_name)
+        await commands.enable_monitor(monitor_name)
         success_response = {
             "status": "monitor_enabled",
             "monitor_name": monitor_name,
@@ -133,7 +133,7 @@ async def monitor_register(request: Request) -> Response:
     monitor_name = monitor_name.replace(".", "_")
 
     try:
-        monitor = await external_requests.monitor_register(
+        monitor = await commands.monitor_register(
             monitor_name, monitor_code, additional_files
         )
     except pydantic.ValidationError as e:

src/components/http_server/issue_routes.py

@@ -1,48 +1,48 @@
 import re
 from typing import Any, Coroutine
 
-import external_requests as external_requests
+import commands as commands
 import message_queue as message_queue
 
 
 def disable_monitor(
     message_match: re.Match[Any], context: dict[str, Any]
 ) -> Coroutine[Any, Any, Any]:
     """Disable a monitor"""
-    return external_requests.disable_monitor(message_match.group(1))
+    return commands.disable_monitor(message_match.group(1))
 
 
 def enable_monitor(
     message_match: re.Match[Any], context: dict[str, Any]
 ) -> Coroutine[Any, Any, Any]:
     """Enable a monitor"""
-    return external_requests.enable_monitor(message_match.group(1))
+    return commands.enable_monitor(message_match.group(1))
 
 
 def alert_acknowledge(
     message_match: re.Match[Any], context: dict[str, Any]
 ) -> Coroutine[Any, Any, Any]:
     """Get the alert acknowledge action"""
     alert_id = int(message_match.group(1))
-    return external_requests.alert_acknowledge(alert_id)
+    return commands.alert_acknowledge(alert_id)
 
 
 def alert_lock(message_match: re.Match[Any], context: dict[str, Any]) -> Coroutine[Any, Any, Any]:
     """Get the alert lock action"""
     alert_id = int(message_match.group(1))
-    return external_requests.alert_lock(alert_id)
+    return commands.alert_lock(alert_id)
 
 
 def alert_solve(message_match: re.Match[Any], context: dict[str, Any]) -> Coroutine[Any, Any, Any]:
     """Get the alert solve action"""
     alert_id = int(message_match.group(1))
-    return external_requests.alert_solve(alert_id)
+    return commands.alert_solve(alert_id)
 
 
 def issue_drop(message_match: re.Match[Any], context: dict[str, Any]) -> Coroutine[Any, Any, Any]:
     """Get the issue drop action"""
     issue_id = int(message_match.group(1))
-    return external_requests.issue_drop(issue_id)
+    return commands.issue_drop(issue_id)
 
 
 def resend_notifications(

src/components/http_server/monitor_routes.py

@@ -3,8 +3,8 @@
 
 import pytest
 
+import commands.requests as requests
 import components.monitors_loader as monitors_loader
-import external_requests.requests as requests
 import message_queue as message_queue
 from models import CodeModule, Monitor
 

src/plugins/slack/services/pattern_match.py

@@ -4,10 +4,10 @@
 import pytest
 import pytest_asyncio
 
+import commands as commands
 import components.controller.controller as controller
 import components.http_server as http_server
 import databases as databases
-import external_requests as external_requests
 from models import CodeModule, Monitor
 
 pytestmark = pytest.mark.asyncio(loop_scope="session")
@@ -93,7 +93,7 @@ async def test_get_monitor_invalid_code_module(clear_database, sample_monitor: M
 
 async def test_monitor_disable(mocker, clear_database, sample_monitor: Monitor):
     """The 'monitor disable' route should disable a monitor"""
-    monitor_disable_spy: AsyncMock = mocker.spy(external_requests, "disable_monitor")
+    monitor_disable_spy: AsyncMock = mocker.spy(commands, "disable_monitor")
 
     assert sample_monitor.enabled
 
@@ -114,7 +114,7 @@ async def test_monitor_disable(mocker, clear_database, sample_monitor: Monitor):
 
 async def test_monitor_disable_not_found(mocker, clear_database):
     """The 'monitor disable' route should return an error if the monitor is not found"""
-    monitor_disable_spy: AsyncMock = mocker.spy(external_requests, "disable_monitor")
+    monitor_disable_spy: AsyncMock = mocker.spy(commands, "disable_monitor")
 
     url = BASE_URL + "/not_found/disable"
     async with aiohttp.ClientSession() as session:
@@ -130,7 +130,7 @@ async def test_monitor_disable_not_found(mocker, clear_database):
 
 async def test_monitor_disable_error(mocker, clear_database):
     """The 'monitor disable' route should return an error if an exception is raised"""
-    monitor_disable_spy: AsyncMock = mocker.spy(external_requests, "disable_monitor")
+    monitor_disable_spy: AsyncMock = mocker.spy(commands, "disable_monitor")
     monitor_disable_spy.side_effect = Exception("Something went wrong")
 
     url = BASE_URL + "/error/disable"
@@ -147,7 +147,7 @@ async def test_monitor_disable_error(mocker, clear_database):
 
 async def test_monitor_enable(mocker, clear_database, sample_monitor: Monitor):
     """The 'monitor enable' route should enable a monitor"""
-    monitor_enable_spy: AsyncMock = mocker.spy(external_requests, "enable_monitor")
+    monitor_enable_spy: AsyncMock = mocker.spy(commands, "enable_monitor")
 
     await sample_monitor.set_enabled(False)
     assert not sample_monitor.enabled
@@ -169,7 +169,7 @@ async def test_monitor_enable(mocker, clear_database, sample_monitor: Monitor):
 
 async def test_monitor_enable_not_found(mocker, clear_database):
     """The 'monitor enable' route should return an error if the monitor is not found"""
-    monitor_enable_spy: AsyncMock = mocker.spy(external_requests, "enable_monitor")
+    monitor_enable_spy: AsyncMock = mocker.spy(commands, "enable_monitor")
 
     url = BASE_URL + "/not_found/enable"
     async with aiohttp.ClientSession() as session:
@@ -185,7 +185,7 @@ async def test_monitor_enable_not_found(mocker, clear_database):
 
 async def test_monitor_enable_error(mocker, clear_database):
     """The 'monitor enable' route should return an error if an exception is raised"""
-    monitor_enable_spy: AsyncMock = mocker.spy(external_requests, "enable_monitor")
+    monitor_enable_spy: AsyncMock = mocker.spy(commands, "enable_monitor")
     monitor_enable_spy.side_effect = Exception("Something went wrong")
 
     url = BASE_URL + "/error/enable"
@@ -208,7 +208,7 @@ async def test_monitor_enable_error(mocker, clear_database):
 async def test_monitor_register(mocker, clear_database, monitor_name):
     """The 'monitor register' route should register a new monitor with the provided module code if
     it doesn't exists. The monitor name should replace any dots with underscores"""
-    monitor_register_spy: AsyncMock = mocker.spy(external_requests, "monitor_register")
+    monitor_register_spy: AsyncMock = mocker.spy(commands, "monitor_register")
 
     monitor = await Monitor.get(Monitor.name == monitor_name)
     assert monitor is None
@@ -267,7 +267,7 @@ async def test_monitor_register_batch(mocker, clear_database):
 async def test_monitor_register_additional_files(mocker, clear_database):
     """The 'monitor register' route should register a new monitor with the provided module code and
     additional files if it not exists"""
-    monitor_register_spy: AsyncMock = mocker.spy(external_requests, "monitor_register")
+    monitor_register_spy: AsyncMock = mocker.spy(commands, "monitor_register")
 
     monitor_name = "test_monitor_register_additional_files"
     monitor = await Monitor.get(Monitor.name == monitor_name)

tests/external_requests/test_requests.py tests/commands/test_requests.pytests/external_requests/test_requests.py renamed to tests/commands/test_requests.py

@@ -5,7 +5,7 @@
 
 import pytest
 
-import external_requests as external_requests
+import commands as commands
 import message_queue as message_queue
 import plugins.slack.services.pattern_match as pattern_match
 
@@ -14,7 +14,7 @@
 
 async def test_disable_monitor(mocker):
     """'disable_monitor' should return the coroutine to disable the monitor"""
-    disable_monitor_spy: MagicMock = mocker.spy(external_requests, "disable_monitor")
+    disable_monitor_spy: MagicMock = mocker.spy(commands, "disable_monitor")
 
     action = pattern_match.disable_monitor(
         message_match=re.match(r"disable monitor +(\w+)", "disable monitor abc"),
@@ -31,7 +31,7 @@ async def test_disable_monitor(mocker):
 
 async def test_enable_monitor(mocker):
     """'enable_monitor' should return the coroutine to enable the monitor"""
-    enable_monitor_spy: MagicMock = mocker.spy(external_requests, "enable_monitor")
+    enable_monitor_spy: MagicMock = mocker.spy(commands, "enable_monitor")
 
     action = pattern_match.enable_monitor(
         message_match=re.match(r"enable monitor +(\w+)", "enable monitor abc"),
@@ -48,7 +48,7 @@ async def test_enable_monitor(mocker):
 
 async def test_alert_acknowledge(mocker):
     """'alert_acknowledge' should return the coroutine to acknowledge the alert"""
-    alert_acknowledge_spy: MagicMock = mocker.spy(external_requests, "alert_acknowledge")
+    alert_acknowledge_spy: MagicMock = mocker.spy(commands, "alert_acknowledge")
 
     action = pattern_match.alert_acknowledge(
         message_match=re.match(r"ack +(\d+)", "ack 12345"),
@@ -65,7 +65,7 @@ async def test_alert_acknowledge(mocker):
 
 async def test_alert_lock(mocker):
     """'alert_lock' should return the coroutine to lock the alert"""
-    alert_lock_spy: MagicMock = mocker.spy(external_requests, "alert_lock")
+    alert_lock_spy: MagicMock = mocker.spy(commands, "alert_lock")
 
     action = pattern_match.alert_lock(
         message_match=re.match(r"lock +(\d+)", "lock 12345"),
@@ -82,7 +82,7 @@ async def test_alert_lock(mocker):
 
 async def test_alert_solve(mocker):
     """'alert_solve' should return the coroutine to solve the alert"""
-    alert_solve_spy: MagicMock = mocker.spy(external_requests, "alert_solve")
+    alert_solve_spy: MagicMock = mocker.spy(commands, "alert_solve")
 
     action = pattern_match.alert_solve(
         message_match=re.match(r"solve +(\d+)", "solve 12345"),
@@ -99,7 +99,7 @@ async def test_alert_solve(mocker):
 
 async def test_issue_drop(mocker):
     """'issue_drop' should return the coroutine to drop the issue"""
-    issue_drop_spy: MagicMock = mocker.spy(external_requests, "issue_drop")
+    issue_drop_spy: MagicMock = mocker.spy(commands, "issue_drop")
 
     action = pattern_match.issue_drop(
         message_match=re.match(r"drop issue +(\d+)", "drop issue 12345"),
@@ -172,7 +172,7 @@ async def test_get_message_request_match_external(
 ):
     """'get_message_request' should return the correct request coroutine based on the received
     message, using the external requests"""
-    action_spy: MagicMock = mocker.spy(external_requests, expected_request)
+    action_spy: MagicMock = mocker.spy(commands, expected_request)
 
     context = {
         "channel": "C1234567890",

tests/components/http_server/test_monitor_routes.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-import external_requests as external_requests
+import commands as commands
 import plugins.slack.services.websocket as websocket
 import plugins.slack.slack as slack
 
@@ -18,7 +18,7 @@
 async def test_app_mention(mocker, message, action_name):
     """'app_mention' should call the correct action for the event if there's an action mapped for
     it, reacting to the message with a check mark"""
-    action_spy: AsyncMock = mocker.spy(external_requests, action_name)
+    action_spy: AsyncMock = mocker.spy(commands, action_name)
     slack_add_reaction_spy: AsyncMock = mocker.spy(slack, "add_reaction")
 
     body = {
@@ -49,7 +49,7 @@ async def test_app_mention_invalid_action(mocker):
 async def test_app_mention_error(mocker):
     """'app_mention' should react to the message with an 'x' and send the error message if an
     exception is raised"""
-    action_spy: AsyncMock = mocker.spy(external_requests, "alert_acknowledge")
+    action_spy: AsyncMock = mocker.spy(commands, "alert_acknowledge")
     slack_add_reaction_spy: AsyncMock = mocker.spy(slack, "add_reaction")
     slack_send_spy: AsyncMock = mocker.spy(slack, "send")
 
@@ -77,7 +77,7 @@ async def test_command(mocker, message, action_name):
     """'command' should ack the command and call the correct action for the event if there's an
     action mapped for it"""
     ack_mock = AsyncMock()
-    action_spy: AsyncMock = mocker.spy(external_requests, action_name)
+    action_spy: AsyncMock = mocker.spy(commands, action_name)
 
     body = {
         "actions": [{"value": message}]