devservices 1.1.4__tar.gz → 1.1.5__tar.gz

{devservices-1.1.4 → devservices-1.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devservices
-Version: 1.1.4
+Version: 1.1.5
 Requires-Python: >=3.11
 License-File: LICENSE.md
 Requires-Dist: pyyaml

{devservices-1.1.4 → devservices-1.1.5}/README.md

@@ -31,7 +31,7 @@ NOTE: service-name is an optional parameter. If not provided, devservices will a
 The recommended way to install devservices is through a virtualenv in the requirements.txt. Once that is installed and a devservices config file is added, you should be able to run `devservices up` to begin local development.
 
 ```
-devservices==1.1.4
+devservices==1.1.5
 ```
 
 ### 2. Add devservices config files

{devservices-1.1.4 → devservices-1.1.5}/devservices/commands/down.py

@@ -83,7 +83,7 @@ def down(args: Namespace) -> None:
         exit(1)
 
     modes = service.config.modes
-    exclude_local = args.exclude_local
+    exclude_local = getattr(args, "exclude_local", False)
 
     state = State()
     starting_services = set(state.get_service_entries(StateTables.STARTING_SERVICES))

{devservices-1.1.4 → devservices-1.1.5}/devservices/commands/purge.py

@@ -40,7 +40,9 @@ def purge(_args: Namespace) -> None:
     state.clear_state()
 
     try:
-        devservices_containers = get_matching_containers(DEVSERVICES_ORCHESTRATOR_LABEL)
+        devservices_containers = get_matching_containers(
+            [DEVSERVICES_ORCHESTRATOR_LABEL]
+        )
     except DockerDaemonNotRunningError as e:
         console.warning(str(e))
         return

devservices-1.1.5/devservices/commands/reset.py

@@ -0,0 +1,115 @@
+from __future__ import annotations
+
+from argparse import _SubParsersAction
+from argparse import ArgumentParser
+from argparse import Namespace
+
+from sentry_sdk import capture_exception
+
+from devservices.commands.down import down
+from devservices.constants import DEVSERVICES_ORCHESTRATOR_LABEL
+from devservices.exceptions import DockerDaemonNotRunningError
+from devservices.exceptions import DockerError
+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 DependencyNode
+from devservices.utils.dependencies import DependencyType
+from devservices.utils.docker import get_matching_containers
+from devservices.utils.docker import get_volumes_for_containers
+from devservices.utils.docker import remove_docker_resources
+from devservices.utils.docker import stop_containers
+from devservices.utils.services import find_matching_service
+from devservices.utils.state import State
+from devservices.utils.state import StateTables
+
+
+def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
+    parser = subparsers.add_parser("reset", help="Reset a service's volumes")
+    parser.add_argument(
+        "service_name",
+        help="Name of the service to reset volumes for",
+        nargs="?",
+        default=None,
+    )
+    parser.set_defaults(func=reset)
+
+
+def reset(args: Namespace) -> None:
+    """Reset a specified service's volumes."""
+    console = Console()
+    service_name = args.service_name
+
+    try:
+        matching_containers = get_matching_containers(
+            [
+                DEVSERVICES_ORCHESTRATOR_LABEL,
+                f"com.docker.compose.service={args.service_name}",
+            ]
+        )
+    except DockerDaemonNotRunningError as e:
+        console.warning(str(e))
+        return
+    except DockerError as e:
+        console.failure(f"Failed to get matching containers {e.stderr}")
+        exit(1)
+
+    if len(matching_containers) == 0:
+        console.failure(f"No containers found for {service_name}")
+        exit(1)
+
+    try:
+        matching_volumes = get_volumes_for_containers(matching_containers)
+    except DockerError as e:
+        console.failure(f"Failed to get matching volumes {e.stderr}")
+        exit(1)
+
+    if len(matching_volumes) == 0:
+        console.failure(f"No volumes found for {service_name}")
+        exit(1)
+
+    state = State()
+    started_services = set(state.get_service_entries(StateTables.STARTED_SERVICES))
+    starting_services = set(state.get_service_entries(StateTables.STARTING_SERVICES))
+    active_service_names = starting_services.union(started_services)
+
+    # TODO: We should add threading here to speed up the process
+    for active_service_name in active_service_names:
+        active_service = find_matching_service(active_service_name)
+        starting_active_modes = state.get_active_modes_for_service(
+            active_service_name, StateTables.STARTING_SERVICES
+        )
+        started_active_modes = state.get_active_modes_for_service(
+            active_service_name, StateTables.STARTED_SERVICES
+        )
+        active_modes = starting_active_modes or started_active_modes
+        dependency_graph = construct_dependency_graph(active_service, active_modes)
+        if (
+            DependencyNode(name=service_name, dependency_type=DependencyType.COMPOSE)
+            in dependency_graph.graph
+        ):
+            console.warning(
+                f"Bringing down {active_service_name} in order to safely reset {service_name}"
+            )
+            down(Namespace(service_name=active_service_name, exclude_local=True))
+
+    with Status(
+        lambda: console.warning(f"Resetting docker volumes for {service_name}"),
+        lambda: console.success(f"Docker volumes have been reset for {service_name}"),
+    ):
+        try:
+            stop_containers(matching_containers, should_remove=True)
+        except DockerError as e:
+            console.failure(
+                f"Failed to stop and remove {', '.join(matching_containers)}\nError: {e.stderr}"
+            )
+            capture_exception(e)
+            exit(1)
+        try:
+            remove_docker_resources("volume", list(matching_volumes))
+        except DockerError as e:
+            console.failure(
+                f"Failed to remove volumes {', '.join(matching_volumes)}\nError: {e.stderr}"
+            )
+            capture_exception(e)
+            exit(1)

{devservices-1.1.4 → devservices-1.1.5}/devservices/commands/toggle.py

@@ -138,6 +138,18 @@ def handle_transition_to_local_runtime(service_to_transition: Service) -> None:
                 service_to_transition,
                 [service_to_transition_dependency_config.remote.mode],
             )
