devservices 1.0.15__tar.gz → 1.0.17__tar.gz

{devservices-1.0.15 → devservices-1.0.17}/PKG-INFO

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

{devservices-1.0.15 → devservices-1.0.17}/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.15
+devservices==1.0.17
 ```
 
 

{devservices-1.0.15 → devservices-1.0.17}/devservices/commands/down.py

@@ -60,7 +60,7 @@ def down(args: Namespace) -> None:
     try:
         service = find_matching_service(service_name)
     except ConfigNotFoundError as e:
-        capture_exception(e)
+        capture_exception(e, level="info")
         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."
         )
@@ -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
@@ -148,7 +148,7 @@ def down(args: Namespace) -> None:
             try:
                 _down(service, remote_dependencies, list(mode_dependencies), status)
             except DockerComposeError as dce:
-                capture_exception(dce)
+                capture_exception(dce, level="info")
                 status.failure(f"Failed to stop {service.name}: {dce.stderr}")
                 exit(1)
         else:

{devservices-1.0.15 → devservices-1.0.17}/devservices/commands/list_dependencies.py

@@ -34,7 +34,7 @@ def list_dependencies(args: Namespace) -> None:
     try:
         service = find_matching_service(service_name)
     except ConfigNotFoundError as e:
-        capture_exception(e)
+        capture_exception(e, level="info")
         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."
         )

{devservices-1.0.15 → devservices-1.0.17}/devservices/commands/logs.py

@@ -49,7 +49,7 @@ def logs(args: Namespace) -> None:
     try:
         service = find_matching_service(service_name)
     except ConfigNotFoundError as e:
-        capture_exception(e)
+        capture_exception(e, level="info")
         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."
         )
@@ -86,7 +86,7 @@ def logs(args: Namespace) -> None:
     try:
         logs_output = _logs(service, remote_dependencies, mode_dependencies)
     except DockerComposeError as dce:
-        capture_exception(dce)
+        capture_exception(dce, level="info")
         console.failure(f"Failed to get logs for {service.name}: {dce.stderr}")
         exit(1)
     for log in logs_output:

{devservices-1.0.15 → devservices-1.0.17}/devservices/commands/up.py

@@ -63,7 +63,7 @@ def up(args: Namespace) -> None:
     try:
         service = find_matching_service(service_name)
     except ConfigNotFoundError as e:
-        capture_exception(e)
+        capture_exception(e, level="info")
         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."
         )
@@ -110,7 +110,7 @@ def up(args: Namespace) -> None:
             mode_dependencies = modes[mode]
             _up(service, [mode], remote_dependencies, mode_dependencies, status)
         except DockerComposeError as dce:
-            capture_exception(dce)
+            capture_exception(dce, level="info")
             status.failure(f"Failed to start {service.name}: {dce.stderr}")
             exit(1)
     # TODO: We should factor in healthchecks here before marking service as running

{devservices-1.0.15 → devservices-1.0.17}/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.15 → devservices-1.0.17}/devservices/main.py

@@ -15,6 +15,8 @@ from sentry_sdk import set_tag
 from sentry_sdk import set_user
 from sentry_sdk import start_transaction
 from sentry_sdk.integrations.argv import ArgvIntegration
+from sentry_sdk.types import Event
+from sentry_sdk.types import Hint
 
 from devservices.commands import down
 from devservices.commands import list_dependencies
@@ -42,6 +44,31 @@ disable_sentry = os.environ.get("DEVSERVICES_DISABLE_SENTRY", default="0") == "1
 logging.basicConfig(level=logging.INFO)
 current_version = metadata.version("devservices")
 
+error_trace_ids = set()
+
+
+def before_send_error(event: Event, hint: Hint) -> Event:
+    """Gets the trace_id from the errors we care about.
+
+    This function is used as a before_send callback for Sentry to track error trace IDs.
+    It adds the trace_id to error_trace_ids set for non-info level events.
+    """
+    if event["level"] != "info":
+        error_trace_ids.add(event["contexts"]["trace"]["trace_id"])
+    return event
+
+
+def before_send_transaction(event: Event, hint: Hint) -> Event:
+    """Manually sets the status of a transaction.
+
+    This function is used as a before_send_transaction callback for Sentry to mark transaction status
+    as unknown if they don't correspond to errors we care about.
+    """
+    if event["contexts"]["trace"]["trace_id"] not in error_trace_ids:
+        event["contexts"]["trace"]["status"] = "unknown"
+    return event
+
+
 if not disable_sentry:
     init(
         dsn="https://56470da7302c16e83141f62f88e46449@o1.ingest.us.sentry.io/4507946704961536",
@@ -50,16 +77,18 @@ if not disable_sentry:
         enable_tracing=True,
         integrations=[ArgvIntegration()],
         environment=sentry_environment,
+        before_send=before_send_error,
+        before_send_transaction=before_send_transaction,
         release=current_version,
     )
     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)
     except GitError as e:
-        capture_exception(e)
+        capture_exception(e, level="info")
         logging.debug("Failed to get git version: %s", e)
         set_tag("git_version", "unknown")
 
@@ -75,11 +104,11 @@ def main() -> None:
     try:
         check_docker_compose_version()
     except DockerDaemonNotRunningError as e:
-        capture_exception(e)
+        capture_exception(e, level="info")
         console.failure(str(e))
         exit(1)
     except DockerComposeInstallationError as e:
-        capture_exception(e)
+        capture_exception(e, level="info")
         console.failure("Failed to ensure docker compose is installed and up-to-date")
         exit(1)
     parser = argparse.ArgumentParser(

{devservices-1.0.15 → devservices-1.0.17}/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.15 → devservices-1.0.17}/devservices.egg-info/PKG-INFO

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

{devservices-1.0.15 → devservices-1.0.17}/pyproject.toml

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

{devservices-1.0.15 → devservices-1.0.17}/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(