stoobly-agent 1.6.7__tar.gz → 1.7.1__tar.gz

{stoobly_agent-1.6.7 → stoobly_agent-1.7.1}/PKG-INFO

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

{stoobly_agent-1.6.7 → stoobly_agent-1.7.1}/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.6.7"
+version = "1.7.1"
 
 [tool.poetry.dependencies]
 python = "^3.10"

{stoobly_agent-1.6.7 → stoobly_agent-1.7.1}/stoobly_agent/__init__.py

@@ -1,2 +1,2 @@
 COMMAND = 'stoobly-agent'
-VERSION = '1.6.7'
+VERSION = '1.7.1'

{stoobly_agent-1.6.7 → stoobly_agent-1.7.1}/stoobly_agent/app/cli/scaffold/docker/constants.py

@@ -10,6 +10,7 @@ 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-1.7.1/stoobly_agent/app/cli/scaffold/docker/service/configure_gateway.py

@@ -0,0 +1,102 @@
+import os
+import pdb
+import shutil
+import yaml
+
+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.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:
+    return
+
+  hostnames, ports = __find_hosts(service_paths)
+
+  service_dir_path = os.path.dirname(service_paths[0])
+  gateway_service_path = os.path.join(service_dir_path, CORE_GATEWAY_SERVICE_NAME)
+  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)
+
+  compose = {}
+  with open(docker_compose_src_path, 'r') as fp:
+    compose = yaml.safe_load(fp)
+    services = compose.get('services')
+
+    if not services:
+      return
+    
+    gateway_base = services.get('gateway_base')
+
+    if gateway_base:
+      if not no_publish:
+        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_networks(gateway_base, hostnames) 
+
+  with open(docker_compose_dest_path, 'w') as fp:
+    yaml.dump(compose, fp) 
+
+def __with_networks(config: dict, hostnames: List[str]):
+  networks = {} 
+  config['networks'] = networks
+  networks[APP_EGRESS_NETWORK_NAME] = {}
+  networks[APP_INGRESS_NETWORK_NAME] = {
+    'aliases': hostnames
+  }
+
+def __with_no_publish(config: dict, app_dir_path: str):
+  if not config['volumes']:
+    config['volumes'] = []
+
+  # 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)
+
+  if not os.path.exists(os.path.dirname(nginx_template_dest_path)):
+    os.makedirs(os.path.dirname(nginx_template_dest_path), exist_ok=True)
+
+  shutil.copy(nginx_template_src_path, nginx_template_dest_path)
+
+  config['volumes'].append(
+    f"{os.path.join(APP_DIR, nginx_template_relative_path)}:/app/nginx.tmpl:ro"
+  )
+
+  environment = {}
+  if not config['environment']:
+    config['environment'] = environment
+  else:
+    environment = config['environment']
+
+  environment['HTTPS_METHOD'] = 'noredirect'
+
+def __find_hosts(service_paths):
+  hostnames = []
+  ports = []
+  for path in service_paths:
+    config = ServiceConfig(path)
+
+    if not config.hostname:
+      continue
+
+    try:
+      port = int(config.port)
+    except Exception:
+      continue
+    
+    port_mapping = f"{port}:{port}"
+    if port > 0 and port <= 65535 and port_mapping not in ports:
+      ports.append(port_mapping)
+
+    if config.hostname not in hostnames:
+      hostnames.append(config.hostname) 
+
+  return hostnames, ports

{stoobly_agent-1.6.7 → stoobly_agent-1.7.1}/stoobly_agent/app/cli/scaffold/hosts_file_manager.py

@@ -15,21 +15,21 @@ class HostsFileManager():
     ip_address: str
     hostnames: list[str]
 
-  def __get_hosts_file_path(self) -> str:
+  # Split IP address and hostnames. Don't include inline comments
+  def __split_hosts_line(self, line: str) -> list[str]:
+    ip_addr_hosts_split = line.split('#')[0].split()
+    return ip_addr_hosts_split
+
+  def get_hosts_file_path(self) -> str:
     file_path = '/etc/hosts'
     if not os.path.exists(file_path):
       print(f"Error: File {file_path} not found.", file=sys.stderr)
       sys.exit(1)
     return file_path
 
-  # Split IP address and hostnames. Don't include inline comments
-  def __split_hosts_line(self, line: str) -> list[str]:
-    ip_addr_hosts_split = line.split('#')[0].split()
-    return ip_addr_hosts_split
-
   # Parses hosts file and returns a mapping of IP address to hostnames in a list.
   def get_hosts(self) -> list[IpAddressToHostnames]:
