Merge remote-tracking branch 'origin/dev' into feature/2137-refactor-request-api

tests/unit_tests/_primaite/_simulator/_network/_hardware/test_node_actions.py

@@ -53,12 +53,12 @@ def test_node_os_scan(node, service, application):
     # TODO implement processes
 
     # add services to node
-    service.health_state_actual = SoftwareHealthState.COMPROMISED
+    service.set_health_state(SoftwareHealthState.COMPROMISED)
     node.install_service(service=service)
     assert service.health_state_visible == SoftwareHealthState.UNUSED
 
     # add application to node
-    application.health_state_actual = SoftwareHealthState.COMPROMISED
+    application.set_health_state(SoftwareHealthState.COMPROMISED)
     node.install_application(application=application)
     assert application.health_state_visible == SoftwareHealthState.UNUSED
 
@@ -101,7 +101,7 @@ def test_node_red_scan(node, service, application):
     assert service.revealed_to_red is False
 
     # add application to node
-    application.health_state_actual = SoftwareHealthState.COMPROMISED
+    application.set_health_state(SoftwareHealthState.COMPROMISED)
     node.install_application(application=application)
     assert application.revealed_to_red is False
 

tests/unit_tests/_primaite/_simulator/_network/test_container.py

@@ -10,6 +10,22 @@ from primaite.simulator.system.applications.database_client import DatabaseClien
 from primaite.simulator.system.services.database.database_service import DatabaseService
 
 
+def filter_keys_nested_item(data, keys):
+    stack = [(data, {})]
+    while stack:
+        current, filtered = stack.pop()
+        if isinstance(current, dict):
+            for k, v in current.items():
+                if k in keys:
+                    filtered[k] = filter_keys_nested_item(v, keys)
+                elif isinstance(v, (dict, list)):
+                    stack.append((v, {}))
+        elif isinstance(current, list):
+            for item in current:
+                stack.append((item, {}))
+    return filtered
+
+
 @pytest.fixture(scope="function")
 def network(example_network) -> Network:
     assert len(example_network.routers) is 1
@@ -59,10 +75,10 @@ def test_reset_network(network):
 
     assert client_1.operating_state is NodeOperatingState.ON
     assert server_1.operating_state is NodeOperatingState.ON
-
-    assert json.dumps(network.describe_state(), sort_keys=True, indent=2) == json.dumps(
-        state_before, sort_keys=True, indent=2
-    )
+    # don't worry if UUIDs change
+    a = filter_keys_nested_item(json.dumps(network.describe_state(), sort_keys=True, indent=2), ["uuid"])
+    b = filter_keys_nested_item(json.dumps(state_before, sort_keys=True, indent=2), ["uuid"])
+    assert a == b
 
 
 def test_creating_container():

tests/unit_tests/_primaite/_simulator/_system/_applications/test_applications.py

@@ -0,0 +1,50 @@
+from primaite.simulator.system.applications.application import ApplicationOperatingState
+from primaite.simulator.system.software import SoftwareHealthState
+
+
+def test_scan(application):
+    assert application.operating_state == ApplicationOperatingState.CLOSED
+    assert application.health_state_visible == SoftwareHealthState.UNUSED
+
+    application.run()
+    assert application.operating_state == ApplicationOperatingState.RUNNING
+    assert application.health_state_visible == SoftwareHealthState.UNUSED
+
+    application.scan()
+    assert application.operating_state == ApplicationOperatingState.RUNNING
+    assert application.health_state_visible == SoftwareHealthState.GOOD
+
+
+def test_run_application(application):
+    assert application.operating_state == ApplicationOperatingState.CLOSED
+    assert application.health_state_actual == SoftwareHealthState.UNUSED
+
+    application.run()
+    assert application.operating_state == ApplicationOperatingState.RUNNING
+    assert application.health_state_actual == SoftwareHealthState.GOOD
+
+
+def test_close_application(application):
+    application.run()
+    assert application.operating_state == ApplicationOperatingState.RUNNING
+    assert application.health_state_actual == SoftwareHealthState.GOOD
+
+    application.close()
+    assert application.operating_state == ApplicationOperatingState.CLOSED
+    assert application.health_state_actual == SoftwareHealthState.GOOD
+
+
+def test_application_describe_states(application):
+    assert application.operating_state == ApplicationOperatingState.CLOSED
+    assert application.health_state_actual == SoftwareHealthState.UNUSED
+
+    assert SoftwareHealthState.UNUSED.value == application.describe_state().get("health_state_actual")
+
+    application.run()
+    assert SoftwareHealthState.GOOD.value == application.describe_state().get("health_state_actual")
+
+    application.set_health_state(SoftwareHealthState.COMPROMISED)
+    assert SoftwareHealthState.COMPROMISED.value == application.describe_state().get("health_state_actual")
+
+    application.patch()
+    assert SoftwareHealthState.PATCHING.value == application.describe_state().get("health_state_actual")

