devservices 1.0.7__tar.gz → 1.0.8__tar.gz

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

@@ -1,10 +1,12 @@
 Metadata-Version: 2.1
 Name: devservices
-Version: 1.0.7
+Version: 1.0.8
 Requires-Python: >=3.10
 License-File: LICENSE.md
 Requires-Dist: pyyaml
 Requires-Dist: sentry-devenv
+Requires-Dist: sentry-sdk
+Requires-Dist: packaging
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: mypy; extra == "dev"

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

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

@@ -7,6 +7,7 @@ import subprocess
 from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import Namespace
+from collections import namedtuple
 
 from sentry_sdk import capture_exception
 
@@ -30,6 +31,9 @@ from devservices.utils.services import Service
 LINE_LENGTH = 40
 
 
+ServiceStatus = namedtuple("ServiceStatus", ["name", "formatted_output"])
+
+
 def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     parser = subparsers.add_parser("status", help="View status of a service")
     parser.add_argument(
@@ -41,12 +45,12 @@ def add_parser(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     parser.set_defaults(func=status)
 
 
-def format_status_output(status_json: str) -> str:
+def format_status_output(service_status_json: str) -> list[ServiceStatus]:
     # Docker compose ps is line delimited json, so this constructs this into an array we can use
-    service_statuses = status_json.split("\n")[:-1]
-    output = []
-    output.append("-" * LINE_LENGTH)
+    service_statuses = service_status_json.split("\n")[:-1]
+    outputs = []
     for service_status in service_statuses:
+        output = []
         service = json.loads(service_status)
         name = service["Service"]
         state = service["State"]
@@ -71,8 +75,9 @@ def format_status_output(status_json: str) -> str:
             output.append("No ports exposed")
 
         output.append("")  # Empty line for readability
+        outputs.append(ServiceStatus(name=name, formatted_output="\n".join(output)))
 
-    return "\n".join(output)
+    return outputs
 
 
 def status(args: Namespace) -> None:
@@ -115,10 +120,15 @@ def status(args: Namespace) -> None:
         console.warning(f"{service.name} is not running")
         return
     output = f"Service: {service.name}\n\n"
+    output += "=" * LINE_LENGTH + "\n"
+    formatted_status_outputs = []
     for status_json in status_json_results:
-        output += format_status_output(status_json.stdout)
-    output += "=" * LINE_LENGTH
-    console.info(output + "\n")
+        formatted_status_outputs.extend(format_status_output(status_json.stdout))
+    formatted_status_outputs.sort(key=lambda x: x.name)
+    for formatted_status_output in formatted_status_outputs:
+        output += formatted_status_output[1]
+        output += "-" * LINE_LENGTH + "\n"
+    console.info(output)
 
 
 def _status(

{devservices-1.0.7 → devservices-1.0.8}/devservices/commands/up.py

@@ -107,7 +107,6 @@ def up(args: Namespace) -> None:
 def _bring_up_dependency(
     cmd: DockerComposeCommand, current_env: dict[str, str], status: Status
 ) -> subprocess.CompletedProcess[str]:
-    # TODO: Get rid of these constants, we need a smarter way to determine the containers being brought up
     for dependency in cmd.services:
         status.info(f"Starting {dependency}")
     return run_cmd(cmd.full_command, current_env)
@@ -132,7 +131,6 @@ def _up(
     current_env[
         DEVSERVICES_DEPENDENCIES_CACHE_DIR_KEY
     ] = relative_local_dependency_directory
-    options = ["-d", "--pull", "always"]
     dependency_graph = construct_dependency_graph(service, modes=modes)
     starting_order = dependency_graph.get_starting_order()
     sorted_remote_dependencies = sorted(
@@ -143,7 +141,7 @@ def _up(
         remote_dependencies=sorted_remote_dependencies,
         current_env=current_env,
         command="up",
-        options=options,
+        options=["-d", "--pull", "always"],
         service_config_file_path=service_config_file_path,
         mode_dependencies=mode_dependencies,
     )
@@ -180,4 +178,5 @@ def _create_devservices_network() -> None:
         ["docker", "network", "create", "devservices"],
         stdout=subprocess.DEVNULL,
         stderr=subprocess.DEVNULL,
+        check=True,
     )

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

@@ -68,7 +68,7 @@ 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}")
-    with open(config_path, "r") as stream:
+    with open(config_path, "r", encoding="utf-8") as stream:
         try:
             config = yaml.safe_load(stream)
         except yaml.YAMLError as yml_error:

{devservices-1.0.7 → devservices-1.0.8}/devservices/constants.py

@@ -37,5 +37,5 @@ DEVSERVICES_LATEST_VERSION_CACHE_FILE = os.path.join(
     DEVSERVICES_CACHE_DIR, "latest_version.txt"
 )
 DEVSERVICES_LATEST_VERSION_CACHE_TTL = timedelta(minutes=15)
-HEALTHCHECK_TIMEOUT = 30
+HEALTHCHECK_TIMEOUT = 45
 HEALTHCHECK_INTERVAL = 5

{devservices-1.0.7 → devservices-1.0.8}/devservices/main.py

@@ -26,7 +26,6 @@ from devservices.commands import update
 from devservices.constants import LOGGER_NAME
 from devservices.exceptions import DockerComposeInstallationError
 from devservices.exceptions import DockerDaemonNotRunningError
-from devservices.utils.check_for_update import check_for_update
 from devservices.utils.console import Console
 from devservices.utils.docker_compose import check_docker_compose_version
 
@@ -102,14 +101,6 @@ def main() -> None:
     else:
         parser.print_help()
 
-    if args.command != "update" and os.environ.get("CI") != "true":
-        newest_version = check_for_update()
-        if newest_version != current_version:
-            console.warning(
-                f"WARNING: A new version of devservices is available: {newest_version}"
-            )
-            console.warning('To update, run: "devservices update"')
-
 
 if __name__ == "__main__":
     main()

{devservices-1.0.7 → devservices-1.0.8}/devservices/utils/docker.py

@@ -66,7 +66,7 @@ def wait_for_healthy(container_name: str, status: Status) -> None:
 
         if result == "healthy":
             return
-        elif result == "unknown":
+        if result == "unknown":
             status.warning(
                 f"WARNING: Container {container_name} does not have a healthcheck"
             )

{devservices-1.0.7 → devservices-1.0.8}/devservices/utils/file_lock.py

@@ -7,7 +7,7 @@ from collections.abc import Generator
 
 @contextlib.contextmanager
 def lock(path: str) -> Generator[None, None, None]:
-    with open(path, mode="a+") as f:
+    with open(path, mode="a+", encoding="utf-8") as f:
         with _locked(f.fileno()):
             yield
 

{devservices-1.0.7 → devservices-1.0.8}/devservices.egg-info/PKG-INFO

@@ -1,10 +1,12 @@
 Metadata-Version: 2.1
 Name: devservices
-Version: 1.0.7
+Version: 1.0.8
 Requires-Python: >=3.10
 License-File: LICENSE.md
 Requires-Dist: pyyaml
 Requires-Dist: sentry-devenv
+Requires-Dist: sentry-sdk
+Requires-Dist: packaging
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: mypy; extra == "dev"

{devservices-1.0.7 → devservices-1.0.8}/devservices.egg-info/requires.txt

@@ -1,5 +1,7 @@
 pyyaml
 sentry-devenv
+sentry-sdk
+packaging
 
 [dev]
 black

{devservices-1.0.7 → devservices-1.0.8}/pyproject.toml

@@ -4,12 +4,14 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "devservices"
-version = "1.0.7"
+version = "1.0.8"
 # 3.10 is just for internal pypi compat
 requires-python = ">=3.10"
 dependencies = [
     "pyyaml",
     "sentry-devenv",
+    "sentry-sdk",
+    "packaging",
 ]
 
 [project.optional-dependencies]

{devservices-1.0.7 → devservices-1.0.8}/tests/commands/test_status.py

@@ -8,6 +8,7 @@ from unittest import mock
 import pytest
 
 from devservices.commands.status import status
+from devservices.configs.service_config import Dependency
 from devservices.configs.service_config import ServiceConfig
 from devservices.exceptions import DependencyError
 from devservices.exceptions import ServiceNotFoundError
@@ -156,7 +157,7 @@ def test_status_service_running(
     assert (
         """Service: test-service
 
-----------------------------------------
+========================================
 test-service
 Container: test-container
 Status: running
@@ -164,7 +165,80 @@ Health: healthy
 Uptime: 2 days ago
 Ports:
   http://localhost:8080:8080 -> 8080/tcp
+----------------------------------------
+
+"""
+        == captured.out
+    )
+
+
+@mock.patch("devservices.commands.status._status")
+@mock.patch("devservices.commands.status.find_matching_service")
+@mock.patch("devservices.commands.status.install_and_verify_dependencies")
+def test_status_services_running_sorted_order(
+    mock_install_and_verify_dependencies: mock.Mock,
+    mock_find_matching_service: mock.Mock,
+    mock_status: mock.Mock,
+    capsys: pytest.CaptureFixture[str],
+    tmp_path: Path,
+) -> None:
+    args = Namespace(service_name="test-service")
+    service = Service(
+        name="test-service",
+        repo_path=str(tmp_path),
+        config=ServiceConfig(
+            version=0.1,
+            service_name="test-service",
+            dependencies={
+                "test-dependency": Dependency(
+                    description="Test dependency",
+                )
+            },
+            modes={"default": []},
+        ),
+    )
+    mock_find_matching_service.return_value = service
+    mock_install_and_verify_dependencies.return_value = set()
+    mock_status.return_value = [
+        subprocess.CompletedProcess(
+            args=[],
+            returncode=0,
+            stdout='{"Service": "test-service", "State": "running", "Name": "test-container", "Health": "healthy", "RunningFor": "2 days ago", "Publishers": [{"URL": "http://localhost:8080", "PublishedPort": 8080, "TargetPort": 8080, "Protocol": "tcp"}]}\n',
+        ),
+        subprocess.CompletedProcess(
+            args=[],
+            returncode=0,
+            stdout='{"Service": "test-dependency", "State": "running", "Name": "test-dependency-container", "Health": "healthy", "RunningFor": "2 days ago", "Publishers": [{"URL": "http://localhost:8081", "PublishedPort": 8081, "TargetPort": 8081, "Protocol": "tcp"}]}\n',
+        ),
+    ]
+
+    status(args)
+
+    mock_find_matching_service.assert_called_once_with("test-service")
+    mock_install_and_verify_dependencies.assert_called_once_with(service)
+    mock_status.assert_called_once_with(service, set(), [])
+
+    captured = capsys.readouterr()
+    assert (
+        """Service: test-service
+
 ========================================
+test-dependency
+Container: test-dependency-container
+Status: running
+Health: healthy
+Uptime: 2 days ago
+Ports:
+  http://localhost:8081:8081 -> 8081/tcp
+----------------------------------------
+test-service
+Container: test-container
+Status: running
+Health: healthy
+Uptime: 2 days ago
+Ports:
+  http://localhost:8080:8080 -> 8080/tcp
+----------------------------------------
 
 """
         == captured.out

{devservices-1.0.7 → devservices-1.0.8}/tests/commands/test_up.py

@@ -457,7 +457,7 @@ def test_up_docker_compose_container_healthcheck_failed(
         assert "Starting clickhouse" in captured.out.strip()
         assert "Starting redis" in captured.out.strip()
         assert (
-            "Container container1 did not become healthy within 30 seconds."
+            "Container container1 did not become healthy within 45 seconds."
             in captured.out.strip()
         )