scenarios: use initContainer

Author: pinheadmz

resources/charts/commander/templates/pod.yaml

@@ -8,19 +8,30 @@ metadata:
     mission: commander
 spec:
   restartPolicy: {{ .Values.restartPolicy }}
+  initContainers:
+    - name: init
+      image: busybox
+      command: ["/bin/sh", "-c"]
+      args:
+        - |
+          while [ ! -f /shared/archive.pyz ]; do
+            echo "Waiting for /shared/archive.pyz to exist..."
+            sleep 2
+          done
+      volumeMounts:
+        - name: shared-volume
+          mountPath: /shared
   containers:
     - name: {{ .Chart.Name }}
       image: python:3.12-slim
       imagePullPolicy: IfNotPresent
       command: ["/bin/sh", "-c"]
       args:
         - |
-          python3 /archive.pyz {{ .Values.args }}
+          python3 /shared/archive.pyz {{ .Values.args }}
       volumeMounts:
-        - name: warnet
-          mountPath: /warnet.json
-          subPath: warnet.json
+        - name: shared-volume
+          mountPath: /shared
   volumes:
-    - name: warnet
-      configMap:
-        name: {{ include "commander.fullname" . }}-warnet
+    - name: shared-volume
+      emptyDir: {}

resources/scenarios/commander.py

@@ -8,7 +8,6 @@
 import signal
 import sys
 import tempfile
-from pathlib import Path
 from typing import Dict
 
 from test_framework.authproxy import AuthServiceProxy
@@ -21,7 +20,7 @@
 from test_framework.test_node import TestNode
 from test_framework.util import PortSeed, get_rpc_proxy
 
-WARNET_FILE = Path("/warnet.json")
+WARNET_FILE = "/shared/warnet.json"
 
 try:
     with open(WARNET_FILE) as file:

resources/scenarios/test_buggy_failure.py renamed to resources/scenarios/testscenario_buggy_failure.py

@@ -1,4 +1,3 @@
-import base64
 import io
 import json
 import os
@@ -26,6 +25,8 @@
     pod_log,
     snapshot_bitcoin_datadir,
     wait_for_pod,
+    wait_for_init,
+    write_file_to_container,
 )
 from .process import run_command, stream_command
 
@@ -202,7 +203,7 @@ def run(scenario_file: str, debug: bool, additional_args: tuple[str]):
     ]
 
     # Encode tank data for warnet.json
-    warnet_data = base64.b64encode(json.dumps(tanks).encode()).decode()
+    warnet_data = json.dumps(tanks).encode()
 
     # Create in-memory buffer to store python archive instead of writing to disk
     archive_buffer = io.BytesIO()
@@ -226,8 +227,9 @@ def filter(path):
 
     # Encode the binary data as Base64
     archive_buffer.seek(0)
-    archive_data = base64.b64encode(archive_buffer.read()).decode()
+    archive_data = archive_buffer.read()
 
+    # Start the commander pod with python and init containers
     try:
         # Construct Helm command
         helm_command = [
@@ -238,8 +240,6 @@ def filter(path):
             namespace,
             "--set",
             f"fullnameOverride={name}",
-            "--set",
-            f"warnet={warnet_data}",
         ]
 
         # Add additional arguments
@@ -252,19 +252,24 @@ def filter(path):
         result = subprocess.run(helm_command, check=True, capture_output=True, text=True)
 
         if result.returncode == 0:
-            print(f"Successfully started scenario: {scenario_name}")
+            print(f"Successfully deployed scenario commander: {scenario_name}")
             print(f"Commander pod name: {name}")
         else:
-            print(f"Failed to start scenario: {scenario_name}")
+            print(f"Failed to deploy scenario commander: {scenario_name}")
             print(f"Error: {result.stderr}")
 
     except subprocess.CalledProcessError as e:
-        print(f"Failed to start scenario: {scenario_name}")
+        print(f"Failed to deploy scenario commander: {scenario_name}")
         print(f"Error: {e.stderr}")
 
+    # upload scenario files and network data to the init container
+    wait_for_init(name)
+    if write_file_to_container(
+        name, "init", "/shared/warnet.json", warnet_data
+    ) and write_file_to_container(name, "init", "/shared/archive.pyz", archive_data):
+        print(f"Successfully uploaded scenario data to commander: {scenario_name}")
+
     if debug:
-        print("Waiting for commander pod to start...")
-        wait_for_pod(name)
         _logs(pod_name=name, follow=True)
         print("Deleting pod...")
         delete_pod(name)

resources/scenarios/test_connect_dag.py renamed to resources/scenarios/testscenario_connect_dag.py

@@ -264,6 +264,24 @@ def wait_for_pod_ready(name, namespace, timeout=300):
     return False
 
 
