devservices 0.0.1__tar.gz → 0.0.3__tar.gz

{devservices-0.0.1 → devservices-0.0.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: devservices
-Version: 0.0.1
-Requires-Python: >=3.12
+Version: 0.0.3
+Requires-Python: >=3.10
 Requires-Dist: pyyaml
 Requires-Dist: sentry-devenv
 Provides-Extra: dev

devservices-0.0.3/README.md

@@ -0,0 +1,22 @@
+# devservices
+
+A standalone cli tool used to manage dependencies for services. It simplifies the process of starting, stopping, and managing services for development purposes.
+
+## Overview
+
+`devservices` reads configuration files located in the `devservices` directory of your repository. These configurations define services, their dependencies, and various modes of operation.
+
+## Usage
+
+devservices provides several commands to manage your services:
+
+### Commands
+
+NOTE: service-name is an optional parameter. If not provided, devservices will attempt to automatically find a devservices configuration in the current directory in order to proceed.
+
+- `devservices start <service-name>`: Start a service and its dependencies.
+- `devservices stop <service-name>`: Stop a service including its dependencies.
+- `devservices status <service-name>`: Display the current status of all services, including their dependencies and ports.
+- `devservices logs <service-name>`: View logs for a specific service.
+- `devservices list-services`: List all available Sentry services.
+- `devservices list-dependencies <service-name>`: List all dependencies for a service and whether they are enabled/disabled.

devservices-0.0.3/devservices/__init__.py

@@ -0,0 +1,4 @@
+"""
+DevServices CLI tool for managing Docker Compose services.
+"""
+from __future__ import annotations

{devservices-0.0.1/src → devservices-0.0.3/devservices}/commands/list_dependencies.py

@@ -4,7 +4,7 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
-from utils.services import find_matching_service
+from devservices.utils.services import find_matching_service
 
 
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:

{devservices-0.0.1/src → devservices-0.0.3/devservices}/commands/list_services.py

@@ -4,8 +4,8 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
-from utils.devenv import get_coderoot
-from utils.services import get_local_services
+from devservices.utils.devenv import get_coderoot
+from devservices.utils.services import get_local_services
 
 
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:

{devservices-0.0.1/src → devservices-0.0.3/devservices}/commands/logs.py

@@ -6,11 +6,11 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
-from constants import DEVSERVICES_DIR_NAME
-from constants import DOCKER_COMPOSE_FILE_NAME
-from exceptions import DockerComposeError
-from utils.docker_compose import run_docker_compose_command
-from utils.services import find_matching_service
+from devservices.constants import CONFIG_FILE_NAME
+from devservices.constants import DEVSERVICES_DIR_NAME
+from devservices.exceptions import DockerComposeError
+from devservices.utils.docker_compose import run_docker_compose_command
+from devservices.utils.services import find_matching_service
 
 
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
@@ -37,7 +37,7 @@ def logs(args: Namespace) -> None:
     mode_to_use = "default"
     mode_dependencies = " ".join(modes[mode_to_use])
     service_config_file_path = os.path.join(
-        service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
     )
     try:
         logs = run_docker_compose_command(

{devservices-0.0.1/src → devservices-0.0.3/devservices}/commands/start.py

@@ -5,12 +5,12 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
-from constants import DEVSERVICES_DIR_NAME
-from constants import DOCKER_COMPOSE_FILE_NAME
-from exceptions import DockerComposeError
-from utils.console import Status
-from utils.docker_compose import run_docker_compose_command
-from utils.services import find_matching_service
+from devservices.constants import CONFIG_FILE_NAME
+from devservices.constants import DEVSERVICES_DIR_NAME
+from devservices.exceptions import DockerComposeError
+from devservices.utils.console import Status
+from devservices.utils.docker_compose import run_docker_compose_command
+from devservices.utils.services import find_matching_service
 
 
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
@@ -34,7 +34,7 @@ def start(args: Namespace) -> None:
     mode_to_start = "default"
     mode_dependencies = " ".join(modes[mode_to_start])
     service_config_file_path = os.path.join(
-        service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
     )
     with Status(f"Starting {service.name}", f"{service.name} started") as status:
         try:

{devservices-0.0.1/src → devservices-0.0.3/devservices}/commands/status.py

@@ -7,11 +7,11 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
-from constants import DEVSERVICES_DIR_NAME
-from constants import DOCKER_COMPOSE_FILE_NAME
-from exceptions import DockerComposeError
-from utils.docker_compose import run_docker_compose_command
-from utils.services import find_matching_service
+from devservices.constants import CONFIG_FILE_NAME
+from devservices.constants import DEVSERVICES_DIR_NAME
+from devservices.exceptions import DockerComposeError
+from devservices.utils.docker_compose import run_docker_compose_command
+from devservices.utils.services import find_matching_service
 
 LINE_LENGTH = 40
 
@@ -49,7 +49,7 @@ def format_status_output(status_json: str) -> str:
             output.append("Ports:")
             for port in ports:
                 output.append(
-                    f"  {port['PublishedPort']} -> {port['TargetPort']}/{port['Protocol']}"
+                    f"  {port['URL']}:{port['PublishedPort']} -> {port['TargetPort']}/{port['Protocol']}"
                 )
         else:
             output.append("No ports exposed")
@@ -70,11 +70,10 @@ def status(args: Namespace) -> None:
     modes = service.config.modes
     # TODO: allow custom modes to be used
     mode_to_view = "default"
-    mode_dependencies = modes[mode_to_view]
+    mode_dependencies = " ".join(modes[mode_to_view])
     service_config_file_path = os.path.join(
-        service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
     )
-    mode_dependencies = " ".join(modes[mode_to_view])
     try:
         status_json = run_docker_compose_command(
             f"-f {service_config_file_path} ps {mode_dependencies} --format json"

{devservices-0.0.1/src → devservices-0.0.3/devservices}/commands/stop.py

@@ -5,12 +5,12 @@ from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
 
-from constants import DEVSERVICES_DIR_NAME
-from constants import DOCKER_COMPOSE_FILE_NAME
-from exceptions import DockerComposeError
-from utils.console import Status
-from utils.docker_compose import run_docker_compose_command
-from utils.services import find_matching_service
+from devservices.constants import CONFIG_FILE_NAME
+from devservices.constants import DEVSERVICES_DIR_NAME
+from devservices.exceptions import DockerComposeError
+from devservices.utils.console import Status
+from devservices.utils.docker_compose import run_docker_compose_command
+from devservices.utils.services import find_matching_service
 
 
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
@@ -34,7 +34,7 @@ def stop(args: Namespace) -> None:
     mode_to_stop = "default"
     mode_dependencies = " ".join(modes[mode_to_stop])
     service_config_file_path = os.path.join(
-        service.repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
+        service.repo_path, DEVSERVICES_DIR_NAME, CONFIG_FILE_NAME
     )
     with Status(f"Stopping {service.name}", f"{service.name} stopped") as status:
         try:

{devservices-0.0.1/src → devservices-0.0.3/devservices}/configs/service_config.py

@@ -4,20 +4,27 @@ import os
 from dataclasses import dataclass
 
 import yaml
-from constants import DEVSERVICES_DIR_NAME
-from constants import DOCKER_COMPOSE_FILE_NAME
-from exceptions import ConfigNotFoundError
-from exceptions import ConfigParseError
-from exceptions import ConfigValidationError
 
+from devservices.constants import CONFIG_FILE_NAME
+from devservices.constants import DEVSERVICES_DIR_NAME
+from devservices.exceptions import ConfigNotFoundError
+from devservices.exceptions import ConfigParseError
+from devservices.exceptions import ConfigValidationError
 
 VALID_VERSIONS = [0.1]
 
 
+@dataclass
+class RemoteConfig:
+    repo_name: str
+    branch: str
+    repo_link: str
+
+
 @dataclass
 class Dependency:
     description: str
-    link: str | None = None
+    remote: RemoteConfig | None = None
 
 
 @dataclass
@@ -56,9 +63,7 @@ class ServiceConfig:
 
 
 def load_service_config_from_file(repo_path: str) -> ServiceConfig:
-    config_path = os.path.join(
-        repo_path, DEVSERVICES_DIR_NAME, DOCKER_COMPOSE_FILE_NAME
-    )
+    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:

devservices-0.0.3/devservices/constants.py

@@ -0,0 +1,4 @@
+from __future__ import annotations
+
+DEVSERVICES_DIR_NAME = "devservices"
+CONFIG_FILE_NAME = "config.yml"

devservices-0.0.3/devservices/exceptions.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+
+class ServiceNotFoundError(Exception):
+    """Raised when a service is not found."""
+
+    pass
+
+
+class ConfigError(Exception):
+    """Base class for configuration-related errors."""
+
+    pass
+
+
+class ConfigNotFoundError(ConfigError):
+    """Raised when a configuration file is not found."""
+
+    pass
+
+
+class ConfigValidationError(ConfigError):
+    """Raised when a configuration file is invalid."""
+
+    pass
+
+
+class ConfigParseError(ConfigError):
+    """Raised when a configuration file cannot be parsed."""
+
+    pass
+
+
+class DockerComposeError(Exception):
+    """Base class for Docker Compose related errors."""
+
+    def __init__(self, command: str, returncode: int, stdout: str, stderr: str):
+        self.command = command
+        self.returncode = returncode
+        self.stdout = stdout
+        self.stderr = stderr

devservices-0.0.3/devservices/main.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+import argparse
+import atexit
+from importlib import metadata
+
+import sentry_sdk
+from sentry_sdk.integrations.argv import ArgvIntegration
+
+from devservices.commands import list_dependencies
+from devservices.commands import list_services
+from devservices.commands import logs
+from devservices.commands import start
+from devservices.commands import status
+from devservices.commands import stop
+
+sentry_sdk.init(
+    dsn="https://56470da7302c16e83141f62f88e46449@o1.ingest.us.sentry.io/4507946704961536",
+    traces_sample_rate=1.0,
+    profiles_sample_rate=1.0,
+    enable_tracing=True,
+    integrations=[ArgvIntegration()],
+)
+
+
+@atexit.register
+def cleanup() -> None:
+    sentry_sdk.flush()
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(
+        prog="devservices",
+        description="CLI tool for managing service dependencies.",
+        usage="devservices [-h] [--version] COMMAND ...",
+    )
+    parser.add_argument(
+        "--version", action="version", version=metadata.version("devservices")
+    )
+
+    subparsers = parser.add_subparsers(dest="command", title="commands", metavar="")
+
+    # Add subparsers for each command
+    start.add_parser(subparsers)
+    stop.add_parser(subparsers)
+    list_dependencies.add_parser(subparsers)
+    list_services.add_parser(subparsers)
+    status.add_parser(subparsers)
+    logs.add_parser(subparsers)
+
+    args = parser.parse_args()
+
+    if args.command:
+        # Call the appropriate function based on the command
+        with sentry_sdk.start_transaction(op="command", name=args.command):
+            args.func(args)
+    else:
+        parser.print_help()
+
+
+if __name__ == "__main__":
+    main()

{devservices-0.0.1/src → devservices-0.0.3/devservices}/utils/docker_compose.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import subprocess
 
-from exceptions import DockerComposeError
+from devservices.exceptions import DockerComposeError
 
 
 def run_docker_compose_command(command: str) -> subprocess.CompletedProcess[str]:

{devservices-0.0.1/src → devservices-0.0.3/devservices}/utils/services.py

@@ -3,12 +3,12 @@ from __future__ import annotations
 import os
 from dataclasses import dataclass
 
-from configs.service_config import ServiceConfig
-from exceptions import ConfigNotFoundError
-from exceptions import ConfigParseError
-from exceptions import ConfigValidationError
-from exceptions import ServiceNotFoundError
-from utils.devenv import get_coderoot
+from devservices.configs.service_config import ServiceConfig
+from devservices.exceptions import ConfigNotFoundError
+from devservices.exceptions import ConfigParseError
+from devservices.exceptions import ConfigValidationError
+from devservices.exceptions import ServiceNotFoundError
+from devservices.utils.devenv import get_coderoot
 
 
 @dataclass
@@ -20,7 +20,7 @@ class Service:
 
 def get_local_services(coderoot: str) -> list[Service]:
     """Get a list of services in the coderoot."""
-    from configs.service_config import load_service_config_from_file
+    from devservices.configs.service_config import load_service_config_from_file
 
     services = []
     for repo in os.listdir(coderoot):
@@ -43,7 +43,7 @@ def get_local_services(coderoot: str) -> list[Service]:
 def find_matching_service(service_name: str | None = None) -> Service:
     """Find a service with the given name."""
     if service_name is None:
-        from configs.service_config import load_service_config_from_file
+        from devservices.configs.service_config import load_service_config_from_file
 
         repo_path = os.getcwd()
         service_config = load_service_config_from_file(repo_path)

{devservices-0.0.1/src → devservices-0.0.3}/devservices.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: devservices
-Version: 0.0.1
-Requires-Python: >=3.12
+Version: 0.0.3
+Requires-Python: >=3.10
 Requires-Dist: pyyaml
 Requires-Dist: sentry-devenv
 Provides-Extra: dev

devservices-0.0.3/devservices.egg-info/SOURCES.txt

@@ -0,0 +1,32 @@
+README.md
+pyproject.toml
+setup.cfg
+devservices/__init__.py
+devservices/constants.py
+devservices/exceptions.py
+devservices/main.py
+devservices.egg-info/PKG-INFO
+devservices.egg-info/SOURCES.txt
+devservices.egg-info/dependency_links.txt
+devservices.egg-info/entry_points.txt
+devservices.egg-info/requires.txt
+devservices.egg-info/top_level.txt
+devservices/commands/__init__.py
+devservices/commands/list_dependencies.py
+devservices/commands/list_services.py
+devservices/commands/logs.py
+devservices/commands/start.py
+devservices/commands/status.py
+devservices/commands/stop.py
+devservices/configs/service_config.py
+devservices/utils/__init__.py
+devservices/utils/console.py
+devservices/utils/devenv.py
+devservices/utils/docker_compose.py
+devservices/utils/services.py
+tests/__init__.py
+tests/conftest.py
+tests/testutils.py
+tests/commands/test_start.py
+tests/commands/test_stop.py
+tests/configs/test_service_config.py

devservices-0.0.3/devservices.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+devservices = devservices.main:main

devservices-0.0.3/devservices.egg-info/top_level.txt

@@ -0,0 +1,4 @@
+devservices
+dist
+scripts
+tests

{devservices-0.0.1 → devservices-0.0.3}/pyproject.toml

@@ -1,11 +1,12 @@
 [build-system]
-requires = ["setuptools>=45", "wheel"]
+requires = ["setuptools>=70", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "devservices"
-version = "0.0.1"
-requires-python = ">=3.12"
+version = "0.0.3"
+# 3.10 is just for internal pypi compat
+requires-python = ">=3.10"
 dependencies = [
     "pyyaml",
     "sentry-devenv",
@@ -21,12 +22,11 @@ dev = [
 ]
 
 [project.scripts]
-devservices = "main:main"
+devservices = "devservices.main:main"
+
+[tool.setuptools.packages]
+find = {}
 
-[tool.setuptools]
-package-dir = {"" = "src"}
-packages = {find = {where = ["src"]}}
-include-package-data = true
 
 [tool.mypy]
 python_version = "3.12"

devservices-0.0.3/tests/commands/test_start.py

@@ -0,0 +1,97 @@
+from __future__ import annotations
+
+import os
+import subprocess
+from argparse import Namespace
+from pathlib import Path
+from unittest import mock
+
+import pytest
+
+from devservices.commands.start import start
+from devservices.constants import CONFIG_FILE_NAME
+from devservices.constants import DEVSERVICES_DIR_NAME
+from tests.testutils import create_config_file
+
+
+@mock.patch("devservices.utils.docker_compose.subprocess.run")
+def test_start_simple(mock_run: mock.Mock, tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "dependencies": {
+                "redis": {"description": "Redis"},
+                "clickhouse": {"description": "Clickhouse"},
+            },
+            "modes": {"default": ["redis", "clickhouse"]},
+        },
+        "services": {
+            "redis": {"image": "redis:6.2.14-alpine"},
+            "clickhouse": {
+                "image": "altinity/clickhouse-server:23.8.11.29.altinitystable"
+            },
+        },
+    }
+    create_config_file(tmp_path, config)
+    os.chdir(tmp_path)
+
+    args = Namespace(service_name=None)
+    start(args)
+
+    mock_run.assert_called_once_with(
+        [
+            "docker",
+            "compose",
+            "-f",
+            f"{tmp_path}/{DEVSERVICES_DIR_NAME}/{CONFIG_FILE_NAME}",
+            "up",
+            "-d",
+            "redis",
+            "clickhouse",
+        ],
+        check=True,
+        capture_output=True,
+        text=True,
+    )
+
+
+@mock.patch("devservices.utils.docker_compose.subprocess.run")
+def test_start_error(
+    mock_run: mock.Mock, capsys: pytest.CaptureFixture[str], tmp_path: Path
+) -> None:
+    mock_run.side_effect = subprocess.CalledProcessError(
+        returncode=1, stderr="Docker Compose error", cmd=""
+    )
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "dependencies": {
+                "redis": {"description": "Redis"},
+                "clickhouse": {"description": "Clickhouse"},
+            },
+            "modes": {"default": ["redis", "clickhouse"]},
+        },
+        "services": {
+            "redis": {"image": "redis:6.2.14-alpine"},
+            "clickhouse": {
+                "image": "altinity/clickhouse-server:23.8.11.29.altinitystable"
+            },
+        },
+    }
+
+    create_config_file(tmp_path, config)
+    os.chdir(tmp_path)
+
+    args = Namespace(service_name=None)
+
+    with pytest.raises(SystemExit):
+        start(args)
+
+    # Capture the printed output
+    captured = capsys.readouterr()
+
+    assert (
+        "Failed to start example-service: Docker Compose error" in captured.out.strip()
+    )

devservices-0.0.3/tests/commands/test_stop.py

@@ -0,0 +1,97 @@
+from __future__ import annotations
+
+import os
+import subprocess
+from argparse import Namespace
+from pathlib import Path
+from unittest import mock
+
+import pytest
+
+from devservices.commands.stop import stop
+from devservices.constants import CONFIG_FILE_NAME
+from devservices.constants import DEVSERVICES_DIR_NAME
+from tests.testutils import create_config_file
+
+
+@mock.patch("devservices.utils.docker_compose.subprocess.run")
+def test_stop_simple(mock_run: mock.Mock, tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "dependencies": {
+                "redis": {"description": "Redis"},
+                "clickhouse": {"description": "Clickhouse"},
+            },
+            "modes": {"default": ["redis", "clickhouse"]},
+        },
+        "services": {
+            "redis": {"image": "redis:6.2.14-alpine"},
+            "clickhouse": {
+                "image": "altinity/clickhouse-server:23.8.11.29.altinitystable"
+            },
+        },
+    }
+    create_config_file(tmp_path, config)
+    os.chdir(tmp_path)
+
+    args = Namespace(service_name=None)
+
+    stop(args)
+
+    mock_run.assert_called_once_with(
+        [
+            "docker",
+            "compose",
+            "-f",
+            f"{tmp_path}/{DEVSERVICES_DIR_NAME}/{CONFIG_FILE_NAME}",
+            "down",
+            "redis",
+            "clickhouse",
+        ],
+        check=True,
+        capture_output=True,
+        text=True,
+    )
+
+
+@mock.patch("devservices.utils.docker_compose.subprocess.run")
+def test_stop_error(
+    mock_run: mock.Mock, capsys: pytest.CaptureFixture[str], tmp_path: Path
+) -> None:
+    mock_run.side_effect = subprocess.CalledProcessError(
+        returncode=1, stderr="Docker Compose error", cmd=""
+    )
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "dependencies": {
+                "redis": {"description": "Redis"},
+                "clickhouse": {"description": "Clickhouse"},
+            },
+            "modes": {"default": ["redis", "clickhouse"]},
+        },
+        "services": {
+            "redis": {"image": "redis:6.2.14-alpine"},
+            "clickhouse": {
+                "image": "altinity/clickhouse-server:23.8.11.29.altinitystable"
+            },
+        },
+    }
+
+    create_config_file(tmp_path, config)
+    os.chdir(tmp_path)
+
+    args = Namespace(service_name=None)
+
+    with pytest.raises(SystemExit):
+        stop(args)
+
+    # Capture the printed output
+    captured = capsys.readouterr()
+
+    assert (
+        "Failed to stop example-service: Docker Compose error" in captured.out.strip()
+    )