-    hosts_file_path = self.__get_hosts_file_path()
+    hosts_file_path = self.get_hosts_file_path()
 
     if not hosts_file_path:
       return []
@@ -64,14 +64,14 @@ class HostsFileManager():
     return None
 
   def install_hostnames(self, hostnames: list[str]) -> None:
-    hosts_file_path = self.__get_hosts_file_path()
+    hosts_file_path = self.get_hosts_file_path()
 
     self.__add_lines_between_markers(
       hosts_file_path, SCAFFOLD_HOSTS_DELIMITTER_BEGIN, SCAFFOLD_HOSTS_DELIMITTER_END, hostnames
     )
 
   def uninstall_hostnames(self, hostnames: list[str] = []) -> None:
-    hosts_file_path = self.__get_hosts_file_path()
+    hosts_file_path = self.get_hosts_file_path()
 
     self.__remove_lines_between_markers(
       hosts_file_path, SCAFFOLD_HOSTS_DELIMITTER_BEGIN, SCAFFOLD_HOSTS_DELIMITTER_END, hostnames
@@ -182,4 +182,4 @@ class HostsFileManager():
       filtered_lines.append(line)
 
     with open(file_path, "w") as file:
-      file.writelines(filtered_lines)
+      file.writelines(filtered_lines)

{stoobly_agent-1.6.7 → stoobly_agent-1.7.1}/stoobly_agent/app/cli/scaffold/service_workflow_validate_command.py

@@ -4,6 +4,7 @@ import socket
 import time
 
 from collections import Counter
+from docker import errors as docker_errors
 from pathlib import Path
 
 import yaml
@@ -25,6 +26,7 @@ from stoobly_agent.app.cli.scaffold.service_docker_compose import ServiceDockerC
 from stoobly_agent.app.cli.scaffold.validate_command import ValidateCommand
 from stoobly_agent.app.cli.scaffold.validate_exceptions import ScaffoldValidateException
 from stoobly_agent.config.data_dir import DATA_DIR_NAME
+from stoobly_agent.lib.logger import bcolors
 
 from .app import App
 
@@ -84,7 +86,10 @@ class ServiceWorkflowValidateCommand(ServiceCommand, ValidateCommand):
         if attempt < retries - 1:
           time.sleep(delay)
 
-    raise ScaffoldValidateException(f"Connection failed to hostname: {hostname}, port: {port}")
+    hostname_not_reachable_message = f"{bcolors.FAIL}Connection failed to hostname: {hostname}, port: {port}, num_retries: {retries}{bcolors.ENDC}"
+    suggestion_message = f"{bcolors.BOLD}Try confirming that {hostname} is reachable from your machine or environment.{bcolors.ENDC}"
+    error_message = f"{hostname_not_reachable_message}\n\n{suggestion_message}"
+    raise ScaffoldValidateException(error_message)
 
   # Check if hostname is defined in hosts file
   def hostname_exists(self, hostname: str) -> bool:
@@ -96,7 +101,12 @@ class ServiceWorkflowValidateCommand(ServiceCommand, ValidateCommand):
       print(f"Correct hosts mapping found for {hostname}")
       return True
 
-    raise ScaffoldValidateException(f"Missing hosts mapping for {hostname}")
+    hosts_file_path = hosts_file_manager.get_hosts_file_path()
+
+    missing_host_message = f"{bcolors.FAIL}Missing hosts mapping for {hostname}{bcolors.ENDC}"
+    suggestion_message = f"{bcolors.BOLD}Confirm hostname '{hostname}' is in your hosts file at '{hosts_file_path}'. If not there, please add it{bcolors.ENDC}"
+    error_message = f"{missing_host_message}\n\n{suggestion_message}"
+    raise ScaffoldValidateException(error_message)
  
   def validate_hostname(self, hostname: str, port: int) -> None:
     print(f"Validating hostname: {hostname}")
@@ -188,8 +198,13 @@ class ServiceWorkflowValidateCommand(ServiceCommand, ValidateCommand):
   
   def validate_proxy_container(self, service_proxy_container: Container):
     print(f"Validating proxy container: {service_proxy_container.name}")
+
+    if service_proxy_container.status == 'exited' or service_proxy_container.attrs['State']['ExitCode'] != 0:
+      raise ScaffoldValidateException(f"Proxy container is exited: {service_proxy_container.name}")
+    if service_proxy_container.status != 'running':
+      raise ScaffoldValidateException(f"Proxy container is not running: {service_proxy_container.name}")
     if not service_proxy_container.attrs:
-      raise ScaffoldValidateException(f"Container attributes are missing for: {container.name}")
+      raise ScaffoldValidateException(f"Container attributes are missing for: {service_proxy_container.name}")
 
     if not self.service_config.detached:
       self.validate_public_folder(service_proxy_container)
@@ -219,32 +234,53 @@ class ServiceWorkflowValidateCommand(ServiceCommand, ValidateCommand):
     self.validate_public_folder(init_container)
 
     if self.service_config.hostname:
-      service_proxy_container = self.docker_client.containers.get(self.service_docker_compose.proxy_container_name)
+      try:
+        service_proxy_container = self.docker_client.containers.get(self.service_docker_compose.proxy_container_name)
+      except docker_errors.NotFound:
+        error_message = self._ValidateCommand__generate_container_not_found_error(self.service_docker_compose.proxy_container_name)
+        raise ScaffoldValidateException(error_message)
+
       self.validate_proxy_container(service_proxy_container)
 
+    # External services won't have a container to check
+    if self.is_local() or self.service_config.detached:
+      container_name = self.service_docker_compose.container_name
+      try:
+        service_container = self.docker_client.containers.get(container_name)
+      except docker_errors.NotFound:
+        error_message = self._ValidateCommand__generate_container_not_found_error(container_name)
+        raise ScaffoldValidateException(error_message)
+      if service_container.status == 'exited' or service_container.attrs['State']['ExitCode'] != 0:
+        raise ScaffoldValidateException(f"Custom container is exited: {service_container.name}")
+      if service_container.status != 'running':
+        raise ScaffoldValidateException(f"Custom container is not running: {service_container.name}")
+    
     if self.is_local():
       print(f"Validating local user defined service: {self.service_name}")
       # Validate docker-compose path exists
       docker_compose_path = f"{self.app_dir_path}/{DATA_DIR_NAME}/docker/{self.service_docker_compose.service_name}/{self.workflow_name}/docker-compose.yml"
       destination_path = Path(docker_compose_path)
+
+      if not destination_path.exists():
+        message = f"{bcolors.FAIL}Docker Compose file does not exist: {destination_path}{bcolors.ENDC}"
+        suggestion_message = f"{bcolors.BOLD}A missing Docker Compose file often means it got deleted by accident. Please restore from backup or rerun the scaffold service create command.{bcolors.ENDC}"
+        error_message = f"{message}\n\n{suggestion_message}"
+        raise ScaffoldValidateException(error_message)
       if not destination_path.is_file():
         raise ScaffoldValidateException(f"Docker compose path is not a file: {destination_path}")
 
       # Validate docker-compose.yml file has the service defined
       with open(destination_path) as f:
         if self.service_name not in f.read():
-          raise ScaffoldValidateException(f"Local service is not defined in Docker Compose file: {destination_path}")
-
-      service_container = self.docker_client.containers.get(self.service_docker_compose.container_name)
-      if service_container.status == 'exited':
-        return False
+          message = f"{bcolors.FAIL}Custom container service is not defined in Docker Compose file: {destination_path}{bcolors.ENDC}"
+          suggestion_message = f"{bcolors.BOLD}Please add your service definition. See https://docs.docker.com/reference/compose-file/services {bcolors.ENDC}"
+          error_message = f"{message}\n\n{suggestion_message}"
+          raise ScaffoldValidateException(error_message)
 
     if self.service_config.detached:
-      service_container = self.docker_client.containers.get(self.service_docker_compose.container_name)
       self.validate_detached(service_container)
 
-    print(f"Done validating service: {self.service_name}, success!")
-    print()
+    print(f"{bcolors.OKGREEN}✔ Done validating service: {self.service_name}, success!{bcolors.ENDC}\n")
 
     return True
 

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

@@ -0,0 +1,8 @@
+import os
+import pathlib
+
+def __path():
+  return os.path.join(pathlib.Path(__file__).parent.resolve())
+
+def run_template_path():
+  return os.path.join(__path(), 'run')

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

@@ -0,0 +1,6 @@
+FROM stoobly/agent:1.7
+
+ARG USER_ID
+
+# Change user id of stoobly user to that of host's user id
+RUN if [ -n "$USER_ID" ]; then usermod -u $USER_ID stoobly; fi

{stoobly_agent-1.6.7 → stoobly_agent-1.7.1}/stoobly_agent/app/cli/scaffold/templates/app/gateway/.docker-compose.base.template.yml

@@ -2,7 +2,7 @@ services:
   gateway_base:
     environment:
       TRUST_DOWNSTREAM_PROXY: true
-    image: nginxproxy/nginx-proxy:1.5
+    image: nginxproxy/nginx-proxy:1.7
     profiles:
       - gateway_base
     volumes: