uber-compose 2.3.3__tar.gz → 2.4.0__tar.gz

{uber_compose-2.3.3 → uber_compose-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uber-compose
-Version: 2.3.3
+Version: 2.4.0
 Summary: docker compose testing env orchestrator
 Home-page: https://github.com/ko10ok/uber-compose
 Author: Yuriy Sagitov
@@ -231,6 +231,7 @@ This is particularly useful when:
 - **[E2E Test Setup](docs/E2E_CONTAINER_SETUP.md)** - Configure test container for E2E testing
 - **[CLI Usage Guide](docs/CLI_USAGE.md)** - Guide for using CommonJsonCli with JSON log parsing
 - **[X-Migration](docs/X_MIGRATION.md)** - Extended service initialization and migration commands
+- **[Lifecycle Hooks](docs/HOOKS.md)** - Register callbacks that run after the environment is up
 
 ## 🛠️ Development Guide
 

{uber_compose-2.3.3 → uber_compose-2.4.0}/README.md

@@ -198,6 +198,7 @@ This is particularly useful when:
 - **[E2E Test Setup](docs/E2E_CONTAINER_SETUP.md)** - Configure test container for E2E testing
 - **[CLI Usage Guide](docs/CLI_USAGE.md)** - Guide for using CommonJsonCli with JSON log parsing
 - **[X-Migration](docs/X_MIGRATION.md)** - Extended service initialization and migration commands
+- **[Lifecycle Hooks](docs/HOOKS.md)** - Register callbacks that run after the environment is up
 
 ## 🛠️ Development Guide
 

{uber_compose-2.3.3 → uber_compose-2.4.0}/uber_compose/__init__.py

@@ -10,6 +10,7 @@ from uber_compose.env_description.env_types import OverridenService
 from uber_compose.env_description.env_types import Service
 from uber_compose.helpers.exec_result import ExecTimeout
 from uber_compose.helpers.health_policy import UpHealthPolicy
+from uber_compose.helpers.hooks import UberComposeEvent
 from uber_compose.uber_compose import SystemUberCompose
 from uber_compose.uber_compose import TheUberCompose
 from uber_compose.vedro_plugin.base_structures.common_json_cli import CommandResult
@@ -27,5 +28,5 @@ __all__ = (
     'CommonJsonCli', 'CommandResult', 'ProcessExit', 'JsonParser', 'json_parser', 'ExecTimeout', 'TimeOutCheck',
     'ExecLifeCyclePolicy',
     'VedroUberCompose', 'UpHealthPolicy', 'DEFAULT_COMPOSE', 'ComposeConfig', 'DEFAULT_ENV_DESCRIPTION',
-    'DEFAULT_ENV_ID',
+    'DEFAULT_ENV_ID', 'UberComposeEvent',
 )

uber_compose-2.4.0/uber_compose/helpers/hooks.py

@@ -0,0 +1,24 @@
+from collections import defaultdict
+from enum import Enum
+import inspect
+from typing import Any
+from typing import Callable
+
+
+class UberComposeEvent(Enum):
+    AFTER_UP = 'after_up'
+    AFTER_UPDATED_ENV_UP = 'after_updated_env_up'
+
+
+class HooksRegistry:
+    def __init__(self) -> None:
+        self._hooks: dict[UberComposeEvent, list[tuple[Callable[..., Any], tuple, dict]]] = defaultdict(list)
+
+    def on(self, event: UberComposeEvent, func: Callable[..., Any], *args: Any, **kwargs: Any) -> None:
+        self._hooks[event].append((func, args, kwargs))
+
+    async def run(self, event: UberComposeEvent) -> None:
+        for func, args, kwargs in self._hooks[event]:
+            result = func(*args, **kwargs)
+            if inspect.isawaitable(result):
+                await result

{uber_compose-2.3.3 → uber_compose-2.4.0}/uber_compose/uber_compose.py

@@ -1,5 +1,6 @@
 from dataclasses import dataclass
 import shlex
+from typing import Any
 from typing import Callable
 from uuid import uuid4
 
@@ -23,6 +24,8 @@ from uber_compose.helpers.bytes_pickle import debase64_pickled
 from uber_compose.helpers.exec_result import ExecResult
 from uber_compose.helpers.exec_result import ExecTimeout
 from uber_compose.helpers.health_policy import UpHealthPolicy
+from uber_compose.helpers.hooks import HooksRegistry
+from uber_compose.helpers.hooks import UberComposeEvent
 from uber_compose.helpers.jobs_result import JobResult
 from uber_compose.helpers.labels import Label
 from uber_compose.helpers.singleton import SingletonMeta
@@ -59,6 +62,11 @@ class SystemUberCompose:
         self.health_policy = health_policy
         self.run_id = run_id
         self.last_release_id = None
+        self._previous_release_id: str | None = None
+        self._hooks = HooksRegistry()
+
+    def on(self, event: UberComposeEvent, func: Callable, *args: Any, **kwargs: Any) -> None:
+        self._hooks.on(event, func, *args, **kwargs)
 
     async def up(self,
                  config_template: Environment | None = None,
@@ -76,6 +84,7 @@ class SystemUberCompose:
 
         reusable_env = self._find_reusable_env(services_state, config_template, force_restart)
         if reusable_env is not None:
+            await self._hooks.run(UberComposeEvent.AFTER_UP)
             return reusable_env
 
         self._log_inflight_and_restart_info(services_state, force_restart)
@@ -145,6 +154,7 @@ class SystemUberCompose:
 
         last_release_id = services_state.get_any().labels.get(Label.RELEASE_ID)
         self.last_release_id = last_release_id
+        self._previous_release_id = last_release_id
         return ReadyEnv(existing_env_id, env_config, last_release_id)
 
     def _log_inflight_and_restart_info(self, services_state: ServicesComposeState, force_restart: bool) -> None:
@@ -183,6 +193,8 @@ class SystemUberCompose:
         if self.last_release_id is None:
             self.last_release_id = str(uuid4())
 
+        is_env_update = self._previous_release_id is not None
+
         if parallelism_limit == 1:
             self.logger.stage_debug(f'Using default service names with {parallelism_limit=}')
             new_env_id = DEFAULT_ENV_ID
@@ -216,6 +228,11 @@ class SystemUberCompose:
 
         self.logger.stage_info(Text('New environment started'))
 
+        await self._hooks.run(UberComposeEvent.AFTER_UP)
+        if is_env_update:
+            await self._hooks.run(UberComposeEvent.AFTER_UPDATED_ENV_UP)
+        self._previous_release_id = self.last_release_id
+
         return ReadyEnv(
             new_env_id,
             compose_instance.compose_instance_files.env_config_instance.env,

uber_compose-2.4.0/uber_compose/version

@@ -0,0 +1 @@
+2.4.0

{uber_compose-2.3.3 → uber_compose-2.4.0}/uber_compose.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uber-compose
-Version: 2.3.3
+Version: 2.4.0
 Summary: docker compose testing env orchestrator
 Home-page: https://github.com/ko10ok/uber-compose
 Author: Yuriy Sagitov
@@ -231,6 +231,7 @@ This is particularly useful when:
 - **[E2E Test Setup](docs/E2E_CONTAINER_SETUP.md)** - Configure test container for E2E testing
 - **[CLI Usage Guide](docs/CLI_USAGE.md)** - Guide for using CommonJsonCli with JSON log parsing
 - **[X-Migration](docs/X_MIGRATION.md)** - Extended service initialization and migration commands
+- **[Lifecycle Hooks](docs/HOOKS.md)** - Register callbacks that run after the environment is up
 
 ## 🛠️ Development Guide
 

{uber_compose-2.3.3 → uber_compose-2.4.0}/uber_compose.egg-info/SOURCES.txt

@@ -39,6 +39,7 @@ uber_compose/helpers/countdown_counter.py
 uber_compose/helpers/exec_record.py
 uber_compose/helpers/exec_result.py
 uber_compose/helpers/health_policy.py
+uber_compose/helpers/hooks.py
 uber_compose/helpers/jobs_result.py
 uber_compose/helpers/labels.py
 uber_compose/helpers/singleton.py

uber_compose-2.3.3/uber_compose/version

@@ -1 +0,0 @@
-2.3.3