#3062 - First pass at unifying naming convention for discriminators (still errors) [skip ci]

tests/unit_tests/_primaite/_game/_agent/test_actions.py

@@ -21,7 +21,7 @@ from primaite.game.agent.actions.service import (
 def test_do_nothing_action_form_request():
     """Test that the do_nothingAction can form a request and that it is correct."""
     request = DoNothingAction.form_request(DoNothingAction.ConfigSchema())
-    assert request == ["do_nothing"]
+    assert request == ["do-nothing"]
 
 
 @pytest.mark.parametrize(

tests/unit_tests/_primaite/_game/_agent/test_agent.py

@@ -13,15 +13,15 @@ def test_creating_empty_agent():
 def test_creating_agent_from_dict():
     action_config = {
         "action_map": {
-            0: {"action": "do_nothing", "options": {}},
+            0: {"action": "do-nothing", "options": {}},
             1: {
-                "action": "node_application_execute",
+                "action": "node-application-execute",
                 "options": {"node_name": "client", "application_name": "database"},
             },
         }
     }
     observation_config = {
-        "type": "FILE",
+        "type": "file",
         "options": {
             "file_name": "dog.pdf",
             "include_num_access": False,
@@ -31,7 +31,7 @@ def test_creating_agent_from_dict():
     reward_config = {
         "reward_components": [
             {
-                "type": "DATABASE_FILE_INTEGRITY",
+                "type": "database-file-integrity",
                 "weight": 0.3,
                 "options": {"node_hostname": "server", "folder_name": "database", "file_name": "database.db"},
             }

tests/unit_tests/_primaite/_game/_agent/test_observations.py

@@ -21,17 +21,17 @@ class TestFileSystemRequiresScan:
     def test_obs_config(self, yaml_option_string, expected_val):
         """Check that the default behaviour is to set FileSystemRequiresScan to True."""
         obs_cfg_yaml = f"""
-      type: CUSTOM
+      type: custom
       options:
         components:
-          - type: NODES
+          - type: nodes
             label: NODES
             options:
               hosts:
                 - hostname: domain_controller
                 - hostname: web_server
                   services:
-                    - service_name: WebServer
+                    - service_name: web-server
                 - hostname: database_server
                   folders:
                     - folder_name: database
@@ -77,7 +77,7 @@ class TestFileSystemRequiresScan:
                 - UDP
               num_rules: 10
 
-          - type: LINKS
+          - type: links
             label: LINKS
             options:
               link_references:
@@ -91,7 +91,7 @@ class TestFileSystemRequiresScan:
                 - switch_2:eth-1<->client_1:eth-1
                 - switch_2:eth-2<->client_2:eth-1
                 - switch_2:eth-7<->security_suite:eth-2
-          - type: "NONE"
+          - type: "none"
             label: ICS
             options: {{}}
 

tests/unit_tests/_primaite/_game/_agent/test_probabilistic_agent.py

@@ -28,13 +28,13 @@ def test_probabilistic_agent():
 
     action_space_cfg = {
         "action_map": {
-            0: {"action": "do_nothing", "options": {}},
+            0: {"action": "do-nothing", "options": {}},
             1: {
-                "action": "node_application_execute",
-                "options": {"node_name": "client_1", "application_name": "WebBrowser"},
+                "action": "node-application-execute",
+                "options": {"node_name": "client_1", "application_name": "web-browser"},
             },
             2: {
-                "action": "node_file_delete",
+                "action": "node-file-delete",
                 "options": {"node_name": "client_1", "folder_name": "downloads", "file_name": "cat.png"},
             },
         },
@@ -44,8 +44,8 @@ def test_probabilistic_agent():
     game.options = PrimaiteGameOptions(ports=[], protocols=[])
 
     pa_config = {
-        "type": "ProbabilisticAgent",
-        "ref": "ProbabilisticAgent",
+        "type": "probabilistic-agent",
+        "ref": "probabilistic-agent",
         "team": "BLUE",
         "action_space": action_space_cfg,
         "agent_settings": {
@@ -60,11 +60,11 @@ def test_probabilistic_agent():
     node_file_delete_count = 0
     for _ in range(N_TRIALS):
         a = pa.get_action(0)
-        if a == ("do_nothing", {}):
+        if a == ("do-nothing", {}):
             do_nothing_count += 1
-        elif a == ("node_application_execute", {"node_name": "client_1", "application_name": "WebBrowser"}):
+        elif a == ("node-application-execute", {"node_name": "client_1", "application_name": "web-browser"}):
             node_application_execute_count += 1
-        elif a == ("node_file_delete", {"node_name": "client_1", "folder_name": "downloads", "file_name": "cat.png"}):
+        elif a == ("node-file-delete", {"node_name": "client_1", "folder_name": "downloads", "file_name": "cat.png"}):
             node_file_delete_count += 1
         else:
             raise AssertionError("Probabilistic agent produced an unexpected action.")

tests/unit_tests/_primaite/_game/_agent/test_sticky_rewards.py

@@ -81,22 +81,22 @@ class TestWebpageUnavailabilitySticky:
         reward = WebpageUnavailablePenalty(config=schema)
 
         # no response codes yet, reward is 0
-        action, params, request = "do_nothing", {}, ["do_nothing"]
+        action, params, request = "do-nothing", {}, ["do-nothing"]
         response = RequestResponse(status="success", data={})
         browser_history = []
-        state = {"network": {"nodes": {"computer": {"applications": {"WebBrowser": {"history": browser_history}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"web-browser": {"history": browser_history}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == 0
 
         # agent did a successful fetch
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "WebBrowser"}
-        request = ["network", "node", "computer", "application", "WebBrowser", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "web-browser"}
+        request = ["network", "node", "computer", "application", "web-browser", "execute"]
         response = RequestResponse(status="success", data={})
         browser_history.append({"outcome": 200})
-        state = {"network": {"nodes": {"computer": {"applications": {"WebBrowser": {"history": browser_history}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"web-browser": {"history": browser_history}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
@@ -104,34 +104,34 @@ class TestWebpageUnavailabilitySticky:
 
         # THE IMPORTANT BIT
         # agent did nothing, because reward is not sticky, it goes back to 0
-        action, params, request = "do_nothing", {}, ["do_nothing"]
+        action, params, request = "do-nothing", {}, ["do-nothing"]
         response = RequestResponse(status="success", data={})
         browser_history = []
-        state = {"network": {"nodes": {"computer": {"applications": {"WebBrowser": {"history": browser_history}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"web-browser": {"history": browser_history}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == 0.0
 
         # agent fails to fetch, get a -1.0 reward
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "WebBrowser"}
-        request = ["network", "node", "computer", "application", "WebBrowser", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "web-browser"}
+        request = ["network", "node", "computer", "application", "web-browser", "execute"]
         response = RequestResponse(status="failure", data={})
         browser_history.append({"outcome": 404})
-        state = {"network": {"nodes": {"computer": {"applications": {"WebBrowser": {"history": browser_history}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"web-browser": {"history": browser_history}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == -1.0
 
         # agent fails again to fetch, get a -1.0 reward again
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "WebBrowser"}
-        request = ["network", "node", "computer", "application", "WebBrowser", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "web-browser"}
+        request = ["network", "node", "computer", "application", "web-browser", "execute"]
         response = RequestResponse(status="failure", data={})
         browser_history.append({"outcome": 404})
-        state = {"network": {"nodes": {"computer": {"applications": {"WebBrowser": {"history": browser_history}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"web-browser": {"history": browser_history}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
@@ -142,22 +142,22 @@ class TestWebpageUnavailabilitySticky:
         reward = WebpageUnavailablePenalty(config=schema)
 
         # no response codes yet, reward is 0
-        action, params, request = "do_nothing", {}, ["do_nothing"]
+        action, params, request = "do-nothing", {}, ["do-nothing"]
         response = RequestResponse(status="success", data={})
         browser_history = []
-        state = {"network": {"nodes": {"computer": {"applications": {"WebBrowser": {"history": browser_history}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"web-browser": {"history": browser_history}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == 0
 
         # agent did a successful fetch
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "WebBrowser"}
-        request = ["network", "node", "computer", "application", "WebBrowser", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "web-browser"}
+        request = ["network", "node", "computer", "application", "web-browser", "execute"]
         response = RequestResponse(status="success", data={})
         browser_history.append({"outcome": 200})
-        state = {"network": {"nodes": {"computer": {"applications": {"WebBrowser": {"history": browser_history}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"web-browser": {"history": browser_history}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
@@ -165,33 +165,33 @@ class TestWebpageUnavailabilitySticky:
 
         # THE IMPORTANT BIT
         # agent did nothing, because reward is sticky, it stays at 1.0
-        action, params, request = "do_nothing", {}, ["do_nothing"]
+        action, params, request = "do-nothing", {}, ["do-nothing"]
         response = RequestResponse(status="success", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"WebBrowser": {"history": browser_history}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"web-browser": {"history": browser_history}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == 1.0
 
         # agent fails to fetch, get a -1.0 reward
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "WebBrowser"}
-        request = ["network", "node", "computer", "application", "WebBrowser", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "web-browser"}
+        request = ["network", "node", "computer", "application", "web-browser", "execute"]
         response = RequestResponse(status="failure", data={})
         browser_history.append({"outcome": 404})
-        state = {"network": {"nodes": {"computer": {"applications": {"WebBrowser": {"history": browser_history}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"web-browser": {"history": browser_history}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == -1.0
 
         # agent fails again to fetch, get a -1.0 reward again
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "WebBrowser"}
-        request = ["network", "node", "computer", "application", "WebBrowser", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "web-browser"}
+        request = ["network", "node", "computer", "application", "web-browser", "execute"]
         response = RequestResponse(status="failure", data={})
         browser_history.append({"outcome": 404})
-        state = {"network": {"nodes": {"computer": {"applications": {"WebBrowser": {"history": browser_history}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"web-browser": {"history": browser_history}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
@@ -207,20 +207,20 @@ class TestGreenAdminDatabaseUnreachableSticky:
         reward = GreenAdminDatabaseUnreachablePenalty(config=schema)
 
         # no response codes yet, reward is 0
-        action, params, request = "do_nothing", {}, ["do_nothing"]
+        action, params, request = "do-nothing", {}, ["do-nothing"]
         response = RequestResponse(status="success", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"DatabaseClient": {}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"database-client": {}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == 0
 
         # agent did a successful fetch
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "DatabaseClient"}
-        request = ["network", "node", "computer", "application", "DatabaseClient", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "database-client"}
+        request = ["network", "node", "computer", "application", "database-client", "execute"]
         response = RequestResponse(status="success", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"DatabaseClient": {}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"database-client": {}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
@@ -228,31 +228,31 @@ class TestGreenAdminDatabaseUnreachableSticky:
 
         # THE IMPORTANT BIT
         # agent did nothing, because reward is not sticky, it goes back to 0
-        action, params, request = "do_nothing", {}, ["do_nothing"]
+        action, params, request = "do-nothing", {}, ["do-nothing"]
         response = RequestResponse(status="success", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"DatabaseClient": {}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"database-client": {}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == 0.0
 
         # agent fails to fetch, get a -1.0 reward
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "DatabaseClient"}
-        request = ["network", "node", "computer", "application", "DatabaseClient", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "database-client"}
+        request = ["network", "node", "computer", "application", "database-client", "execute"]
         response = RequestResponse(status="failure", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"DatabaseClient": {}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"database-client": {}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == -1.0
 
         # agent fails again to fetch, get a -1.0 reward again
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "DatabaseClient"}
-        request = ["network", "node", "computer", "application", "DatabaseClient", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "database-client"}
+        request = ["network", "node", "computer", "application", "database-client", "execute"]
         response = RequestResponse(status="failure", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"DatabaseClient": {}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"database-client": {}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
@@ -266,20 +266,20 @@ class TestGreenAdminDatabaseUnreachableSticky:
         reward = GreenAdminDatabaseUnreachablePenalty(config=schema)
 
         # no response codes yet, reward is 0
-        action, params, request = "do_nothing", {}, ["do_nothing"]
+        action, params, request = "do-nothing", {}, ["do-nothing"]
         response = RequestResponse(status="success", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"DatabaseClient": {}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"database-client": {}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == 0
 
         # agent did a successful fetch
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "DatabaseClient"}
-        request = ["network", "node", "computer", "application", "DatabaseClient", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "database-client"}
+        request = ["network", "node", "computer", "application", "database-client", "execute"]
         response = RequestResponse(status="success", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"DatabaseClient": {}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"database-client": {}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
@@ -287,31 +287,31 @@ class TestGreenAdminDatabaseUnreachableSticky:
 
         # THE IMPORTANT BIT
         # agent did nothing, because reward is not sticky, it goes back to 0
-        action, params, request = "do_nothing", {}, ["do_nothing"]
+        action, params, request = "do-nothing", {}, ["do-nothing"]
         response = RequestResponse(status="success", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"DatabaseClient": {}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"database-client": {}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == 1.0
 
         # agent fails to fetch, get a -1.0 reward
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "DatabaseClient"}
-        request = ["network", "node", "computer", "application", "DatabaseClient", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "database-client"}
+        request = ["network", "node", "computer", "application", "database-client", "execute"]
         response = RequestResponse(status="failure", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"DatabaseClient": {}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"database-client": {}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )
         assert reward.calculate(state, last_action_response) == -1.0
 
         # agent fails again to fetch, get a -1.0 reward again
-        action = "node_application_execute"
-        params = {"node_name": "computer", "application_name": "DatabaseClient"}
-        request = ["network", "node", "computer", "application", "DatabaseClient", "execute"]
+        action = "node-application-execute"
+        params = {"node_name": "computer", "application_name": "database-client"}
+        request = ["network", "node", "computer", "application", "database-client", "execute"]
         response = RequestResponse(status="failure", data={})
-        state = {"network": {"nodes": {"computer": {"applications": {"DatabaseClient": {}}}}}}
+        state = {"network": {"nodes": {"computer": {"applications": {"database-client": {}}}}}}
         last_action_response = AgentHistoryItem(
             timestep=0, action=action, parameters=params, request=request, response=response
         )