stoobly-agent 1.7.2__py3-none-any.whl → 1.8.1__py3-none-any.whl

stoobly_agent/__init__.py

@@ -1,2 +1,2 @@
 COMMAND = 'stoobly-agent'
-VERSION = '1.7.2'
+VERSION = '1.8.1'

stoobly_agent/app/cli/intercept_cli.py

@@ -41,6 +41,8 @@ def intercept(ctx):
     help="Enable intercept"
 )
 def enable(**kwargs):
+    settings = Settings.instance()
+
     settings.proxy.intercept.active = True
 
     handle_intercept_active_update(settings)

stoobly_agent/app/cli/scaffold/constants.py

@@ -40,9 +40,6 @@ STOOBLY_HOME_DIR = '/home/stoobly'
 STOOBLY_DATA_DIR = os.path.join(STOOBLY_HOME_DIR, DATA_DIR_NAME)
 STOOBLY_CERTS_DIR = os.path.join(STOOBLY_DATA_DIR, CERTS_DIR_NAME)
 USER_ID_ENV = 'USER_ID'
-VIRTUAL_HOST_ENV = 'VIRTUAL_HOST'
-VIRTUAL_PORT_ENV = 'VIRTUAL_PORT'
-VIRTUAL_PROTO_ENV = 'VIRTUAL_PROTO'
 WORKFLOW_CONTAINER_CONFIGURE = 'configure'
 WORKFLOW_CONTAINER_INIT = 'init'
 WORKFLOW_CONTAINER_PROXY = 'proxy'

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

@@ -10,7 +10,6 @@ DOCKER_COMPOSE_CUSTOM = 'docker-compose.yml'
 DOCKER_COMPOSE_NETWORKS = '.docker-compose.networks.yml'
 DOCKERFILE_CONTEXT = '.Dockerfile.context'
 DOCKERFILE_SERVICE = 'Dockerfile.source'
-GATEWAY_NGINX_TEMPLATE = 'nginx.tmpl'
 
 # TODO: add scaffold container name templates here
 

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

@@ -91,22 +91,28 @@ class ServiceBuilder(Builder):
     if not self.config.hostname:
       return
 
+    service_id = self.config.id
     environment = { **self.env_dict() }
+    labels = [
+      'traefik.enable=true',
+      f"traefik.http.routers.{service_id}.rule=Host(`{SERVICE_HOSTNAME}`)",
+      f"traefik.http.services.{service_id}.loadbalancer.server.port={SERVICE_PORT}"
+    ]
     volumes = []
 
-    environment['VIRTUAL_HOST'] = SERVICE_HOSTNAME
-    environment['VIRTUAL_PORT'] = SERVICE_PORT
-    environment['VIRTUAL_PROTO'] = SERVICE_SCHEME
-
     if self.config.detached:
       self.__with_detached_volumes(volumes)
 
+    if self.config.tls:
+      labels.append(f"traefik.http.routers.{service_id}.tls=true")
+
     base = {
       'environment': environment,
       'extends': {
         'file': os.path.relpath(self.app_builder.compose_file_path, self.dir_path),
         'service': self.extends_service
       },
+      'labels': labels,
       'working_dir': self.__working_dir,
     }
 

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

@@ -1,6 +1,5 @@
 import os
 import pdb
-import shutil
 import yaml
 
 from typing import List
@@ -8,9 +7,8 @@ from typing import List
 from stoobly_agent.config.data_dir import DATA_DIR_NAME, TMP_DIR_NAME
 from stoobly_agent.app.cli.scaffold.constants import APP_DIR
 from stoobly_agent.app.cli.scaffold.service_config import ServiceConfig
-from stoobly_agent.app.cli.scaffold.docker.constants import APP_INGRESS_NETWORK_NAME, APP_EGRESS_NETWORK_NAME, DOCKER_COMPOSE_BASE, DOCKER_COMPOSE_BASE_TEMPLATE, GATEWAY_NGINX_TEMPLATE
+from stoobly_agent.app.cli.scaffold.docker.constants import APP_INGRESS_NETWORK_NAME, APP_EGRESS_NETWORK_NAME, DOCKER_COMPOSE_BASE, DOCKER_COMPOSE_BASE_TEMPLATE
 from stoobly_agent.app.cli.scaffold.templates.constants import CORE_GATEWAY_SERVICE_NAME
