Common: Add HTTPRequestEvent

Author: mssalvatore

monkey/common/agent_events/__init__.py

@@ -13,3 +13,4 @@
 from .register import register_common_agent_events
 from .cpu_consumption_event import CPUConsumptionEvent
 from .ram_consumption_event import RAMConsumptionEvent
+from .http_request_event import HTTPRequestEvent

monkey/common/agent_events/http_request_event.py

@@ -0,0 +1,18 @@
+from http import HTTPMethod
+
+from pydantic import AnyHttpUrl
+
+from . import AbstractAgentEvent
+
+
+class HTTPRequestEvent(AbstractAgentEvent):
+    """
+    An event that occurs when the Agent consumes significant RAM for its own purposes.
+
+    Attributes:
+        :param method: The HTTP method used to make the request
+        :param url: The URL to which the request was sent
+    """
+
+    method: HTTPMethod
+    url: AnyHttpUrl

monkey/tests/unit_tests/common/agent_events/test_http_request_event.py

@@ -0,0 +1,43 @@
+from http import HTTPMethod
+from uuid import UUID
+
+import pytest
+
+from common.agent_events import HTTPRequestEvent
+
+AGENT_ID = UUID("012e7238-7b81-4108-8c7f-0787bc3f3c10")
+TIMESTAMP = 1664371327.4067292
+HTTP_URL = "http://www.test.org/RESTFUL/test?filter=my_filter"
+HTTPS_URL = "https://www.test.org/RESTFUL/test?filter=my_filter"
+METHOD = HTTPMethod.GET
+
+
+@pytest.mark.parametrize("url", (HTTP_URL, HTTPS_URL))
+def test_constructor(url: str):
+    event = HTTPRequestEvent(source=AGENT_ID, timestamp=TIMESTAMP, method=METHOD, url=url)
+
+    assert event.source == AGENT_ID
+    assert event.timestamp == TIMESTAMP
+    assert event.target is None
+    assert len(event.tags) == 0
+    assert event.method == METHOD
+    assert event.url == url
+
+
+@pytest.mark.parametrize(
+    "invalid_url", ("www.missing-schema.org", -1, None, "ftp://wrong.schema.org")
+)
+def test_invalid_url(invalid_url):
+    with pytest.raises((ValueError, TypeError)):
+        HTTPRequestEvent(
+            source=AGENT_ID,
+            timestamp=TIMESTAMP,
+            method=METHOD,
+            url=invalid_url,
+        )
+
+
+@pytest.mark.parametrize("invalid_method", ("not-a-method", "POST/GET", None, 999))
+def test_invalid_method(invalid_method):
+    with pytest.raises((ValueError, TypeError)):
+        HTTPRequestEvent(source=AGENT_ID, timestamp=TIMESTAMP, method=invalid_method, url=HTTP_URL)

vulture_allowlist.py

@@ -17,6 +17,7 @@
     AbstractAgentEvent,
     CPUConsumptionEvent,
     FileEncryptionEvent,
+    HTTPRequestEvent,
     RAMConsumptionEvent,
 )
 from common.agent_plugins import (
@@ -203,3 +204,6 @@
 RAMConsumptionEvent
 RAMConsumptionEvent.utilization
 RAMConsumptionEvent.bytes
+HTTPRequestEvent
+HTTPRequestEvent.method
+HTTPRequestEvent.url