+def wait_for_init(pod_name, timeout=300):
+    sclient = get_static_client()
+    namespace = get_default_namespace()
+    w = watch.Watch()
+    for event in w.stream(
+        sclient.list_namespaced_pod, namespace=namespace, timeout_seconds=timeout
+    ):
+        pod = event["object"]
+        if pod.metadata.name == pod_name:
+            for init_container_status in pod.status.init_container_statuses:
+                if init_container_status.state.running:
+                    print(f"initContainer in pod {pod_name} is ready")
+                    w.stop()
+                    return True
+    print(f"Timeout waiting for initContainer in {pod_name} to be ready.")
+    return False
+
+
 def wait_for_ingress_controller(timeout=300):
     # get name of ingress controller pod
     sclient = get_static_client()
@@ -308,3 +326,28 @@ def wait_for_pod(pod_name, timeout_seconds=10):
             return
         sleep(1)
         timeout_seconds -= 1
+
+
+def write_file_to_container(pod_name, container_name, dst_path, data):
+    sclient = get_static_client()
+    namespace = get_default_namespace()
+    exec_command = ["sh", "-c", f"cat > {dst_path}"]
+    try:
+        res = stream(
+            sclient.connect_get_namespaced_pod_exec,
+            pod_name,
+            namespace,
+            command=exec_command,
+            container=container_name,
+            stdin=True,
+            stderr=True,
+            stdout=True,
+            tty=False,
+            _preload_content=False,
+        )
+        res.write_stdin(data)
+        res.close()
+        print(f"Successfully copied data to {pod_name}({container_name}):{dst_path}")
+        return True
+    except Exception as e:
+        print(f"Failed to copy data to {pod_name}({container_name}):{dst_path}:\n{e}")

resources/scenarios/test_p2p_interface.py renamed to resources/scenarios/testscenario_p2p_interface.py

@@ -44,7 +44,7 @@ def copy_scenario_defaults(directory: Path):
         directory,
         SCENARIOS_DIR.name,
         SCENARIOS_DIR,
-        ["__pycache__", "TEST_*.py"],
+        ["__pycache__", "testscenario_*.py"],
     )
 
 

src/warnet/control.py

@@ -10,6 +10,7 @@ class DAGConnectionTest(TestBase):
     def __init__(self):
         super().__init__()
         self.network_dir = Path(os.path.dirname(__file__)) / "data" / "ten_semi_unconnected"
+        self.scen_dir = Path(os.path.dirname(__file__)).parent / "resources" / "scenarios"
 
     def run_test(self):
         try:
@@ -25,8 +26,9 @@ def setup_network(self):
         self.wait_for_all_edges()
 
     def run_connect_dag_scenario(self):
-        self.log.info("Running connect_dag scenario")
-        self.warnet("run resources/scenarios/TEST_connect_dag.py")
+        scenario_file = self.scen_dir / "testscenario_connect_dag.py"
+        self.log.info(f"Running scenario from: {scenario_file}")
+        self.warnet(f"run {scenario_file}")
         self.wait_for_all_scenarios()
 
 

src/warnet/k8s.py

@@ -14,6 +14,7 @@ class ScenariosTest(TestBase):
     def __init__(self):
         super().__init__()
         self.network_dir = Path(os.path.dirname(__file__)) / "data" / "12_node_ring"
+        self.scen_dir = Path(os.path.dirname(__file__)).parent / "resources" / "scenarios"
 
     def run_test(self):
         try:
@@ -71,7 +72,7 @@ def check_blocks(self, target_blocks, start: int = 0):
         return count >= start + target_blocks
 
     def run_and_check_miner_scenario_from_file(self):
-        scenario_file = "resources/scenarios/miner_std.py"
+        scenario_file = self.scen_dir / "miner_std.py"
         self.log.info(f"Running scenario from file: {scenario_file}")
         self.warnet(f"run {scenario_file} --allnodes --interval=1")
         start = int(self.warnet("bitcoin rpc tank-0000 getblockcount"))
@@ -82,19 +83,19 @@ def run_and_check_miner_scenario_from_file(self):
         self.stop_scenario()
 
     def run_and_check_scenario_from_file(self):
-        scenario_file = "resources/scenarios/TEST_p2p_interface.py"
+        scenario_file = self.scen_dir / "testscenario_p2p_interface.py"
         self.log.info(f"Running scenario from: {scenario_file}")
         self.warnet(f"run {scenario_file}")
         self.wait_for_predicate(self.check_scenario_clean_exit)
 
     def check_regtest_recon(self):
-        scenario_file = "resources/scenarios/reconnaissance.py"
+        scenario_file = self.scen_dir / "reconnaissance.py"
         self.log.info(f"Running scenario from file: {scenario_file}")
         self.warnet(f"run {scenario_file}")
         self.wait_for_predicate(self.check_scenario_clean_exit)
 
     def check_active_count(self):
-        scenario_file = "resources/scenarios/TEST_buggy_failure.py"
+        scenario_file = self.scen_dir / "testscenario_buggy_failure.py"
         self.log.info(f"Running scenario from: {scenario_file}")
         self.warnet(f"run {scenario_file}")