+            console.warning(f"Restarting {service_to_transition.name} in default mode")
+            # This behavior matches the default behavior of up as it
+            # will bring up dependencies with local runtimes automatically
+            # in the default mode. If the user wants to run it in a different
+            # mode, they can switch to that mode manually.
+            up(
+                Namespace(
+                    service_name=service_to_transition.name,
+                    mode="default",
+                    exclude_local=False,
+                )
+            )
             break
     state.update_service_runtime(service_to_transition.name, ServiceRuntime.LOCAL)
 
@@ -206,6 +218,7 @@ def restart_dependent_services(
                     service_name=dependent_service,
                     mode=mode,
                     debug=False,
+                    exclude_local=True,
                 )
                 try:
                     up(args)

{devservices-1.1.4 → devservices-1.1.5}/devservices/commands/up.py

@@ -87,6 +87,7 @@ def up(args: Namespace, existing_status: Status | None = None) -> None:
 
     modes = service.config.modes
     mode = args.mode
+    exclude_local = getattr(args, "exclude_local", False)
 
     state = State()
 
@@ -101,15 +102,15 @@ def up(args: Namespace, existing_status: Status | None = None) -> None:
         services_with_local_runtime = state.get_services_by_runtime(
             ServiceRuntime.LOCAL
         )
-        skipped_services = set()
+        local_runtime_dependency_names = set()
         for service_with_local_runtime in services_with_local_runtime:
             if (
                 mode in modes
                 and service_with_local_runtime != service.name
                 and service_with_local_runtime in modes[mode]
             ):
-                skipped_services.add(service_with_local_runtime)
-                if args.exclude_local:
+                local_runtime_dependency_names.add(service_with_local_runtime)
+                if exclude_local:
                     status.warning(
                         f"Skipping '{service_with_local_runtime}' as it is set to run locally"
                     )
@@ -139,10 +140,10 @@ def up(args: Namespace, existing_status: Status | None = None) -> None:
             if (
                 service_with_local_runtime
                 in [dep.service_name for dep in remote_dependencies]
-                and service_with_local_runtime not in skipped_services
+                and service_with_local_runtime not in local_runtime_dependency_names
             ):
-                skipped_services.add(service_with_local_runtime)
-                if args.exclude_local:
+                local_runtime_dependency_names.add(service_with_local_runtime)
+                if exclude_local:
                     status.warning(
                         f"Skipping '{service_with_local_runtime}' as it is set to run locally"
                     )
