UT: Add unit tests for PingScanEvent

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

@@ -0,0 +1,116 @@
+from ipaddress import IPv4Address
+from uuid import UUID
+
+import pytest
+from pydantic.errors import IPv4AddressError, UUIDError
+from tests.unit_tests.monkey_island.cc.models.test_agent import AGENT_ID
+
+from common import OperatingSystem
+from common.agent_events import PingScanEvent
+
+PING_EVENT = PingScanEvent(
+    source=AGENT_ID, target=IPv4Address("1.1.1.1"), response_received=True, os=OperatingSystem.LINUX
+)
+
+PING_OBJECT_DICT = {
+    "source": UUID("012e7238-7b81-4108-8c7f-0787bc3f3c10"),
+    "target": IPv4Address("1.1.1.1"),
+    "timestamp": 1664371327.4067292,
+    "tags": frozenset(),
+    "response_received": True,
+    "os": OperatingSystem.LINUX,
+}
+
+PING_SIMPLE_DICT = {
+    "source": "012e7238-7b81-4108-8c7f-0787bc3f3c10",
+    "target": "1.1.1.1",
+    "timestamp": 1664371327.4067292,
+    "tags": [],
+    "response_received": True,
+    "os": "linux",
+}
+
+
+def test_constructor():
+    # Raises exception_on_failure
+    PingScanEvent(**PING_OBJECT_DICT)
+
+
+def test_from_dict():
+    # Raises exception_on_failure
+    PingScanEvent(**PING_SIMPLE_DICT)
+
+
+def test_to_dict():
+    ping_scan_event = PingScanEvent(**PING_OBJECT_DICT)
+
+    assert ping_scan_event.dict(simplify=True) == PING_SIMPLE_DICT
+
+
+@pytest.mark.parametrize(
+    "key, value",
+    [
+        ("source", "not-an-uuid"),
+        ("timestamp", "not-a-timestamp"),
+        ("response_received", "not-a-bool"),
+        ("os", 2.1),
+        ("os", "bsd"),
+    ],
+)
+def test_construct_invalid_field__type_error(key, value):
+    invalid_type_dict = PING_SIMPLE_DICT.copy()
+    invalid_type_dict[key] = value
+
+    with pytest.raises(TypeError):
+        PingScanEvent(**invalid_type_dict)
+
+
+@pytest.mark.parametrize(
+    "key, value, expected_error",
+    [
+        ("source", -1, UUIDError),
+        ("target", "not-a-IPv4Address", IPv4AddressError),
+    ],
+)
+def test_construct_invalid_field__value_error(key, value, expected_error):
+    invalid_type_dict = PING_SIMPLE_DICT.copy()
+    invalid_type_dict[key] = value
+
+    with pytest.raises(expected_error):
+        PingScanEvent(**invalid_type_dict)
+
+
+def test_optional_os_field():
+    none_field_dict = PING_SIMPLE_DICT.copy()
+    none_field_dict["os"] = None
+
+    # Raises exception_on_failure
+    PingScanEvent(**none_field_dict)
+
+
+def test_construct__extra_fields_forbidden():
+    extra_field_dict = PING_SIMPLE_DICT.copy()
+    extra_field_dict["extra_field"] = 99  # red balloons
+
+    with pytest.raises(ValueError):
+        PingScanEvent(**extra_field_dict)
+
+
+def test_ping_scan_event_serialization_json():
+    serialized_event = PING_EVENT.json()
+    assert "1.1.1.1" in serialized_event
+    assert "true" in serialized_event
+    assert OperatingSystem.LINUX.value in serialized_event
+    assert str(AGENT_ID) in serialized_event
+
+
+def test_ping_scan_event_deserialization_json():
+    serialized_event = PING_EVENT.json()
+    deserialized_event = PingScanEvent.parse_raw(serialized_event)
+    assert deserialized_event == PING_EVENT
+
+
+def test_ping_scan_event_deserialization_dict():
+    serialized_event = PING_EVENT.dict()
+    deserialized_event = PingScanEvent(**serialized_event)
+    assert deserialized_event == PING_EVENT