Merged PR 308: Fix stubborn logs and default config values

## Summary
Ensure that the logging options are being read correctly from the config. Makes logs actually optional.

Also temporarily disable checkhash and replace it with file scan because checkhash is buggy.

## Test process
By inspection

## Checklist
- [x] PR is linked to a **work item**
- [x] **acceptance criteria** of linked ticket are met
- [x] performed **self-review** of the code
- [ ] written **tests** for any new functionality added with this PR
- [ ] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [ ] updated the **change log**
- [x] ran **pre-commit** checks for code style
- [x] attended to any **TO-DOs** left in the code

Fix some stuff

Related work items: #2382

src/primaite/config/_package_data/data_manipulation.yaml

@@ -11,16 +11,14 @@ training_config:
     - defender
 
 io_settings:
-  save_checkpoints: true
-  checkpoint_interval: 5
   save_agent_actions: true
   save_step_metadata: false
   save_pcap_logs: false
-  save_sys_logs: true
+  save_sys_logs: false
 
 
 game:
-  max_episode_length: 256
+  max_episode_length: 128
   ports:
   - HTTP
   - POSTGRES_SERVER
@@ -323,7 +321,7 @@ agents:
               folder_id: 0
               file_id: 0
           10:
-            action: "NODE_FILE_CHECKHASH"
+            action: "NODE_FILE_SCAN" # CHECKHASH replaced by SCAN - but the behaviour is the same in this context.
             options:
               node_id: 2
               folder_id: 0
@@ -351,7 +349,7 @@ agents:
               node_id: 2
               folder_id: 0
           15:
-            action: "NODE_FOLDER_CHECKHASH"
+            action: "NODE_FOLDER_SCAN" # CHECKHASH replaced by SCAN - but the behaviour is the same in this context.
             options:
               node_id: 2
               folder_id: 0

src/primaite/config/_package_data/data_manipulation_marl.yaml

@@ -4,7 +4,7 @@ training_config:
   seed: 333
   n_learn_episodes: 1
   n_eval_episodes: 5
-  max_steps_per_episode: 256
+  max_steps_per_episode: 128
   deterministic_eval: false
   n_agents: 2
   agent_references:
@@ -22,7 +22,7 @@ io_settings:
 
 
 game:
-  max_episode_length: 256
+  max_episode_length: 128
   ports:
   - ARP
   - DNS
@@ -325,7 +325,7 @@ agents:
               folder_id: 0
               file_id: 0
           10:
-            action: "NODE_FILE_CHECKHASH"
+            action: "NODE_FILE_SCAN" # CHECKHASH replaced by SCAN - but the behaviour is the same in this context.
             options:
               node_id: 2
               folder_id: 0
@@ -353,7 +353,7 @@ agents:
               node_id: 2
               folder_id: 0
           15:
-            action: "NODE_FOLDER_CHECKHASH"
+            action: "NODE_FOLDER_SCAN" # CHECKHASH replaced by SCAN - but the behaviour is the same in this context.
             options:
               node_id: 2
               folder_id: 0
@@ -876,7 +876,7 @@ agents:
               folder_id: 0
               file_id: 0
           10:
-            action: "NODE_FILE_CHECKHASH"
+            action: "NODE_FILE_SCAN" # CHECKHASH replaced by SCAN - but the behaviour is the same in this context.
             options:
               node_id: 2
               folder_id: 0
@@ -904,7 +904,7 @@ agents:
               node_id: 2
               folder_id: 0
           15:
-            action: "NODE_FOLDER_CHECKHASH"
+            action: "NODE_FOLDER_SCAN" # CHECKHASH replaced by SCAN - but the behaviour is the same in this context.
             options:
               node_id: 2
               folder_id: 0

src/primaite/session/io.py

@@ -92,5 +92,5 @@ class PrimaiteIO:
     @classmethod
     def from_config(cls, config: Dict) -> "PrimaiteIO":
         """Create an instance of PrimaiteIO based on a configuration dict."""
-        new = cls()
+        new = cls(settings=cls.Settings(**config))
         return new

src/primaite/simulator/network/hardware/base.py

@@ -108,7 +108,7 @@ class NetworkInterface(SimComponent, ABC):
         """Reset the original state of the SimComponent."""
         super().setup_for_episode(episode=episode)
         self.nmne = {}
-        if episode and self.pcap:
+        if episode and self.pcap and SIM_OUTPUT.save_pcap_logs:
             self.pcap.current_episode = episode
             self.pcap.setup_logger()
         self.enable()

src/primaite/simulator/system/core/packet_capture.py

@@ -49,6 +49,7 @@ class PacketCapture:
 
         self.current_episode: int = 1
 
+        if SIM_OUTPUT.save_pcap_logs:
             self.setup_logger(outbound=False)
             self.setup_logger(outbound=True)
 
@@ -108,6 +109,7 @@ class PacketCapture:
 
         :param frame: The PCAP frame to capture.
         """
+        if SIM_OUTPUT.save_pcap_logs:
             msg = frame.model_dump_json()
             self.inbound_logger.log(level=60, msg=msg)  # Log at custom log level > CRITICAL
 
@@ -117,5 +119,6 @@ class PacketCapture:
 
         :param frame: The PCAP frame to capture.
         """
+        if SIM_OUTPUT.save_pcap_logs:
             msg = frame.model_dump_json()
             self.outbound_logger.log(level=60, msg=msg)  # Log at custom log level > CRITICAL

tests/assets/configs/shared_rewards.yaml

@@ -11,12 +11,10 @@ training_config:
     - defender
 
 io_settings:
-  save_checkpoints: true
+  save_agent_actions: false
-  checkpoint_interval: 5
-  save_agent_actions: true
   save_step_metadata: false
   save_pcap_logs: false
-  save_sys_logs: true
+  save_sys_logs: false
 
 
 game:

tests/assets/configs/test_primaite_session.yaml

@@ -11,8 +11,11 @@ training_config:
     - defender
 
 io_settings:
-  save_checkpoints: true
+  save_agent_actions: true
-  checkpoint_interval: 5
+  save_step_metadata: true
+  save_pcap_logs: true
+  save_sys_logs: true
+
 
 
 game:

tests/e2e_integration_tests/test_primaite_session.py

@@ -31,6 +31,7 @@ class TestPrimaiteSession:
             assert session.env.game.simulation.network
             assert len(session.env.game.simulation.network.nodes) == 10
 
+    @pytest.mark.skip(reason="Session is not being maintained and will be removed in the subsequent beta release.")
     @pytest.mark.parametrize("temp_primaite_session", [[CFG_PATH]], indirect=True)
     def test_start_session(self, temp_primaite_session):
         """Make sure you can go all the way through the session without errors."""