stoobly-agent 1.10.0__py3-none-any.whl → 1.10.2__py3-none-any.whl

stoobly_agent/app/cli/scaffold/docker/service/builder.py

@@ -7,47 +7,40 @@ from stoobly_agent.config.data_dir import DATA_DIR_NAME
 
 from ...app_config import AppConfig
 from ...constants import (
-  APP_DIR, DOCKER_NAMESPACE, 
+  APP_DIR, SERVICES_NAMESPACE, 
   SERVICE_HOSTNAME, SERVICE_HOSTNAME_ENV,
   SERVICE_NAME, SERVICE_NAME_ENV, 
   SERVICE_ID,
   SERVICE_PORT, SERVICE_PORT_ENV, 
-  SERVICE_SCHEME, SERVICE_SCHEME_ENV, 
-  STOOBLY_HOME_DIR, STOOBLY_HOME_DIR, 
+  SERVICE_SCHEME, SERVICE_SCHEME_ENV,
+  SERVICE_UPSTREAM_HOSTNAME, SERVICE_UPSTREAM_HOSTNAME_ENV, SERVICE_UPSTREAM_PORT, SERVICE_UPSTREAM_PORT_ENV, SERVICE_UPSTREAM_SCHEME, SERVICE_UPSTREAM_SCHEME_ENV,
+  STOOBLY_HOME_DIR, 
   WORKFLOW_NAME, WORKFLOW_NAME_ENV, WORKFLOW_SCRIPTS, WORKFLOW_TEMPLATE
 )
 from ...service_config import ServiceConfig
+from ...local.service.builder import ServiceBuilder
 from ..app_builder import AppBuilder
 from ..builder import Builder
 from ..constants import DOCKER_COMPOSE_BASE
 
-class ServiceBuilder(Builder):
+class DockerServiceBuilder(ServiceBuilder, Builder):
 
   def __init__(self, config: ServiceConfig, app_builder: AppBuilder = None):
     service_path = config.dir
-    super().__init__(service_path, DOCKER_COMPOSE_BASE)
+    
+    # Initialize both parent classes
+    ServiceBuilder.__init__(self, config)
+    Builder.__init__(self, service_path, DOCKER_COMPOSE_BASE)
 
     if not app_builder:
-      app_dir = os.path.dirname(service_path)
-      app_builder = AppBuilder(AppConfig(app_dir))
+      app_config = AppConfig(config.app_config_dir_path)
+      app_builder = AppBuilder(app_config)
     self.app_builder = app_builder
 
-    self.__config = config
-    self.__upstream_port = None
-    self.__env = [SERVICE_NAME_ENV, WORKFLOW_NAME_ENV]
-    self.__service_name = os.path.basename(service_path)
-    self.__working_dir = os.path.join(
-      STOOBLY_HOME_DIR, DATA_DIR_NAME, DOCKER_NAMESPACE, SERVICE_NAME, WORKFLOW_NAME
-    )
-
   @property
   def app_base(self):
     return f"{self.service_name}.app_base"
 
-  @property
-  def config(self):
-    return self.__config
-
   @property
   def configure_base(self):
     return f"{self.service_name}.configure_base"
@@ -56,10 +49,6 @@ class ServiceBuilder(Builder):
   def configure_base_service(self):
     return self.services.get(self.configure_base)
 
-  @property
-  def upstream_port(self) -> int:
-    return self.__upstream_port
-
   @property
   def extends_service(self):
     if self.config.detached:
@@ -83,10 +72,6 @@ class ServiceBuilder(Builder):
   def proxy_base_service(self):
     return self.services.get(self.proxy_base)
 
-  @property
-  def service_name(self):
-    return self.__service_name
-
   def build_extends_init_base(self, source_dir: str):
     return self.build_extends(self.init_base, source_dir)
 
@@ -127,7 +112,7 @@ class ServiceBuilder(Builder):
         'service': self.extends_service
       },
       'labels': labels,
