#2912 - Merge in changes on target branch

2025-01-03 14:48:18 +00:00
parent ab2dd6ca27 eb91721518
commit e653afaa4c
407 changed files with 664 additions and 671 deletions
--- a/tests/integration_tests/game_layer/actions/init.py
+++ b/tests/integration_tests/game_layer/actions/init.py
@@ -1 +1 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
--- a/tests/integration_tests/game_layer/actions/test_application_request_permission.py
+++ b/tests/integration_tests/game_layer/actions/test_application_request_permission.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from typing import Tuple

 import pytest
--- a/tests/integration_tests/game_layer/actions/test_c2_suite_actions.py
+++ b/tests/integration_tests/game_layer/actions/test_c2_suite_actions.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address
 from typing import Tuple

--- a/tests/integration_tests/game_layer/actions/test_configure_actions.py
+++ b/tests/integration_tests/game_layer/actions/test_configure_actions.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from ipaddress import IPv4Address

 import pytest
--- a/tests/integration_tests/game_layer/actions/test_file_request_permission.py
+++ b/tests/integration_tests/game_layer/actions/test_file_request_permission.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import uuid
 from typing import Tuple

--- a/tests/integration_tests/game_layer/actions/test_folder_request_permission.py
+++ b/tests/integration_tests/game_layer/actions/test_folder_request_permission.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import uuid
 from typing import Tuple

--- a/tests/integration_tests/game_layer/actions/test_nic_request_permission.py
+++ b/tests/integration_tests/game_layer/actions/test_nic_request_permission.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from typing import Tuple

 import pytest
--- a/tests/integration_tests/game_layer/actions/test_node_request_permission.py
+++ b/tests/integration_tests/game_layer/actions/test_node_request_permission.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from typing import Tuple

 import pytest
--- a/tests/integration_tests/game_layer/actions/test_service_request_permission.py
+++ b/tests/integration_tests/game_layer/actions/test_service_request_permission.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from typing import Tuple

 import pytest
--- a/tests/integration_tests/game_layer/actions/test_terminal_actions.py
+++ b/tests/integration_tests/game_layer/actions/test_terminal_actions.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from typing import Tuple

 import pytest
--- a/tests/integration_tests/game_layer/observations/init.py
+++ b/tests/integration_tests/game_layer/observations/init.py
@@ -1 +1 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
--- a/tests/integration_tests/game_layer/observations/test_acl_observations.py
+++ b/tests/integration_tests/game_layer/observations/test_acl_observations.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.game.agent.observations.acl_observation import ACLObservation
--- a/tests/integration_tests/game_layer/observations/test_file_system_observations.py
+++ b/tests/integration_tests/game_layer/observations/test_file_system_observations.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import pytest
 from gymnasium import spaces

--- a/tests/integration_tests/game_layer/observations/test_firewall_observation.py
+++ b/tests/integration_tests/game_layer/observations/test_firewall_observation.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from primaite.game.agent.observations.firewall_observation import FirewallObservation
 from primaite.simulator.network.container import Network
 from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
--- a/tests/integration_tests/game_layer/observations/test_link_observations.py
+++ b/tests/integration_tests/game_layer/observations/test_link_observations.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import pytest
 from gymnasium import spaces

--- a/tests/integration_tests/game_layer/observations/test_nic_observations.py
+++ b/tests/integration_tests/game_layer/observations/test_nic_observations.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from pathlib import Path
 from typing import Union

--- a/tests/integration_tests/game_layer/observations/test_node_observations.py
+++ b/tests/integration_tests/game_layer/observations/test_node_observations.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import copy
 from uuid import uuid4

--- a/tests/integration_tests/game_layer/observations/test_router_observation.py
+++ b/tests/integration_tests/game_layer/observations/test_router_observation.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from pprint import pprint

 from primaite.game.agent.observations.acl_observation import ACLObservation
--- a/tests/integration_tests/game_layer/observations/test_software_observations.py
+++ b/tests/integration_tests/game_layer/observations/test_software_observations.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import pytest
 from gymnasium import spaces

--- a/tests/integration_tests/game_layer/observations/test_user_observations.py
+++ b/tests/integration_tests/game_layer/observations/test_user_observations.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import pytest

 from primaite.session.environment import PrimaiteGymEnv
--- a/tests/integration_tests/game_layer/test_RNG_seed.py
+++ b/tests/integration_tests/game_layer/test_RNG_seed.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from pprint import pprint

 import pytest
--- a/tests/integration_tests/game_layer/test_action_mask.py
+++ b/tests/integration_tests/game_layer/test_action_mask.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from primaite.session.environment import PrimaiteGymEnv
 from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
 from primaite.simulator.network.hardware.nodes.host.host_node import HostNode
