#2350: tests + application

tests/integration_tests/game_layer/observations/test_file_system_observations.py

@@ -0,0 +1,68 @@
+import pytest
+from gymnasium import spaces
+
+from primaite.game.agent.observations.file_system_observations import FileObservation, FolderObservation
+from primaite.simulator.network.hardware.nodes.host.computer import Computer
+from primaite.simulator.sim_container import Simulation
+
+
+@pytest.fixture(scope="function")
+def simulation(example_network) -> Simulation:
+    sim = Simulation()
+
+    # set simulation network as example network
+    sim.network = example_network
+
+    return sim
+
+
+def test_file_observation(simulation):
+    """Test the file observation."""
+    pc: Computer = simulation.network.get_node_by_hostname("client_1")
+    # create a file on the pc
+    file = pc.file_system.create_file(file_name="dog.png")
+
+    dog_file_obs = FileObservation(
+        where=["network", "nodes", pc.hostname, "file_system", "folders", "root", "files", "dog.png"]
+    )
+
+    assert dog_file_obs.space == spaces.Dict({"health_status": spaces.Discrete(6)})
+
+    observation_state = dog_file_obs.observe(simulation.describe_state())
+    assert observation_state.get("health_status") == 1  # good initial
+
+    file.corrupt()
+    observation_state = dog_file_obs.observe(simulation.describe_state())
+    assert observation_state.get("health_status") == 1  # scan file so this changes
+
+    file.scan()
+    file.apply_timestep(0)  # apply time step
+    observation_state = dog_file_obs.observe(simulation.describe_state())
+    assert observation_state.get("health_status") == 3  # corrupted
+
+
+def test_folder_observation(simulation):
+    """Test the folder observation."""
+    pc: Computer = simulation.network.get_node_by_hostname("client_1")
+    # create a file and folder on the pc
+    folder = pc.file_system.create_folder("test_folder")
+    file = pc.file_system.create_file(file_name="dog.png", folder_name="test_folder")
+
+    root_folder_obs = FolderObservation(
+        where=["network", "nodes", pc.hostname, "file_system", "folders", "test_folder"]
+    )
+
+    observation_state = root_folder_obs.observe(simulation.describe_state())
+    assert observation_state.get("FILES") is not None
+    assert observation_state.get("health_status") == 1
+
+    file.corrupt()  # corrupt just the file
+    observation_state = root_folder_obs.observe(simulation.describe_state())
+    assert observation_state.get("health_status") == 1  # scan folder to change this
+
+    folder.scan()
+    for i in range(folder.scan_duration + 1):
+        folder.apply_timestep(i)  # apply as many timesteps as needed for a scan
+
+    observation_state = root_folder_obs.observe(simulation.describe_state())
+    assert observation_state.get("health_status") == 3  # file is corrupt therefore folder is corrupted too

tests/integration_tests/game_layer/observations/test_node_observations.py

@@ -0,0 +1,43 @@
+import copy
+from uuid import uuid4
+
+import pytest
+
+from primaite.game.agent.observations.node_observations import NodeObservation
+from primaite.simulator.network.hardware.nodes.host.computer import Computer
+from primaite.simulator.sim_container import Simulation
+
+
+@pytest.fixture(scope="function")
+def simulation(example_network) -> Simulation:
+    sim = Simulation()
+
+    # set simulation network as example network
+    sim.network = example_network
+
+    return sim
+
+
+def test_node_observation(simulation):
+    """Test a Node observation."""
+    pc: Computer = simulation.network.get_node_by_hostname("client_1")
+
+    node_obs = NodeObservation(where=["network", "nodes", pc.hostname])
+
+    observation_state = node_obs.observe(simulation.describe_state())
+    assert observation_state.get("operating_status") == 1  # computer is on
+
+    assert observation_state.get("SERVICES") is not None
+    assert observation_state.get("FOLDERS") is not None
+    assert observation_state.get("NETWORK_INTERFACES") is not None
+
+    # turn off computer
+    pc.power_off()
+    observation_state = node_obs.observe(simulation.describe_state())
+    assert observation_state.get("operating_status") == 4  # shutting down
+
+    for i in range(pc.shut_down_duration + 1):
+        pc.apply_timestep(i)
+
+    observation_state = node_obs.observe(simulation.describe_state())
+    assert observation_state.get("operating_status") == 2

