incorporate suggestions

Author: mplsgrant

resources/plugins/simln/charts/simln/Chart.yaml

@@ -1,5 +1,5 @@
 apiVersion: v2
 name: simln
-description: A Helm chart to deploy simln
+description: A Helm chart to deploy SimLN
 version: 0.1.0
 appVersion: "0.1.0"

resources/plugins/simln/charts/simln/files/sim.json

@@ -3,8 +3,6 @@ kind: ConfigMap
 metadata:
   name: {{ include "mychart.fullname" . }}-data
 data:
-  sim.json: |
-    {{ .Files.Get "files/sim.json" | nindent 4 }}
   tls.cert: |
     -----BEGIN CERTIFICATE-----
     MIIB8TCCAZagAwIBAgIUJDsR6mmY+TaO9pCfjtotlbOkzJMwCgYIKoZIzj0EAwIw
@@ -19,11 +17,5 @@ data:
     IQDPofN0fEl5gTwCYhk3nZbjMqJhZ8BsSJ6K8XRhxr7zbwIhAPsgQCFOqUWg632O
     NEO53OQ6CIqnpxSskjsFNH4ZBQOE
     -----END CERTIFICATE-----
-  tls.key: |
-    -----BEGIN EC PRIVATE KEY-----
-    MHcCAQEEIIcFtWTLQv5JaRRxdkPKkO98OrvgeztbZ7h8Ev/4UbE4oAoGCCqGSM49
-    AwEHoUQDQgAEBVltIvaTlAQI/3FFatTqVflZuZdRJ0SmRMSJrFLPtp0fxE7hmteS
-    t6gjQriy90fP8j9OJXBNAjt915kLY4zVvg==
-    -----END EC PRIVATE KEY-----
   admin.macaroon.hex: |
     0201036c6e6402f801030a1062beabbf2a614b112128afa0c0b4fdd61201301a160a0761646472657373120472656164120577726974651a130a04696e666f120472656164120577726974651a170a08696e766f69636573120472656164120577726974651a210a086d616361726f6f6e120867656e6572617465120472656164120577726974651a160a076d657373616765120472656164120577726974651a170a086f6666636861696e120472656164120577726974651a160a076f6e636861696e120472656164120577726974651a140a057065657273120472656164120577726974651a180a067369676e6572120867656e657261746512047265616400000620b17be53e367290871681055d0de15587f6d1cd47d1248fe2662ae27f62cfbdc6

resources/plugins/simln/charts/simln/templates/configmap.yaml

@@ -7,16 +7,20 @@ metadata:
     mission: {{ .Values.name }}
 spec:
   initContainers:
-    - name: "init-container"
+    - name: "init"
       image: "busybox"
       command:
         - "sh"
         - "-c"
       args:
         - >