@@ -155,19 +156,19 @@ def up(args: Namespace, existing_status: Status | None = None) -> None:
             for dep in remote_dependencies
             if dep.service_name not in services_with_local_runtime
         }
+        if not exclude_local and len(local_runtime_dependency_names) > 0:
+            status.warning("Starting dependencies with local runtimes...")
+            for local_runtime_dependency_name in local_runtime_dependency_names:
+                up(
+                    Namespace(
+                        service_name=local_runtime_dependency_name,
+                        mode=mode,
+                        exclude_local=True,
+                    ),
+                    status,
+                )
+            status.warning(f"Continuing with service '{service.name}'")
         try:
-            if not args.exclude_local:
-                status.warning("Starting dependencies with local runtimes...")
-                for skipped_service in skipped_services:
-                    up(
-                        Namespace(
-                            service_name=skipped_service,
-                            mode=mode,
-                            exclude_local=True,
-                        ),
-                        status,
-                    )
-                status.warning(f"Continuing with service '{service.name}'")
             _up(service, [mode], remote_dependencies, mode_dependencies, status)
         except DockerComposeError as dce:
             capture_exception(dce, level="info")

{devservices-1.1.4 → devservices-1.1.5}/devservices/main.py

@@ -24,6 +24,7 @@ from devservices.commands import list_dependencies
 from devservices.commands import list_services
 from devservices.commands import logs
 from devservices.commands import purge
+from devservices.commands import reset
 from devservices.commands import serve
 from devservices.commands import status
 from devservices.commands import toggle
@@ -150,6 +151,7 @@ def main() -> None:
     purge.add_parser(subparsers)
     serve.add_parser(subparsers)
     toggle.add_parser(subparsers)
+    reset.add_parser(subparsers)
 
     args = parser.parse_args()
 

{devservices-1.1.4 → devservices-1.1.5}/devservices/utils/docker.py

@@ -88,11 +88,14 @@ def wait_for_healthy(container: ContainerNames, status: Status) -> None:
     raise ContainerHealthcheckFailedError(container.short_name, HEALTHCHECK_TIMEOUT)
 
 
-def get_matching_containers(label: str) -> list[str]:
+def get_matching_containers(labels: list[str]) -> list[str]:
     """
     Returns a list of container names with the given label
     """
     check_docker_daemon_running()
+    filters = []
+    for label in labels:
+        filters.extend(["--filter", f"label={label}"])
     try:
         return (
             subprocess.check_output(
@@ -101,9 +104,8 @@ def get_matching_containers(label: str) -> list[str]:
                     "ps",
                     "-a",
                     "-q",
-                    "--filter",
-                    f"label={label}",
-                ],
+                ]
+                + filters,
                 text=True,
                 stderr=subprocess.DEVNULL,
             )