tests/integration_tests/game_layer/observations/test_observations.py

@@ -0,0 +1,35 @@
+import pytest
+
+from primaite.game.agent.observations.observations import NicObservation
+from primaite.simulator.network.hardware.nodes.host.computer import Computer
+from primaite.simulator.network.hardware.nodes.host.host_node import NIC
+from primaite.simulator.sim_container import Simulation
+
+
+@pytest.fixture(scope="function")
+def simulation(example_network) -> Simulation:
+    sim = Simulation()
+
+    # set simulation network as example network
+    sim.network = example_network
+
+    return sim
+
+
+def test_nic(simulation):
+    """Test the NIC observation."""
+    pc: Computer = simulation.network.get_node_by_hostname("client_1")
+
+    nic: NIC = pc.network_interface[1]
+
+    nic_obs = NicObservation(where=["network", "nodes", pc.hostname, "NICs", 1])
+
+    observation_state = nic_obs.observe(simulation.describe_state())
+    assert observation_state.get("nic_status") == 1  # enabled
+    assert observation_state.get("nmne") is not None
+    assert observation_state["nmne"].get("inbound") == 0
+    assert observation_state["nmne"].get("outbound") == 0
+
+    nic.disable()
+    observation_state = nic_obs.observe(simulation.describe_state())
+    assert observation_state.get("nic_status") == 2  # disabled

tests/integration_tests/game_layer/observations/test_software_observations.py

@@ -0,0 +1,66 @@
+import pytest
+
+from primaite.game.agent.observations.software_observation import ApplicationObservation, ServiceObservation
+from primaite.simulator.network.hardware.nodes.host.computer import Computer
+from primaite.simulator.sim_container import Simulation
+from primaite.simulator.system.applications.database_client import DatabaseClient
+from primaite.simulator.system.applications.web_browser import WebBrowser
+from primaite.simulator.system.services.ntp.ntp_server import NTPServer
+
+
+@pytest.fixture(scope="function")
+def simulation(example_network) -> Simulation:
+    sim = Simulation()
+
+    # set simulation network as example network
+    sim.network = example_network
+
+    return sim
+
+
+def test_service_observation(simulation):
+    """Test the service observation."""
+    pc: Computer = simulation.network.get_node_by_hostname("client_1")
+    # install software on the computer
+    pc.software_manager.install(NTPServer)
+
+    ntp_server = pc.software_manager.software.get("NTPServer")
+    assert ntp_server
+
+    service_obs = ServiceObservation(where=["network", "nodes", pc.hostname, "services", "NTPServer"])
+
+    observation_state = service_obs.observe(simulation.describe_state())
+
+    assert observation_state.get("health_status") == 0
+    assert observation_state.get("operating_status") == 1  # running
+
+    ntp_server.restart()
+    observation_state = service_obs.observe(simulation.describe_state())
+    assert observation_state.get("health_status") == 0
+    assert observation_state.get("operating_status") == 6  # resetting
+
+
+def test_application_observation(simulation):
+    """Test the application observation."""
+    pc: Computer = simulation.network.get_node_by_hostname("client_1")
+    # install software on the computer
+    pc.software_manager.install(DatabaseClient)
+
+    web_browser: WebBrowser = pc.software_manager.software.get("WebBrowser")
+    assert web_browser
+
+    app_obs = ApplicationObservation(where=["network", "nodes", pc.hostname, "applications", "WebBrowser"])
+
+    web_browser.close()
+    observation_state = app_obs.observe(simulation.describe_state())
+    assert observation_state.get("health_status") == 0
+    assert observation_state.get("operating_status") == 2  # stopped
+    assert observation_state.get("num_executions") == 0
+
+    web_browser.run()
+    web_browser.scan()  # scan to update health status
+    web_browser.get_webpage("test")
+    observation_state = app_obs.observe(simulation.describe_state())
+    assert observation_state.get("health_status") == 1
+    assert observation_state.get("operating_status") == 1  # running
+    assert observation_state.get("num_executions") == 1