devservices 1.0.7__tar.gz → 1.0.9__tar.gz

{devservices-1.0.7 → devservices-1.0.9}/PKG-INFO

@@ -1,10 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: devservices
-Version: 1.0.7
+Version: 1.0.9
 Requires-Python: >=3.10
 License-File: LICENSE.md
 Requires-Dist: pyyaml
 Requires-Dist: sentry-devenv
+Requires-Dist: sentry-sdk
+Requires-Dist: packaging
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: mypy; extra == "dev"

{devservices-1.0.7 → devservices-1.0.9}/README.md

@@ -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.7
+devservices==1.0.9
 ```
 
 

{devservices-1.0.7 → devservices-1.0.9}/devservices/commands/down.py

@@ -15,11 +15,13 @@ 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 ConfigNotFoundError
 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 construct_dependency_graph
 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
@@ -56,6 +58,12 @@ def down(args: Namespace) -> None:
     service_name = args.service_name
     try:
         service = find_matching_service(service_name)
+    except ConfigNotFoundError as e:
+        capture_exception(e)
+        console.failure(
+            f"{str(e)}. Please specify a service (i.e. `devservices down sentry`) or run the command from a directory with a devservices configuration."
+        )
+        exit(1)
     except ConfigError as e:
         capture_exception(e)
         console.failure(str(e))
@@ -80,7 +88,6 @@ def down(args: Namespace) -> None:
 
     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(
@@ -98,16 +105,42 @@ def down(args: Namespace) -> None:
             capture_exception(de)
             status.failure(str(de))
             exit(1)
-        try:
-            _down(service, remote_dependencies, list(mode_dependencies), status)
-        except DockerComposeError as dce:
-            capture_exception(dce)
-            status.failure(f"Failed to stop {service.name}: {dce.stderr}")
-            exit(1)
+
+        # Check if any service depends on the service we are trying to bring down
+        # TODO: We should also take into account the active modes of the other services (this is not trivial to do)
+        other_started_services = set(started_services).difference({service.name})
+        dependent_service_name = None
+        for other_started_service in other_started_services:
+            other_service = find_matching_service(other_started_service)
+            other_service_active_modes = state.get_active_modes_for_service(
+                other_service.name
+            )
+            dependency_graph = construct_dependency_graph(
+                other_service, other_service_active_modes
+            )
+            # If the service we are trying to bring down is in the dependency graph of another service, we should not bring it down
+            if service.name in dependency_graph.graph:
+                dependent_service_name = other_started_service
+                break
+
+        # If no other service depends on the service we are trying to bring down, we can bring it down
+        if dependent_service_name is None:
+            try:
+                _down(service, remote_dependencies, list(mode_dependencies), status)
+            except DockerComposeError as dce:
+                capture_exception(dce)
+                status.failure(f"Failed to stop {service.name}: {dce.stderr}")
+                exit(1)
+        else:
+            status.warning(
+                f"Leaving {service.name} running because it is being used by {dependent_service_name}"
+            )
 
     # TODO: We should factor in healthchecks here before marking service as not running
     state = State()
     state.remove_started_service(service.name)
+    if dependent_service_name is None:
+        console.success(f"{service.name} stopped")
 
 
 def _bring_down_dependency(
@@ -141,7 +174,7 @@ def _down(
         service=service,
         remote_dependencies=list(remote_dependencies),
         current_env=current_env,
-        command="down",
+        command="stop",
         options=[],
         service_config_file_path=service_config_file_path,
         mode_dependencies=mode_dependencies,

{devservices-1.0.7 → devservices-1.0.9}/devservices/commands/list_dependencies.py

@@ -7,6 +7,7 @@ from argparse import Namespace
 from sentry_sdk import capture_exception
 
 from devservices.exceptions import ConfigError
+from devservices.exceptions import ConfigNotFoundError
 from devservices.exceptions import ServiceNotFoundError
 from devservices.utils.console import Console
 from devservices.utils.services import find_matching_service
@@ -32,6 +33,12 @@ def list_dependencies(args: Namespace) -> None:
 
     try:
         service = find_matching_service(service_name)
+    except ConfigNotFoundError as e:
+        capture_exception(e)
+        console.failure(
+            f"{str(e)}. Please specify a service (i.e. `devservices list-dependencies sentry`) or run the command from a directory with a devservices configuration."
+        )
+        exit(1)
     except ConfigError as e:
         capture_exception(e)
         console.failure(str(e))

{devservices-1.0.7 → devservices-1.0.9}/devservices/commands/logs.py

@@ -16,6 +16,7 @@ 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 ConfigNotFoundError
 from devservices.exceptions import DependencyError
 from devservices.exceptions import DockerComposeError
 from devservices.exceptions import ServiceNotFoundError
@@ -46,6 +47,12 @@ def logs(args: Namespace) -> None:
     service_name = args.service_name
     try:
         service = find_matching_service(service_name)
+    except ConfigNotFoundError as e:
+        capture_exception(e)
+        console.failure(
+            f"{str(e)}. Please specify a service (i.e. `devservices logs sentry`) or run the command from a directory with a devservices configuration."
+        )
+        exit(1)
     except ConfigError as e:
         capture_exception(e)
         console.failure(str(e))

{devservices-1.0.7 → devservices-1.0.9}/devservices/commands/status.py

@@ -7,6 +7,7 @@ import subprocess
 from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
+from collections import namedtuple
 
 from sentry_sdk import capture_exception
 
@@ -16,6 +17,7 @@ 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 ConfigNotFoundError
 from devservices.exceptions import DependencyError
 from devservices.exceptions import DockerComposeError
 from devservices.exceptions import ServiceNotFoundError
@@ -30,6 +32,9 @@ from devservices.utils.services import Service
 LINE_LENGTH = 40
 
 
+ServiceStatus = namedtuple("ServiceStatus", ["name", "formatted_output"])
+
+
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     parser = subparsers.add_parser("status", help="View status of a service")
     parser.add_argument(
@@ -41,12 +46,12 @@ def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     parser.set_defaults(func=status)
 
 
-def format_status_output(status_json: str) -> str:
+def format_status_output(service_status_json: str) -> list[ServiceStatus]:
     # Docker compose ps is line delimited json, so this constructs this into an array we can use
-    service_statuses = status_json.split("\n")[:-1]
-    output = []
-    output.append("-" * LINE_LENGTH)
+    service_statuses = service_status_json.split("\n")[:-1]
+    outputs = []
     for service_status in service_statuses:
+        output = []
         service = json.loads(service_status)
         name = service["Service"]
         state = service["State"]
@@ -71,8 +76,9 @@ def format_status_output(status_json: str) -> str:
             output.append("No ports exposed")
 
         output.append("")  # Empty line for readability
+        outputs.append(ServiceStatus(name=name, formatted_output="\n".join(output)))
 
-    return "\n".join(output)
+    return outputs
 
 
 def status(args: Namespace) -> None:
@@ -81,6 +87,12 @@ def status(args: Namespace) -> None:
     service_name = args.service_name
     try:
         service = find_matching_service(service_name)
+    except ConfigNotFoundError as e:
+        capture_exception(e)
+        console.failure(
+            f"{str(e)}. Please specify a service (i.e. `devservices status sentry`) or run the command from a directory with a devservices configuration."
+        )
+        exit(1)
     except ConfigError as e:
         capture_exception(e)
         console.failure(str(e))
@@ -115,10 +127,15 @@ def status(args: Namespace) -> None:
         console.warning(f"{service.name} is not running")
         return
     output = f"Service: {service.name}\n\n"
+    output += "=" * LINE_LENGTH + "\n"
+    formatted_status_outputs = []
     for status_json in status_json_results:
-        output += format_status_output(status_json.stdout)
-    output += "=" * LINE_LENGTH
-    console.info(output + "\n")
+        formatted_status_outputs.extend(format_status_output(status_json.stdout))
+    formatted_status_outputs.sort(key=lambda x: x.name)
+    for formatted_status_output in formatted_status_outputs:
+        output += formatted_status_output[1]
+        output += "-" * LINE_LENGTH + "\n"
+    console.info(output)
 
 
 def _status(

{devservices-1.0.7 → devservices-1.0.9}/devservices/commands/up.py

@@ -15,6 +15,7 @@ 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 ConfigNotFoundError
 from devservices.exceptions import ContainerHealthcheckFailedError
 from devservices.exceptions import DependencyError
 from devservices.exceptions import DockerComposeError
@@ -60,6 +61,12 @@ def up(args: Namespace) -> None:
     service_name = args.service_name
     try:
         service = find_matching_service(service_name)
+    except ConfigNotFoundError as e:
+        capture_exception(e)
+        console.failure(
+            f"{str(e)}. Please specify a service (i.e. `devservices up sentry`) or run the command from a directory with a devservices configuration."
+        )
+        exit(1)
     except ConfigError as e:
         capture_exception(e)
         console.failure(str(e))
@@ -107,7 +114,6 @@ def up(args: Namespace) -> None:
 def _bring_up_dependency(
     cmd: DockerComposeCommand, 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 up
     for dependency in cmd.services:
         status.info(f"Starting {dependency}")
     return run_cmd(cmd.full_command, current_env)
@@ -132,7 +138,6 @@ def _up(
     current_env[
         DEVSERVICES_DEPENDENCIES_CACHE_DIR_KEY
     ] = relative_local_dependency_directory
-    options = ["-d", "--pull", "always"]
     dependency_graph = construct_dependency_graph(service, modes=modes)
     starting_order = dependency_graph.get_starting_order()
     sorted_remote_dependencies = sorted(
@@ -143,7 +148,7 @@ def _up(
         remote_dependencies=sorted_remote_dependencies,
         current_env=current_env,
         command="up",
-        options=options,
+        options=["-d", "--pull", "always"],
         service_config_file_path=service_config_file_path,
         mode_dependencies=mode_dependencies,
     )
@@ -180,4 +185,5 @@ def _create_devservices_network() -> None:
         ["docker", "network", "create", "devservices"],
         stdout=subprocess.DEVNULL,
         stderr=subprocess.DEVNULL,
+        check=True,
     )

{devservices-1.0.7 → devservices-1.0.9}/devservices/configs/service_config.py

@@ -67,8 +67,10 @@ class ServiceConfig:
 def load_service_config_from_file(repo_path: str) -> ServiceConfig:
     config_path = os.path.join(repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME)
     if not os.path.exists(config_path):
-        raise ConfigNotFoundError(f"Config file not found in directory: {config_path}")
-    with open(config_path, "r") as stream:
+        raise ConfigNotFoundError(
+            f"No devservices configuration found in {config_path}"
+        )
+    with open(config_path, "r", encoding="utf-8") as stream:
         try:
             config = yaml.safe_load(stream)
         except yaml.YAMLError as yml_error:

{devservices-1.0.7 → devservices-1.0.9}/devservices/constants.py

@@ -37,5 +37,5 @@ DEVSERVICES_LATEST_VERSION_CACHE_FILE = os.path.join(
     DEVSERVICES_CACHE_DIR, "latest_version.txt"
 )
 DEVSERVICES_LATEST_VERSION_CACHE_TTL = timedelta(minutes=15)
-HEALTHCHECK_TIMEOUT = 30
+HEALTHCHECK_TIMEOUT = 45
 HEALTHCHECK_INTERVAL = 5

{devservices-1.0.7 → devservices-1.0.9}/devservices/main.py

@@ -26,7 +26,6 @@ from devservices.commands import update
 from devservices.constants import LOGGER_NAME
 from devservices.exceptions import DockerComposeInstallationError
 from devservices.exceptions import DockerDaemonNotRunningError
-from devservices.utils.check_for_update import check_for_update
 from devservices.utils.console import Console
 from devservices.utils.docker_compose import check_docker_compose_version
 
@@ -102,14 +101,6 @@ def main() -> None:
     else:
         parser.print_help()
 
-    if args.command != "update" and os.environ.get("CI") != "true":
-        newest_version = check_for_update()
-        if newest_version != current_version:
-            console.warning(
-                f"WARNING: A new version of devservices is available: {newest_version}"
-            )
-            console.warning('To update, run: "devservices update"')
-
 
 if __name__ == "__main__":
     main()

{devservices-1.0.7 → devservices-1.0.9}/devservices/utils/console.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import os
 import sys
 import threading
 import time
@@ -97,6 +98,8 @@ class Status:
             self.on_success()
 
     def _loading_animation(self) -> None:
+        if os.environ.get("CI", default="false") == "true":
+            return
         idx = 0
         while not self._stop_loading.is_set():
             sys.stdout.write("\r" + ANIMATION_FRAMES[idx % len(ANIMATION_FRAMES)] + " ")

{devservices-1.0.7 → devservices-1.0.9}/devservices/utils/dependencies.py

@@ -5,6 +5,7 @@ import os
 import shutil
 import subprocess
 import tempfile
+import time
 from collections import deque
 from concurrent.futures import as_completed
 from concurrent.futures import ThreadPoolExecutor
@@ -264,15 +265,28 @@ def get_non_shared_remote_dependencies(
     # We don't care about the remote dependencies of the service we are stopping
     started_services.remove(service_to_stop.name)
     other_running_remote_dependencies: set[InstalledRemoteDependency] = set()
-    for service_name in started_services:
-        service = find_matching_service(service_name)
+    base_running_service_names: set[str] = set()
+    for started_service_name in started_services:
+        started_service = find_matching_service(started_service_name)
+        for dependency_name in service_to_stop.config.dependencies.keys():
+            if dependency_name == started_service.config.service_name:
+                base_running_service_names.add(started_service_name)
+        installed_remote_dependencies = get_installed_remote_dependencies(
+            list(started_service.config.dependencies.values())
+        )
         # TODO: There is an edge case here where there is a shared remote dependency with different modes
         other_running_remote_dependencies = other_running_remote_dependencies.union(
-            get_installed_remote_dependencies(
-                list(service.config.dependencies.values())
-            )
+            installed_remote_dependencies
         )
-    return remote_dependencies.difference(other_running_remote_dependencies)
+    non_shared_remote_dependencies = remote_dependencies.difference(
+        other_running_remote_dependencies
+    )
+    non_shared_remote_dependencies = {
+        dependency
+        for dependency in non_shared_remote_dependencies
+        if dependency.service_name not in base_running_service_names
+    }
+    return non_shared_remote_dependencies
 
 
 def get_installed_remote_dependencies(
@@ -448,7 +462,7 @@ def _update_dependency(
         ) from e
 
     try:
-        _run_command(
+        _run_command_with_retries(
             ["git", "fetch", "origin", dependency.branch, "--filter=blob:none"],
             cwd=dependency_repo_dir,
         )
@@ -574,6 +588,25 @@ def _run_command(
     subprocess.run(cmd, cwd=cwd, check=True, stdout=stdout, stderr=subprocess.DEVNULL)
 
 
+def _run_command_with_retries(
+    cmd: list[str],
+    cwd: str,
+    stdout: int | TextIO | None = subprocess.DEVNULL,
+    retries: int = 3,
+    backoff: int = 2,
+) -> None:
+    for i in range(retries):
+        try:
+            _run_command(cmd, cwd=cwd, stdout=stdout)
+            break
+        except subprocess.CalledProcessError as e:
+            logger = logging.getLogger(LOGGER_NAME)
+            logger.exception("Attempt %s of %s failed: %s", i + 1, retries, e)
+            if i == retries - 1:
+                raise e
+            time.sleep(backoff**i)
+
+
 def _try_set_git_config_context(
     git_config_manager: GitConfigManager,
 ) -> None:

{devservices-1.0.7 → devservices-1.0.9}/devservices/utils/docker.py

@@ -66,7 +66,7 @@ def wait_for_healthy(container_name: str, status: Status) -> None:
 
         if result == "healthy":
             return
-        elif result == "unknown":
+        if result == "unknown":
             status.warning(
                 f"WARNING: Container {container_name} does not have a healthcheck"
             )

{devservices-1.0.7 → devservices-1.0.9}/devservices/utils/docker_compose.py

@@ -5,7 +5,6 @@ import os
 import platform
 import re
 import subprocess
-from collections.abc import Callable
 from typing import cast
 from typing import NamedTuple
 
@@ -170,7 +169,7 @@ def check_docker_compose_version() -> None:
 
 
 # TODO: Consider removing this in favor of in house logic for determining non-remote services
-def _get_non_remote_services(
+def get_non_remote_services(
     service_config_path: str, current_env: dict[str, str]
 ) -> set[str]:
     config_command = [
@@ -195,19 +194,14 @@ def _get_non_remote_services(
     return set(config_services.splitlines())
 
 
-def get_docker_compose_commands_to_run(
-    service: Service,
-    remote_dependencies: list[InstalledRemoteDependency],
-    current_env: dict[str, str],
+def create_docker_compose_command(
+    name: str,
+    config_path: str,
+    services_to_use: set[str],
     command: str,
     options: list[str],
-    service_config_file_path: str,
-    mode_dependencies: list[str],
-) -> list[DockerComposeCommand]:
-    docker_compose_commands = []
-    create_docker_compose_command: Callable[
-        [str, str, set[str]], DockerComposeCommand
-    ] = lambda name, config_path, services_to_use: DockerComposeCommand(
+) -> DockerComposeCommand:
+    return DockerComposeCommand(
         full_command=[
             "docker",
             "compose",
@@ -223,13 +217,25 @@ def get_docker_compose_commands_to_run(
         config_path=config_path,
         services=sorted(list(services_to_use)),
     )
+
+
+def get_docker_compose_commands_to_run(
+    service: Service,
+    remote_dependencies: list[InstalledRemoteDependency],
+    current_env: dict[str, str],
+    command: str,
+    options: list[str],
+    service_config_file_path: str,
+    mode_dependencies: list[str],
+) -> list[DockerComposeCommand]:
+    docker_compose_commands = []
     for dependency in remote_dependencies:
         # TODO: Consider passing in service config in InstalledRemoteDependency instead of loading it here
         dependency_service_config = load_service_config_from_file(dependency.repo_path)
         dependency_config_path = os.path.join(
             dependency.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
         )
-        non_remote_services = _get_non_remote_services(
+        non_remote_services = get_non_remote_services(
             dependency_config_path, current_env
         )
         services_to_use = non_remote_services.intersection(
@@ -240,18 +246,22 @@ def get_docker_compose_commands_to_run(
                 dependency_service_config.service_name,
                 dependency_config_path,
                 services_to_use,
+                command,
+                options,
             )
         )
 
     # Add docker compose command for the top level service
-    non_remote_services = _get_non_remote_services(
-        service_config_file_path, current_env
-    )
+    non_remote_services = get_non_remote_services(service_config_file_path, current_env)
     services_to_use = non_remote_services.intersection(set(mode_dependencies))
     if len(services_to_use) > 0:
         docker_compose_commands.append(
             create_docker_compose_command(
-                service.name, service_config_file_path, services_to_use
+                service.name,
+                service_config_file_path,
+                services_to_use,
+                command,
+                options,
             )
         )
     return docker_compose_commands

{devservices-1.0.7 → devservices-1.0.9}/devservices/utils/file_lock.py

@@ -7,7 +7,7 @@ from collections.abc import Generator
 
 @contextlib.contextmanager
 def lock(path: str) -> Generator[None, None, None]:
-    with open(path, mode="a+") as f:
+    with open(path, mode="a+", encoding="utf-8") as f:
         with _locked(f.fileno()):
             yield
 

{devservices-1.0.7 → devservices-1.0.9}/devservices/utils/services.py

@@ -65,4 +65,11 @@ def find_matching_service(service_name: str | None = None) -> Service:
     for service in services:
         if service.name.lower() == service_name.lower():
             return service
-    raise ServiceNotFoundError(f'Service "{service_name}" not found')
+    unique_service_names = sorted(set(service.name for service in services))
+    error_message = f"Service '{service_name}' not found."
+    if len(unique_service_names) > 0:
+        service_bullet_points = "\n".join(
+            [f"- {service_name}" for service_name in unique_service_names]
+        )
+        error_message += "\nSupported services:\n" + service_bullet_points
+    raise ServiceNotFoundError(error_message)

{devservices-1.0.7 → devservices-1.0.9}/devservices.egg-info/PKG-INFO

@@ -1,10 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: devservices
-Version: 1.0.7
+Version: 1.0.9
 Requires-Python: >=3.10
 License-File: LICENSE.md
 Requires-Dist: pyyaml
 Requires-Dist: sentry-devenv
+Requires-Dist: sentry-sdk
+Requires-Dist: packaging
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: mypy; extra == "dev"

{devservices-1.0.7 → devservices-1.0.9}/devservices.egg-info/requires.txt

@@ -1,5 +1,7 @@
 pyyaml
 sentry-devenv
+sentry-sdk
+packaging
 
 [dev]
 black

{devservices-1.0.7 → devservices-1.0.9}/pyproject.toml

@@ -4,12 +4,14 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "devservices"
-version = "1.0.7"
+version = "1.0.9"
 # 3.10 is just for internal pypi compat
 requires-python = ">=3.10"
 dependencies = [
     "pyyaml",
     "sentry-devenv",
+    "sentry-sdk",
+    "packaging",
 ]
 
 [project.optional-dependencies]