Merge remote-tracking branch 'origin/dev' into dev-game-layer

tests/conftest.py

@@ -4,9 +4,10 @@ import shutil
 import tempfile
 from datetime import datetime
 from pathlib import Path
-from typing import Any, Union
+from typing import Any, Dict, Union
 from unittest.mock import patch
 
+import nodeenv
 import pytest
 
 from primaite import getLogger
@@ -16,6 +17,7 @@ from primaite import getLogger
 from primaite.simulator.network.container import Network
 from primaite.simulator.network.networks import arcd_uc2_network
 from primaite.simulator.network.transmission.transport_layer import Port
+from primaite.simulator.system.applications.application import Application
 from primaite.simulator.system.core.sys_log import SysLog
 from primaite.simulator.system.services.service import Service
 from tests.mock_and_patch.get_session_path_mock import get_temp_session_path
@@ -37,6 +39,13 @@ class TestService(Service):
         pass
 
 
+class TestApplication(Application):
+    """Test Application class"""
+
+    def describe_state(self) -> Dict:
+        pass
+
+
 @pytest.fixture(scope="function")
 def uc2_network() -> Network:
     return arcd_uc2_network()
@@ -49,6 +58,13 @@ def service(file_system) -> TestService:
     )
 
 
+@pytest.fixture(scope="function")
+def application(file_system) -> TestApplication:
+    return TestApplication(
+        name="TestApplication", port=Port.ARP, file_system=file_system, sys_log=SysLog(hostname="test_application")
+    )
+
+
 @pytest.fixture(scope="function")
 def file_system() -> FileSystem:
     return Node(hostname="fs_node").file_system

tests/unit_tests/_primaite/_simulator/_file_system/test_file_system.py

@@ -215,8 +215,8 @@ def test_folder_scan(file_system):
     folder.apply_timestep(timestep=0)
 
     assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert folder.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file1.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+    assert folder.visible_health_status == FileSystemItemHealthStatus.GOOD
+    assert file1.visible_health_status == FileSystemItemHealthStatus.GOOD
     assert file2.visible_health_status == FileSystemItemHealthStatus.GOOD
 
     folder.apply_timestep(timestep=1)
@@ -226,12 +226,33 @@ def test_folder_scan(file_system):
     assert file1.visible_health_status == FileSystemItemHealthStatus.CORRUPT
     assert file2.visible_health_status == FileSystemItemHealthStatus.CORRUPT
 
-    folder.apply_timestep(timestep=2)
 
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert folder.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file1.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file2.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+def test_folder_reveal_to_red_scan(file_system):
+    """Test the ability to reveal files to red."""
+    folder: Folder = file_system.create_folder(folder_name="test_folder")
+    file_system.create_file(file_name="test_file.txt", folder_name="test_folder")
+    file_system.create_file(file_name="test_file2.txt", folder_name="test_folder")
+
+    file1: File = folder.get_file_by_id(file_uuid=list(folder.files)[1])
+    file2: File = folder.get_file_by_id(file_uuid=list(folder.files)[0])
+
+    assert folder.revealed_to_red is False
+    assert file1.revealed_to_red is False
+    assert file2.revealed_to_red is False
+
+    folder.reveal_to_red()
+
+    folder.apply_timestep(timestep=0)
+
+    assert folder.revealed_to_red is False
+    assert file1.revealed_to_red is False
+    assert file2.revealed_to_red is False
+
+    folder.apply_timestep(timestep=1)
+
+    assert folder.revealed_to_red is True
+    assert file1.revealed_to_red is True
+    assert file2.revealed_to_red is True
 
 
 def test_simulated_file_check_hash(file_system):

tests/unit_tests/_primaite/_simulator/_file_system/test_file_system_actions.py

@@ -47,8 +47,8 @@ def test_folder_scan_request(populated_file_system):
     folder.apply_timestep(timestep=0)
 
     assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert folder.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file1.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+    assert folder.visible_health_status == FileSystemItemHealthStatus.GOOD
+    assert file1.visible_health_status == FileSystemItemHealthStatus.GOOD
     assert file2.visible_health_status == FileSystemItemHealthStatus.GOOD
 
     folder.apply_timestep(timestep=1)
@@ -58,13 +58,6 @@ def test_folder_scan_request(populated_file_system):
     assert file1.visible_health_status == FileSystemItemHealthStatus.CORRUPT
     assert file2.visible_health_status == FileSystemItemHealthStatus.CORRUPT
 