-from stoobly_agent.app.cli.scaffold.templates import run_template_path
 
 def configure_gateway(service_paths: List[str], no_publish = False):
   if len(service_paths) == 0:
@@ -38,7 +36,7 @@ def configure_gateway(service_paths: List[str], no_publish = False):
         gateway_base['ports'] = ports
 
       app_dir_path = os.path.dirname(os.path.dirname(service_dir_path))
-      __with_no_publish(gateway_base, app_dir_path)
+      __with_traefik_config(service_paths, gateway_base, app_dir_path)
       __with_networks(gateway_base, hostnames) 
 
   with open(docker_compose_dest_path, 'w') as fp:
@@ -52,31 +50,60 @@ def __with_networks(config: dict, hostnames: List[str]):
     'aliases': hostnames
   }
 
-def __with_no_publish(config: dict, app_dir_path: str):
-  if not config['volumes']:
-    config['volumes'] = []
+def __with_traefik_config(service_paths: str, compose: dict, app_dir_path: str):
+  if not compose['volumes']:
+    compose['volumes'] = []
+
+  entry_points = {}
+  certificates = []
+  traefik_config = {
+    'accessLog': {
+      'format': 'common',
+    },
+    'entryPoints': entry_points,
+    'log': {
+      'format': 'common',
+      'level': 'INFO',
+    },
+    'providers': {
+      'docker': {
+        'exposedByDefault': False
+      }
+    },
+    'tls': {
+      'certificates': certificates
+    }
+  }
 
-  # Copy nginx.tmpl to .stoobly/tmp
-  nginx_template_src_path = os.path.join(run_template_path(), GATEWAY_NGINX_TEMPLATE)
-  nginx_template_relative_path = os.path.join(DATA_DIR_NAME, TMP_DIR_NAME, GATEWAY_NGINX_TEMPLATE)
-  nginx_template_dest_path = os.path.join(app_dir_path, nginx_template_relative_path)
+  for path in service_paths:
+    config = ServiceConfig(path)
 
-  if not os.path.exists(os.path.dirname(nginx_template_dest_path)):
-    os.makedirs(os.path.dirname(nginx_template_dest_path), exist_ok=True)
+    if not config.hostname:
+      continue
 
-  shutil.copy(nginx_template_src_path, nginx_template_dest_path)
+    entry_points[config.port] = {
+      'address': f":{config.port}"
+    }
 
-  config['volumes'].append(
-    f"{os.path.join(APP_DIR, nginx_template_relative_path)}:/app/nginx.tmpl:ro"
-  )
+    if config.scheme == 'https':
+      certificates.append({
+        'certFile': f"/certs/{config.hostname}.crt",
+        'keyFile': f"/certs/{config.hostname}.key"
+      })
+
+  # Create traefik.yml in .stoobly/tmp
+  traefik_template_relative_path = os.path.join(DATA_DIR_NAME, TMP_DIR_NAME, 'traefik.yml')
+  traefik_template_dest_path = os.path.join(app_dir_path, traefik_template_relative_path)
 
-  environment = {}
-  if not config['environment']:
-    config['environment'] = environment
-  else:
-    environment = config['environment']
+  if not os.path.exists(os.path.dirname(traefik_template_dest_path)):
+    os.makedirs(os.path.dirname(traefik_template_dest_path), exist_ok=True)
 
-  environment['HTTPS_METHOD'] = 'noredirect'
+  with open(traefik_template_dest_path, 'w') as fp:
+    fp.write(yaml.dump(traefik_config))
+
+  compose['volumes'].append(
+    f"{os.path.join(APP_DIR, traefik_template_relative_path)}:/etc/traefik/traefik.yml:ro"
+  )
 
 def __find_hosts(service_paths):
   hostnames = []

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

@@ -1,6 +1,6 @@
 from stoobly_agent.app.cli.scaffold.service_config import ServiceConfig
 
