#3060 - Adding version to YAML files within PrimAITE

src/primaite/config/_package_data/basic_lan_network_example.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   ports:
   - ARP

src/primaite/config/_package_data/client_server_p2p_network_example.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   ports:
   - ARP

src/primaite/config/_package_data/data_manipulation.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: false

src/primaite/config/_package_data/data_manipulation_marl.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: false

src/primaite/config/_package_data/mini_scenario_with_simulation_variation/base_scenario.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   max_episode_length: 128
   ports: []

src/primaite/config/_package_data/multi_lan_internet_network_example.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   ports:
   - ARP

src/primaite/config/_package_data/scenario_with_placeholders/scenario.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: false

src/primaite/game/game.py

@@ -247,6 +247,11 @@ class PrimaiteGame:
         game.options = PrimaiteGameOptions(**cfg["game"])
         game.save_step_metadata = cfg.get("io_settings", {}).get("save_step_metadata") or False
 
+        # TODO: Future YAML config should specify the PrimAITE version they are written for.
+        #       For now, we warn that if it is missing, pending a mechanism to handle variations.
+        if not cfg["version"]:
+            _LOGGER.warning("Version definition is missing from provided configuration. ")
+
         # 1. create simulation
         sim = game.simulation
         net = sim.network

tests/assets/configs/action_penalty.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: false
   save_step_metadata: false

tests/assets/configs/bad_primaite_session.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   ports:
   - ARP

tests/assets/configs/basic_c2_setup.yaml

@@ -4,6 +4,8 @@
 #  |  node_a  |------|  switch_1  |------|  node_b  |
 #  --------------      --------------      --------------
 #
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/basic_firewall.yaml

@@ -4,6 +4,7 @@
 #  |  client_1  |------|  switch_1  |------|  client_2  |
 #  --------------      --------------      --------------
 #
+version: 3.0
 
 io_settings:
   save_step_metadata: false

tests/assets/configs/basic_node_with_software_listening_ports.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/basic_node_with_users.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/basic_switched_network.yaml

@@ -4,6 +4,8 @@
 #  |  client_1  |------|  switch_1  |------|  client_2  |
 #  --------------      --------------      --------------
 #
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/data_manipulation.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: false

tests/assets/configs/dmz_network.yaml

@@ -30,6 +30,8 @@
 #                        |  external_computer  |------|  switch_3  |------|  external_server  |
 #                        -----------------------      --------------      ---------------------
 #
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/eval_only_primaite_session.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   ports:
   - ARP

tests/assets/configs/extended_config.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: false

tests/assets/configs/firewall_actions_network.yaml

@@ -30,6 +30,8 @@
 #                        |  external_computer  |------|  switch_3  |------|  external_server  |
 #                        -----------------------      --------------      ---------------------
 #
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/fixing_duration_one_item.yaml

@@ -4,6 +4,8 @@
 #  |  client_1  |------|  switch_1  |------|  client_2  |
 #  --------------      --------------      --------------
 #
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/install_and_configure_apps.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: false

tests/assets/configs/multi_agent_session.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: false
   save_step_metadata: false

tests/assets/configs/nmap_network_service_recon_red_agent_config.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/nmap_ping_scan_red_agent_config.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/nmap_port_scan_red_agent_config.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/no_nodes_links_agents_network.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/scenario_with_placeholders/scenario.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: false

tests/assets/configs/shared_rewards.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: false
   save_step_metadata: false

tests/assets/configs/software_fixing_duration.yaml

@@ -4,6 +4,8 @@
 #  |  client_1  |------|  switch_1  |------|  client_2  |
 #  --------------      --------------      --------------
 #
+version: 3.0
+
 io_settings:
   save_step_metadata: false
   save_pcap_logs: true

tests/assets/configs/test_application_install.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: false

tests/assets/configs/test_primaite_session.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 io_settings:
   save_agent_actions: true
   save_step_metadata: true

tests/assets/configs/wireless_wan_network_config.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   max_episode_length: 256
   ports:

tests/assets/configs/wireless_wan_network_config_freq_max_override.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   max_episode_length: 256
   ports:

tests/assets/configs/wireless_wan_network_config_freq_max_override_blocked.yaml

@@ -1,3 +1,5 @@
+version: 3.0
+
 game:
   max_episode_length: 256
   ports: