#2445: added the ability to pass the game options thresholds to observations so that relevant observation items can retrieve the thresholds from config

tests/assets/configs/basic_switched_network.yaml

@@ -25,7 +25,19 @@ game:
   - ICMP
   - TCP
   - UDP
-
+  thresholds:
+    nmne:
+      high: 100
+      medium: 25
+      low: 5
+    file_access:
+      high: 10
+      medium: 5
+      low: 2
+    app_executions:
+      high: 5
+      medium: 3
+      low: 2
 agents:
   - ref: client_2_green_user
     team: GREEN
@@ -79,10 +91,16 @@ agents:
             options:
               hosts:
                 - hostname: client_1
+                  applications:
+                    - application_name: WebBrowser
+                  folders:
+                    - folder_name: root
+                      files:
+                        - file_name: "test.txt"
                 - hostname: client_2
                 - hostname: client_3
               num_services: 1
-              num_applications: 0
+              num_applications: 1
               num_folders: 1
               num_files: 1
               num_nics: 2
@@ -219,6 +237,9 @@ simulation:
         options:
           ntp_server_ip: 192.168.1.10
       - type: NTPServer
+      file_system:
+        - root:
+          - "test.txt"
     - hostname: client_2
       type: computer
       ip_address: 192.168.10.22

tests/integration_tests/configuration_file_parsing/test_game_options_config.py

@@ -8,7 +8,7 @@ from primaite.config.load import data_manipulation_config_path
 from primaite.game.game import PrimaiteGame
 from tests import TEST_ASSETS_ROOT
 
-BASIC_CONFIG = TEST_ASSETS_ROOT / "configs/basic_switched_network.yaml"
+BASIC_SWITCHED_NETWORK_CONFIG = TEST_ASSETS_ROOT / "configs/basic_switched_network.yaml"
 
 
 def load_config(config_path: Union[str, Path]) -> PrimaiteGame:
@@ -24,3 +24,42 @@ def test_thresholds():
     game = load_config(data_manipulation_config_path())
 
     assert game.options.thresholds is not None
+
+
+def test_nmne_threshold():
+    """Test that the NMNE thresholds are properly loaded in by observation."""
+    game = load_config(BASIC_SWITCHED_NETWORK_CONFIG)
+
+    assert game.options.thresholds["nmne"] is not None
+
+    # get NIC observation
+    nic_obs = game.agents["defender"].observation_manager.obs.components["NODES"].hosts[0].nics[0]
+    assert nic_obs.low_threshold == 5
+    assert nic_obs.med_threshold == 25
+    assert nic_obs.high_threshold == 100
+
+
+def test_file_access_threshold():
+    """Test that the NMNE thresholds are properly loaded in by observation."""
+    game = load_config(BASIC_SWITCHED_NETWORK_CONFIG)
+
+    assert game.options.thresholds["file_access"] is not None
+
+    # get file observation
+    file_obs = game.agents["defender"].observation_manager.obs.components["NODES"].hosts[0].folders[0].files[0]
+    assert file_obs.low_threshold == 2
+    assert file_obs.med_threshold == 5
+    assert file_obs.high_threshold == 10
+
+
+def test_app_executions_threshold():
+    """Test that the NMNE thresholds are properly loaded in by observation."""
+    game = load_config(BASIC_SWITCHED_NETWORK_CONFIG)
+
+    assert game.options.thresholds["app_executions"] is not None
+
+    # get application observation
+    app_obs = game.agents["defender"].observation_manager.obs.components["NODES"].hosts[0].applications[0]
+    assert app_obs.low_threshold == 2
+    assert app_obs.med_threshold == 3
+    assert app_obs.high_threshold == 5

tests/integration_tests/game_layer/observations/test_file_system_observations.py

@@ -44,6 +44,38 @@ def test_file_observation(simulation):
     assert observation_state.get("health_status") == 3  # corrupted
 
 
