Merge pull request #106 from GabrielSalla/format-monitor-name

Format monitor name

Author: GabrielSalla

src/components/http_server/format_monitor_name.py

@@ -0,0 +1,8 @@
+import re
+
+
+def format_monitor_name(monitor_name: str) -> str:
+    """Format the monitor name"""
+    monitor_name = re.sub(r"[\. ]", "_", monitor_name.lower())
+    monitor_name = re.sub(r"[^\w_]", "", monitor_name)
+    return re.sub(r"_{2,}", "_", monitor_name).strip("_")

src/components/http_server/monitor_routes.py

@@ -7,7 +7,8 @@
 from aiohttp.web_request import Request
 from aiohttp.web_response import Response
 
-import commands as commands
+import commands
+from components.http_server.format_monitor_name import format_monitor_name
 from components.monitors_loader import MonitorValidationError
 from models import CodeModule, Monitor
 
@@ -153,6 +154,16 @@ async def monitor_validate(request: Request) -> Response:
     return web.json_response(success_response)
 
 
+@monitor_routes.post(base_route + "/format_name/{monitor_name}")
+@monitor_routes.post(base_route + "/format_name/{monitor_name}/")
+async def format_name(request: Request) -> Response:
+    """Route to format a monitor name"""
+    monitor_name = request.match_info["monitor_name"]
+    return web.json_response(
+        {"name": monitor_name, "formatted_name": format_monitor_name(monitor_name)}
+    )
+
+
 @monitor_routes.post(base_route + "/register/{monitor_name}")
 @monitor_routes.post(base_route + "/register/{monitor_name}/")
 async def monitor_register(request: Request) -> Response:
@@ -169,8 +180,7 @@ async def monitor_register(request: Request) -> Response:
         error_response = {"status": "error", "message": "'monitor_code' parameter is required"}
         return web.json_response(error_response, status=400)
 
-    # Remove any dots from the monitor name
-    monitor_name = monitor_name.replace(".", "_")
+    monitor_name = format_monitor_name(monitor_name)
 
     try:
         monitor = await commands.monitor_register(monitor_name, monitor_code, additional_files)

tests/components/http_server/test_format_monitor_name.py

@@ -0,0 +1,38 @@
+import pytest
+
+import components.http_server.format_monitor_name as format_monitor_name
+
+
+@pytest.mark.parametrize(
+    "input_name, expected_output",
+    [
+        ("simple_monitor", "simple_monitor"),
+        ("UPPERCASE", "uppercase"),
+        ("MixedCase", "mixedcase"),
+        ("monitor.name", "monitor_name"),
+        ("a.b.c.d", "a_b_c_d"),
+        ("monitor name", "monitor_name"),
+        ("monitor._name", "monitor_name"),
+        ("monitor_._name", "monitor_name"),
+        ("monitor____name", "monitor_name"),
+        ("_monitor_", "monitor"),
+        ("__monitor__", "monitor"),
+        ("___monitor___", "monitor"),
+        ("My.Monitor-Name@123", "my_monitorname123"),
+        ("Service.Monitor_v2.1", "service_monitor_v2_1"),
+        ("test...monitor", "test_monitor"),
+        ("Monitor--.--Name", "monitor_name"),
+        ("API_Gateway.Health-Check@v1", "api_gateway_healthcheckv1"),
+        ("", ""),
+        (".", ""),
+        ("..", ""),
+        ("...", ""),
+        ("___", ""),
+        ("123", "123"),
+        ("monitor123", "monitor123"),
+        ("123monitor", "123monitor"),
+    ],
+)
+def test_format_monitor_name(input_name, expected_output):
+    """'format_monitor_name' should format the monitor name correctly"""
+    assert format_monitor_name.format_monitor_name(input_name) == expected_output

tests/components/http_server/test_monitor_routes.py

@@ -317,6 +317,25 @@ async def test_monitor_validate_invalid_monitor_code(mocker, monitor_code, expec
             }
 
 
+@pytest.mark.parametrize(
+    "monitor_name, expected_formatted_name",
+    [
+        ("test_monitor_format_name", "test_monitor_format_name"),
+        ("a.b.c", "a_b_c"),
+        ("My.Monitor-Name@123", "my_monitorname123"),
+    ],
+)
+async def test_format_name(monitor_name, expected_formatted_name):
+    """The 'format name' route should return the formatted name of the monitor"""
+    url = BASE_URL + f"/format_name/{monitor_name}"
+    async with aiohttp.ClientSession() as session:
+        async with session.post(url) as response:
+            assert await response.json() == {
+                "name": monitor_name,
+                "formatted_name": expected_formatted_name,
+            }
+
+
 @pytest.mark.parametrize(
     "monitor_name",
     [