devservices 1.0.14__tar.gz → 1.0.16__tar.gz

{devservices-1.0.14 → devservices-1.0.16}/PKG-INFO

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

{devservices-1.0.14 → devservices-1.0.16}/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.14
+devservices==1.0.16
 ```
 
 

{devservices-1.0.14 → devservices-1.0.16}/devservices/commands/down.py

@@ -81,7 +81,7 @@ def down(args: Namespace) -> None:
     active_services = starting_services.union(started_services)
     if service.name not in active_services:
         console.warning(f"{service.name} is not running")
-        exit(0)
+        return  # Since exit(0) is captured as an internal_error by sentry
 
     active_starting_modes = state.get_active_modes_for_service(
         service.name, StateTables.STARTING_SERVICES

{devservices-1.0.14 → devservices-1.0.16}/devservices/commands/update.py

@@ -36,7 +36,7 @@ def update_version(exec_path: str, latest_version: str) -> None:
 
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     parser = subparsers.add_parser(
-        "update", help="update devservices to the latest version"
+        "update", help="Update devservices to the latest version"
     )
     parser.set_defaults(func=update)
 

{devservices-1.0.14 → devservices-1.0.16}/devservices/constants.py

@@ -6,7 +6,8 @@ from datetime import timedelta
 MINIMUM_DOCKER_COMPOSE_VERSION = "2.29.7"
 DEVSERVICES_DIR_NAME = "devservices"
 CONFIG_FILE_NAME = "config.yml"
-DOCKER_USER_PLUGIN_DIR = os.path.expanduser("~/.docker/cli-plugins/")
+DOCKER_CONFIG_DIR = os.environ.get("DOCKER_CONFIG", os.path.expanduser("~/.docker"))
+DOCKER_USER_PLUGIN_DIR = os.path.join(DOCKER_CONFIG_DIR, "cli-plugins/")
 
 DEVSERVICES_CACHE_DIR = os.path.expanduser("~/.cache/sentry-devservices")
 DEVSERVICES_LOCAL_DIR = os.path.expanduser("~/.local/share/sentry-devservices")

{devservices-1.0.14 → devservices-1.0.16}/devservices/main.py

@@ -54,7 +54,7 @@ if not disable_sentry:
     )
     username = getpass.getuser()
     set_user({"username": username})
-    set_tag("platform", platform.platform())
+    set_tag("user_platform", platform.platform())
     try:
         git_version = get_git_version()
         set_tag("git_version", git_version)

{devservices-1.0.14 → devservices-1.0.16}/devservices/utils/dependencies.py

@@ -272,6 +272,17 @@ def get_non_shared_remote_dependencies(
     active_services = starting_services.union(started_services)
     # We don't care about the remote dependencies of the service we are stopping
     active_services.remove(service_to_stop.name)
+
+    active_modes: dict[str, list[str]] = dict()
+    for active_service in active_services:
+        starting_modes = state.get_active_modes_for_service(
+            active_service, StateTables.STARTING_SERVICES
+        )
+        started_modes = state.get_active_modes_for_service(
+            active_service, StateTables.STARTED_SERVICES
+        )
+        active_modes[active_service] = starting_modes or started_modes
+
     other_running_remote_dependencies: set[InstalledRemoteDependency] = set()
     base_running_service_names: set[str] = set()
     for started_service_name in active_services:
@@ -279,8 +290,18 @@ def get_non_shared_remote_dependencies(
         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)
+
+        started_service_modes = active_modes[started_service_name]
+        # Only consider the dependencies of the modes that are running
+        started_service_dependencies: dict[str, Dependency] = dict()
+        for started_service_mode in started_service_modes:
+            for dependency_name in started_service.config.modes[started_service_mode]:
+                started_service_dependencies[
+                    dependency_name
+                ] = started_service.config.dependencies[dependency_name]
+
         installed_remote_dependencies = get_installed_remote_dependencies(
-            list(started_service.config.dependencies.values())
+            list(started_service_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(

{devservices-1.0.14 → devservices-1.0.16}/devservices/utils/docker_compose.py

@@ -83,15 +83,10 @@ def install_docker_compose() -> None:
 
     # Verify the installation
     try:
-        version = subprocess.run(
-            ["docker", "compose", "version", "--short"],
-            capture_output=True,
-            check=True,
-            text=True,
-        ).stdout
-    except Exception as e:
+        version = get_docker_compose_version()
+    except DockerComposeError as e:
         raise DockerComposeInstallationError(
-            f"Failed to verify Docker Compose installation: {e}"
+            f"Failed to verify Docker Compose installation: {e.stderr}"
         )
 
     console.success(f"Verified Docker Compose installation: v{version}")
@@ -129,20 +124,17 @@ def check_docker_compose_version() -> None:
     check_docker_daemon_running()
     try:
         # Run the docker compose version command
-        result = subprocess.run(
-            ["docker", "compose", "version", "--short"],
-            capture_output=True,
-            text=True,
-            check=True,
-        )
-    except subprocess.CalledProcessError:
-        result = None
+        docker_compose_version = get_docker_compose_version()
+    except DockerComposeError:
+        docker_compose_version = None
         console.warning(
             f"Docker Compose is not installed, attempting to install v{MINIMUM_DOCKER_COMPOSE_VERSION}"
         )
 
     # Extract the version number from the output
-    version_output = result.stdout.strip() if result is not None else ""
+    version_output = (
+        docker_compose_version if docker_compose_version is not None else ""
+    )
 
     # Use regex to find the version number
     pattern = r"^(\d+\.\d+\.\d+)"
@@ -171,7 +163,24 @@ def check_docker_compose_version() -> None:
     install_docker_compose()
 
 
-# TODO: Consider removing this in favor of in house logic for determining non-remote services
+def get_docker_compose_version() -> str:
+    try:
+        result = subprocess.run(
+            ["docker", "compose", "version", "--short"],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+    except subprocess.CalledProcessError as e:
+        raise DockerComposeError(
+            command="docker compose versions --short",
+            returncode=e.returncode,
+            stdout=e.stdout,
+            stderr=e.stderr,
+        )
+    return result.stdout.strip()
+
+
 def get_non_remote_services(
     service_config_path: str, current_env: dict[str, str]
 ) -> set[str]:

{devservices-1.0.14 → devservices-1.0.16}/devservices.egg-info/PKG-INFO

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

{devservices-1.0.14 → devservices-1.0.16}/pyproject.toml

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

{devservices-1.0.14 → devservices-1.0.16}/tests/utils/test_dependencies.py

@@ -2164,6 +2164,8 @@ def test_get_non_shared_remote_dependencies_shared_dependencies(
         ),
     )
     assert len(shared_remote_dependencies) == 0
+    mock_find_matching_service.assert_called_once_with("service-2")
+    mock_get_installed_remote_dependencies.assert_called_once_with([])
 
 
 @mock.patch(
@@ -2186,8 +2188,25 @@ def test_get_non_shared_remote_dependencies_shared_dependencies(
         config=ServiceConfig(
             version=0.1,
             service_name="service-2",
-            dependencies={},
-            modes={"default": []},
+            dependencies={
+                "dependency-3": Dependency(
+                    description="dependency-3",
+                    remote=RemoteConfig(
+                        repo_name="dependency-3",
+                        repo_link="file://path/to/dependency-3",
+                        branch="main",
+                    ),
+                ),
+                "dependency-4": Dependency(
+                    description="dependency-4",
+                    remote=RemoteConfig(
+                        repo_name="dependency-4",
+                        repo_link="file://path/to/dependency-4",
+                        branch="main",
+                    ),
+                ),
+            },
+            modes={"default": ["dependency-3"], "other": ["dependency-4"]},
         ),
     ),
 )
@@ -2252,6 +2271,20 @@ def test_get_non_shared_remote_dependencies_complex(
             mode="default",
         )
     }
+    mock_find_matching_service.assert_called_once_with("service-2")
+    # dependency-4 is not installed, so it should not be passed to get_installed_remote_dependencies
+    mock_get_installed_remote_dependencies.assert_called_once_with(
+        [
+            Dependency(
+                description="dependency-3",
+                remote=RemoteConfig(
+                    repo_name="dependency-3",
+                    repo_link="file://path/to/dependency-3",
+                    branch="main",
+                ),
+            )
+        ]
+    )
 
 
 @mock.patch("devservices.utils.dependencies.install_dependencies", return_value=[])

{devservices-1.0.14 → devservices-1.0.16}/tests/utils/test_docker_compose.py

@@ -18,6 +18,7 @@ from devservices.utils.dependencies import InstalledRemoteDependency
 from devservices.utils.docker_compose import check_docker_compose_version
 from devservices.utils.docker_compose import DockerComposeCommand
 from devservices.utils.docker_compose import get_docker_compose_commands_to_run
+from devservices.utils.docker_compose import get_docker_compose_version
 from devservices.utils.docker_compose import get_non_remote_services
 from devservices.utils.docker_compose import install_docker_compose
 from devservices.utils.services import Service
@@ -30,6 +31,26 @@ def test_check_docker_compose_version_success(mock_run: mock.Mock) -> None:
     check_docker_compose_version()  # Should not raise any exception
 
 
+@mock.patch("subprocess.run")
+def test_get_docker_compose_version(mock_run: mock.Mock) -> None:
+    mock_run.return_value.stdout = "2.29.7\n"
+    assert get_docker_compose_version() == "2.29.7"
+
+
+@mock.patch(
+    "subprocess.run",
+    side_effect=subprocess.CalledProcessError(
+        returncode=1,
+        cmd="docker compose version --short",
+        stderr="Docker Compose failed",
+    ),
+)
+def test_get_docker_compose_version_error(mock_run: mock.Mock) -> None:
+    with pytest.raises(DockerComposeError) as e:
+        get_docker_compose_version()
+    assert e.value.stderr == "Docker Compose failed"
+
+
 @mock.patch("subprocess.run")
 @mock.patch(
     "devservices.utils.docker_compose.install_docker_compose", side_effect=lambda: None
@@ -76,18 +97,27 @@ def test_check_docker_compose_docker_daemon_not_running(
     "subprocess.run",
     side_effect=[
         0,  # First call is to check if docker daemon is running
-        subprocess.CalledProcessError(
-            returncode=1, cmd="docker compose version --short"
-        ),
     ],
 )
+@mock.patch(
+    "devservices.utils.docker_compose.get_docker_compose_version",
+    side_effect=DockerComposeError(
+        command="docker compose version --short",
+        returncode=1,
+        stdout="",
+        stderr="",
+    ),
+)
 @mock.patch(
     "devservices.utils.docker_compose.install_docker_compose", side_effect=lambda: None
 )
 def test_check_docker_compose_command_failure(
-    mock_install_docker_compose: mock.Mock, _mock_run: mock.Mock
+    mock_install_docker_compose: mock.Mock,
+    mock_get_docker_compose_version: mock.Mock,
+    _mock_run: mock.Mock,
 ) -> None:
     check_docker_compose_version()
+    mock_get_docker_compose_version.assert_called_once()
     mock_install_docker_compose.assert_called_once()
 
 
@@ -139,11 +169,16 @@ def test_install_docker_compose_binary_install_error(
 @mock.patch("devservices.utils.install_binary.os.chmod")
 @mock.patch("devservices.utils.install_binary.shutil.move")
 @mock.patch(
-    "devservices.utils.docker_compose.subprocess.run",
-    side_effect=Exception("Docker Compose failed"),
+    "devservices.utils.docker_compose.get_docker_compose_version",
+    side_effect=DockerComposeError(
+        command="docker compose version --short",
+        returncode=1,
+        stdout="",
+        stderr="Docker Compose failed",
+    ),
 )
 def test_install_docker_compose_compose_verification_error(
-    _mock_subprocess_run: mock.Mock,
+    _mock_get_docker_compose_version: mock.Mock,
     _mock_shutil_move: mock.Mock,
     _mock_chmod: mock.Mock,
     _mock_urlretrieve: mock.Mock,
@@ -157,22 +192,18 @@ def test_install_docker_compose_compose_verification_error(
         install_docker_compose()
 
 
-@mock.patch("tempfile.TemporaryDirectory")
+@mock.patch("devservices.utils.install_binary.tempfile.TemporaryDirectory")
 @mock.patch("platform.system", return_value="Darwin")
 @mock.patch("platform.machine", return_value="arm64")
 @mock.patch("devservices.utils.install_binary.urlretrieve")
 @mock.patch("devservices.utils.install_binary.os.chmod")
 @mock.patch("devservices.utils.install_binary.shutil.move")
 @mock.patch(
-    "devservices.utils.docker_compose.subprocess.run",
-    return_value=subprocess.CompletedProcess(
-        args=["docker", "compose", "version", "--short"],
-        returncode=0,
-        stdout="2.29.7\n",
-    ),
+    "devservices.utils.docker_compose.get_docker_compose_version",
+    return_value="2.29.7\n",
 )
 def test_install_docker_compose_macos_arm64(
-    mock_subprocess_run: mock.Mock,
+    mock_get_docker_compose_version: mock.Mock,
     mock_shutil_move: mock.Mock,
     mock_chmod: mock.Mock,
     mock_urlretrieve: mock.Mock,
@@ -191,30 +222,21 @@ def test_install_docker_compose_macos_arm64(
         "tempdir/docker-compose",
         os.path.expanduser("~/.docker/cli-plugins/docker-compose"),
     )
-    mock_subprocess_run.assert_called_once_with(
-        ["docker", "compose", "version", "--short"],
-        capture_output=True,
-        check=True,
-        text=True,
-    )
+    mock_get_docker_compose_version.assert_called_once()
 
 
-@mock.patch("tempfile.TemporaryDirectory")
+@mock.patch("devservices.utils.install_binary.tempfile.TemporaryDirectory")
 @mock.patch("platform.system", return_value="Linux")
 @mock.patch("platform.machine", return_value="x86_64")
 @mock.patch("devservices.utils.install_binary.urlretrieve")
 @mock.patch("devservices.utils.install_binary.os.chmod")
 @mock.patch("devservices.utils.install_binary.shutil.move")
 @mock.patch(
-    "devservices.utils.docker_compose.subprocess.run",
-    return_value=subprocess.CompletedProcess(
-        args=["docker", "compose", "version", "--short"],
-        returncode=0,
-        stdout="2.29.7\n",
-    ),
+    "devservices.utils.docker_compose.get_docker_compose_version",
+    return_value="2.29.7\n",
 )
 def test_install_docker_compose_linux_x86(
-    mock_subprocess_run: mock.Mock,
+    mock_get_docker_compose_version: mock.Mock,
     mock_shutil_move: mock.Mock,
     mock_chmod: mock.Mock,
     mock_urlretrieve: mock.Mock,
@@ -233,12 +255,44 @@ def test_install_docker_compose_linux_x86(
         "tempdir/docker-compose",
         os.path.expanduser("~/.docker/cli-plugins/docker-compose"),
     )
-    mock_subprocess_run.assert_called_once_with(
-        ["docker", "compose", "version", "--short"],
-        capture_output=True,
-        check=True,
-        text=True,
+    mock_get_docker_compose_version.assert_called_once()
+
+
+@mock.patch("devservices.utils.install_binary.tempfile.TemporaryDirectory")
+@mock.patch("platform.system", return_value="Darwin")
+@mock.patch("platform.machine", return_value="arm64")
+@mock.patch("devservices.utils.install_binary.urlretrieve")
+@mock.patch("devservices.utils.install_binary.os.chmod")
+@mock.patch("devservices.utils.install_binary.shutil.move")
+@mock.patch(
+    "devservices.utils.docker_compose.get_docker_compose_version",
+    return_value="2.29.7\n",
+)
+def test_install_docker_compose_custom_docker_config_dir(
+    mock_get_docker_compose_version: mock.Mock,
+    mock_shutil_move: mock.Mock,
+    mock_chmod: mock.Mock,
+    mock_urlretrieve: mock.Mock,
+    _mock_machine: mock.Mock,
+    _mock_system: mock.Mock,
+    mock_tempdir: mock.Mock,
+) -> None:
+    mock_tempdir.return_value.__enter__.return_value = "tempdir"
+    with mock.patch(
+        "devservices.utils.docker_compose.DOCKER_USER_PLUGIN_DIR",
+        "tempdir/docker/config/cli-plugins",
+    ):
+        install_docker_compose()
+    mock_urlretrieve.assert_called_once_with(
+        "https://github.com/docker/compose/releases/download/v2.29.7/docker-compose-darwin-aarch64",
+        "tempdir/docker-compose",
+    )
+    mock_chmod.assert_called_once_with("tempdir/docker-compose", 0o755)
+    mock_shutil_move.assert_called_once_with(
+        "tempdir/docker-compose",
+        "tempdir/docker/config/cli-plugins/docker-compose",
     )
+    mock_get_docker_compose_version.assert_called_once()
 
 
 @mock.patch(