+def test_config_file_access_categories(simulation):
+    pc: Computer = simulation.network.get_node_by_hostname("client_1")
+    file_obs = FileObservation(
+        where=["network", "nodes", pc.hostname, "file_system", "folders", "root", "files", "dog.png"],
+        include_num_access=False,
+        file_system_requires_scan=True,
+        thresholds={"file_access": {"low": 3, "medium": 6, "high": 9}},
+    )
+
+    assert file_obs.high_threshold == 9
+    assert file_obs.med_threshold == 6
+    assert file_obs.low_threshold == 3
+
+    with pytest.raises(Exception):
+        # should throw an error
+        FileObservation(
+            where=["network", "nodes", pc.hostname, "file_system", "folders", "root", "files", "dog.png"],
+            include_num_access=False,
+            file_system_requires_scan=True,
+            thresholds={"file_access": {"low": 9, "medium": 6, "high": 9}},
+        )
+
+    with pytest.raises(Exception):
+        # should throw an error
+        FileObservation(
+            where=["network", "nodes", pc.hostname, "file_system", "folders", "root", "files", "dog.png"],
+            include_num_access=False,
+            file_system_requires_scan=True,
+            thresholds={"file_access": {"low": 3, "medium": 9, "high": 9}},
+        )
+
+
 def test_folder_observation(simulation):
     """Test the folder observation."""
     pc: Computer = simulation.network.get_node_by_hostname("client_1")

tests/integration_tests/game_layer/observations/test_nic_observations.py

@@ -110,33 +110,28 @@ def test_nic_categories(simulation):
 
     nic_obs = NICObservation(where=["network", "nodes", pc.hostname, "NICs", 1], include_nmne=True)
 
-    assert nic_obs.high_nmne_threshold == 10  # default
-    assert nic_obs.med_nmne_threshold == 5  # default
-    assert nic_obs.low_nmne_threshold == 0  # default
+    assert nic_obs.high_threshold == 10  # default
+    assert nic_obs.med_threshold == 5  # default
+    assert nic_obs.low_threshold == 0  # default
 
 
-@pytest.mark.skip(reason="Feature not implemented yet")
 def test_config_nic_categories(simulation):
     pc: Computer = simulation.network.get_node_by_hostname("client_1")
     nic_obs = NICObservation(
         where=["network", "nodes", pc.hostname, "NICs", 1],
-        low_nmne_threshold=3,
-        med_nmne_threshold=6,
-        high_nmne_threshold=9,
+        thresholds={"nmne": {"low": 3, "medium": 6, "high": 9}},
         include_nmne=True,
     )
 
-    assert nic_obs.high_nmne_threshold == 9
-    assert nic_obs.med_nmne_threshold == 6
-    assert nic_obs.low_nmne_threshold == 3
+    assert nic_obs.high_threshold == 9
+    assert nic_obs.med_threshold == 6
+    assert nic_obs.low_threshold == 3
 
     with pytest.raises(Exception):
         # should throw an error
         NICObservation(
             where=["network", "nodes", pc.hostname, "NICs", 1],
-            low_nmne_threshold=9,
-            med_nmne_threshold=6,
-            high_nmne_threshold=9,
+            thresholds={"nmne": {"low": 9, "medium": 6, "high": 9}},
             include_nmne=True,
         )
 
@@ -144,9 +139,7 @@ def test_config_nic_categories(simulation):
         # should throw an error
         NICObservation(
             where=["network", "nodes", pc.hostname, "NICs", 1],
-            low_nmne_threshold=3,
-            med_nmne_threshold=9,
-            high_nmne_threshold=9,
+            thresholds={"nmne": {"low": 3, "medium": 9, "high": 9}},
             include_nmne=True,
         )
 

tests/integration_tests/game_layer/observations/test_software_observations.py

@@ -69,3 +69,30 @@ def test_application_observation(simulation):
     assert observation_state.get("health_status") == 1
     assert observation_state.get("operating_status") == 1  # running
     assert observation_state.get("num_executions") == 1
+
+
+def test_application_executions_categories(simulation):
+    pc: Computer = simulation.network.get_node_by_hostname("client_1")
+
+    app_obs = ApplicationObservation(
+        where=["network", "nodes", pc.hostname, "applications", "WebBrowser"],
+        thresholds={"app_executions": {"low": 3, "medium": 6, "high": 9}},
+    )
+
+    assert app_obs.high_threshold == 9
+    assert app_obs.med_threshold == 6
+    assert app_obs.low_threshold == 3
+
+    with pytest.raises(Exception):
+        # should throw an error
+        ApplicationObservation(
+            where=["network", "nodes", pc.hostname, "applications", "WebBrowser"],
+            thresholds={"app_executions": {"low": 9, "medium": 6, "high": 9}},
+        )
+
+    with pytest.raises(Exception):
+        # should throw an error
+        ApplicationObservation(
+            where=["network", "nodes", pc.hostname, "applications", "WebBrowser"],
+            thresholds={"app_executions": {"low": 3, "medium": 9, "high": 9}},
+        )