-    folder.apply_timestep(timestep=2)
-
-    assert folder.health_status == FileSystemItemHealthStatus.CORRUPT
-    assert folder.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file1.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-    assert file2.visible_health_status == FileSystemItemHealthStatus.CORRUPT
-
 
 def test_file_checkhash_request(populated_file_system):
     """Test that an agent can request a file hash check."""

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

@@ -1,6 +1,11 @@
 import pytest
 
+from primaite.simulator.file_system.file_system import File, FileSystemItemHealthStatus, Folder
 from primaite.simulator.network.hardware.base import Node, NodeOperatingState
+from primaite.simulator.system.applications.application import Application
+from primaite.simulator.system.processes.process import Process
+from primaite.simulator.system.services.service import Service
+from primaite.simulator.system.software import SoftwareHealthState
 
 
 @pytest.fixture
@@ -39,3 +44,113 @@ def test_node_shutdown(node):
         idx += 1
 
     assert node.operating_state == NodeOperatingState.OFF
+
+
+def test_node_os_scan(node, service, application):
+    """Test OS Scanning."""
+    node.operating_state = NodeOperatingState.ON
+
+    # add process to node
+    # TODO implement processes
+
+    # add services to node
+    service.health_state_actual = SoftwareHealthState.COMPROMISED
+    node.install_service(service=service)
+    assert service.health_state_visible == SoftwareHealthState.UNUSED
+
+    # add application to node
+    application.health_state_actual = SoftwareHealthState.COMPROMISED
+    node.install_application(application=application)
+    assert application.health_state_visible == SoftwareHealthState.UNUSED
+
+    # add folder and file to node
+    folder: Folder = node.file_system.create_folder(folder_name="test_folder")
+    folder.corrupt()
+    assert folder.visible_health_status == FileSystemItemHealthStatus.GOOD
+
+    file: File = node.file_system.create_file(folder_name="test_folder", file_name="file.txt")
+    file2: File = node.file_system.create_file(folder_name="test_folder", file_name="file2.txt")
+    file.corrupt()
+    file2.corrupt()
+    assert file.visible_health_status == FileSystemItemHealthStatus.GOOD
+
+    # run os scan
+    node.apply_request(["os", "scan"])
+
+    # apply time steps
+    for i in range(10):
+        node.apply_timestep(timestep=i)
+
+    # should update the state of all items
+    # TODO assert process.health_state_visible == SoftwareHealthState.COMPROMISED
+    assert service.health_state_visible == SoftwareHealthState.COMPROMISED
+    assert application.health_state_visible == SoftwareHealthState.COMPROMISED
+    assert folder.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+    assert file.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+    assert file2.visible_health_status == FileSystemItemHealthStatus.CORRUPT
+
+
+def test_node_red_scan(node, service, application):
+    """Test revealing to red"""
+    node.operating_state = NodeOperatingState.ON
+
+    # add process to node
+    # TODO implement processes
+
+    # add services to node
+    node.install_service(service=service)
+    assert service.revealed_to_red is False
+
+    # add application to node
+    application.health_state_actual = SoftwareHealthState.COMPROMISED
+    node.install_application(application=application)
+    assert application.revealed_to_red is False
+
+    # add folder and file to node
+    folder: Folder = node.file_system.create_folder(folder_name="test_folder")
+    assert folder.revealed_to_red is False
+
+    file: File = node.file_system.create_file(folder_name="test_folder", file_name="file.txt")
+    file2: File = node.file_system.create_file(folder_name="test_folder", file_name="file2.txt")
+    assert file.revealed_to_red is False
+    assert file2.revealed_to_red is False
+
+    # run os scan
+    node.apply_request(["scan"])
+
+    # apply time steps
+    for i in range(10):
+        node.apply_timestep(timestep=i)
+
+    # should update the state of all items
+    # TODO assert process.revealed_to_red is True
+    assert service.revealed_to_red is True
+    assert application.revealed_to_red is True
+    assert folder.revealed_to_red is True
+    assert file.revealed_to_red is True
+    assert file2.revealed_to_red is True
+
+
+def test_reset_node(node):
+    """Test that a node can be reset."""
+    node.operating_state = NodeOperatingState.ON
+
+    node.apply_request(["reset"])
+    assert node.operating_state == NodeOperatingState.SHUTTING_DOWN
+
+    """
+    3 steps to shut down
+    2 steps to set up the turning of it back on
+    3 steps to turn back on
+
+    3 + 2 + 3 = 8
+    kwik mafs
+    """
+
+    for i in range(8):
+        node.apply_timestep(timestep=i)
+
+        if i == 3:
+            assert node.operating_state == NodeOperatingState.BOOTING
+
+    assert node.operating_state == NodeOperatingState.ON