-      'working_dir': self.__working_dir,
+      'working_dir': self.working_dir,
     }
 
     if len(volumes):
@@ -146,14 +131,14 @@ class ServiceBuilder(Builder):
       self.__with_detached_volumes(volumes)
 
     self.with_service(self.init_base, {
-      'command': [f"{WORKFLOW_SCRIPTS}/{WORKFLOW_TEMPLATE}/.init", 'bin/init'],
+      'command': [f"{WORKFLOW_SCRIPTS}/{WORKFLOW_TEMPLATE}/.init", 'init'],
       'environment': environment,
       'extends': {
         'file': os.path.relpath(self.app_builder.compose_file_path, self.dir_path),
         'service': self.extends_service
       },
       'volumes': volumes,
-      'working_dir': self.__working_dir,
+      'working_dir': self.working_dir,
     })
 
   def build_configure_base(self):
@@ -167,13 +152,13 @@ class ServiceBuilder(Builder):
       self.__with_detached_volumes(volumes)
 
     base = {
-      'command': [f"{WORKFLOW_SCRIPTS}/{WORKFLOW_TEMPLATE}/.configure", 'bin/configure'],
+      'command': [f"{WORKFLOW_SCRIPTS}/{WORKFLOW_TEMPLATE}/.configure", 'configure'],
       'environment': environment,
       'extends': {
         'file': os.path.relpath(self.app_builder.compose_file_path, self.dir_path),
         'service': self.extends_service
       },
-      'working_dir': self.__working_dir,
+      'working_dir': self.working_dir,
     }
 
     if len(volumes):
@@ -181,24 +166,6 @@ class ServiceBuilder(Builder):
 
     self.with_service(self.configure_base, base)
 
-  def env_dict(self):
-    env = {}
-    for e in self.__env:
-      env[e] = '${' + e + '}'
-    return env
-
-  def with_upstream_port(self, v: int):
-    if not isinstance(v, int):
-      return self
-    self.__upstream_port = v
-    return self
-
-  def with_env(self, v: List[str]): 
-    if not isinstance(v, list):
-      return self
-    self.__env += v
-    return self
-
   def write(self):
     self.build_init_base()
     self.build_configure_base()
@@ -213,20 +180,30 @@ class ServiceBuilder(Builder):
     if self.networks:
       compose['networks'] = self.networks
 
-    super().write(compose)
+    Builder.write(self, compose)
 
   def __with_detached_volumes(self, volumes: list):
     # Mount named volume
     volumes.append(f"{self.service_name}:{STOOBLY_HOME_DIR}/{DATA_DIR_NAME}")
 
     # Mount docker folder
-    volumes.append(f"../:{STOOBLY_HOME_DIR}/{DATA_DIR_NAME}/{DOCKER_NAMESPACE}")
+    volumes.append(f"../:{STOOBLY_HOME_DIR}/{DATA_DIR_NAME}/{SERVICES_NAMESPACE}")
 
   def __with_url_environment(self, environment):
-    environment[SERVICE_HOSTNAME_ENV] = SERVICE_HOSTNAME
+    if self.config.hostname:
+      environment[SERVICE_HOSTNAME_ENV] = SERVICE_HOSTNAME
 
     if self.config.scheme:
       environment[SERVICE_SCHEME_ENV] = SERVICE_SCHEME
 
     if self.config.port:
-      environment[SERVICE_PORT_ENV] = SERVICE_PORT
+      environment[SERVICE_PORT_ENV] = SERVICE_PORT
+
+    if self.config.upstream_hostname:
+      environment[SERVICE_UPSTREAM_HOSTNAME_ENV] = SERVICE_UPSTREAM_HOSTNAME
+
+    if self.config.upstream_port:
+      environment[SERVICE_UPSTREAM_PORT_ENV] = SERVICE_UPSTREAM_PORT
+
+    if self.config.upstream_scheme:
+      environment[SERVICE_UPSTREAM_SCHEME_ENV] = SERVICE_UPSTREAM_SCHEME

stoobly_agent/app/cli/scaffold/docker/service/configure_gateway.py

@@ -21,6 +21,9 @@ def configure_gateway(workflow_namespace: WorkflowNamespace, service_paths: List
   docker_compose_src_path = os.path.join(gateway_service_path, DOCKER_COMPOSE_BASE_TEMPLATE)
   docker_compose_dest_path = os.path.join(gateway_service_path, DOCKER_COMPOSE_BASE)
 
+  if not os.path.exists(docker_compose_src_path):
+    return
+
   compose = {}
   with open(docker_compose_src_path, 'r') as fp:
     compose = yaml.safe_load(fp)

stoobly_agent/app/cli/scaffold/docker/template_files.py

@@ -0,0 +1,112 @@
+import os
+import shutil
+import yaml
+
+from mergedeep import merge
+
+from ..constants import PLUGINS_FOLDER, WORKFLOW_TEST_TYPE
+from ..templates.constants import CORE_ENTRYPOINT_SERVICE_NAME
+from .constants import (
+  DOCKER_COMPOSE_BASE_TEMPLATE,
+  DOCKER_COMPOSE_CUSTOM,
+  DOCKER_COMPOSE_WORKFLOW,
+  DOCKER_MAKEFILE,
+  DOCKER_MAKEFILE_DOT,
+  DOCKERFILE_CONTEXT,
+  DOCKER_COMPOSE_BASE,
+  DOCKER_COMPOSE_NETWORKS,
+  PLUGIN_CONTAINER_SERVICE_TEMPLATE,
+  PLUGIN_DOCKER_ENTRYPOINT,
+  PLUGIN_DOCKERFILE_TEMPLATE,
+)
+
+DOCKER_APP_TEMPLATE_FILES = [
+  DOCKER_MAKEFILE,
+  DOCKER_MAKEFILE_DOT,
+  DOCKERFILE_CONTEXT,
+  DOCKER_COMPOSE_BASE,
+  DOCKER_COMPOSE_NETWORKS,
+]
+
+def __merge_compose_plugin(dest_path: str, template_path: str, plugin: str):
+    if not os.path.exists(dest_path):
+        open(dest_path, 'a').close()
+
+    def load_yaml(path):
+        with open(path, 'r') as f:
+            return yaml.safe_load(f) or {}
+
+    data1 = load_yaml(dest_path)
+    data2 = load_yaml(template_path)
+
+    services = data1.get('services') or {}
+    if services.get(PLUGIN_CONTAINER_SERVICE_TEMPLATE.format(plugin=plugin, service=CORE_ENTRYPOINT_SERVICE_NAME)):
+        return
+
+    with open(dest_path, 'w') as out:
+        merged = merge(data1, data2)
+        yaml.dump(merged, out, default_flow_style=False)
+
+def remove_app_docker_files(dest_path: str):
+  for file_name in DOCKER_APP_TEMPLATE_FILES:
+      file_path = os.path.join(dest_path, file_name)
+      if os.path.exists(file_path):
+          os.remove(file_path)
+
+def remove_service_docker_files(service_path: str):
+  compose_files = [DOCKER_COMPOSE_BASE, DOCKER_COMPOSE_CUSTOM, DOCKER_COMPOSE_BASE_TEMPLATE]
+
+  # For each file in dest_path recursively, check whether it is DOCKER_COMPOSE_BASE or DOCKER_COMPOSE_BASE_TEMPLATE, if so remove it
+  for root, _, files in os.walk(service_path):
+      for file in files:
+          if file in compose_files or file == DOCKER_COMPOSE_WORKFLOW:
+              os.remove(os.path.join(root, file))
+
+def plugin_docker_cypress(templates_root_dir: str, plugin: str, dest: str):
+  dockerfile_name = PLUGIN_DOCKERFILE_TEMPLATE.format(plugin=plugin)
+  dockerfile_dest_path = os.path.join(dest, CORE_ENTRYPOINT_SERVICE_NAME, WORKFLOW_TEST_TYPE, dockerfile_name)
+
+  # Copy Dockerfile to workflow
+  dockerfile_src_path = os.path.join(templates_root_dir, PLUGINS_FOLDER, plugin, WORKFLOW_TEST_TYPE, dockerfile_name)
+  shutil.copyfile(dockerfile_src_path, dockerfile_dest_path)
+
+  # Merge template into dest compose yml
+  compose_dest_path = os.path.join(
+      dest, CORE_ENTRYPOINT_SERVICE_NAME, WORKFLOW_TEST_TYPE, DOCKER_COMPOSE_WORKFLOW
+  )
+  template_path = os.path.join(
+      templates_root_dir, PLUGINS_FOLDER, plugin, WORKFLOW_TEST_TYPE, DOCKER_COMPOSE_WORKFLOW
+  )
+  __merge_compose_plugin(compose_dest_path, template_path, plugin)
+
+def plugin_docker_playwright(templates_root_dir: str, plugin: str, dest: str):
+  dockerfile_name = PLUGIN_DOCKERFILE_TEMPLATE.format(plugin=plugin)
+  dockerfile_src_path = os.path.join(templates_root_dir, PLUGINS_FOLDER, plugin, WORKFLOW_TEST_TYPE, dockerfile_name)
+  dockerfile_dest_path = os.path.join(dest, CORE_ENTRYPOINT_SERVICE_NAME, WORKFLOW_TEST_TYPE, dockerfile_name)
+  shutil.copyfile(dockerfile_src_path, dockerfile_dest_path)
+
+  entrypoint_src_path = os.path.join(templates_root_dir, PLUGINS_FOLDER, plugin, WORKFLOW_TEST_TYPE, PLUGIN_DOCKER_ENTRYPOINT)
+  entrypoint_dest_path = os.path.join(dest, CORE_ENTRYPOINT_SERVICE_NAME, WORKFLOW_TEST_TYPE, PLUGIN_DOCKER_ENTRYPOINT)
+  shutil.copyfile(entrypoint_src_path, entrypoint_dest_path)
+
+  # Merge template into dest compose yml
+  compose_dest_path = os.path.join(
+      dest, CORE_ENTRYPOINT_SERVICE_NAME, WORKFLOW_TEST_TYPE, DOCKER_COMPOSE_WORKFLOW
+  )
+  template_path = os.path.join(
+      templates_root_dir, PLUGINS_FOLDER, plugin, WORKFLOW_TEST_TYPE, DOCKER_COMPOSE_WORKFLOW
+  )
+  __merge_compose_plugin(compose_dest_path, template_path, plugin)
+
+def plugin_local_cypress(templates_root_dir: str, plugin: str, dest: str):
+  # Copy run script
+  run_script_src_path = os.path.join(templates_root_dir, PLUGINS_FOLDER, plugin, WORKFLOW_TEST_TYPE, '.run')
+  run_script_dest_path = os.path.join(dest, CORE_ENTRYPOINT_SERVICE_NAME, WORKFLOW_TEST_TYPE, '.run')
+  # Use shutil.copy instead of shutil.copyfile to preserve permissions
+  shutil.copy(run_script_src_path, run_script_dest_path)
+
+def plugin_local_playwright(templates_root_dir: str, plugin: str, dest: str):
+  # Copy run script
+  run_script_src_path = os.path.join(templates_root_dir, PLUGINS_FOLDER, plugin, WORKFLOW_TEST_TYPE, '.run')
+  run_script_dest_path = os.path.join(dest, CORE_ENTRYPOINT_SERVICE_NAME, WORKFLOW_TEST_TYPE, '.run')
+  shutil.copy(run_script_src_path, run_script_dest_path)

stoobly_agent/app/cli/scaffold/docker/workflow/build_decorator.py

@@ -1,6 +1,6 @@
 import pdb
 
-from .builder import WorkflowBuilder
+from ...local.workflow.builder import WorkflowBuilder
 
 class BuildDecorator():
 

stoobly_agent/app/cli/scaffold/docker/workflow/builder.py

@@ -1,29 +1,26 @@
 import os
 import pdb
 
+from typing import List, Union
+
 from ...constants import (
-  COMPOSE_TEMPLATE, SERVICE_HOSTNAME, 
-  SERVICE_HOSTNAME_ENV, SERVICE_NAME_ENV, SERVICE_PORT, SERVICE_PORT_ENV, SERVICE_SCHEME, SERVICE_SCHEME_ENV, 
   WORKFLOW_CONTAINER_CONFIGURE_TEMPLATE, WORKFLOW_CONTAINER_INIT_TEMPLATE, WORKFLOW_CONTAINER_PROXY_TEMPLATE, WORKFLOW_NAME, WORKFLOW_NAME_ENV
 )
+from ...local.workflow.builder import WorkflowBuilder
 from ..builder import Builder
-from ..service.builder import ServiceBuilder
-
-class WorkflowBuilder(Builder):
-
-  def __init__(self, workflow_path: str, service_builder: ServiceBuilder):
-    self._env = [SERVICE_NAME_ENV, WORKFLOW_NAME_ENV]
-    self.__workflow_name = os.path.basename(workflow_path)
-    super().__init__(workflow_path, COMPOSE_TEMPLATE.format(workflow=self.__workflow_name))
+from ..constants import DOCKER_COMPOSE_WORKFLOW
+from ..service.builder import DockerServiceBuilder
+from .mock_decorator import MockDecorator
+from .reverse_proxy_decorator import ReverseProxyDecorator
 
-    self.__context = '../'
-    self.__profiles = [WORKFLOW_NAME]
+class DockerWorkflowBuilder(Builder, WorkflowBuilder):
 
-    if not service_builder:
-      service_path = os.path.dirname(workflow_path)
-      service_builder = ServiceBuilder(service_path)
+  def __init__(self, workflow_path: str, service_builder: DockerServiceBuilder):
+    WorkflowBuilder.__init__(self, workflow_path, service_builder)
+    Builder.__init__(self, workflow_path, DOCKER_COMPOSE_WORKFLOW)
 
-    self.__service_builder = service_builder
+    self._context = '../'
+    self._profiles = [WORKFLOW_NAME]
 
   @property
   def app(self):
@@ -33,17 +30,13 @@ class WorkflowBuilder(Builder):
   def base_compose_file_path(self):
     return os.path.relpath(self.service_builder.compose_file_path, self.dir_path)
 
-  @property
-  def config(self):
-    return self.service_builder.config
-
   @property
   def configure(self):
     return WORKFLOW_CONTAINER_CONFIGURE_TEMPLATE.format(service_name=self.namespace)
 
   @property
   def context(self):
-    return self.__context
+    return self._context
 
   @property
   def context_docker_file_path(self):
@@ -59,24 +52,12 @@ class WorkflowBuilder(Builder):
 
   @property
   def profiles(self):
-    return self.__profiles
+    return self._profiles
 
   @property
   def proxy(self):
     return WORKFLOW_CONTAINER_PROXY_TEMPLATE.format(service_name=self.namespace)
 
-  @property
-  def service_builder(self):
-    return self.__service_builder
-
-  @property
-  def service_path(self):
-    return self.__service_builder.dir_path
-
-  @property
-  def workflow_name(self):
-    return self.__workflow_name
-
   def build_all(self):
     # Resources
     if self.config.detached:
@@ -147,11 +128,21 @@ class WorkflowBuilder(Builder):
 
     self.with_service(self.proxy, service)
 
-  def env_dict(self):
-    env = {}
-    for e in self._env:
-      env[e] = '${' + e + '}'
-    return env
+  def build(self, workflow_decorators: List[Union[MockDecorator, ReverseProxyDecorator]] = None):
+    """Build the Docker workflow with all components and decorators."""
+
+    # Build all workflow components
+    self.build_all()
+
+    # Apply workflow decorators if provided
+    if isinstance(workflow_decorators, list):
+      for workflow_decorator in workflow_decorators:
+        workflow_decorator(self).decorate()
+
+    # Write the compose file
+    self.write()
+
+    return self
 
   def write(self):
     compose = {
@@ -166,11 +157,3 @@ class WorkflowBuilder(Builder):
 
     super().write(compose)
 
-  def __with_url_environment(self, environment):
-    environment[SERVICE_HOSTNAME_ENV] = SERVICE_HOSTNAME
-
-    if self.config.scheme:
-      environment[SERVICE_SCHEME_ENV] = SERVICE_SCHEME
-
-    if self.config.port:
-      environment[SERVICE_PORT_ENV] = SERVICE_PORT

stoobly_agent/app/cli/scaffold/docker/workflow/command_decorator.py

@@ -1,7 +1,7 @@
 from ...constants import (
-  SERVICE_PROXY_MODE, SERVICE_UPSTREAM_HOSTNAME, SERVICE_UPSTREAM_PORT, SERVICE_UPSTREAM_SCHEME,
+  SERVICE_UPSTREAM_HOSTNAME, SERVICE_UPSTREAM_PORT, SERVICE_UPSTREAM_SCHEME,
 )
-from .builder import WorkflowBuilder
+from ...local.workflow.builder import WorkflowBuilder
 
 class CommandDecorator():
 
@@ -15,6 +15,7 @@ class CommandDecorator():
   @property
   def proxy_mode(self):
     config = self.workflow_builder.config
+
     if config.upstream_hostname == 'host.docker.internal':
       return f"upstream:{SERVICE_UPSTREAM_SCHEME}://{SERVICE_UPSTREAM_HOSTNAME}:{SERVICE_UPSTREAM_PORT}"
 

stoobly_agent/app/cli/scaffold/docker/workflow/detached_decorator.py

@@ -2,7 +2,7 @@ import os
 import pdb
 
 from ...constants import SERVICE_HOSTNAME, SERVICE_PORT, STOOBLY_CERTS_DIR
-from .builder import WorkflowBuilder
+from ...local.workflow.builder import WorkflowBuilder
 from .command_decorator import CommandDecorator
 
 class DetachedDecorator(CommandDecorator):

stoobly_agent/app/cli/scaffold/docker/workflow/dns_decorator.py

@@ -1,8 +1,7 @@
 from ...constants import SERVICE_DNS
+from ...local.workflow.builder import WorkflowBuilder
 
-from .builder import WorkflowBuilder
-
-class DnsDecorator():
+class DnsDecorator:
 
   def __init__(self, workflow_builder: WorkflowBuilder):
     self.__workflow_builder = workflow_builder

stoobly_agent/app/cli/scaffold/docker/workflow/local_decorator.py

@@ -1,4 +1,4 @@
-from .builder import WorkflowBuilder
+from ...local.workflow.builder import WorkflowBuilder
 
 class LocalDecorator():
 

stoobly_agent/app/cli/scaffold/docker/workflow/mock_decorator.py

@@ -4,7 +4,7 @@ import pdb
 from ...constants import (
   SERVICE_HOSTNAME, SERVICE_PORT, STOOBLY_CERTS_DIR,
 )
-from .builder import WorkflowBuilder
+from ...local.workflow.builder import WorkflowBuilder
 from .command_decorator import CommandDecorator
 
 class MockDecorator(CommandDecorator):

stoobly_agent/app/cli/scaffold/docker/workflow/reverse_proxy_decorator.py

@@ -4,7 +4,7 @@ import pdb
 from urllib.parse import urlparse
 
 from ...constants import SERVICE_HOSTNAME, SERVICE_PORT, STOOBLY_CERTS_DIR
-from .builder import WorkflowBuilder
+from ...local.workflow.builder import WorkflowBuilder
 from .command_decorator import CommandDecorator
 
 class ReverseProxyDecorator(CommandDecorator):