devservices 1.0.2__tar.gz → 1.0.4__tar.gz

{devservices-1.0.2 → devservices-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devservices
-Version: 1.0.2
+Version: 1.0.4
 Requires-Python: >=3.10
 License-File: LICENSE.md
 Requires-Dist: pyyaml

{devservices-1.0.2 → devservices-1.0.4}/README.md

@@ -1,6 +1,6 @@
 # devservices
 
-A standalone cli tool used to manage dependencies for services. It simplifies the process of starting, stopping, and managing services for development purposes.
+A standalone cli tool used to manage dependencies for services. It simplifies the process of managing services for development purposes and bringing services up/down.
 
 ## Overview
 
@@ -11,7 +11,7 @@ A standalone cli tool used to manage dependencies for services. It simplifies th
 The recommended way to install devservices is through a virtualenv in the requirements.txt.
 
 ```
-devservices==1.0.2
+devservices==1.0.4
 ```
 
 
@@ -23,8 +23,8 @@ devservices provides several commands to manage your services:
 
 NOTE: service-name is an optional parameter. If not provided, devservices will attempt to automatically find a devservices configuration in the current directory in order to proceed.
 
-- `devservices start <service-name>`: Start a service and its dependencies.
-- `devservices stop <service-name>`: Stop a service including its dependencies.
+- `devservices up <service-name>`: Bring up a service and its dependencies.
+- `devservices down <service-name>`: Bring down service including its dependencies.
 - `devservices status <service-name>`: Display the current status of all services, including their dependencies and ports.
 - `devservices logs <service-name>`: View logs for a specific service.
 - `devservices list-services`: List all available Sentry services.

{devservices-1.0.2 → devservices-1.0.4}/devservices/commands/check_for_update.py

@@ -4,7 +4,7 @@ import json
 from urllib.request import urlopen
 
 
-def check_for_update(current_version: str) -> str | None:
+def check_for_update() -> str | None:
     url = "https://api.github.com/repos/getsentry/devservices/releases/latest"
     with urlopen(url) as response:
         if response.status == 200:

devservices-1.0.4/devservices/commands/down.py

@@ -0,0 +1,145 @@
+from __future__ import annotations
+
+import concurrent.futures
+import os
+import subprocess
+from argparse import _SubParsersAction
+from argparse import ArgumentParser
+from argparse import Namespace
+
+from sentry_sdk import capture_exception
+
+from devservices.constants import CONFIG_FILE_NAME
+from devservices.constants import DEPENDENCY_CONFIG_VERSION
+from devservices.constants import DEVSERVICES_DEPENDENCIES_CACHE_DIR
+from devservices.constants import DEVSERVICES_DEPENDENCIES_CACHE_DIR_KEY
+from devservices.constants import DEVSERVICES_DIR_NAME
+from devservices.constants import DOCKER_COMPOSE_COMMAND_LENGTH
+from devservices.exceptions import ConfigError
+from devservices.exceptions import DependencyError
+from devservices.exceptions import DockerComposeError
+from devservices.exceptions import ServiceNotFoundError
+from devservices.utils.console import Console
+from devservices.utils.console import Status
+from devservices.utils.dependencies import get_non_shared_remote_dependencies
+from devservices.utils.dependencies import install_and_verify_dependencies
+from devservices.utils.dependencies import InstalledRemoteDependency
+from devservices.utils.docker_compose import get_docker_compose_commands_to_run
+from devservices.utils.docker_compose import run_cmd
+from devservices.utils.services import find_matching_service
+from devservices.utils.services import Service
+from devservices.utils.state import State
+
+
+def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
+    parser = subparsers.add_parser(
+        "down", help="Bring down a service and its dependencies"
+    )
+    parser.add_argument(
+        "service_name",
+        help="Name of the service to bring down",
+        nargs="?",
+        default=None,
+    )
+    parser.add_argument(
+        "--debug",
+        help="Enable debug mode",
+        action="store_true",
+        default=False,
+    )
+    parser.set_defaults(func=down)
+
+
+def down(args: Namespace) -> None:
+    """Bring down a service and its dependencies."""
+    console = Console()
+    service_name = args.service_name
+    try:
+        service = find_matching_service(service_name)
+    except (ConfigError, ServiceNotFoundError) as e:
+        capture_exception(e)
+        console.failure(str(e))
+        exit(1)
+
+    modes = service.config.modes
+
+    state = State()
+    started_services = state.get_started_services()
+    if service.name not in started_services:
+        console.warning(f"{service.name} is not running")
+        exit(0)
+
+    mode = state.get_mode_for_service(service.name) or "default"
+    mode_dependencies = modes[mode]
+
+    with Status(
+        lambda: console.warning(f"Stopping {service.name}"),
+        lambda: console.success(f"{service.name} stopped"),
+    ) as status:
+        try:
+            remote_dependencies = install_and_verify_dependencies(service, mode=mode)
+        except DependencyError as de:
+            capture_exception(de)
+            status.failure(str(de))
+            exit(1)
+        remote_dependencies = get_non_shared_remote_dependencies(
+            service, remote_dependencies
+        )
+        try:
+            _down(service, remote_dependencies, mode_dependencies, status)
+        except DockerComposeError as dce:
+            capture_exception(dce)
+            status.failure(f"Failed to stop {service.name}: {dce.stderr}")
+            exit(1)
+
+    # TODO: We should factor in healthchecks here before marking service as not running
+    state = State()
+    state.remove_started_service(service.name)
+
+
+def _bring_down_dependency(
+    cmd: list[str], current_env: dict[str, str], status: Status
+) -> subprocess.CompletedProcess[str]:
+    # TODO: Get rid of these constants, we need a smarter way to determine the containers being brought down
+    for dependency in cmd[DOCKER_COMPOSE_COMMAND_LENGTH:]:
+        status.info(f"Stopping {dependency}")
+    return run_cmd(cmd, current_env)
+
+
+def _down(
+    service: Service,
+    remote_dependencies: set[InstalledRemoteDependency],
+    mode_dependencies: list[str],
+    status: Status,
+) -> None:
+    relative_local_dependency_directory = os.path.relpath(
+        os.path.join(DEVSERVICES_DEPENDENCIES_CACHE_DIR, DEPENDENCY_CONFIG_VERSION),
+        service.repo_path,
+    )
+    service_config_file_path = os.path.join(
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
+    )
+    # Set the environment variable for the local dependencies directory to be used by docker compose
+    current_env = os.environ.copy()
+    current_env[
+        DEVSERVICES_DEPENDENCIES_CACHE_DIR_KEY
+    ] = relative_local_dependency_directory
+    docker_compose_commands = get_docker_compose_commands_to_run(
+        service=service,
+        remote_dependencies=list(remote_dependencies),
+        current_env=current_env,
+        command="down",
+        options=[],
+        service_config_file_path=service_config_file_path,
+        mode_dependencies=mode_dependencies,
+    )
+
+    cmd_outputs = []
+
+    with concurrent.futures.ThreadPoolExecutor() as executor:
+        futures = [
+            executor.submit(_bring_down_dependency, cmd, current_env, status)
+            for cmd in docker_compose_commands
+        ]
+        for future in concurrent.futures.as_completed(futures):
+            cmd_outputs.append(future.result())

{devservices-1.0.2 → devservices-1.0.4}/devservices/commands/list_dependencies.py

@@ -4,6 +4,10 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
+from sentry_sdk import capture_exception
+
+from devservices.exceptions import ConfigError
+from devservices.exceptions import ServiceNotFoundError
 from devservices.utils.console import Console
 from devservices.utils.services import find_matching_service
 
@@ -28,7 +32,8 @@ def list_dependencies(args: Namespace) -> None:
 
     try:
         service = find_matching_service(service_name)
-    except Exception as e:
+    except (ConfigError, ServiceNotFoundError) as e:
+        capture_exception(e)
         console.failure(str(e))
         exit(1)
 

devservices-1.0.4/devservices/commands/logs.py

@@ -0,0 +1,120 @@
+from __future__ import annotations
+
+import concurrent.futures
+import os
+import subprocess
+from argparse import _SubParsersAction
+from argparse import ArgumentParser
+from argparse import Namespace
+
+from sentry_sdk import capture_exception
+
+from devservices.constants import CONFIG_FILE_NAME
+from devservices.constants import DEPENDENCY_CONFIG_VERSION
+from devservices.constants import DEVSERVICES_DEPENDENCIES_CACHE_DIR
+from devservices.constants import DEVSERVICES_DEPENDENCIES_CACHE_DIR_KEY
+from devservices.constants import DEVSERVICES_DIR_NAME
+from devservices.constants import MAX_LOG_LINES
+from devservices.exceptions import ConfigError
+from devservices.exceptions import DependencyError
+from devservices.exceptions import DockerComposeError
+from devservices.exceptions import ServiceNotFoundError
+from devservices.utils.console import Console
+from devservices.utils.dependencies import install_and_verify_dependencies
+from devservices.utils.dependencies import InstalledRemoteDependency
+from devservices.utils.docker_compose import get_docker_compose_commands_to_run
+from devservices.utils.docker_compose import run_cmd
+from devservices.utils.services import find_matching_service
+from devservices.utils.services import Service
+from devservices.utils.state import State
+
+
+def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
+    parser = subparsers.add_parser("logs", help="View logs for a service")
+    parser.add_argument(
+        "service_name",
+        help="Name of the service to view logs for",
+        nargs="?",
+        default=None,
+    )
+    parser.set_defaults(func=logs)
+
+
+def logs(args: Namespace) -> None:
+    """View the logs for a specified service."""
+    console = Console()
+    service_name = args.service_name
+    try:
+        service = find_matching_service(service_name)
+    except (ConfigError, ServiceNotFoundError) as e:
+        capture_exception(e)
+        console.failure(str(e))
+        exit(1)
+
+    modes = service.config.modes
+    # TODO: allow custom modes to be used
+    mode_to_use = "default"
+    mode_dependencies = modes[mode_to_use]
+
+    state = State()
+    running_services = state.get_started_services()
+    if service.name not in running_services:
+        console.warning(f"Service {service.name} is not running")
+        return
+
+    try:
+        remote_dependencies = install_and_verify_dependencies(service)
+    except DependencyError as de:
+        capture_exception(de)
+        console.failure(str(de))
+        exit(1)
+    try:
+        logs_output = _logs(service, remote_dependencies, mode_dependencies)
+    except DockerComposeError as dce:
+        capture_exception(dce)
+        console.failure(f"Failed to get logs for {service.name}: {dce.stderr}")
+        exit(1)
+    for log in logs_output:
+        log_stdout: str | None = log.stdout
+        if log_stdout is not None:
+            console.info(log_stdout)
+
+
+def _logs(
+    service: Service,
+    remote_dependencies: set[InstalledRemoteDependency],
+    mode_dependencies: list[str],
+) -> list[subprocess.CompletedProcess[str]]:
+    relative_local_dependency_directory = os.path.relpath(
+        os.path.join(DEVSERVICES_DEPENDENCIES_CACHE_DIR, DEPENDENCY_CONFIG_VERSION),
+        service.repo_path,
+    )
+    service_config_file_path = os.path.join(
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
+    )
+    # Set the environment variable for the local dependencies directory to be used by docker compose
+    current_env = os.environ.copy()
+    current_env[
+        DEVSERVICES_DEPENDENCIES_CACHE_DIR_KEY
+    ] = relative_local_dependency_directory
+    docker_compose_commands = get_docker_compose_commands_to_run(
+        service=service,
+        remote_dependencies=list(remote_dependencies),
+        current_env=current_env,
+        command="logs",
+        options=["-n", MAX_LOG_LINES],
+        service_config_file_path=service_config_file_path,
+        mode_dependencies=mode_dependencies,
+    )
+
+    cmd_outputs = []
+
+    with concurrent.futures.ThreadPoolExecutor() as executor:
+        futures = [
+            executor.submit(run_cmd, cmd, current_env)
+            for cmd in docker_compose_commands
+        ]
+        for future in concurrent.futures.as_completed(futures):
+            cmd_outputs.append(future.result())
+
+    return cmd_outputs

{devservices-1.0.2 → devservices-1.0.4}/devservices/commands/purge.py

@@ -2,11 +2,13 @@ from __future__ import annotations
 
 import os
 import shutil
+import subprocess
 from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
 from devservices.constants import DEVSERVICES_CACHE_DIR
+from devservices.constants import DOCKER_NETWORK_NAME
 from devservices.exceptions import DockerDaemonNotRunningError
 from devservices.utils.console import Console
 from devservices.utils.console import Status
@@ -19,9 +21,10 @@ def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     parser.set_defaults(func=purge)
 
 
-def purge(args: Namespace) -> None:
+def purge(_args: Namespace) -> None:
     """Purge the local devservices cache."""
     console = Console()
+
     # Prompt the user to stop all running containers
     should_stop_containers = console.confirm(
         "Warning: Purging stops all running containers and clears devservices state. Would you like to continue?"
@@ -47,4 +50,32 @@ def purge(args: Namespace) -> None:
         except DockerDaemonNotRunningError:
             console.warning("The docker daemon not running, no containers to stop")
 
+    console.warning("Removing any devservices networks")
+    devservices_networks = (
+        subprocess.check_output(
+            [
+                "docker",
+                "network",
+                "ls",
+                "--filter",
+                f"name={DOCKER_NETWORK_NAME}",
+                "--format",
+                "{{.ID}}",
+            ]
+        )
+        .decode()
+        .strip()
+        .splitlines()
+    )
+    if len(devservices_networks) == 0:
+        console.success("No devservices networks found to remove")
+    for network in devservices_networks:
+        subprocess.run(
+            ["docker", "network", "rm", network],
+            check=True,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+        console.success(f"Network {network} removed")
+
     console.success("The local devservices cache and state has been purged")

{devservices-1.0.2 → devservices-1.0.4}/devservices/commands/status.py

@@ -1,16 +1,31 @@
 from __future__ import annotations
 
+import concurrent.futures
 import json
+import os
+import subprocess
 from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
+from sentry_sdk import capture_exception
+
+from devservices.constants import CONFIG_FILE_NAME
+from devservices.constants import DEPENDENCY_CONFIG_VERSION
+from devservices.constants import DEVSERVICES_DEPENDENCIES_CACHE_DIR
+from devservices.constants import DEVSERVICES_DEPENDENCIES_CACHE_DIR_KEY
+from devservices.constants import DEVSERVICES_DIR_NAME
+from devservices.exceptions import ConfigError
 from devservices.exceptions import DependencyError
 from devservices.exceptions import DockerComposeError
+from devservices.exceptions import ServiceNotFoundError
 from devservices.utils.console import Console
 from devservices.utils.dependencies import install_and_verify_dependencies
-from devservices.utils.docker_compose import run_docker_compose_command
+from devservices.utils.dependencies import InstalledRemoteDependency
+from devservices.utils.docker_compose import get_docker_compose_commands_to_run
+from devservices.utils.docker_compose import run_cmd
 from devservices.utils.services import find_matching_service
+from devservices.utils.services import Service
 
 LINE_LENGTH = 40
 
@@ -61,12 +76,13 @@ def format_status_output(status_json: str) -> str:
 
 
 def status(args: Namespace) -> None:
-    """Start a service and its dependencies."""
+    """Get the status of a specified service."""
     console = Console()
     service_name = args.service_name
     try:
         service = find_matching_service(service_name)
-    except Exception as e:
+    except (ConfigError, ServiceNotFoundError) as e:
+        capture_exception(e)
         console.failure(str(e))
         exit(1)
 
@@ -78,17 +94,13 @@ def status(args: Namespace) -> None:
     try:
         remote_dependencies = install_and_verify_dependencies(service)
     except DependencyError as de:
+        capture_exception(de)
         console.failure(str(de))
         exit(1)
     try:
-        status_json_results = run_docker_compose_command(
-            service,
-            "ps",
-            mode_dependencies,
-            remote_dependencies,
-            options=["--format", "json"],
-        )
+        status_json_results = _status(service, remote_dependencies, mode_dependencies)
     except DockerComposeError as dce:
+        capture_exception(dce)
         console.failure(f"Failed to get status for {service.name}: {dce.stderr}")
         exit(1)
 
@@ -104,3 +116,43 @@ def status(args: Namespace) -> None:
         output += format_status_output(status_json.stdout)
     output += "=" * LINE_LENGTH
     console.info(output + "\n")
+
+
+def _status(
+    service: Service,
+    remote_dependencies: set[InstalledRemoteDependency],
+    mode_dependencies: list[str],
+) -> list[subprocess.CompletedProcess[str]]:
+    relative_local_dependency_directory = os.path.relpath(
+        os.path.join(DEVSERVICES_DEPENDENCIES_CACHE_DIR, DEPENDENCY_CONFIG_VERSION),
+        service.repo_path,
+    )
+    service_config_file_path = os.path.join(
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
+    )
+    # Set the environment variable for the local dependencies directory to be used by docker compose
+    current_env = os.environ.copy()
+    current_env[
+        DEVSERVICES_DEPENDENCIES_CACHE_DIR_KEY
+    ] = relative_local_dependency_directory
+    docker_compose_commands = get_docker_compose_commands_to_run(
+        service=service,
+        remote_dependencies=list(remote_dependencies),
+        current_env=current_env,
+        command="ps",
+        options=["--format", "json"],
+        service_config_file_path=service_config_file_path,
+        mode_dependencies=mode_dependencies,
+    )
+
+    cmd_outputs = []
+
+    with concurrent.futures.ThreadPoolExecutor() as executor:
+        futures = [
+            executor.submit(run_cmd, cmd, current_env)
+            for cmd in docker_compose_commands
+        ]
+        for future in concurrent.futures.as_completed(futures):
+            cmd_outputs.append(future.result())
+
+    return cmd_outputs