-from ...constants import WORKFLOW_MOCK_TYPE, WORKFLOW_RECORD_TYPE
+from ...constants import WORKFLOW_MOCK_TYPE, WORKFLOW_RECORD_TYPE, WORKFLOW_TEST_TYPE
 from .dns_decorator import DnsDecorator
 from .mock_decorator import MockDecorator
 from .reverse_proxy_decorator import ReverseProxyDecorator
@@ -12,7 +12,7 @@ def get_workflow_decorators(workflow: str, service_config: ServiceConfig):
     if service_config.hostname:
       workflow_decorators.append(ReverseProxyDecorator)
       workflow_decorators.append(DnsDecorator)
-  elif workflow == WORKFLOW_MOCK_TYPE:
+  elif workflow == WORKFLOW_MOCK_TYPE or workflow == WORKFLOW_TEST_TYPE:
      if service_config.hostname:
       workflow_decorators.append(ReverseProxyDecorator if service_config.detached else MockDecorator)    
       workflow_decorators.append(DnsDecorator)

stoobly_agent/app/cli/scaffold/service_config.py

@@ -1,4 +1,6 @@
 # Wraps the .config.yml file in the service folder
+import hashlib
+import os
 import pdb
 
 from .config import Config
@@ -51,6 +53,10 @@ class ServiceConfig(Config):
   def detached(self, v):
     self.__detached = v
 
+  @property
+  def id(self):
+    return hashlib.md5(os.path.basename(self.dir).encode()).hexdigest()
+
   @property
   def hostname(self):
     return (self.__hostname or '').strip()
@@ -120,6 +126,10 @@ class ServiceConfig(Config):
   def scheme(self, v):
     self.__scheme = v
 
+  @property
+  def tls(self) -> bool:
+    return self.__scheme == 'https'
+
   def load(self, config = None):
     config = config or self.read()
 

stoobly_agent/app/cli/scaffold/service_workflow_validate_command.py

@@ -13,9 +13,6 @@ from docker.models.containers import Container
 from stoobly_agent.app.cli.scaffold.constants import (
   PUBLIC_FOLDER_NAME,
   STOOBLY_DATA_DIR,
-  VIRTUAL_HOST_ENV,
-  VIRTUAL_PORT_ENV,
-  VIRTUAL_PROTO_ENV,
   WORKFLOW_RECORD_TYPE,
   WORKFLOW_TEST_TYPE,
 )
@@ -172,30 +169,6 @@ class ServiceWorkflowValidateCommand(ServiceCommand, ValidateCommand):
     if Counter(public_folder_contents_container) != Counter(public_folder_contents_scaffold):
       raise ScaffoldValidateException(f"public folder was not mounted properly, expected {self.public_dir_path} to exist in container path {public_folder_path}")
 
-  # Note: might not need this if the hostname is reachable and working
-  def proxy_environment_variables_exist(self, container: Container) -> None:
-    environment_variables = container.attrs['Config']['Env']
-    virtual_host_exists = False
-    virtual_port_exists = False
-    virtual_proto_exists = False
-
-    for environment_variable in environment_variables:
-      environment_variable_name, environment_variable_value = environment_variable.split('=')
-      if environment_variable_name == VIRTUAL_HOST_ENV:
-        virtual_host_exists = True
-      elif environment_variable_name == VIRTUAL_PORT_ENV:
-        virtual_port_exists = True
-      elif environment_variable_name == VIRTUAL_PROTO_ENV:
-        virtual_proto_exists = True
-
-    if not virtual_host_exists:
-      raise ScaffoldValidateException(f"VIRTUAL_HOST environment variable is missing from container: {container.name}")
-    if not virtual_port_exists:
-      raise ScaffoldValidateException(f"VIRTUAL_POST environment variable is missing from container: {container.name}")
-    if not virtual_proto_exists:
-      raise ScaffoldValidateException(f"VIRTUAL_PROTO environment variable is missing from container: {container.name}")
-
-  
   def validate_proxy_container(self, service_proxy_container: Container):
     print(f"Validating proxy container: {service_proxy_container.name}")
 
@@ -209,8 +182,6 @@ class ServiceWorkflowValidateCommand(ServiceCommand, ValidateCommand):
     if not self.service_config.detached:
       self.validate_public_folder(service_proxy_container)
 
-    self.proxy_environment_variables_exist(service_proxy_container)
-
   def validate_service_container(self):
     pass
   

stoobly_agent/app/cli/scaffold/templates/__init__.py

@@ -4,5 +4,5 @@ import pathlib
 def __path():
   return os.path.join(pathlib.Path(__file__).parent.resolve())
 
-def run_template_path():
-  return os.path.join(__path(), 'run')
+def build_template_path():
+  return os.path.join(__path(), 'build')

stoobly_agent/app/cli/scaffold/templates/app/.Dockerfile.context

@@ -1,4 +1,4 @@
-FROM stoobly/agent:1.7
+FROM stoobly/agent:1.8
 
 ARG USER_ID
 

stoobly_agent/app/cli/scaffold/templates/app/gateway/.docker-compose.base.template.yml

@@ -1,10 +1,10 @@
 services:
   gateway_base:
-    environment:
-      TRUST_DOWNSTREAM_PROXY: true
-    image: nginxproxy/nginx-proxy:1.7
+    command:
+      - "--configFile=/etc/traefik/traefik.yml"
+    image: traefik:v3
     profiles:
       - gateway_base
     volumes:
-      - /var/run/docker.sock:/tmp/docker.sock:ro
-      - ${CERTS_DIR}:/etc/nginx/certs
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+      - ${CERTS_DIR}:/certs:ro

stoobly_agent/app/cli/scaffold/templates/build/services/build/mock/.configure

@@ -3,7 +3,8 @@
 # This file was automatically generated. DO NOT EDIT.
 # Any changes made to this file will be overwritten.
 
-stoobly-agent config reset
+echo "Configuring intercept..."
+stoobly-agent intercept configure --mode mock --policy all
 
 entrypoint=$1
 

stoobly_agent/app/cli/scaffold/templates/build/services/build/mock/.init

@@ -3,6 +3,8 @@
 # This file was automatically generated. DO NOT EDIT.
 # Any changes made to this file will be overwritten.
 
+stoobly-agent config reset
+
 stoobly-agent snapshot apply
 
 entrypoint=$1

stoobly_agent/app/cli/scaffold/templates/build/services/build/record/.configure

@@ -3,7 +3,8 @@
 # This file was automatically generated. DO NOT EDIT.
 # Any changes made to this file will be overwritten.
 
-stoobly-agent config reset
+echo "Configuring intercept..."
+stoobly-agent intercept configure --mode record --policy all
 
 entrypoint=$1
 

stoobly_agent/app/cli/scaffold/templates/build/services/build/record/.init

@@ -3,6 +3,8 @@
 # This file was automatically generated. DO NOT EDIT.
 # Any changes made to this file will be overwritten.
 
+stoobly-agent config reset
+
 stoobly-agent snapshot apply
 
 entrypoint=$1

stoobly_agent/app/cli/scaffold/templates/build/services/build/test/.configure

@@ -3,7 +3,8 @@
 # This file was automatically generated. DO NOT EDIT.
 # Any changes made to this file will be overwritten.
 
-stoobly-agent config reset
+echo "Configuring intercept..."
+stoobly-agent intercept configure --mode mock --policy all
 
 entrypoint=$1
 

stoobly_agent/app/cli/scaffold/templates/build/services/build/test/.init

@@ -3,6 +3,8 @@
 # This file was automatically generated. DO NOT EDIT.
 # Any changes made to this file will be overwritten.
 
+stoobly-agent config reset
+
 stoobly-agent snapshot apply
 
 entrypoint=$1

stoobly_agent/app/cli/scaffold/templates/build/services/entrypoint/mock/.configure

@@ -3,12 +3,6 @@
 # This file was automatically generated. DO NOT EDIT.
 # Any changes made to this file will be overwritten.
 
-echo "Configuring intercept..."
-stoobly-agent intercept configure --mode mock --policy all
-
-echo "Enabling intercept..."
-stoobly-agent intercept enable
-
 entrypoint=$1
 
 if [ -e "$entrypoint" ]; then

stoobly_agent/app/cli/scaffold/templates/build/services/entrypoint/record/.configure

