|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +import sys |
| 4 | +import json |
| 5 | +import asyncio |
| 6 | +from typing import Any, TypeVar, Callable, Awaitable |
| 7 | +from dataclasses import asdict |
| 8 | + |
| 9 | +from .types import ( |
| 10 | + ExampleCheck, |
| 11 | + RecipeOutput, |
| 12 | + ExampleResult, |
| 13 | + RecipeContext, |
| 14 | + ExampleCleanupStatus, |
| 15 | + ExampleCleanupFailure, |
| 16 | + empty_cleanup_status, |
| 17 | +) |
| 18 | + |
| 19 | +T = TypeVar("T") |
| 20 | + |
| 21 | + |
| 22 | +class _CleanupTracker: |
| 23 | + """Tracks cleanup actions and executes them in LIFO order.""" |
| 24 | + |
| 25 | + def __init__(self, status: ExampleCleanupStatus) -> None: |
| 26 | + self._status = status |
| 27 | + self._actions: list[tuple[str, Callable[[], Any]]] = [] |
| 28 | + |
| 29 | + def add(self, resource: str, action: Callable[[], Any]) -> None: |
| 30 | + """Register a cleanup action for a resource.""" |
| 31 | + self._actions.append((resource, action)) |
| 32 | + |
| 33 | + async def run(self) -> None: |
| 34 | + """Execute all cleanup actions in reverse order.""" |
| 35 | + while self._actions: |
| 36 | + resource, action = self._actions.pop() |
| 37 | + self._status.attempted.append(resource) |
| 38 | + try: |
| 39 | + result = action() |
| 40 | + if asyncio.iscoroutine(result): |
| 41 | + await result |
| 42 | + self._status.succeeded.append(resource) |
| 43 | + except Exception as e: |
| 44 | + self._status.failed.append(ExampleCleanupFailure(resource, str(e))) |
| 45 | + |
| 46 | + if self._status.attempted: |
| 47 | + if not self._status.failed: |
| 48 | + print("Cleanup completed.") # noqa: T201 |
| 49 | + else: |
| 50 | + print("Cleanup finished with errors.") # noqa: T201 |
| 51 | + |
| 52 | + |
| 53 | +def _should_fail_process(result: ExampleResult) -> bool: |
| 54 | + """Determine if the process should exit with failure.""" |
| 55 | + has_failed_checks = any(not check.passed for check in result.checks) |
| 56 | + return result.skipped or has_failed_checks or len(result.cleanup_status.failed) > 0 |
| 57 | + |
| 58 | + |
| 59 | +def wrap_recipe( |
| 60 | + recipe: Callable[[RecipeContext], RecipeOutput] | Callable[[RecipeContext], Awaitable[RecipeOutput]], |
| 61 | + validate_env: Callable[[], tuple[bool, list[ExampleCheck]]] | None = None, |
| 62 | +) -> Callable[[], ExampleResult]: |
| 63 | + """Wrap a recipe function with cleanup tracking and result handling. |
| 64 | +
|
| 65 | + Args: |
| 66 | + recipe: The recipe function to wrap. Can be sync or async. |
| 67 | + validate_env: Optional function to validate environment before running. |
| 68 | + Returns (skip, checks) tuple. |
| 69 | +
|
| 70 | + Returns: |
| 71 | + A callable that runs the recipe and returns ExampleResult. |
| 72 | + """ |
| 73 | + |
| 74 | + def run() -> ExampleResult: |
| 75 | + cleanup_status = empty_cleanup_status() |
| 76 | + cleanup = _CleanupTracker(cleanup_status) |
| 77 | + |
| 78 | + if validate_env is not None: |
| 79 | + skip, checks = validate_env() |
| 80 | + if skip: |
| 81 | + return ExampleResult( |
| 82 | + resources_created=[], |
| 83 | + checks=checks, |
| 84 | + cleanup_status=cleanup_status, |
| 85 | + skipped=True, |
| 86 | + ) |
| 87 | + |
| 88 | + ctx = RecipeContext(cleanup=cleanup) |
| 89 | + |
| 90 | + async def _run_async() -> RecipeOutput: |
| 91 | + try: |
| 92 | + result = recipe(ctx) |
| 93 | + if asyncio.iscoroutine(result): |
| 94 | + output: RecipeOutput = await result |
| 95 | + return output |
| 96 | + return result # type: ignore[return-value] |
| 97 | + finally: |
| 98 | + await cleanup.run() |
| 99 | + |
| 100 | + loop = asyncio.new_event_loop() |
| 101 | + try: |
| 102 | + output = loop.run_until_complete(_run_async()) |
| 103 | + return ExampleResult( |
| 104 | + resources_created=output.resources_created, |
| 105 | + checks=output.checks, |
| 106 | + cleanup_status=cleanup_status, |
| 107 | + ) |
| 108 | + finally: |
| 109 | + loop.close() |
| 110 | + |
| 111 | + return run |
| 112 | + |
| 113 | + |
| 114 | +def wrap_recipe_with_options( |
| 115 | + recipe: Callable[[RecipeContext, T], RecipeOutput] | Callable[[RecipeContext, T], Awaitable[RecipeOutput]], |
| 116 | + validate_env: Callable[[T], tuple[bool, list[ExampleCheck]]] | None = None, |
| 117 | +) -> Callable[[T], ExampleResult]: |
| 118 | + """Wrap a recipe function that takes options with cleanup tracking. |
| 119 | +
|
| 120 | + Args: |
| 121 | + recipe: The recipe function to wrap. Can be sync or async. Takes options parameter. |
| 122 | + validate_env: Optional function to validate environment before running. |
| 123 | + Takes options and returns (skip, checks) tuple. |
| 124 | +
|
| 125 | + Returns: |
| 126 | + A callable that runs the recipe with options and returns ExampleResult. |
| 127 | + """ |
| 128 | + |
| 129 | + def run(options: T) -> ExampleResult: |
| 130 | + cleanup_status = empty_cleanup_status() |
| 131 | + cleanup = _CleanupTracker(cleanup_status) |
| 132 | + |
| 133 | + if validate_env is not None: |
| 134 | + skip, checks = validate_env(options) |
| 135 | + if skip: |
| 136 | + return ExampleResult( |
| 137 | + resources_created=[], |
| 138 | + checks=checks, |
| 139 | + cleanup_status=cleanup_status, |
| 140 | + skipped=True, |
| 141 | + ) |
| 142 | + |
| 143 | + ctx = RecipeContext(cleanup=cleanup) |
| 144 | + |
| 145 | + async def _run_async() -> RecipeOutput: |
| 146 | + try: |
| 147 | + result = recipe(ctx, options) |
| 148 | + if asyncio.iscoroutine(result): |
| 149 | + output: RecipeOutput = await result |
| 150 | + return output |
| 151 | + return result # type: ignore[return-value] |
| 152 | + finally: |
| 153 | + await cleanup.run() |
| 154 | + |
| 155 | + loop = asyncio.new_event_loop() |
| 156 | + try: |
| 157 | + output = loop.run_until_complete(_run_async()) |
| 158 | + return ExampleResult( |
| 159 | + resources_created=output.resources_created, |
| 160 | + checks=output.checks, |
| 161 | + cleanup_status=cleanup_status, |
| 162 | + ) |
| 163 | + finally: |
| 164 | + loop.close() |
| 165 | + |
| 166 | + return run |
| 167 | + |
| 168 | + |
| 169 | +def run_as_cli(run: Callable[[], ExampleResult]) -> None: |
| 170 | + """Run an example and exit with appropriate status code.""" |
| 171 | + try: |
| 172 | + result = run() |
| 173 | + print(json.dumps(asdict(result), indent=2)) # noqa: T201 |
| 174 | + if _should_fail_process(result): |
| 175 | + sys.exit(1) |
| 176 | + except Exception as e: |
| 177 | + print(f"Error: {e}") # noqa: T201 |
| 178 | + sys.exit(1) |
0 commit comments