merge for later work (#208)

* fix: worker-app-runner

* fix: doc

* fix: todos

* fix: fixed default params

* chore: comments

* fix: small mods

Author: aidamian

extensions/business/container_apps/container_app_runner.py

@@ -235,8 +235,24 @@ def on_command(self, data, **kwargs):
     else:
       self.P(f"Unknown plugin command: {data}")
     return
+  
+  def on_post_container_start(self):
+    """
+    Lifecycle hook called after the container is started.
+    Runs commands in the container if specified in the config.
+
+      - after the container first start
+      - after the container is restarted
+    """
+    self.P("Container started, running post-start commands...")
+    return
+
 
   def get_setup_commands(self):
+    """
+    TODO: fix the attack vector here, we should not allow arbitrary commands to be run
+    
+    """
     cfg_setup_commands = self.cfg_setup_commands
     setup_commands = []
     if isinstance(cfg_setup_commands, str):
@@ -258,7 +274,12 @@ def get_setup_commands(self):
 
     return setup_commands
 
+
   def get_start_commands(self):
+    """
+    TODO: fix the attack vector here, we should not allow arbitrary commands to be run
+    
+    """
     cfg_start_commands = self.cfg_start_commands
     start_commands = []
     if isinstance(cfg_start_commands, str):

extensions/business/container_apps/container_utils.py

@@ -76,6 +76,33 @@ def _container_pull_image(self):
     # end if result
     self.Pd(f"Image {full_ref} pulled successfully: {result.decode('utf-8', errors='ignore')}", score=30)
     return pulled
+  
+  
+  def _get_default_env_vars(self):
+    """
+    Get the default environment variables for the container.
+    
+    WARNING: This is a critical method that should be thoroughly reviewed for attack vectors.
+    
+    Returns:
+        dict: Default environment variables.
+    """
+    localhost_ip = self.log.get_localhost_ip()
+    chainstore_peers = getattr(self, 'cfg_chainstore_peers', [])
+    str_chainstore_peers = self.json_dumps(chainstore_peers)
+    dct_env = {
+      "CONTAINER_NAME": self.container_name,
+      "EE_CONTAINER_NAME": self.container_name,
+      "EE_HOST_IP": localhost_ip,
+      "EE_HOST_ID": self.ee_id,
+      "EE_HOST_ADDR": self.ee_addr,
+      "EE_HOST_ETH_ADDR": self.bc.eth_address,
+      "EE_CHAINSTORE_API_URL": f"http://{localhost_ip}:31234",
+      "EE_R1FS_API_URL": f"http://{localhost_ip}:31235",
+      "EE_CHAINSTORE_PEERS": str_chainstore_peers,
+    }
+
+    return dct_env
 
 
   def _get_container_run_command(self):
@@ -110,18 +137,10 @@ def _get_container_run_command(self):
 
     for key, val in self.dynamic_env.items():
       cmd += ["-e", f"{key}={val}"]
-      
-    cmd += ["-e", f"CONTAINER_NAME={self.container_name}"]
-    
-    # TODO: check if this is a potential security issue (host is a container itself but we need to make sure)
-    host_ip = self._setup_dynamic_env_var_host_ip()
-    cmd += ["-e", f"EE_HOST_IP={host_ip}"]
-    cmd += ["-e", f"EE_CHAINSTORE_API_URL=http://{self._setup_dynamic_env_var_host_ip()}:31234"]
-    cmd += ["-e", f"EE_R1FS_API_URL=http://{self._setup_dynamic_env_var_host_ip()}:31235"]
-
-    chainstore_peers = getattr(self, 'cfg_chainstore_peers', [])
-    cmd += ["-e", f"EE_CHAINSTORE_PEERS='{self.json_dumps(chainstore_peers)}'"]
 
+    # now add the default env vars
+    for key, val in self._get_default_env_vars().items():
+      cmd += ["-e", f"{key}={val}"]      
 
     # Volume mounts
     if len(self.volumes) > 0:
@@ -243,15 +262,21 @@ def _restart_container(self):
     self._reload_server()
     self.container_id = None
     self.container_start_time = self.time()  # Reset the start time after restart
+    return
 
   def _maybe_set_container_id_and_show_app_info(self):
     if self.container_id is None:
+      # this is the first time we are starting the container, so we need to get its ID
       container_id = self._get_container_id()
       if container_id:
         self.container_id = container_id
         self.P(f"Container ID set to: {self.container_id}")
+        self.on_post_container_start()  # Call the lifecycle hoo        
         self._maybe_send_plugin_start_confirmation()
         self._show_container_app_info()
+      #endif
+    #endif
+    return
 
   def _maybe_send_plugin_start_confirmation(self):
     """
@@ -352,4 +377,24 @@ def _show_container_app_info(self):
     msg += f"  CLI Tool:         {self.cli_tool}\n"
     self.P(msg)
     return
-  ## END CONTAINER MIXIN ###
+
+  
+  def _run_command_in_container(self, command):
+    """
+    Run a command inside the container.
+    
+    Args:
+        command (str): The command to run inside the container.
+    """
+    if not self.container_id:
+      self.P("Container ID is not set. Cannot run command.")
+      return
+    
+    cmd = [self.cli_tool, "exec", "-i", self.container_id] + command.split()
+    try:
+      result = subprocess.run(cmd, capture_output=True, text=True, check=True)
+      self.P(f"Command output: {result.stdout}")
+    except subprocess.CalledProcessError as e:
+      self.P(f"Error running command in container: {e.stderr}", color='r')
+      
+  ## END CONTAINER MIXIN ###

extensions/business/container_apps/worker_app_runner.py

@@ -0,0 +1,93 @@
+"""
+DRAFT worker_app_runner.py
+
+
+TODO:
+- add git clone command after each container is started
+- OBS: cannot use the parent already existing git helper functions as they deploy in the Edge Node host not in the container.
+  - use `remote_commit = self.git_get_last_commit_hash(repo_url=url, user=username, token=token)` to check if the repo is at the latest version
+    - save latest commit hash in plugin state
+    - if last version restart the container and re-run the clone & build-and-run commands
+
+- (fix running the build and run commands)
+
+"""
+
+from .container_app_runner import ContainerAppRunnerPlugin as BasePlugin
+
+__VER__ = "0.0.1"
+
+_CONFIG = {
+  **BasePlugin.CONFIG,
+
+  "IMAGE": "node:lts-alpine",   # default image to run
+  
+  "GIT_URL" : None,         # clone mandatory url of the git repository
+  
+  "BUILD_AND_RUN_COMMANDS" : [], 
+  
+  "CR_DATA": {              # dict of container registry data
+    "SERVER": 'docker.io',  # Optional container registry URL
+    "USERNAME": None,       # Optional registry username
+    "PASSWORD": None,       # Optional registry password or token
+  },
+
+  'VALIDATION_RULES': {
+    **BasePlugin.CONFIG['VALIDATION_RULES'],
+  },  
+}
+
+class WorkerAppRunnerPlugin(
+  BasePlugin
+):
+  """
+  A Ratio1 plugin to run a single Docker/Podman container.
+
+  This plugin:
+    - Does the same job, as ContainerAppRunner, except:
+      - Mapping the volumes is done directly, you can map any path to your container path
+      - Runs only on oracles.
+      - Can't be deployed via Deeploy
+  """
+
+  CONFIG = _CONFIG
+
+
+  def on_init(self):
+    super(WorkerAppRunnerPlugin, self).on_init()
+
+    return
+  
+  def __run_commands_in_container(self):
+    for container_command in self.cfg_build_and_run_commands:
+      if container_command:
+        self.log.info(f"Running command in container: {container_command}")
+        self._run_command_in_container(container_command) # this is from container utils.
+      else:
+        self.log.warning("Empty command found in build and run commands, skipping.")
+    return
+  
+  
+  def on_post_container_start(self):
+    """
+    Lifecycle hook called after the container has started.
+    Runs any build and run commands specified in the configuration.
+    """
+    super(WorkerAppRunnerPlugin, self).on_post_container_start()
+    
+    self.__run_commands_in_container()
+    
+    return
+
+  def on_close(self):
+    """
+    Lifecycle hook called when plugin is stopping.
+    Ensures container is shut down and logs are saved.
+    Ensures the log process is killed.
+    Stops tunnel if started.
+    """
+    super(WorkerAppRunnerPlugin, self).on_close()
+
+  def process(self):
+    super(WorkerAppRunnerPlugin, self).process()
+    return