--- a/tests/integration_tests/game_layer/test_actions.py
+++ b/tests/integration_tests/game_layer/test_actions.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 # Plan for creating integration tests for the actions:
 # I need to test that the requests coming out of the actions have the intended effect on the simulation.
 # I can do this by creating a simulation, and then running the action on the simulation, and then checking
--- a/tests/integration_tests/game_layer/test_observations.py
+++ b/tests/integration_tests/game_layer/test_observations.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 from gymnasium import spaces

 from primaite.game.agent.observations.file_system_observations import FileObservation
--- a/tests/integration_tests/game_layer/test_rewards.py
+++ b/tests/integration_tests/game_layer/test_rewards.py
@@ -1,4 +1,4 @@
-# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2025, Defence Science and Technology Laboratory UK
 import pytest
 import yaml

@@ -18,12 +18,14 @@ from tests import TEST_ASSETS_ROOT
 from tests.conftest import ControlledAgent


-def test_WebpageUnavailablePenalty(game_and_agent):
+def test_WebpageUnavailablePenalty(game_and_agent: tuple[PrimaiteGame, ControlledAgent]):
    """Test that we get the right reward for failing to fetch a website."""
    # set up the scenario, configure the web browser to the correct url
    game, agent = game_and_agent
    agent: ControlledAgent
-    comp = WebpageUnavailablePenalty(node_hostname="client_1")
+    schema = WebpageUnavailablePenalty.ConfigSchema(node_hostname="client_1", sticky=True)
+    comp = WebpageUnavailablePenalty(config=schema)
+
    client_1 = game.simulation.network.get_node_by_hostname("client_1")
    browser: WebBrowser = client_1.software_manager.software.get("WebBrowser")
    browser.run()
@@ -53,7 +55,7 @@ def test_WebpageUnavailablePenalty(game_and_agent):
    assert agent.reward_function.current_reward == -0.7


-def test_uc2_rewards(game_and_agent):
+def test_uc2_rewards(game_and_agent: tuple[PrimaiteGame, ControlledAgent]):
    """Test that the reward component correctly applies a penalty when the selected client cannot reach the database."""
    game, agent = game_and_agent
    agent: ControlledAgent
@@ -74,7 +76,8 @@ def test_uc2_rewards(game_and_agent):
        ACLAction.PERMIT, src_port=PORT_LOOKUP["POSTGRES_SERVER"], dst_port=PORT_LOOKUP["POSTGRES_SERVER"], position=2
    )

-    comp = GreenAdminDatabaseUnreachablePenalty("client_1")
+    schema = GreenAdminDatabaseUnreachablePenalty.ConfigSchema(node_hostname="client_1", sticky=True)
+    comp = GreenAdminDatabaseUnreachablePenalty(config=schema)

    request = ["network", "node", "client_1", "application", "DatabaseClient", "execute"]
    response = game.simulation.apply_request(request)
@@ -139,15 +142,17 @@ def test_action_penalty_loads_from_config():
            act_penalty_obj = comp[0]
    if act_penalty_obj is None:
        pytest.fail("Action penalty reward component was not added to the agent from config.")
-    assert act_penalty_obj.action_penalty == -0.75
-    assert act_penalty_obj.do_nothing_penalty == 0.125
+    assert act_penalty_obj.config.action_penalty == -0.75
+    assert act_penalty_obj.config.do_nothing_penalty == 0.125


 def test_action_penalty():
    """Test that the action penalty is correctly applied when agent performs any action"""

    # Create an ActionPenalty Reward
-    Penalty = ActionPenalty(action_penalty=-0.75, do_nothing_penalty=0.125)
+    schema = ActionPenalty.ConfigSchema(action_penalty=-0.75, do_nothing_penalty=0.125)
+    # Penalty = ActionPenalty(action_penalty=-0.75, do_nothing_penalty=0.125)
+    Penalty = ActionPenalty(config=schema)

    # Assert that penalty is applied if action isn't do_nothing
    reward_value = Penalty.calculate(
@@ -178,11 +183,12 @@ def test_action_penalty():
    assert reward_value == 0.125


-def test_action_penalty_e2e(game_and_agent):
+def test_action_penalty_e2e(game_and_agent: tuple[PrimaiteGame, ControlledAgent]):
    """Test that we get the right reward for doing actions to fetch a website."""
    game, agent = game_and_agent
    agent: ControlledAgent
-    comp = ActionPenalty(action_penalty=-0.75, do_nothing_penalty=0.125)
+    schema = ActionPenalty.ConfigSchema(action_penalty=-0.75, do_nothing_penalty=0.125)
+    comp = ActionPenalty(config=schema)

    agent.reward_function.register_component(comp, 1.0)