devservices 1.0.8__tar.gz → 1.0.10__tar.gz

{devservices-1.0.8 → devservices-1.0.10}/PKG-INFO

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

{devservices-1.0.8 → devservices-1.0.10}/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.8
+devservices==1.0.10
 ```
 
 

{devservices-1.0.8 → devservices-1.0.10}/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
@@ -29,6 +31,7 @@ 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
+from devservices.utils.state import StateTables
 
 
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
@@ -56,6 +59,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))
@@ -67,12 +76,20 @@ def down(args: Namespace) -> None:
     modes = service.config.modes
 
     state = State()
-    started_services = state.get_started_services()
-    if service.name not in started_services:
+    starting_services = set(state.get_service_entries(StateTables.STARTING_SERVICES))
+    started_services = set(state.get_service_entries(StateTables.STARTED_SERVICES))
+    active_services = starting_services.union(started_services)
+    if service.name not in active_services:
         console.warning(f"{service.name} is not running")
         exit(0)
 
-    active_modes = state.get_active_modes_for_service(service.name)
+    active_starting_modes = state.get_active_modes_for_service(
+        service.name, StateTables.STARTING_SERVICES
+    )
+    active_started_modes = state.get_active_modes_for_service(
+        service.name, StateTables.STARTED_SERVICES
+    )
+    active_modes = active_starting_modes or active_started_modes
     mode_dependencies = set()
     for active_mode in active_modes:
         active_mode_dependencies = modes.get(active_mode, [])
@@ -80,7 +97,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(
@@ -88,7 +104,9 @@ def down(args: Namespace) -> None:
             )
         except DependencyError as de:
             capture_exception(de)
-            status.failure(str(de))
+            status.failure(
+                f"{str(de)}. If this error persists, try running `devservices purge`"
+            )
             exit(1)
         try:
             remote_dependencies = get_non_shared_remote_dependencies(
@@ -96,18 +114,53 @@ def down(args: Namespace) -> None:
             )
         except DependencyError as de:
             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}")
+            status.failure(
+                f"{str(de)}. If this error persists, try running `devservices purge`"
+            )
             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 = active_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_starting_modes = state.get_active_modes_for_service(
+                other_service.name, StateTables.STARTING_SERVICES
+            )
+            other_service_active_started_modes = state.get_active_modes_for_service(
+                other_service.name, StateTables.STARTED_SERVICES
+            )
+            other_service_active_modes = (
+                other_service_active_starting_modes
+                or other_service_active_started_modes
+            )
+            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)
+    state.remove_service_entry(service.name, StateTables.STARTING_SERVICES)
+    state.remove_service_entry(service.name, StateTables.STARTED_SERVICES)
+    if dependent_service_name is None:
+        console.success(f"{service.name} stopped")
 
 
 def _bring_down_dependency(
@@ -141,7 +194,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.8 → devservices-1.0.10}/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.8 → devservices-1.0.10}/devservices/commands/list_services.py

@@ -8,6 +8,7 @@ from devservices.utils.console import Console
 from devservices.utils.devenv import get_coderoot
 from devservices.utils.services import get_local_services
 from devservices.utils.state import State
+from devservices.utils.state import StateTables
 
 
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
@@ -30,7 +31,9 @@ def list_services(args: Namespace) -> None:
     coderoot = get_coderoot()
     services = get_local_services(coderoot)
     state = State()
-    running_services = state.get_started_services()
+    starting_services = set(state.get_service_entries(StateTables.STARTING_SERVICES))
+    started_services = set(state.get_service_entries(StateTables.STARTED_SERVICES))
+    running_services = starting_services.union(started_services)
 
     if not services:
         console.warning("No services found")
@@ -46,8 +49,18 @@ def list_services(args: Namespace) -> None:
         console.info("Running services:")
 
     for service in services_to_show:
-        status = "running" if service.name in running_services else "stopped"
-        active_modes = state.get_active_modes_for_service(service.name)
+        status = "stopped"
+        if service.name in starting_services:
+            status = "starting"
+        elif service.name in started_services:
+            status = "started"
+        active_starting_modes = state.get_active_modes_for_service(
+            service.name, StateTables.STARTING_SERVICES
+        )
+        active_started_modes = state.get_active_modes_for_service(
+            service.name, StateTables.STARTED_SERVICES
+        )
+        active_modes = active_starting_modes or active_started_modes
         console.info(f"- {service.name}")
         console.info(f"  modes: {active_modes}")
         console.info(f"  status: {status}")

{devservices-1.0.8 → devservices-1.0.10}/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
@@ -27,6 +28,7 @@ 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
+from devservices.utils.state import StateTables
 
 
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
@@ -46,6 +48,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))
@@ -60,7 +68,9 @@ def logs(args: Namespace) -> None:
     mode_dependencies = modes[mode_to_use]
 
     state = State()
-    running_services = state.get_started_services()
+    starting_services = set(state.get_service_entries(StateTables.STARTING_SERVICES))
+    started_services = set(state.get_service_entries(StateTables.STARTED_SERVICES))
+    running_services = starting_services.union(started_services)
     if service.name not in running_services:
         console.warning(f"Service {service.name} is not running")
         return
@@ -69,7 +79,9 @@ def logs(args: Namespace) -> None:
         remote_dependencies = install_and_verify_dependencies(service)
     except DependencyError as de:
         capture_exception(de)
-        console.failure(str(de))
+        console.failure(
+            f"{str(de)}. If this error persists, try running `devservices purge`"
+        )
         exit(1)
     try:
         logs_output = _logs(service, remote_dependencies, mode_dependencies)

{devservices-1.0.8 → devservices-1.0.10}/devservices/commands/status.py

@@ -17,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
@@ -86,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))
@@ -103,7 +110,9 @@ def status(args: Namespace) -> None:
         remote_dependencies = install_and_verify_dependencies(service)
     except DependencyError as de:
         capture_exception(de)
-        console.failure(str(de))
+        console.failure(
+            f"{str(de)}. If this error persists, try running `devservices purge`"
+        )
         exit(1)
     try:
         status_json_results = _status(service, remote_dependencies, mode_dependencies)

{devservices-1.0.8 → devservices-1.0.10}/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
@@ -33,6 +34,7 @@ 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
+from devservices.utils.state import StateTables
 
 
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
@@ -60,6 +62,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))
@@ -71,6 +79,8 @@ def up(args: Namespace) -> None:
     modes = service.config.modes
     mode = args.mode
 
+    state = State()
+
     with Status(
         lambda: console.warning(f"Starting '{service.name}' in mode: '{mode}'"),
         lambda: console.success(f"{service.name} started"),
@@ -82,7 +92,9 @@ def up(args: Namespace) -> None:
             )
         except DependencyError as de:
             capture_exception(de)
-            status.failure(str(de))
+            status.failure(
+                f"{str(de)}. If this error persists, try running `devservices purge`"
+            )
             exit(1)
         except ModeDoesNotExistError as mde:
             status.failure(str(mde))
@@ -92,6 +104,8 @@ def up(args: Namespace) -> None:
         except subprocess.CalledProcessError:
             # Network already exists, ignore the error
             pass
+        # Add the service to the starting services table
+        state.update_service_entry(service.name, mode, StateTables.STARTING_SERVICES)
         try:
             mode_dependencies = modes[mode]
             _up(service, [mode], remote_dependencies, mode_dependencies, status)
@@ -100,8 +114,8 @@ def up(args: Namespace) -> None:
             status.failure(f"Failed to start {service.name}: {dce.stderr}")
             exit(1)
     # TODO: We should factor in healthchecks here before marking service as running
-    state = State()
-    state.update_started_service(service.name, mode)
+    state.remove_service_entry(service.name, StateTables.STARTING_SERVICES)
+    state.update_service_entry(service.name, mode, StateTables.STARTED_SERVICES)
 
 
 def _bring_up_dependency(

{devservices-1.0.8 → devservices-1.0.10}/devservices/configs/service_config.py

@@ -67,7 +67,9 @@ 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}")
+        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)

{devservices-1.0.8 → devservices-1.0.10}/devservices/exceptions.py

@@ -70,27 +70,33 @@ class DockerError(Exception):
 class DockerComposeError(DockerError):
     """Base class for Docker Compose related errors."""
 
-    pass
+    def __str__(self) -> str:
+        return f"DockerComposeError: {self.command} returned {self.returncode} error: {self.stderr}"
 
 
 class ModeDoesNotExistError(Exception):
     """Raised when a mode does not exist."""
 
-    def __init__(self, service_name: str, mode: str):
+    def __init__(self, service_name: str, mode: str, available_modes: list[str]):
         self.service_name = service_name
         self.mode = mode
+        self.available_modes = available_modes
 
     def __str__(self) -> str:
-        return f"ModeDoesNotExistError: Mode '{self.mode}' does not exist for service '{self.service_name}'"
+        # All valid services should have at least one mode, so we don't check for an empty list
+        return f"ModeDoesNotExistError: Mode '{self.mode}' does not exist for service '{self.service_name}'.\nAvailable modes: {', '.join(self.available_modes)}"
 
 
 class DependencyError(Exception):
     """Base class for dependency-related errors."""
 
-    def __init__(self, repo_name: str, repo_link: str, branch: str):
+    def __init__(
+        self, repo_name: str, repo_link: str, branch: str, stderr: str | None = None
+    ):
         self.repo_name = repo_name
         self.repo_link = repo_link
         self.branch = branch
+        self.stderr = stderr
 
     def __str__(self) -> str:
         return f"DependencyError: {self.repo_name} ({self.repo_link}) on {self.branch}"

{devservices-1.0.8 → devservices-1.0.10}/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)] + " ")