devservices 1.2.1__tar.gz → 1.2.2__tar.gz

{devservices-1.2.1 → devservices-1.2.2}/PKG-INFO

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

{devservices-1.2.1 → devservices-1.2.2}/README.md

@@ -33,7 +33,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.2.1
+devservices==1.2.2
 ```
 
 ### 2. Add devservices config files
@@ -47,7 +47,7 @@ The configuration file is a yaml file that looks like this:
 # - version: The version of the devservices config file. This is used to ensure compatibility between devservices and the config file.
 # - service_name: The name of the service. This is used to identify the service in the config file.
 # - dependencies: A list of dependencies for the service. Each dependency is a yaml block that holds the dependency configuration. There are two types of dependencies:
-#   - local: A dependency that is defined in the config file. These dependencies do not have a remote field. These dependency definitions are specific to the service and are not defined elsewhere.
+#   - local: A dependency that is defined in the config file. These dependencies do not have a remote field and must correspond to either a service defined in the 'services' section or a program defined in the 'x-programs' section.
 #   - remote: A dependency that is defined in the devservices directory in a remote repository. These configs are automatically fetched from the remote repository and installed. Any dependency with a remote field will be treated as a remote dependency. Example: https://github.com/getsentry/snuba/blob/59a5258ccbb502827ebc1d3b1bf80c607a3301bf/devservices/config.yml#L8
 # - modes: A list of modes for the service. Each mode includes a list of dependencies that are used in that mode.
 x-sentry-service-config:
@@ -69,6 +69,27 @@ x-sentry-service-config:
     default: [example-dependency-1, example-remote-dependency]
     custom-mode: [example-dependency-1, example-dependency-2, example-remote-dependency]
 
+# This block defines supervisor programs that can be managed by devservices.
+# Programs defined here are managed using Python's supervisor package and can be:
+# - Started and stopped along with docker services when running `devservices up/down`
+# - Run in the foreground for interactive debugging using `devservices foreground <program-name>`
+# - Used as development server with `devservices serve` (requires a program named "devserver")
+#
+# These are particularly useful for:
+# - Defining a devserver to run locally
+# - Background workers or task processors
+# - Any process that needs to be managed alongside your docker services
+x-programs:
+  # Example devserver
+  devserver:
+    # Required: The command to execute
+    command: "python manage.py run_server"
+    # Optional: You can also specify any of the supervisor program settings defined here: https://supervisord.org/configuration.html#program-x-section-settings
+
+  # Example background worker
+  example-worker:
+    command: "python manage.py worker"
+
 # This will be a standard block used by docker compose to define dependencies.
 #
 # The following fields are important to all dependencies:

{devservices-1.2.1 → devservices-1.2.2}/devservices/commands/up.py

@@ -98,14 +98,16 @@ def up(args: Namespace, existing_status: Status | None = None) -> None:
 
     with Status(
         lambda: (
-            console.warning(f"Starting '{service.name}' in mode: '{mode}'")
+            console.warning(f"Starting '{service.name}' dependencies in mode: '{mode}'")
             if existing_status is None
-            else existing_status.warning(f"Starting '{service.name}' in mode: '{mode}'")
+            else existing_status.warning(
+                f"Starting '{service.name}' dependencies in mode: '{mode}'"
+            )
         ),
         lambda: (
-            console.success(f"{service.name} started")
+            console.success(f"{service.name} dependencies started")
             if existing_status is None
-            else existing_status.success(f"{service.name} started")
+            else existing_status.success(f"{service.name} dependencies started")
         ),
     ) as status:
         local_runtime_dependency_names = set()

{devservices-1.2.1 → devservices-1.2.2}/devservices/utils/docker.py

@@ -10,6 +10,7 @@ from devservices.constants import HEALTHCHECK_TIMEOUT
 from devservices.exceptions import ContainerHealthcheckFailedError
 from devservices.exceptions import DockerDaemonNotRunningError
 from devservices.exceptions import DockerError
+from devservices.utils.console import Console
 from devservices.utils.console import Status
 
 
@@ -20,6 +21,7 @@ class ContainerNames(NamedTuple):
 
 def check_docker_daemon_running() -> None:
     """Checks if the Docker daemon is running. Raises DockerDaemonNotRunningError if not."""
+    console = Console()
     try:
         subprocess.run(
             ["docker", "info"],
@@ -27,7 +29,13 @@ def check_docker_daemon_running() -> None:
             text=True,
             check=True,
         )
+        return
+    except subprocess.CalledProcessError:
+        console.info("Docker daemon is not running. Checking if colima is available")
+    try:
+        subprocess.run(["devenv", "colima", "start"], check=True)
     except subprocess.CalledProcessError as e:
+        console.failure("Failed to start colima")
         raise DockerDaemonNotRunningError from e
 
 

{devservices-1.2.1 → devservices-1.2.2}/devservices.egg-info/PKG-INFO

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

{devservices-1.2.1 → devservices-1.2.2}/pyproject.toml

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

{devservices-1.2.1 → devservices-1.2.2}/tests/commands/test_up.py

@@ -170,7 +170,10 @@ def test_up_simple(
         mock_check_all_containers_healthy.assert_called_once()
         captured = capsys.readouterr()
         assert "Retrieving dependencies" in captured.out.strip()
-        assert "Starting 'example-service' in mode: 'default'" in captured.out.strip()
+        assert (
+            "Starting 'example-service' dependencies in mode: 'default'"
+            in captured.out.strip()
+        )
         assert "Starting clickhouse" in captured.out.strip()
         assert "Starting redis" in captured.out.strip()
 
@@ -238,7 +241,8 @@ def test_up_dependency_error(
         captured = capsys.readouterr()
         assert "Retrieving dependencies" not in captured.out.strip()
         assert (
-            "Starting 'example-service' in mode: 'default'" not in captured.out.strip()
+            "Starting 'example-service' dependencies in mode: 'default'"
+            not in captured.out.strip()
         )
         assert "Starting clickhouse" not in captured.out.strip()
         assert "Starting redis" not in captured.out.strip()
@@ -348,7 +352,10 @@ def test_up_error(
     mock_remove_service_entry.assert_not_called()
 
     assert "Retrieving dependencies" in captured.out.strip()
-    assert "Starting 'example-service' in mode: 'default'" in captured.out.strip()
+    assert (
+        "Starting 'example-service' dependencies in mode: 'default'"
+        in captured.out.strip()
+    )
     assert "Starting clickhouse" not in captured.out.strip()
     assert "Starting redis" not in captured.out.strip()
 
@@ -564,7 +571,7 @@ def test_up_pull_error_eventual_success(
     mock_create_devservices_network.assert_called_once()
     captured = capsys.readouterr()
 
-    assert "example-service started" in captured.out.strip()
+    assert "example-service dependencies started" in captured.out.strip()
 
 
 @mock.patch("devservices.utils.state.State.remove_service_entry")
@@ -704,7 +711,10 @@ def test_up_docker_compose_container_lookup_error(
         mock_check_all_containers_healthy.assert_not_called()
         captured = capsys.readouterr()
         assert "Retrieving dependencies" in captured.out.strip()
-        assert "Starting 'example-service' in mode: 'default'" in captured.out.strip()
+        assert (
+            "Starting 'example-service' dependencies in mode: 'default'"
+            in captured.out.strip()
+        )
         assert "Starting clickhouse" in captured.out.strip()
         assert "Starting redis" in captured.out.strip()
         assert (
@@ -848,7 +858,10 @@ def test_up_docker_compose_container_healthcheck_failed(
         mock_check_all_containers_healthy.assert_called_once()
         captured = capsys.readouterr()
         assert "Retrieving dependencies" in captured.out.strip()
-        assert "Starting 'example-service' in mode: 'default'" in captured.out.strip()
+        assert (
+            "Starting 'example-service' dependencies in mode: 'default'"
+            in captured.out.strip()
+        )
         assert "Starting clickhouse" in captured.out.strip()
         assert "Starting redis" in captured.out.strip()
         assert (
@@ -993,7 +1006,10 @@ def test_up_mode_simple(
         assert (
             "Starting dependencies with local runtimes..." not in captured.out.strip()
         ), "This shouldn't be printed since we don't have any dependencies with local runtimes"
-        assert "Starting 'example-service' in mode: 'test'" in captured.out.strip()
+        assert (
+            "Starting 'example-service' dependencies in mode: 'test'"
+            in captured.out.strip()
+        )
         assert "Starting redis" in captured.out.strip()
 
 
@@ -1079,7 +1095,10 @@ def test_up_mode_does_not_exist(
         assert (
             "Starting dependencies with local runtimes..." not in captured.out.strip()
         ), "This shouldn't be printed since we don't have any dependencies with local runtimes"
-        assert "Starting 'example-service' in mode: 'test'" not in captured.out.strip()
+        assert (
+            "Starting 'example-service' dependencies in mode: 'test'"
+            not in captured.out.strip()
+        )
         assert "Starting clickhouse" not in captured.out.strip()
         assert "Starting redis" not in captured.out.strip()
 
@@ -1184,7 +1203,10 @@ def test_up_multiple_modes(
         mock_check_all_containers_healthy.assert_called_once()
 
         captured = capsys.readouterr()
-        assert "Starting 'example-service' in mode: 'test'" in captured.out.strip()
+        assert (
+            "Starting 'example-service' dependencies in mode: 'test'"
+            in captured.out.strip()
+        )
         assert (
             "Starting dependencies with local runtimes..." not in captured.out.strip()
         ), "This shouldn't be printed since we don't have any dependencies with local runtimes"
@@ -1351,7 +1373,10 @@ def test_up_multiple_modes_overlapping_running_service(
         )
 
         captured = capsys.readouterr()
-        assert "Starting 'example-service' in mode: 'test'" in captured.out.strip()
+        assert (
+            "Starting 'example-service' dependencies in mode: 'test'"
+            in captured.out.strip()
+        )
         assert "Retrieving dependencies" in captured.out.strip()
         assert (
             "Starting dependencies with local runtimes..." not in captured.out.strip()
@@ -2522,7 +2547,10 @@ def test_up_supervisor_program(
         assert (
             "Starting dependencies with local runtimes..." not in captured.out.strip()
         ), "This shouldn't be printed since we don't have any dependencies with local runtimes"
-        assert "Starting 'example-service' in mode: 'default'" in captured.out.strip()
+        assert (
+            "Starting 'example-service' dependencies in mode: 'default'"
+            in captured.out.strip()
+        )
         assert "Starting supervisor daemon" in captured.out.strip()
         assert "Starting supervisor-program" in captured.out.strip()
 
@@ -2615,7 +2643,10 @@ def test_up_supervisor_program_error(
         assert (
             "Starting dependencies with local runtimes..." not in captured.out.strip()
         ), "This shouldn't be printed since we don't have any dependencies with local runtimes"
-        assert "Starting 'example-service' in mode: 'default'" in captured.out.strip()
+        assert (
+            "Starting 'example-service' dependencies in mode: 'default'"
+            in captured.out.strip()
+        )
         assert "Starting supervisor daemon" in captured.out.strip()
         assert "Error starting supervisor daemon" in captured.out.strip()
 

{devservices-1.2.1 → devservices-1.2.2}/tests/utils/test_docker.py

@@ -7,6 +7,7 @@ from unittest import mock
 import pytest
 from freezegun import freeze_time
 
+from devservices.constants import Color
 from devservices.constants import DEVSERVICES_ORCHESTRATOR_LABEL
 from devservices.constants import DOCKER_NETWORK_NAME
 from devservices.constants import HEALTHCHECK_INTERVAL
@@ -25,15 +26,29 @@ from devservices.utils.docker import wait_for_healthy
 
 
 @mock.patch("subprocess.run")
-def test_check_docker_daemon_running_error(mock_run: mock.Mock) -> None:
+def test_check_docker_daemon_running_error(
+    mock_run: mock.Mock, capsys: pytest.CaptureFixture[str]
+) -> None:
     mock_run.side_effect = subprocess.CalledProcessError(1, "cmd")
     with pytest.raises(DockerDaemonNotRunningError):
         check_docker_daemon_running()
-    mock_run.assert_called_once_with(
-        ["docker", "info"],
-        capture_output=True,
-        text=True,
-        check=True,
+    mock_run.assert_has_calls(
+        [
+            mock.call(
+                ["docker", "info"],
+                capture_output=True,
+                text=True,
+                check=True,
+            ),
+            mock.call(
+                ["devenv", "colima", "start"],
+                check=True,
+            ),
+        ]
+    )
+    assert (
+        capsys.readouterr().out
+        == f"Docker daemon is not running. Checking if colima is available\n{Color.RED}Failed to start colima{Color.RESET}\n"
     )
 
 

{devservices-1.2.1 → devservices-1.2.2}/tests/utils/test_docker_compose.py

@@ -79,7 +79,10 @@ def test_check_docker_compose_invalid_version(
 
 @mock.patch(
     "subprocess.run",
-    side_effect=[subprocess.CalledProcessError(returncode=1, cmd="docker info")],
+    side_effect=[
+        subprocess.CalledProcessError(returncode=1, cmd="docker info"),
+        subprocess.CalledProcessError(returncode=1, cmd="devenv colima start"),
+    ],
 )
 @mock.patch(
     "devservices.utils.docker_compose.install_docker_compose", side_effect=lambda: None