@@ -3,12 +3,6 @@
 # This file was automatically generated. DO NOT EDIT.
 # Any changes made to this file will be overwritten.
 
-echo "Configuring intercept..."
-stoobly-agent intercept configure --mode record --policy all
-
-echo "Disabling intercept..."
-stoobly-agent intercept disable
-
 entrypoint=$1
 
 if [ -e "$entrypoint" ]; then

stoobly_agent/app/cli/scaffold/templates/build/services/entrypoint/test/.configure

@@ -3,12 +3,6 @@
 # This file was automatically generated. DO NOT EDIT.
 # Any changes made to this file will be overwritten.
 
-echo "Configuring intercept..."
-stoobly-agent intercept configure --mode mock --policy all
-
-echo "Enabling intercept..."
-stoobly-agent intercept enable
-
 entrypoint=$1
 
 if [ -e "$entrypoint" ]; then

stoobly_agent/app/cli/scaffold/templates/constants.py

@@ -16,14 +16,13 @@ CUSTOM_CONFIGURE = os.path.join('bin', 'configure')
 CUSTOM_INIT = os.path.join('bin', 'init')
 CUSTOM_FIXTURES = 'fixtures.yml'
 CUSTOM_LIFECYCLE_HOOKS = os.path.join('lifecycle_hooks.py')
+CUSTOM_PUBLIC_GITIGNORE = os.path.join('public', '.gitignore')
 MAINTAINED_CONFIGURE = os.path.join('bin', '.configure')
 MAINTAINED_INIT = os.path.join('bin', '.init')