@@ -112,7 +114,7 @@ def get_matching_containers(label: str) -> list[str]:
         )
     except subprocess.CalledProcessError as e:
         raise DockerError(
-            command=f"docker ps -q --filter label={label}",
+            command=f"docker ps -a -q {' '.join(filters)}",
             returncode=e.returncode,
             stdout=e.stdout,
             stderr=e.stderr,
@@ -196,7 +198,7 @@ def stop_containers(containers: list[str], should_remove: bool = False) -> None:
             ["docker", "stop"] + containers,
             check=True,
             stdout=subprocess.DEVNULL,
-            stderr=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
     except subprocess.CalledProcessError as e:
         raise DockerError(
@@ -218,7 +220,7 @@ def remove_docker_resources(resource_type: str, resources: list[str]) -> None:
             ["docker", resource_type, "rm", *resources],
             check=True,
             stdout=subprocess.DEVNULL,
-            stderr=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
         )
     except subprocess.CalledProcessError as e:
         raise DockerError(

{devservices-1.1.4 → devservices-1.1.5}/devservices.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devservices
-Version: 1.1.4
+Version: 1.1.5
 Requires-Python: >=3.11
 License-File: LICENSE.md
 Requires-Dist: pyyaml

{devservices-1.1.4 → devservices-1.1.5}/devservices.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ devservices/commands/list_dependencies.py
 devservices/commands/list_services.py
 devservices/commands/logs.py
 devservices/commands/purge.py
+devservices/commands/reset.py
 devservices/commands/serve.py
 devservices/commands/status.py
 devservices/commands/toggle.py
@@ -46,6 +47,7 @@ tests/commands/test_list_dependencies.py
 tests/commands/test_list_services.py
 tests/commands/test_logs.py
 tests/commands/test_purge.py
+tests/commands/test_reset.py
 tests/commands/test_serve.py
 tests/commands/test_status.py
 tests/commands/test_toggle.py

{devservices-1.1.4 → devservices-1.1.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "devservices"
-version = "1.1.4"
+version = "1.1.5"
 # 3.11 is just for internal pypi compat
 requires-python = ">=3.11"
 dependencies = [

{devservices-1.1.4 → devservices-1.1.5}/tests/commands/test_purge.py

@@ -58,7 +58,7 @@ def test_purge_docker_daemon_not_running(
         assert state.get_service_entries(StateTables.STARTED_SERVICES) == []
 
         mock_get_matching_containers.assert_called_once_with(
-            DEVSERVICES_ORCHESTRATOR_LABEL
+            [DEVSERVICES_ORCHESTRATOR_LABEL]
         )
         mock_get_volumes_for_containers.assert_not_called()
         mock_stop_containers.assert_not_called()
@@ -117,7 +117,7 @@ def test_purge_docker_error_get_matching_containers(
         assert state.get_service_entries(StateTables.STARTED_SERVICES) == []
 
         mock_get_matching_containers.assert_called_once_with(
-            DEVSERVICES_ORCHESTRATOR_LABEL
+            [DEVSERVICES_ORCHESTRATOR_LABEL]
         )
         mock_get_volumes_for_containers.assert_not_called()
         mock_stop_containers.assert_not_called()
@@ -174,7 +174,7 @@ def test_purge_docker_error_get_volumes_for_containers(
         assert state.get_service_entries(StateTables.STARTED_SERVICES) == []
 
         mock_get_matching_containers.assert_called_once_with(
-            DEVSERVICES_ORCHESTRATOR_LABEL
+            [DEVSERVICES_ORCHESTRATOR_LABEL]
         )
         mock_get_volumes_for_containers.assert_called_once_with(["abc", "def", "ghi"])
         mock_stop_containers.assert_not_called()
@@ -234,7 +234,7 @@ def test_purge_docker_error_get_matching_networks(
         assert state.get_service_entries(StateTables.STARTED_SERVICES) == []
 
         mock_get_matching_containers.assert_called_once_with(
-            DEVSERVICES_ORCHESTRATOR_LABEL
+            [DEVSERVICES_ORCHESTRATOR_LABEL]
         )
         mock_get_volumes_for_containers.assert_called_once_with(["abc", "def", "ghi"])
         mock_stop_containers.assert_called_once_with(
@@ -293,7 +293,7 @@ def test_purge_docker_error_stop_containers(
         assert state.get_service_entries(StateTables.STARTED_SERVICES) == []
 
         mock_get_matching_containers.assert_called_once_with(
-            DEVSERVICES_ORCHESTRATOR_LABEL
+            [DEVSERVICES_ORCHESTRATOR_LABEL]
         )
         mock_get_volumes_for_containers.assert_called_once_with(["abc", "def", "ghi"])
         mock_stop_containers.assert_called_once_with(
@@ -355,7 +355,7 @@ def test_purge_docker_error_remove_volumes_continues_to_remove_networks(
         assert state.get_service_entries(StateTables.STARTED_SERVICES) == []
 
         mock_get_matching_containers.assert_called_once_with(
-            DEVSERVICES_ORCHESTRATOR_LABEL
+            [DEVSERVICES_ORCHESTRATOR_LABEL]
         )
         mock_get_volumes_for_containers.assert_called_once_with(["abc", "def", "ghi"])
         mock_stop_containers.assert_called_once_with(
@@ -425,7 +425,7 @@ def test_purge_docker_error_remove_networks(
         assert state.get_service_entries(StateTables.STARTED_SERVICES) == []
 
         mock_get_matching_containers.assert_called_once_with(
-            DEVSERVICES_ORCHESTRATOR_LABEL
+            [DEVSERVICES_ORCHESTRATOR_LABEL]
         )
         mock_get_volumes_for_containers.assert_called_once_with(["abc", "def", "ghi"])
         mock_stop_containers.assert_called_once_with(