tests/unit_tests/_primaite/_simulator/_system/_services/test_ftp_client.py

@@ -2,6 +2,7 @@ from ipaddress import IPv4Address
 
 import pytest
 
+from primaite.simulator.file_system.file_system_item_abc import FileSystemItemHealthStatus
 from primaite.simulator.network.hardware.base import Node
 from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
 from primaite.simulator.network.hardware.nodes.computer import Computer
@@ -42,6 +43,7 @@ def test_ftp_client_store_file(ftp_client):
             "dest_folder_name": "downloads",
             "dest_file_name": "file.txt",
             "file_size": 24,
+            "health_status": FileSystemItemHealthStatus.GOOD,
         },
         packet_payload_size=24,
         status_code=FTPStatusCode.OK,

tests/unit_tests/_primaite/_simulator/_system/_services/test_ftp_server.py

@@ -1,5 +1,6 @@
 import pytest
 
+from primaite.simulator.file_system.file_system_item_abc import FileSystemItemHealthStatus
 from primaite.simulator.network.hardware.base import Node
 from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
 from primaite.simulator.network.hardware.nodes.server import Server
@@ -41,6 +42,7 @@ def test_ftp_server_store_file(ftp_server):
             "dest_folder_name": "downloads",
             "dest_file_name": "file.txt",
             "file_size": 24,
+            "health_status": FileSystemItemHealthStatus.GOOD,
         },
         packet_payload_size=24,
     )

tests/unit_tests/_primaite/_simulator/_system/_services/test_services.py

@@ -19,55 +19,146 @@ def test_scan(service):
 
 def test_start_service(service):
     assert service.operating_state == ServiceOperatingState.STOPPED
+    assert service.health_state_actual == SoftwareHealthState.UNUSED
     service.start()
 
     assert service.operating_state == ServiceOperatingState.RUNNING
+    assert service.health_state_actual == SoftwareHealthState.GOOD
 
 
 def test_stop_service(service):
     service.start()
     assert service.operating_state == ServiceOperatingState.RUNNING
+    assert service.health_state_actual == SoftwareHealthState.GOOD
 
     service.stop()
     assert service.operating_state == ServiceOperatingState.STOPPED
+    assert service.health_state_actual == SoftwareHealthState.GOOD
 
 
 def test_pause_and_resume_service(service):
     assert service.operating_state == ServiceOperatingState.STOPPED
     service.resume()
     assert service.operating_state == ServiceOperatingState.STOPPED
+    assert service.health_state_actual == SoftwareHealthState.UNUSED
 
     service.start()
+    assert service.health_state_actual == SoftwareHealthState.GOOD
     service.pause()
     assert service.operating_state == ServiceOperatingState.PAUSED
+    assert service.health_state_actual == SoftwareHealthState.GOOD
 
     service.resume()
     assert service.operating_state == ServiceOperatingState.RUNNING
+    assert service.health_state_actual == SoftwareHealthState.GOOD
 
 
 def test_restart(service):
     assert service.operating_state == ServiceOperatingState.STOPPED
+    assert service.health_state_actual == SoftwareHealthState.UNUSED
     service.restart()
+    # Service is STOPPED. Restart will only work if the service was PAUSED or RUNNING
     assert service.operating_state == ServiceOperatingState.STOPPED
+    assert service.health_state_actual == SoftwareHealthState.UNUSED
 
     service.start()
+    assert service.operating_state == ServiceOperatingState.RUNNING
+    assert service.health_state_actual == SoftwareHealthState.GOOD
     service.restart()
+    # Service is RUNNING. Restart should work
     assert service.operating_state == ServiceOperatingState.RESTARTING
+    assert service.health_state_actual == SoftwareHealthState.GOOD
 
     timestep = 0
     while service.operating_state == ServiceOperatingState.RESTARTING:
         service.apply_timestep(timestep)
+        assert service.health_state_actual == SoftwareHealthState.GOOD
         timestep += 1
 
     assert service.operating_state == ServiceOperatingState.RUNNING