-MAINTAINED_PUBLIC = os.path.join('public', '.gitignore')
 
 MOCK_WORKFLOW_MAINTAINED_FILES = [
   MAINTAINED_CONFIGURE,
   MAINTAINED_INIT,
-  MAINTAINED_PUBLIC
 ]
 
 MOCK_WORKFLOW_CUSTOM_FILES = [
@@ -32,6 +31,7 @@ MOCK_WORKFLOW_CUSTOM_FILES = [
   CUSTOM_FIXTURES,
   CUSTOM_INIT,
   CUSTOM_LIFECYCLE_HOOKS,
+  CUSTOM_PUBLIC_GITIGNORE
 ]
 
 RECORD_WORKFLOW_MAINTAINED_FILES = [
@@ -43,13 +43,12 @@ RECORD_WORKFLOW_CUSTOM_FILES = [
   CUSTOM_BUILD,
   CUSTOM_CONFIGURE,
   CUSTOM_INIT,
-  CUSTOM_LIFECYCLE_HOOKS
+  CUSTOM_LIFECYCLE_HOOKS,
 ]
 
 TEST_WORKFLOW_MAINTAINED_FILES = [
   MAINTAINED_CONFIGURE,
   MAINTAINED_INIT,
-  MAINTAINED_PUBLIC
 ]
 
 TEST_WORKFLOW_CUSTOM_FILES = [
@@ -57,7 +56,8 @@ TEST_WORKFLOW_CUSTOM_FILES = [
   CUSTOM_CONFIGURE,
   CUSTOM_FIXTURES,
   CUSTOM_INIT,
-  CUSTOM_LIFECYCLE_HOOKS
+  CUSTOM_LIFECYCLE_HOOKS,
+  CUSTOM_PUBLIC_GITIGNORE
 ]
 
 SERVICE_HOSTNAME_BUILD_ARG = 'SERVICE_HOSTNAME'

stoobly_agent/app/cli/scaffold/templates/factory.py

@@ -1,7 +1,9 @@
+import pdb
+
 from ..constants import WORKFLOW_MOCK_TYPE, WORKFLOW_RECORD_TYPE, WORKFLOW_TEST_TYPE
 from ..docker.workflow.builder import WorkflowBuilder
 from .constants import (
-  CUSTOM_CONFIGURE, CUSTOM_INIT, MAINTAINED_CONFIGURE, MAINTAINED_PUBLIC, MOCK_WORKFLOW_CUSTOM_FILES, MOCK_WORKFLOW_MAINTAINED_FILES, RECORD_WORKFLOW_CUSTOM_FILES, RECORD_WORKFLOW_MAINTAINED_FILES, TEST_WORKFLOW_CUSTOM_FILES, TEST_WORKFLOW_MAINTAINED_FILES
+  CUSTOM_CONFIGURE, CUSTOM_INIT, CUSTOM_PUBLIC_GITIGNORE, MAINTAINED_CONFIGURE, MOCK_WORKFLOW_CUSTOM_FILES, MOCK_WORKFLOW_MAINTAINED_FILES, RECORD_WORKFLOW_CUSTOM_FILES, RECORD_WORKFLOW_MAINTAINED_FILES, TEST_WORKFLOW_CUSTOM_FILES, TEST_WORKFLOW_MAINTAINED_FILES
 )
 
 def custom_files(workflow: str, workflow_builder: WorkflowBuilder):
@@ -21,8 +23,8 @@ def custom_files(workflow: str, workflow_builder: WorkflowBuilder):
 
   # Fixtures are only relevant if the workflow is mock/test and if the service has a hostname
   if not workflow_builder.config.hostname:
-    if MAINTAINED_PUBLIC in files:
-      files.remove(MAINTAINED_PUBLIC)
+    if CUSTOM_PUBLIC_GITIGNORE in files:
+      files.remove(CUSTOM_PUBLIC_GITIGNORE)
 
   return files
 
@@ -39,8 +41,4 @@ def maintained_files(workflow: str, workflow_builder: WorkflowBuilder):
     if workflow_builder.configure in workflow_builder.services:
       files.append(MAINTAINED_CONFIGURE)
 
-  if not workflow_builder.config.hostname:
-    if MAINTAINED_PUBLIC in files:
-      files.remove(MAINTAINED_PUBLIC)
-
   return files

stoobly_agent/app/cli/scaffold_cli.py

@@ -1,6 +1,7 @@
 import click
 import os
 import pdb
+import re
 import sys
 
 from io import TextIOWrapper
@@ -142,6 +143,16 @@ def mkcert(**kwargs):
 def create(**kwargs):
   __validate_app_dir(kwargs['app_dir_path'])
 
+  if '/' in kwargs['service_name']:
+    print(f"Error: {kwargs['service_name']} is invalid. It cannot container '/", file=sys.stderr)
+    sys.exit(1)
+
+  if kwargs.get('hostname'):
+    hostname_regex = re.compile(r'^[a-zA-Z0-9.-]+$')
+    if not re.search(hostname_regex, kwargs['hostname']):
+      print(f"Error: {kwargs['hostname']} is invalid.", file=sys.stderr)
+      sys.exit(1)
+
   app = App(kwargs['app_dir_path'], DOCKER_NAMESPACE)
 
   service = Service(kwargs['service_name'], app)

stoobly_agent/app/settings/__init__.py

@@ -178,14 +178,18 @@ class Settings:
 
     def write(self, contents):
         if contents:
-            fp = open(self.__settings_file_path, 'w')
-            yaml.dump(contents, fp, allow_unicode=True)
-            fp.close()
+            with open(self.__settings_file_path, 'w') as fp:
+                yaml.dump(contents, fp, allow_unicode=True)
 
     ### Helpers
 
     def __create_default_file(self):
-        copyfile(SourceDir.instance().settings_template_file_path, self.__settings_file_path)
+        contents = ''
+        with open(SourceDir.instance().settings_template_file_path, 'r') as fp:
+            contents = fp.read()
+
+        with open(self.__settings_file_path, 'w') as fp:
+            fp.write(contents)
 
     def __detect_paths(self):
         self.__settings_file_path = os.environ.get(env_vars.AGENT_CONFIG_PATH) or self.__data_dir.settings_file_path

stoobly_agent/test/app/models/schemas/.stoobly/db/VERSION

@@ -1 +1 @@
-1.7.0
+1.7.2

{stoobly_agent-1.7.2.dist-info → stoobly_agent-1.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stoobly-agent
-Version: 1.7.2
+Version: 1.8.1
 Summary: Record, mock, and test HTTP(s) requests. CLI agent for Stoobly
 License: Apache-2.0
 Author: Matt Le