-          cp /configmap/* /working;
-          cd /working;
-          cat admin.macaroon.hex | xxd -r -p > admin.macaroon
+          cp /configmap/* /working &&
+          cd /working &&
+          cat admin.macaroon.hex | xxd -r -p > admin.macaroon &&
+          while [ ! -f /working/sim.json ]; do
+            echo "Waiting for /working/sim.json to exist..."
+            sleep 1
+          done
       volumeMounts:
         - name: {{ .Values.workingVolume.name }}
           mountPath: {{ .Values.workingVolume.mountPath }}

resources/plugins/simln/charts/simln/templates/pod.yaml

@@ -1,6 +1,6 @@
 import json
 import logging
-import random
+import time
 from pathlib import Path
 from subprocess import run
 from time import sleep
@@ -17,7 +17,9 @@
     get_default_namespace,
     get_mission,
     get_static_client,
+    wait_for_init,
     wait_for_pod,
+    write_file_to_container,
 )
 from warnet.plugins import get_plugins_directory_or
 from warnet.process import run_command
@@ -63,7 +65,7 @@ def warnet_register_plugin(register_command):
 
 
 # The group function name is then used in decorators to create commands. These commands are
-# available to users when the access your plugin from the command line in Warnet.
+# available to users when they access your plugin from the command line in Warnet.
 @simln.command()
 def run_demo():
     """Run the SimLN Plugin demo"""
@@ -128,22 +130,40 @@ def get_example_activity():
 
 def _launch_activity(activity: list[dict], user_dir: Optional[str] = None) -> str:
     """Launch a SimLN chart which includes the `activity`"""
-    random_digits = "".join(random.choices("0123456789", k=10))
     plugin_dir = get_plugins_directory_or(user_dir)
-    _generate_nodes_file(activity, plugin_dir / Path("simln/charts/simln/files/sim.json"))
-    command = f"helm upgrade --install simln-{random_digits} {plugin_dir}/simln/charts/simln"
-    log.info(f"generate activity: {command}")
+
+    timestamp = int(time.time())
+    name = f"simln-{timestamp}"
+
+    command = f"helm upgrade --install {timestamp} {plugin_dir}/simln/charts/simln"
     run_command(command)
-    return f"simln-simln-{random_digits}"
+
+    activity_json = _generate_activity_json(activity)
+    wait_for_init(name, namespace=get_default_namespace(), quiet=True)
+    if write_file_to_container(
+        name,
+        "init",
+        "/working/sim.json",
+        activity_json,
+        namespace=get_default_namespace(),
+        quiet=True,
+    ):
+        return name
+    else:
+        raise SimLNError(f"Could not write sim.json to the init container: {name}")
 
 
 # Take note of how click expects us to explicitly declare command line arguments.
 @simln.command()
 @click.argument("activity", type=str)
 @click.pass_context
 def launch_activity(ctx, activity: str):
-    """Takes a SimLN Activity which is a JSON list of objects."""
-    parsed_activity = json.loads(activity)
+    """Deploys a SimLN Activity which is a JSON list of objects"""
+    try:
+        parsed_activity = json.loads(activity)
+    except json.JSONDecodeError:
+        log.error("Invalid JSON input for activity.")
+        raise click.BadArgumentUsage("Activity must be a valid JSON string.") from None
     user_dir = ctx.obj.get(USER_DIR_TAG)
     print(_launch_activity(parsed_activity, user_dir))
 
@@ -283,7 +303,7 @@ def warnet(cmd: str = "--help"):
     return proc.stdout.decode()
 
 
-def _generate_nodes_file(activity: list[dict], output_file: Path = Path("nodes.json")):
+def _generate_activity_json(activity: list[dict]) -> str:
     nodes = []
 
     for i in get_mission(LIGHTNING_MISSION):
@@ -298,8 +318,7 @@ def _generate_nodes_file(activity: list[dict], output_file: Path = Path("nodes.j
 
     data = {"nodes": nodes, "activity": activity}
 
-    with open(output_file, "w") as f:
-        json.dump(data, f, indent=2)
+    return json.dumps(data, indent=2)
 
 
 def manual_open_channels():
@@ -342,7 +361,7 @@ def wait_for_two_txs():
     warnet("bitcoin rpc tank-0000 -generate 10")
 
 
-def _rpc(pod, method: str, params: tuple[str, ...]) -> str:
+def _sh(pod, method: str, params: tuple[str, ...]) -> str:
     namespace = get_default_namespace()
 
     sclient = get_static_client()
@@ -356,7 +375,7 @@ def _rpc(pod, method: str, params: tuple[str, ...]) -> str:
             sclient.connect_get_namespaced_pod_exec,
             pod,
             namespace,
-            container="simln",
+            container=CONTAINER,
             command=cmd,
             stderr=True,
             stdin=False,
@@ -383,6 +402,6 @@ def _rpc(pod, method: str, params: tuple[str, ...]) -> str:
 @click.argument("pod", type=str)
 @click.argument("method", type=str)
 @click.argument("params", type=str, nargs=-1)  # this will capture all remaining arguments
-def rpc(pod: str, method: str, params: tuple[str, ...]):
+def sh(pod: str, method: str, params: tuple[str, ...]):
     """Run commands on a pod"""
-    print(_rpc(pod, method, params))
+    print(_sh(pod, method, params))

resources/plugins/simln/simln.py

@@ -319,7 +319,7 @@ def wait_for_pod_ready(name, namespace, timeout=300):
     return False
 
 
-def wait_for_init(pod_name, timeout=300, namespace: Optional[str] = None):
+def wait_for_init(pod_name, timeout=300, namespace: Optional[str] = None, quiet: bool = False):
     namespace = get_default_namespace_or(namespace)
     sclient = get_static_client()
     w = watch.Watch()
@@ -332,10 +332,12 @@ def wait_for_init(pod_name, timeout=300, namespace: Optional[str] = None):
                 continue
             for init_container_status in pod.status.init_container_statuses:
                 if init_container_status.state.running:
-                    print(f"initContainer in pod {pod_name} ({namespace}) is ready")
+                    if not quiet:
+                        print(f"initContainer in pod {pod_name} ({namespace}) is ready")
                     w.stop()
                     return True
-    print(f"Timeout waiting for initContainer in {pod_name} ({namespace})to be ready.")
+    if not quiet:
+        print(f"Timeout waiting for initContainer in {pod_name} ({namespace}) to be ready.")
     return False
 
 
@@ -389,7 +391,7 @@ def wait_for_pod(pod_name, timeout_seconds=10, namespace: Optional[str] = None):
 
 
 def write_file_to_container(
-    pod_name, container_name, dst_path, data, namespace: Optional[str] = None
+    pod_name, container_name, dst_path, data, namespace: Optional[str] = None, quiet: bool = False
 ):
     namespace = get_default_namespace_or(namespace)
     sclient = get_static_client()
@@ -421,7 +423,8 @@ def write_file_to_container(
             stdout=True,
             tty=False,
         )
-        print(f"Successfully copied data to {pod_name}({container_name}):{dst_path}")
+        if not quiet:
+            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}")

src/warnet/k8s.py

@@ -37,6 +37,12 @@ def plugins():
     pass
 
 
+@plugins.command()
+def run(plugin: str):
+    """Run a file"""
+    pass
+
+
 @plugins.command()
 @click.pass_context
 def ls(ctx):

src/warnet/plugins.py

@@ -15,10 +15,6 @@
 
 lightning_selector = "mission=lightning"
 
-UP = "\033[A"
-DOWN = "\033[B"
-ENTER = "\n"
-
 
 class SimLNTest(TestBase):
     def __init__(self):
@@ -72,6 +68,7 @@ def run_activity(self):
         activity_result = run_command(cmd)
         activity = json.loads(activity_result)
         pod_result = run_command(f"warnet plugins simln launch-activity '{json.dumps(activity)}'")
+        self.log.info(f"launched activity: {pod_result}")
         partial_func = partial(self.found_results_remotely, pod_result.strip())
         self.wait_for_predicate(partial_func)
         self.log.info("Successfully ran activity")
@@ -82,6 +79,7 @@ def run_activity_with_user_dir(self):
         activity_result = run_command(cmd)
         activity = json.loads(activity_result)
         pod_result = run_command(f"warnet plugins simln launch-activity '{json.dumps(activity)}'")
+        self.log.info(f"launched activity: {pod_result}")
         partial_func = partial(self.found_results_remotely, pod_result.strip())
         self.wait_for_predicate(partial_func)
         run_command("cd ../")
@@ -107,10 +105,10 @@ def found_results_remotely(self, pod: Optional[str] = None) -> bool:
             pod_names = ast.literal_eval(pod_names_literal)
             pod = pod_names[0]
         self.log.info(f"Checking for results file in {pod}")
-        results_file = run_command(f"warnet plugins simln rpc {pod} ls /working/results").strip()
+        results_file = run_command(f"warnet plugins simln sh {pod} ls /working/results").strip()
         self.log.info(f"Results file: {results_file}")
         results = run_command(
-            f"warnet plugins simln rpc {pod} cat /working/results/{results_file}"
+            f"warnet plugins simln sh {pod} cat /working/results/{results_file}"
         ).strip()
         self.log.info(results)
         return results.find("Success") > 0