stoobly-agent 1.10.3__tar.gz → 1.10.5__tar.gz

{stoobly_agent-1.10.3 → stoobly_agent-1.10.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stoobly-agent
-Version: 1.10.3
+Version: 1.10.5
 Summary: Record, mock, and test HTTP(s) requests. CLI agent for Stoobly
 License: Apache-2.0
 License-File: LICENSE

{stoobly_agent-1.10.3 → stoobly_agent-1.10.5}/pyproject.toml

@@ -10,7 +10,7 @@ description = "Record, mock, and test HTTP(s) requests. CLI agent for Stoobly"
 license = "Apache License 2.0"
 name = "stoobly-agent"
 readme = "README.md"
-version = "1.10.3"
+version = "1.10.5"
 
 [tool.poetry.dependencies]
 python = "^3.10"

{stoobly_agent-1.10.3 → stoobly_agent-1.10.5}/stoobly_agent/__init__.py

@@ -1,2 +1,2 @@
 COMMAND = 'stoobly-agent'
-VERSION = '1.10.3'
+VERSION = '1.10.5'

{stoobly_agent-1.10.3 → stoobly_agent-1.10.5}/stoobly_agent/app/cli/scaffold/app_create_command.py

@@ -12,7 +12,7 @@ from .app import App
 from .app_command import AppCommand
 from .constants import PLUGIN_CYPRESS, PLUGIN_PLAYWRIGHT, RUN_ON_DOCKER, RUN_ON_LOCAL
 from .docker.template_files import plugin_docker_cypress, plugin_docker_playwright, plugin_local_cypress, plugin_local_playwright, remove_app_docker_files, remove_service_docker_files
-from .templates.constants import CORE_GATEWAY_SERVICE_NAME, CORE_MOCK_UI_SERVICE_NAME, MAINTAINED_RUN
+from .templates.constants import CORE_GATEWAY_SERVICE_NAME, CORE_MOCK_UI_SERVICE_NAME, CUSTOM_RUN, MAINTAINED_RUN
 
 class AppCreateOptions(TypedDict):
   docker_socket_path: str
@@ -85,6 +85,7 @@ class AppCreateCommand(AppCommand):
             ignore.append(f"{CORE_MOCK_UI_SERVICE_NAME}/.*")
 
         if RUN_ON_DOCKER in self.app_run_on:
+            ignore.append(f".*/{CUSTOM_RUN}")
             ignore.append(f".*/{MAINTAINED_RUN}")
 
         # Copy all app templates

{stoobly_agent-1.10.3 → stoobly_agent-1.10.5}/stoobly_agent/app/cli/scaffold/docker/workflow/run_command.py

@@ -2,12 +2,14 @@ import os
 import pdb
 import subprocess
 import sys
+import time
 
 from typing import List
+from types import FunctionType
 
 from stoobly_agent.app.cli.scaffold.docker.constants import APP_EGRESS_NETWORK_TEMPLATE, APP_INGRESS_NETWORK_TEMPLATE, DOCKERFILE_CONTEXT
 from stoobly_agent.app.cli.scaffold.docker.service.configure_gateway import configure_gateway
-from stoobly_agent.app.cli.scaffold.templates.constants import CORE_ENTRYPOINT_SERVICE_NAME
+from stoobly_agent.app.cli.scaffold.templates.constants import CORE_ENTRYPOINT_SERVICE_NAME, CORE_SERVICES
 from stoobly_agent.app.cli.scaffold.workflow import Workflow
 from stoobly_agent.app.cli.scaffold.workflow_run_command import WorkflowRunCommand
 from stoobly_agent.app.cli.types.workflow_run_command import BuildOptions, DownOptions, UpOptions, WorkflowDownOptions, WorkflowUpOptions, WorkflowLogsOptions
@@ -27,10 +29,14 @@ class DockerWorkflowRunCommand(WorkflowRunCommand):
     self.services = services or []
     self.script = script
 
+  @property
+  def timestamp_file_extension(self):
+    return '.timestamp'
+
   @property
   def timestamp_file_path(self):
     """Get the path to the timestamp file for this workflow."""
-    return os.path.join(self.workflow_namespace.path, f"{self.workflow_name}.timestamp")
+    return os.path.join(self.workflow_namespace.path, self.timestamp_file_name(self.workflow_name))
 
   def exec_setup(self, containerized=False, user_id=None, verbose=False):
     """Setup Docker environment including gateway, images, and networks."""
@@ -47,25 +53,22 @@ class DockerWorkflowRunCommand(WorkflowRunCommand):
     
     for command in init_commands:
       self.exec(command, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
-    
+
+  def timestamp_file_name(self, workflow_name: str):
+    return f"{workflow_name}{self.timestamp_file_extension}"
+
   def up(self, **options: WorkflowUpOptions):
     """Execute the complete Docker workflow up process."""
-    # Define timestamp file path
-    timestamp_file = self.timestamp_file_path
-    
-    # Create timestamp file to indicate workflow is starting
-    try:
-      with open(timestamp_file, 'w') as f:
-        import time
-        f.write(str(time.time()))
-      Logger.instance(LOG_ID).info(f"Created timestamp file: {timestamp_file}")
-    except Exception as e:
-      Logger.instance(LOG_ID).error(f"Failed to create timestamp file: {e}")
-      sys.exit(1)
-    
+
     no_publish = options.get('no_publish', False)
     print_service_header = options.get('print_service_header')
-    
+    timestamp_file = None
+
+    if not self.dry_run:
+      self.__iterate_active_workflows(handle_active=self.__handle_up_active)
+
+      timestamp_file = self.__create_timestamp_file()
+
     try:
       # Create individual service commands
       commands: List[DockerWorkflowRunCommand] = []
@@ -117,22 +120,17 @@ class DockerWorkflowRunCommand(WorkflowRunCommand):
           self.exec(exec_command)
     
     except Exception as e:
-      # Clean up timestamp file on error
-      if os.path.exists(timestamp_file):
-        try:
-          os.remove(timestamp_file)
-          Logger.instance(LOG_ID).info(f"Removed timestamp file due to error: {timestamp_file}")
-        except Exception as cleanup_error:
-          Logger.instance(LOG_ID).warning(f"Failed to remove timestamp file after error: {cleanup_error}")
+      if timestamp_file:
+        # Clean up timestamp file on error
+        self.__remove_timestamp_file(timestamp_file) 
       raise e
 
   def down(self, **options: WorkflowDownOptions):
     """Execute the complete Docker workflow down process."""
-    # Check if workflow is running (timestamp file exists)
-    timestamp_file = self.timestamp_file_path
-    if not os.path.exists(timestamp_file):
-      Logger.instance(LOG_ID).info(f"Workflow '{self.workflow_name}' is not running. No timestamp file found: {timestamp_file}")
-      return
+
+    timestamp_file = None
+    if not self.dry_run: 
+      timestamp_file = self.__find_and_verify_timestamp_file()
     
     print_service_header = options.get('print_service_header')
     
@@ -186,25 +184,16 @@ class DockerWorkflowRunCommand(WorkflowRunCommand):
       remove_ingress_network_command = command.remove_ingress_network()
       if remove_ingress_network_command:
         self.exec(remove_ingress_network_command, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
-    
-    # Clean up timestamp file
-    timestamp_file = os.path.join(self.workflow_namespace.path, f"{self.workflow_name}.timestamp")
-    if os.path.exists(timestamp_file):
-      try:
-        os.remove(timestamp_file)
-      except Exception as e:
-        Logger.instance(LOG_ID).warning(f"Failed to remove timestamp file: {e}")
+
+    if timestamp_file:
+      self.__remove_timestamp_file(timestamp_file)
 
   def logs(self, **options: WorkflowLogsOptions):
     """Execute the complete Docker workflow logs process."""
-    # Check if workflow is running (timestamp file exists)
-    timestamp_file = self.timestamp_file_path
-    if not os.path.exists(timestamp_file):
-      Logger.instance(LOG_ID).info(f"Workflow '{self.workflow_name}' is not running. No timestamp file found: {timestamp_file}")
-      return
-    
-    from ...templates.constants import CORE_SERVICES
-    
+
+    if not self.dry_run:
+      self.__find_and_verify_timestamp_file()
+     
     print_service_header = options.get('print_service_header')
     
     # Filter services based on options
@@ -414,10 +403,92 @@ class DockerWorkflowRunCommand(WorkflowRunCommand):
     if self.script:
       print(command, file=self.script)
 
-    if self.dry_run:
+    if self.dry_run or self.containerized:
       print(command)
     else:
       result = subprocess.run(command, shell=True, **options)
       if result.returncode != 0:
         Logger.instance(LOG_ID).error(command)
-        sys.exit(1)
+        sys.exit(1)
+
+  def __find_and_verify_timestamp_file(self):
+    # Check if workflow is running (timestamp file exists)
+
+    timestamp_file = self.timestamp_file_path
+
+    if not os.path.exists(timestamp_file):
+      Logger.instance(LOG_ID).error(f"Workflow '{self.workflow_name}' is not running.")
+
+      if self.workflow_name != self.workflow_namespace.namespace:
+        Logger.instance(LOG_ID).error(f"Run `stoobly-agent scaffold workflow up {self.workflow_name} --namespace {self.workflow_namespace.namespace}` to start it first.")
+      else:
+        Logger.instance(LOG_ID).error(f"Run `stoobly-agent scaffold workflow up {self.workflow_name}` to start it first.")
+      sys.exit(2)
+
+    return timestamp_file
+
+  def __handle_up_active(self, folder: str, timestamp_file_path: str):
+    file_name = os.path.basename(timestamp_file_path)
+
+    # In the case of a namespace, the workflow name is the name of the file without the timestamp extension
+    workflow_name = self.workflow_name
+    if folder != self.workflow_name:
+      workflow_name = file_name.split(self.timestamp_file_extension)[0]
+
+    Logger.instance(LOG_ID).error(f"Workflow '{workflow_name}' is running, please stop it first.")
+
+    if folder != workflow_name:
+      Logger.instance(LOG_ID).error(f"Run `stoobly-agent scaffold workflow down {workflow_name} --namespace {folder}` to stop it first.")
+    else:
+      Logger.instance(LOG_ID).error(f"Run `stoobly-agent scaffold workflow down {workflow_name}` to stop it first.")
+
+    sys.exit(1)
+
+  def __iterate_active_workflows(self, **kwargs):
+    handle_active: FunctionType = kwargs.get('handle_active')
+    tmp_dir_path = self.app.data_dir.tmp_dir_path
+
+    # For each folder in self.app.data_dir.tmp_dir_path
+    for folder in os.listdir(tmp_dir_path):
+      folder_path = os.path.join(tmp_dir_path, folder)
+
+      # If the folder is not a directory, skip
+      if not os.path.isdir(folder_path):
+        continue
+
+      # For each file in folder_path that ends with .timestamp
+      for file in os.listdir(folder_path):
+        if not file.endswith(self.timestamp_file_extension):
+          continue
+
+        # If the folder contains a .timestamp file, then another workflow is running
+        timestamp_file_path = os.path.join(folder_path, file)
+
+        # Allow re-running the same workflow
+        if timestamp_file_path == self.timestamp_file_path:
+          continue
+
+        if handle_active:
+          handle_active(folder, timestamp_file_path)
+
+  def __create_timestamp_file(self):
+    # Create timestamp file to indicate workflow is starting
+    timestamp_file = self.timestamp_file_path
+
+    try:
+      with open(timestamp_file, 'w') as f:
+        f.write(str(time.time()))
+      Logger.instance(LOG_ID).debug(f"Created timestamp file: {timestamp_file}")
+    except Exception as e:
+      Logger.instance(LOG_ID).error(f"Failed to create timestamp file: {e}")
+      sys.exit(1)
+    
+    return timestamp_file
+
+  def __remove_timestamp_file(self, timestamp_file: str):
+    # Clean up timestamp file
+    if os.path.exists(timestamp_file):
+      try:
+        os.remove(timestamp_file)
+      except Exception as e:
+        Logger.instance(LOG_ID).warning(f"Failed to remove timestamp file: {e}")

{stoobly_agent-1.10.3 → stoobly_agent-1.10.5}/stoobly_agent/app/cli/scaffold/local/workflow/run_command.py

@@ -3,7 +3,9 @@ import pdb
 import signal
 import subprocess
 import sys
+import time
 
+from types import FunctionType
 from typing import Optional, List
 
 from stoobly_agent.app.cli.scaffold.constants import PLUGIN_CYPRESS, PLUGIN_PLAYWRIGHT
@@ -34,26 +36,28 @@ class LocalWorkflowRunCommand(WorkflowRunCommand):
       self._log_file_path = os.path.join(self.workflow_namespace.path, f"{self.workflow_name}.log")
     return self._log_file_path
 
+  @property
+  def pid_file_extension(self):
+    return '.pid'
+
   @property
   def pid_file_path(self):
     """Get the path to the PID file for this workflow."""
     if not self._pid_file_path:
-      self._pid_file_path = os.path.join(self.workflow_namespace.path, f"{self.workflow_name}.pid")
+      self._pid_file_path = os.path.join(self.workflow_namespace.path, self.pid_file_name(self.workflow_name))
     return self._pid_file_path
 
-  def _write_pid(self, pid: int):
-    """Write the process PID to the PID file."""
-    os.makedirs(os.path.dirname(self.pid_file_path), exist_ok=True)
-    with open(self.pid_file_path, 'w') as f:
-      f.write(str(pid))
+  def pid_file_name(self, workflow_name: str):
+    return f"{workflow_name}{self.pid_file_extension}"
 
-  def _read_pid(self) -> Optional[int]:
+  def _read_pid(self, file_path = None) -> Optional[int]:
     """Read the process PID from the PID file."""
-    if not os.path.exists(self.pid_file_path):
+    file_path = file_path or self.pid_file_path
+    if not os.path.exists(file_path):
       return None
     
     try:
-      with open(self.pid_file_path, 'r') as f:
+      with open(file_path, 'r') as f:
         return int(f.read().strip())
     except (ValueError, IOError):
       return None
@@ -130,9 +134,12 @@ class LocalWorkflowRunCommand(WorkflowRunCommand):
     """Start the workflow using local stoobly-agent run."""
     detached = options.get('detached', False)
 
-    commands = self.workflow_service_commands(**options)
+    if not self.dry_run:
+      self.__iterate_active_workflows(handle_active=self.__handle_up_active, handle_stale=self.__handle_up_stale)
 
     # iterate through each service in the workflow
+    commands = self.workflow_service_commands(**options)
+
     public_directory_paths = []
     response_fixtures_paths = []
     for command in commands:
@@ -145,18 +152,7 @@ class LocalWorkflowRunCommand(WorkflowRunCommand):
         if os.path.exists(command.response_fixtures_path):
           response_fixtures_paths.append('--response-fixtures-path')
           response_fixtures_paths.append(f"{command.response_fixtures_path}:{url}")
-    
-    # Check if PID file already exists
-    if os.path.exists(self.pid_file_path):
-      pid = self._read_pid()
-      if pid and self._is_process_running(pid):
-        Logger.instance(LOG_ID).error(f"Workflow {self.workflow_name} is already running with PID: {pid}")
-        Logger.instance(LOG_ID).error(f"Run `stoobly-agent scaffold workflow down {self.workflow_name}` to stop it first")
-        sys.exit(1)
-      else:
-        # PID file exists but process is not running, clean it up
-        os.remove(self.pid_file_path)
-
+   
     for command in commands:
       command.service_up(**options)
 
@@ -166,17 +162,10 @@ class LocalWorkflowRunCommand(WorkflowRunCommand):
 
   def down(self, **options: WorkflowDownOptions):
     """Stop the workflow by killing the local process."""
-    
-    pid = self._read_pid()
+
+    # Intentially run this during dry run, we need the PID to be returned
+    pid = self.__find_and_verify_workflow_pid()
     if not pid:
-      Logger.instance(LOG_ID).warning(f"No PID file found for {self.workflow_name}")
-      return
-    
-    if not self._is_process_running(pid):
-      Logger.instance(LOG_ID).info(f"Process {pid} for {self.workflow_name} is not running")
-      # Clean up PID file
-      if os.path.exists(self.pid_file_path):
-        os.remove(self.pid_file_path)
       return
     
     # Kill the process
@@ -212,8 +201,7 @@ class LocalWorkflowRunCommand(WorkflowRunCommand):
           Logger.instance(LOG_ID).info(f"Successfully stopped process {pid} for {self.workflow_name}")
         
         # Clean up PID file
-        if os.path.exists(self.pid_file_path):
-          os.remove(self.pid_file_path)
+        self.__remove_pid_file()
           
       except Exception as e:
         Logger.instance(LOG_ID).error(f"Failed to stop {self.workflow_name}: {e}")
@@ -221,11 +209,9 @@ class LocalWorkflowRunCommand(WorkflowRunCommand):
   def logs(self, **options: WorkflowLogsOptions):
     """Show logs for the local workflow process."""
     follow = options.get('follow', False)
-    
-    pid = self._read_pid()
-    if not pid:
-      Logger.instance(LOG_ID).warning(f"No PID file found for {self.workflow_name}")
-      return
+
+    if not self.dry_run:
+      self.__find_and_verify_workflow_pid()
     
     # Build log command
     log_file = f"{self.log_file_path}"
@@ -243,22 +229,17 @@ class LocalWorkflowRunCommand(WorkflowRunCommand):
       except subprocess.CalledProcessError as e:
         Logger.instance(LOG_ID).error(f"Failed to show logs for {self.workflow_name}: {e}")
 
-  def status(self):
-    """Check the status of the local workflow process."""
-    pid = self._read_pid()
-    if not pid:
-      return "not running"
-    
-    if self._is_process_running(pid):
-      return f"running (PID: {pid})"
-    else:
-      return "not running (stale PID file)"
-
   def workflow_service_commands(self, **options: WorkflowUpOptions):
     commands = list(map(lambda service_name: LocalWorkflowRunCommand(self.app, service_name=service_name, **options), self.services))
     commands.sort(key=lambda command: command.service_config.priority)
     return commands
 
+  def __create_pid_file(self, pid: int):
+    """Write the process PID to the PID file."""
+    os.makedirs(os.path.dirname(self.pid_file_path), exist_ok=True)
+    with open(self.pid_file_path, 'w') as f:
+      f.write(str(pid))
+
   def __dry_run_down(self, pid: int, output_file: str):
     print(f"# Stop {self.workflow_name} (PID: {pid})", file=output_file)
     print(f"kill {pid} || true", file=output_file)
@@ -273,6 +254,83 @@ class LocalWorkflowRunCommand(WorkflowRunCommand):
     else:
       print(f"cat {log_file}", file=output_file)
 
+  def __find_and_verify_workflow_pid(self):
+    # Find and verify the workflow PID
+    pid = self._read_pid()
+
+    if not pid:
+      Logger.instance(LOG_ID).error(f"Workflow {self.workflow_name} is not running.")
+
+      # If the workflow name does not match the workflow namespace, then recommend with --namespace option
+      if self.workflow_name != self.workflow_namespace.namespace:
+        Logger.instance(LOG_ID).error(f"Run `stoobly-agent scaffold workflow up {self.workflow_name} --namespace {self.workflow_namespace.namespace}` to start it first.")
+      else:
+        Logger.instance(LOG_ID).error(f"Run `stoobly-agent scaffold workflow up {self.workflow_name}` to start it first.")
+
+      sys.exit(1)
+    
+    if not self._is_process_running(pid):
+      Logger.instance(LOG_ID).info(f"Process {pid} for {self.workflow_name} is not running")
+      # Clean up PID file
+      return self.__remove_pid_file()
+
+    return pid
+
+  def __handle_up_active(self, folder: str, pid: str, pid_file_path: str):
+    # Allow re-running the same workflow, bring workflow down first
+    if pid_file_path == self.pid_file_path and os.path.exists(pid_file_path):
+      self.down()
+    else:
+      file_name = os.path.basename(pid_file_path)
+      workflow_name = self.workflow_name
+      if folder != self.workflow_name:
+        workflow_name = file_name.split(self.pid_file_extension)[0]
+
+      Logger.instance(LOG_ID).error(f"Workflow {workflow_name} is already running with PID {pid}")
+
+      if folder != workflow_name:
+        Logger.instance(LOG_ID).error(f"Run `stoobly-agent scaffold workflow down {workflow_name} --namespace {folder}` to stop it first.")
+      else:
+        Logger.instance(LOG_ID).error(f"Run `stoobly-agent scaffold workflow down {workflow_name}` to stop it first.")
+
+      sys.exit(1)
+
+  def __handle_up_stale(self, folder: str, pid: str, pid_file_path: str):
+    # PID file exists but process is not running, clean it up
+    os.remove(pid_file_path)
+
+  def __iterate_active_workflows(self, **kwargs):
+    handle_active: FunctionType = kwargs.get('handle_active')
+    handle_stale: FunctionType = kwargs.get('handle_stale')
+    tmp_dir_path = self.app.data_dir.tmp_dir_path
+
+    # For each folder in self.app.data_dir.tmp_dir_path
+    for folder in os.listdir(tmp_dir_path):
+      folder_path = os.path.join(tmp_dir_path, folder)
+
+      # If the folder is not a directory, skip
+      if not os.path.isdir(folder_path):
+        continue
+
+      # For each file in folder_path that ends with .pid
+      for file in os.listdir(folder_path):
+        if not file.endswith(self.pid_file_extension):
+          continue
+          
+        # If the folder contains a .pid file, then another workflow is running
+        pid_file_path = os.path.join(folder_path, file)
+        pid = self._read_pid(pid_file_path)
+        if pid and self._is_process_running(pid):
+          if handle_active:
+            handle_active(folder, pid, pid_file_path)
+        else:
+          if handle_stale:
+            handle_stale(folder, pid, pid_file_path)
+
+  def __remove_pid_file(self):
+    if os.path.exists(self.pid_file_path):
+      os.remove(self.pid_file_path)
+
   def __up_command(self, public_directory_paths: List[str], response_fixtures_paths: List[str], **options: WorkflowUpOptions):
     # Build the stoobly-agent run command
     command = ['stoobly-agent', 'run']
@@ -307,7 +365,7 @@ class LocalWorkflowRunCommand(WorkflowRunCommand):
       for line in script_lines:
         print(line, file=self.script)
 
-    if self.dry_run:
+    if self.dry_run or self.containerized:
       print(command_str)
     else:
       # Execute directly
@@ -320,20 +378,31 @@ class LocalWorkflowRunCommand(WorkflowRunCommand):
           check=True
         )
 
+        time.sleep(1) # Wait for the process to start
+
         if result.returncode != 0:
-          Logger.instance(LOG_ID).error(f"Failed to start agent, run `stoobly-agent workflow logs {self.workflow_name}` to see the error")
-          sys.exit(1)
+          self.__handle_up_error()
         
         # The --detached option prints the PID to stdout
         pid = int(result.stdout.strip())
+
+        if not self._is_process_running(pid):
+          self.__handle_up_error()
         
         # Write PID to file
-        self._write_pid(pid)
+        self.__create_pid_file(pid)
         
         Logger.instance(LOG_ID).info(f"Started {self.workflow_name} with PID: {pid}")
       except subprocess.CalledProcessError as e:
-        Logger.instance(LOG_ID).error(f"Failed to start {self.workflow_name}: {e}")
-        return None
+        self.__handle_up_error()
       except ValueError as e:
         Logger.instance(LOG_ID).error(f"Failed to parse PID from output: {e}")
-        return None
+        return None
+
+  def __handle_up_error(self):
+    log_file = f"{self.log_file_path}"
+    # Read log file it exists and print to stderr
+    if os.path.exists(log_file):
+      with open(log_file, 'r') as f:
+        print(f.read(), file=sys.stderr)
+    sys.exit(1)

{stoobly_agent-1.10.3 → stoobly_agent-1.10.5}/stoobly_agent/app/cli/scaffold/service_workflow_validate_command.py

@@ -201,7 +201,12 @@ class ServiceWorkflowValidateCommand(ServiceCommand, ValidateCommand):
     # Test workflow won't expose services that are detached and have a hostname to the host such as assets.
     # Need to test connection from inside the Docker network
     if self.service_config.hostname and self.workflow_name == WORKFLOW_TEST_TYPE:
-      self.validate_internal_hostname(url)
+      try:
+        self.validate_internal_hostname(url)
+      except ScaffoldValidateException:
+        time.sleep(1)
+        # Retry once
+        self.validate_internal_hostname(url)
 
     self.validate_init_containers(self.service_docker_compose.init_container_name, self.service_docker_compose.configure_container_name)