devservices-0.0.3/tests/configs/test_service_config.py

@@ -0,0 +1,334 @@
+from __future__ import annotations
+
+from dataclasses import asdict
+from pathlib import Path
+
+import pytest
+
+from devservices.configs.service_config import load_service_config_from_file
+from devservices.exceptions import ConfigNotFoundError
+from devservices.exceptions import ConfigParseError
+from devservices.exceptions import ConfigValidationError
+from tests.testutils import create_config_file
+
+
+@pytest.mark.parametrize(
+    "service_name, dependencies, modes",
+    [
+        (
+            "example-service",
+            {"example-dependency": {"description": "Example dependency"}},
+            {"default": ["example-dependency"]},
+        ),
+        (
+            "example-service",
+            {
+                "example-dependency-1": {
+                    "description": "Example dependency 1",
+                    "remote": {
+                        "repo_name": "example-dependency-1",
+                        "branch": "main",
+                        "repo_link": "https://example.com",
+                    },
+                },
+                "example-dependency-2": {
+                    "description": "Example dependency 2",
+                },
+            },
+            {"default": ["example-dependency-1", "example-dependency-2"]},
+        ),
+        (
+            "example-service",
+            {
+                "example-dependency-1": {
+                    "description": "Example dependency 1",
+                    "remote": {
+                        "repo_name": "example-dependency-1",
+                        "branch": "main",
+                        "repo_link": "https://example.com",
+                    },
+                },
+                "example-dependency-2": {
+                    "description": "Example dependency 2",
+                },
+            },
+            {"default": ["example-dependency-1"], "custom": ["example-dependency-2"]},
+        ),
+    ],
+)
+def test_load_service_config_from_file(
+    tmp_path: Path,
+    service_name: str,
+    dependencies: dict[str, dict[str, object]],
+    modes: dict[str, list[str]],
+) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": service_name,
+            "dependencies": {key: value for key, value in dependencies.items()},
+            "modes": {key: value for key, value in modes.items()},
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    service_config = load_service_config_from_file(str(tmp_path))
+    assert asdict(service_config) == {
+        "version": 0.1,
+        "service_name": service_name,
+        "dependencies": {
+            key: {
+                "description": value["description"],
+                "remote": value.get("remote"),
+            }
+            for key, value in dependencies.items()
+        },
+        "modes": modes,
+    }
+
+
+def test_load_service_config_from_file_no_dependencies(tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "modes": {"default": []},
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    service_config = load_service_config_from_file(str(tmp_path))
+    assert asdict(service_config) == {
+        "version": 0.1,
+        "service_name": "example-service",
+        "dependencies": {},
+        "modes": {"default": []},
+    }
+
+
+def test_load_service_config_from_file_missing_config(tmp_path: Path) -> None:
+    with pytest.raises(ConfigNotFoundError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert (
+        str(e.value)
+        == f"Config file not found in directory: {tmp_path / 'devservices' / 'config.yml'}"
+    )
+
+
+def test_load_service_config_from_file_invalid_version(tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.2,
+            "service_name": "example-service",
+            "dependencies": {
+                "example-dependency": {"description": "Example dependency"}
+            },
+            "modes": {"default": ["example-dependency"]},
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    with pytest.raises(ConfigValidationError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert str(e.value) == "Invalid version '0.2' in service config"
+
+
+def test_load_service_config_from_file_missing_version(tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "dependencies": {
+                "example-dependency": {"description": "Example dependency"}
+            },
+            "modes": {"default": ["example-dependency"]},
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    with pytest.raises(ConfigValidationError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert str(e.value) == "Version is required in service config"
+
+
+def test_load_service_config_from_file_missing_service_name(tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "dependencies": {
+                "example-dependency": {"description": "Example dependency"}
+            },
+            "modes": {"default": ["example-dependency"]},
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    with pytest.raises(ConfigValidationError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert str(e.value) == "Service name is required in service config"
+
+
+def test_load_service_config_from_file_invalid_dependency(tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "dependencies": {
+                "example-dependency": {"description": "Example dependency"}
+            },
+            "modes": {"default": ["example-dependency", "unknown-dependency"]},
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    with pytest.raises(ConfigValidationError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert (
+        str(e.value)
+        == "Service 'unknown-dependency' in mode 'default' is not defined in dependencies"
+    )
+
+
+def test_load_service_config_from_file_missing_default_mode(tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "dependencies": {
+                "example-dependency": {"description": "Example dependency"}
+            },
+            "modes": {"custom": ["example-dependency"]},
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    with pytest.raises(ConfigValidationError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert str(e.value) == "Default mode is required in service config"
+
+
+def test_load_service_config_from_file_no_modes(tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "dependencies": {
+                "example-dependency": {"description": "Example dependency"}
+            },
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    with pytest.raises(ConfigValidationError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert str(e.value) == "Default mode is required in service config"
+
+
+def test_load_service_config_from_file_invalid_dependencies(tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "dependencies": {
+                "example-dependency": {
+                    "description": "Example dependency",
+                    "unknown": "key",
+                }
+            },
+            "modes": {"default": ["example-dependency"]},
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    with pytest.raises(ConfigParseError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert (
+        str(e.value)
+        == "Error parsing service dependencies: Dependency.__init__() got an unexpected keyword argument 'unknown'"
+    )
+
+
+def test_load_service_config_from_file_invalid_modes(tmp_path: Path) -> None:
+    config = {
+        "x-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "dependencies": {
+                "example-dependency": {"description": "Example dependency"}
+            },
+            "modes": {
+                "default": ["example-dependency"],
+                "custom": "example-dependency",
+            },
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    with pytest.raises(ConfigValidationError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert str(e.value) == "Services in mode 'custom' must be a list"
+
+
+def test_load_service_config_from_file_no_x_sentry_service_config(
+    tmp_path: Path,
+) -> None:
+    config = {
+        "x-not-sentry-service-config": {
+            "version": 0.1,
+            "service_name": "example-service",
+            "dependencies": {
+                "example-dependency": {"description": "Example dependency"}
+            },
+            "modes": {"default": ["example-dependency"]},
+        }
+    }
+    create_config_file(tmp_path, config)
+
+    with pytest.raises(ConfigParseError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert str(e.value) == "Config file does not contain 'x-sentry-service-config' key"
+
+
+def test_load_service_config_from_file_invalid_yaml(tmp_path: Path) -> None:
+    config = """x-sentry-service-config
+    version: 0.1
+    service_name: "example-service"
+    dependencies:
+        example-dependency:
+            description: "Example dependency"
+    modes:
+        default: ["example-dependency"]"""
+    devservices_dir = Path(tmp_path, "devservices")
+    devservices_dir.mkdir(parents=True, exist_ok=True)
+    tmp_file = Path(devservices_dir, "config.yml")
+    with tmp_file.open("w") as f:
+        f.write(config)
+
+    with pytest.raises(ConfigParseError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert (
+        str(e.value)
+        == f"Error parsing config file: mapping values are not allowed here\n  in \"{tmp_path / 'devservices' / 'config.yml'}\", line 2, column 12"
+    )
+
+
+def test_load_service_config_from_file_invalid_yaml_tag(tmp_path: Path) -> None:
+    config = """x-sentry-service-config:
+    version: 0.1
+    service_name: "example-service"
+    dependencies:
+        example-dependency:
+            description: "Example dependency"
+            link: !!invalid_tag "https://example.com"
+    modes:
+        default: ["example-dependency"]"""
+    devservices_dir = Path(tmp_path, "devservices")
+    devservices_dir.mkdir(parents=True, exist_ok=True)
+    tmp_file = Path(devservices_dir, "config.yml")
+    with tmp_file.open("w") as f:
+        f.write(config)
+
+    with pytest.raises(ConfigParseError) as e:
+        load_service_config_from_file(str(tmp_path))
+    assert (
+        str(e.value)
+        == f"Error parsing config file: could not determine a constructor for the tag 'tag:yaml.org,2002:invalid_tag'\n  in \"{tmp_path / 'devservices' / 'config.yml'}\", line 7, column 19"
+    )

{devservices-0.0.1 → devservices-0.0.3}/tests/testutils.py

@@ -10,6 +10,6 @@ def create_config_file(
 ) -> None:
     devservices_dir = Path(tmp_path, "devservices")
     devservices_dir.mkdir(parents=True, exist_ok=True)
-    tmp_file = Path(devservices_dir, "docker-compose.yml")
+    tmp_file = Path(devservices_dir, "config.yml")
     with tmp_file.open("w") as f:
         yaml.dump(config, f, sort_keys=False, default_flow_style=False)

devservices-0.0.1/README.md

@@ -1 +0,0 @@
-# devservices

devservices-0.0.1/src/devservices.egg-info/SOURCES.txt

@@ -1,23 +0,0 @@
-README.md
-pyproject.toml
-setup.cfg
-src/commands/__init__.py
-src/commands/list_dependencies.py
-src/commands/list_services.py
-src/commands/logs.py
-src/commands/start.py
-src/commands/status.py
-src/commands/stop.py
-src/configs/service_config.py
-src/devservices.egg-info/PKG-INFO
-src/devservices.egg-info/SOURCES.txt
-src/devservices.egg-info/dependency_links.txt
-src/devservices.egg-info/entry_points.txt
-src/devservices.egg-info/requires.txt
-src/devservices.egg-info/top_level.txt
-src/utils/__init__.py
-src/utils/console.py
-src/utils/devenv.py
-src/utils/docker_compose.py
-src/utils/services.py
-tests/testutils.py

devservices-0.0.1/src/devservices.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-devservices = main:main

devservices-0.0.1/src/devservices.egg-info/top_level.txt

@@ -1,3 +0,0 @@
-commands
-configs
-utils