+    assert service.health_state_actual == SoftwareHealthState.GOOD
+
+
+def test_restart_compromised(service):
+    service.start()
+    assert service.health_state_actual == SoftwareHealthState.GOOD
+
+    # compromise the service
+    service.set_health_state(SoftwareHealthState.COMPROMISED)
+
+    service.restart()
+    assert service.operating_state == ServiceOperatingState.RESTARTING
+    assert service.health_state_actual == SoftwareHealthState.COMPROMISED
+
+    """
+    Service should be compromised even after reset.
+
+    Only way to remove compromised status is via patching.
+    """
+
+    timestep = 0
+    while service.operating_state == ServiceOperatingState.RESTARTING:
+        service.apply_timestep(timestep)
+        assert service.health_state_actual == SoftwareHealthState.COMPROMISED
+        timestep += 1
+
+    assert service.operating_state == ServiceOperatingState.RUNNING
+    assert service.health_state_actual == SoftwareHealthState.COMPROMISED
+
+
+def test_compromised_service_remains_compromised(service):
+    """
+    Tests that a compromised service stays compromised.
+
+    The only way that the service can be uncompromised is by running patch.
+    """
+    service.start()
+    assert service.health_state_actual == SoftwareHealthState.GOOD
+
+    service.set_health_state(SoftwareHealthState.COMPROMISED)
+
+    service.stop()
+    assert service.health_state_actual == SoftwareHealthState.COMPROMISED
+
+    service.start()
+    assert service.health_state_actual == SoftwareHealthState.COMPROMISED
+
+    service.disable()
+    assert service.health_state_actual == SoftwareHealthState.COMPROMISED
+
+    service.enable()
+    assert service.health_state_actual == SoftwareHealthState.COMPROMISED
+
+    service.pause()
+    assert service.health_state_actual == SoftwareHealthState.COMPROMISED
+
+    service.resume()
+    assert service.health_state_actual == SoftwareHealthState.COMPROMISED
+
+
+def test_service_patching(service):
+    service.start()
+    assert service.health_state_actual == SoftwareHealthState.GOOD
+
+    service.set_health_state(SoftwareHealthState.COMPROMISED)
+
+    service.patch()
+    assert service.health_state_actual == SoftwareHealthState.PATCHING
+
+    for i in range(service.patching_duration + 1):
+        service.apply_timestep(i)
+
+    assert service.health_state_actual == SoftwareHealthState.GOOD
 
 
 def test_enable_disable(service):
     service.disable()
     assert service.operating_state == ServiceOperatingState.DISABLED
+    assert service.health_state_actual == SoftwareHealthState.UNUSED
 
     service.enable()
     assert service.operating_state == ServiceOperatingState.STOPPED
+    assert service.health_state_actual == SoftwareHealthState.UNUSED
 
 
 def test_overwhelm_service(service):
@@ -76,13 +167,13 @@ def test_overwhelm_service(service):
 
     uuid = str(uuid4())
     assert service.add_connection(connection_id=uuid)  # should be true
-    assert service.health_state_actual is SoftwareHealthState.GOOD
+    assert service.health_state_actual == SoftwareHealthState.GOOD
 
     assert not service.add_connection(connection_id=uuid)  # fails because connection already exists
-    assert service.health_state_actual is SoftwareHealthState.GOOD
+    assert service.health_state_actual == SoftwareHealthState.GOOD
 
     assert service.add_connection(connection_id=str(uuid4()))  # succeed
-    assert service.health_state_actual is SoftwareHealthState.GOOD
+    assert service.health_state_actual == SoftwareHealthState.GOOD
 
     assert not service.add_connection(connection_id=str(uuid4()))  # fail because at capacity
     assert service.health_state_actual is SoftwareHealthState.OVERWHELMED

tests/unit_tests/_primaite/_simulator/_system/_services/test_web_server.py

@@ -1,5 +1,6 @@
 import pytest
 
+from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
 from primaite.simulator.network.hardware.nodes.server import Server
 from primaite.simulator.network.protocols.http import (
     HttpRequestMethod,
@@ -15,7 +16,11 @@ from primaite.simulator.system.services.web_server.web_server import WebServer
 @pytest.fixture(scope="function")
 def web_server() -> Server:
     node = Server(
-        hostname="web_server", ip_address="192.168.1.10", subnet_mask="255.255.255.0", default_gateway="192.168.1.1"
+        hostname="web_server",
+        ip_address="192.168.1.10",
+        subnet_mask="255.255.255.0",
+        default_gateway="192.168.1.1",
+        operating_state=NodeOperatingState.ON,
     )
     node.software_manager.install(software_class=WebServer)
     node.software_manager.software.get("WebServer").start()

tests/unit_tests/_primaite/_simulator/_system/test_software.py

@@ -0,0 +1,29 @@
+from typing import Dict
+
+import pytest
+
+from primaite.simulator.network.transmission.transport_layer import Port
+from primaite.simulator.system.core.sys_log import SysLog
+from primaite.simulator.system.software import Software, SoftwareHealthState
+
+
+class TestSoftware(Software):
+    def describe_state(self) -> Dict:
+        pass
+
+
+@pytest.fixture(scope="function")
+def software(file_system):
+    return TestSoftware(
+        name="TestSoftware", port=Port.ARP, file_system=file_system, sys_log=SysLog(hostname="test_service")
+    )
+
+
+def test_software_creation(software):
+    assert software is not None
+
+
+def test_software_set_health_state(software):
+    assert software.health_state_actual == SoftwareHealthState.UNUSED
+    software.set_health_state(SoftwareHealthState.GOOD)
+    assert software.health_state_actual == SoftwareHealthState.GOOD