aws-annoying 0.5.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

aws_annoying/utils/timeout.py

@@ -0,0 +1,88 @@
+from __future__ import annotations
+
+import signal
+from functools import wraps
+from typing import TYPE_CHECKING, Callable, Optional, TypeVar, cast
+
+from pydantic import PositiveInt, validate_call
+
+from aws_annoying.utils.platform import is_windows
+
+if TYPE_CHECKING:
+    from types import FrameType
+    from typing import Any
+
+
+class OperationTimeoutError(Exception):
+    """Operation timed out."""
+
+
+_F = TypeVar("_F", bound=Callable)
+
+
+class Timeout:
+    """Timeout handler utilizing signals.
+
+    This utility relies on Unix signals (`signal.SIGALRM`). The behavior will be dummied
+    to do nothing on Windows OS.
+    """
+
+    @validate_call
+    def __init__(self, seconds: Optional[PositiveInt]) -> None:
+        """Initialize timeout handler.
+
+        Args:
+            seconds: The timeout in seconds. `None` means no timeout,
+                allowing the function to run normally.
+
+        """
+        self.timeout_seconds = seconds
+
+        self._signal_handler_registered = False
+
+    def _set_signal_handler(self) -> None:
+        if is_windows() or self.timeout_seconds is None:
+            return
+
+        signal.signal(signal.SIGALRM, self._handler)
+        signal.alarm(self.timeout_seconds)
+        self._signal_handler_registered = True
+
+    def _handler(self, signum: int, frame: FrameType | None) -> Any:  # noqa: ARG002
+        msg = "Timeout reached"
+        raise OperationTimeoutError(msg)
+
+    def _reset_signal_handler(self) -> None:
+        if is_windows() or not self._signal_handler_registered:
+            return
+
+        signal.signal(signal.SIGALRM, signal.SIG_IGN)
+        signal.alarm(0)
+        self._signal_handler_registered = False
+
+    def __call__(self, func: _F) -> _F:
+        """Decorator to set a timeout for a function.
+
+        Please note, using this decorator in nested functions may not work properly as
+        the signal handler for outer functions may not be resumed correctly.
+
+        Raises:
+            OperationTimeoutError: When timeout is reached.
+        """
+
+        @wraps(func)
+        def wrapper(*args: Any, **kwargs: Any) -> Any:
+            self._set_signal_handler()
+            try:
+                return func(*args, **kwargs)
+            finally:
+                self._reset_signal_handler()
+
+        return cast("_F", wrapper)
+
+    def __enter__(self) -> None:
+        self._set_signal_handler()
+
+    def __exit__(self, *args: object) -> Any:
+        self._reset_signal_handler()
+        return False  # Re-raise

aws_annoying/{variables.py → variable_loader.py}

@@ -2,17 +2,17 @@
 from __future__ import annotations
 
 import json
+import logging
 from typing import Any, TypedDict
 
 import boto3
 
+logger = logging.getLogger(__name__)
+
 # Type aliases for readability
 _ARN = str
 _Variables = dict[str, Any]
 
-# TODO(lasuillard): Need some refactoring (with #2, #3)
-# TODO(lasuillard): Put some logging
-
 
 class _LoadStatsDict(TypedDict):
     secrets: int
@@ -20,14 +20,13 @@ class _LoadStatsDict(TypedDict):
 
 
 class VariableLoader:  # noqa: D101
-    def __init__(self, *, dry_run: bool) -> None:
-        """Initialize the VariableLoader.
+    def __init__(self, *, session: boto3.session.Session | None = None) -> None:
+        """Initialize variable loader.
 
         Args:
-            dry_run: Whether to run in dry-run mode.
-            console: Rich console instance.
+            session: Boto3 session to use for AWS operations.
         """
-        self.dry_run = dry_run
+        self.session = session or boto3.session.Session()
 
     # TODO(lasuillard): Currently not using pagination (do we need more than 10-20 secrets or parameters each?)
     #                   ; consider adding it if needed
@@ -54,12 +53,8 @@ class VariableLoader:  # noqa: D101
         # Retrieve variables from AWS resources
         secrets: dict[str, _Variables]
         parameters: dict[str, _Variables]
-        if self.dry_run:
-            secrets = {idx: {} for idx, _ in secrets_map.items()}
-            parameters = {idx: {} for idx, _ in parameters_map.items()}
-        else:
-            secrets = self._retrieve_secrets(secrets_map)
-            parameters = self._retrieve_parameters(parameters_map)
+        secrets = self._retrieve_secrets(secrets_map)
+        parameters = self._retrieve_parameters(parameters_map)
 
         load_stats: _LoadStatsDict = {
             "secrets": len(secrets),
@@ -79,7 +74,7 @@ class VariableLoader:  # noqa: D101
         if not secrets_map:
             return {}
 
-        secretsmanager = boto3.client("secretsmanager")
+        secretsmanager = self.session.client("secretsmanager")
 
         # Retrieve the secrets
         arns = list(secrets_map.values())
@@ -108,7 +103,7 @@ class VariableLoader:  # noqa: D101
         if not parameters_map:
             return {}
 
-        ssm = boto3.client("ssm")
+        ssm = self.session.client("ssm")
 
         # Retrieve the parameters
         parameter_names = list(parameters_map.values())

{aws_annoying-0.5.0.dist-info → aws_annoying-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws-annoying
-Version: 0.5.0
+Version: 0.6.0
 Summary: Utils to handle some annoying AWS tasks.
 Project-URL: Homepage, https://github.com/lasuillard/aws-annoying
 Project-URL: Repository, https://github.com/lasuillard/aws-annoying.git
@@ -22,13 +22,15 @@ Requires-Dist: types-requests>=2.31.0.6; extra == 'dev'
 Provides-Extra: test
 Requires-Dist: coverage<7.9,>=7.6; extra == 'test'
 Requires-Dist: moto[ecs,secretsmanager,server,ssm]~=5.1.1; extra == 'test'
-Requires-Dist: pytest-cov~=6.0.0; extra == 'test'
+Requires-Dist: pytest-cov<6.2,>=6.0; extra == 'test'
 Requires-Dist: pytest-env~=1.1.1; extra == 'test'
 Requires-Dist: pytest-snapshot>=0.9.0; extra == 'test'
 Requires-Dist: pytest-sugar~=1.0.0; extra == 'test'
 Requires-Dist: pytest-xdist>=3.6.1; extra == 'test'
 Requires-Dist: pytest~=8.3.2; extra == 'test'
 Requires-Dist: testcontainers[localstack]>=4.9.2; extra == 'test'
+Requires-Dist: toml>=0.10.2; extra == 'test'
+Requires-Dist: types-toml>=0.10.8.20240310; extra == 'test'
 Description-Content-Type: text/markdown
 
 # aws-annoying
@@ -39,3 +41,46 @@ Description-Content-Type: text/markdown
 ![PyPI - Version](https://img.shields.io/pypi/v/aws-annoying)
 
 Utils to handle some annoying AWS tasks.
+
+## ❓ About
+
+This project aims to provide a set of utilities and examples to help with some annoying tasks when working with AWS.
+
+Major directories of the project:
+
+- **aws_annoying** Python package containing CLI and utility functions.
+- **console** Utilities to help working with AWS Console.
+- **examples** Examples of how to use the package.
+
+## 🚀 Installation
+
+It is recommended to use [pipx](https://pipx.pypa.io/stable/) to install `aws-annoying`:
+
+```bash
+$ pipx install aws-annoying
+$ aws-annoying --help
+
+ Usage: aws-annoying [OPTIONS] COMMAND [ARGS]...
+
+...
+```
+
+Available commands:
+
+- **ecs** ECS utilities.
+  - **task-definition-lifecycle** Help to manage ECS task definitions lifecycle.
+  - **wait-for-deployment** Wait for ECS deployment to complete.
+- **load-variables** Wrapper command to run command with variables from AWS resources injected as environment variables.
+- **mfa** Commands to manage MFA authentication.
+  - **configure** Configure AWS profile for MFA.
+- **session-manager** AWS Session Manager CLI utilities.
+  - **install** Install AWS Session Manager plugin.
+  - **port-forward** Start a port forwarding session using AWS Session Manager.
+  - **start** Start new session.
+  - **stop** Stop running session for PID file.
+
+Please refer to the CLI help for more information about the available commands and options.
+
+## 💖 Contributing
+
+Any feedback, suggestions or contributions are welcome! Feel free to open an issue or a pull request.

aws_annoying-0.6.0.dist-info/RECORD

@@ -0,0 +1,41 @@
+aws_annoying/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aws_annoying/mfa_config.py,sha256=z0GpRhLHEWaaXbECV4Ei4oNM1WCFoEZAxCIPbpY4Ymc,2200
+aws_annoying/variable_loader.py,sha256=N9qPPHG6mzSIIHrWJnJ_FV5kKZxssOaTHoAQEwiDE3s,4569
+aws_annoying/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aws_annoying/cli/app.py,sha256=6opsAfIFGPnUSK68s7sEnFzLhipnevfP2cDJ0yj7Lh0,2366
+aws_annoying/cli/load_variables.py,sha256=83RGt5eA_TJtza3kyLXoSM_A3lfQs6TNC2TCrWYia_I,5032
+aws_annoying/cli/logging_handler.py,sha256=JPsZePV3YH9e1nLv0Q3fqSeXSEfZ5cGJo6eLK2F4oxE,1426
+aws_annoying/cli/main.py,sha256=bU4Gxic5_3qrrd8l9eN709-D4o_OHgrdH91FS9Xs8zI,477
+aws_annoying/cli/ecs/__init__.py,sha256=IxfaMXcGU6WTHE_RXj-aitXtSg25j5m3HGTG9O02GjI,125
+aws_annoying/cli/ecs/_app.py,sha256=izD0VL55i7oG-2CtWCV21bSoAeE-DZbxyJ5pi6VXhjU,200
+aws_annoying/cli/ecs/task_definition_lifecycle.py,sha256=W7zr8zEPjjHgss9Tnb3QMcJ_45Yb9SJ5D1B315vb9kc,2803
+aws_annoying/cli/ecs/wait_for_deployment.py,sha256=0lzl5t0TOvJJeMxIA6if2TbG7bJFf6JulhPHZqNXjFM,3169
+aws_annoying/cli/mfa/__init__.py,sha256=rbEGhw5lOQZV_XAc3nSbo56JVhsSPpeOgEtiAy9qzEA,50
+aws_annoying/cli/mfa/_app.py,sha256=Ub7gxb6kGF3Ve1ucQSOjHmc4jAu8mxgegcXsIbOzLLQ,189
+aws_annoying/cli/mfa/configure.py,sha256=s2SCz7gzvIE9mJM7w95JPwoGhuQrgkFhjUd6qjD169k,3957
+aws_annoying/cli/session_manager/__init__.py,sha256=FkT6jT6OXduOURN61d-U6hgd-XluQbvuVtKXXiXgSEk,105
+aws_annoying/cli/session_manager/_app.py,sha256=OVOHW0iyKzunvaqLhjoseHw1-WxJ1gGb7QmiyAEezyY,221
+aws_annoying/cli/session_manager/_common.py,sha256=Uj-MF7z8Qntd24Z03xxE-jSKcgrsd8xl41E6db4qCtY,711
+aws_annoying/cli/session_manager/install.py,sha256=VIk6313jUf6THwvs06AOUQwhTjzCGCcvDXMxyz0BcgE,1477
+aws_annoying/cli/session_manager/port_forward.py,sha256=upsUsd7MkUfaAP3o0ZK6N-SkOBnr1ogwqYozG4TDTzY,4331
+aws_annoying/cli/session_manager/start.py,sha256=1Q-WFvbQkMgVntwIrM2HfpUKmVL38aFrjJjG3aA0fzU,1447
+aws_annoying/cli/session_manager/stop.py,sha256=QjjOmmhZr_0IInhOyHvSlodk7Nx4qu9EtrRw4kl8Hks,1535
+aws_annoying/ecs/__init__.py,sha256=Bohwe4-jxF1cxQmErCXl0l5ma08HpWmV2PqdAS-gf4w,432
+aws_annoying/ecs/common.py,sha256=TvP27SEvdIBnA92Oude-oDCy1SuaYNdtpokkbpZmdzo,139
+aws_annoying/ecs/deployment_waiter.py,sha256=e3xWShvr9piraoEMJdZun2GuffkyvTI76-riECfoe9A,9936
+aws_annoying/ecs/errors.py,sha256=n9j_h1MDUV6IVabKgwbCVAiPZQNJDJ5rVRHA82Je5QQ,429
+aws_annoying/session_manager/__init__.py,sha256=IENviL3ux2LF7o9xFGYEiqaGw03hxnyNX2btbB1xyEU,318
+aws_annoying/session_manager/errors.py,sha256=YioKlRtZ-GUP0F_ts_ebw7-HYkxe8mTes6HK821Kuiw,353
+aws_annoying/session_manager/session_manager.py,sha256=pUsyJ_w9UzdIfHA2Z8kU6UcZxOqypFXH1rl6pDytdqo,12046
+aws_annoying/session_manager/shortcuts.py,sha256=Yn4wCl43lfttrZ7GbzfGua2jZHe5Fe6ClEy4ikg-Q_s,2143
+aws_annoying/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aws_annoying/utils/debugger.py,sha256=UFllDCGI2gPtwo1XS5vqw0qyR6bYr7XknmBwSxalKIc,754
+aws_annoying/utils/downloader.py,sha256=aB5RzT-LpbFX24-2HXlAkdgVowc4TR9FWT_K8WwZ1BE,1923
+aws_annoying/utils/ec2.py,sha256=RjEA5eO53c-H6VE6cZBeB1RJo1rxpDQFhbZTYdANbs8,1062
+aws_annoying/utils/platform.py,sha256=TBIzCzYiFj36HmndZedegvFlxPSNtBQyAxzuwelvxNg,985
+aws_annoying/utils/timeout.py,sha256=PjfFtiLALh7lQvchtMYOfjTNrfuZwCaeaPKW16EpM5c,2483
+aws_annoying-0.6.0.dist-info/METADATA,sha256=68sKE-Atya0ibgT1ljJsaKHpnKXHDq-x7EdUy0yRIqI,3503
+aws_annoying-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+aws_annoying-0.6.0.dist-info/entry_points.txt,sha256=DcKE5V0WvVJ8wUOHxyUz1yLAJOuuJUgRPlMcQ4O7jEs,66
+aws_annoying-0.6.0.dist-info/licenses/LICENSE,sha256=Q5GkvYijQ2KTQ-QWhv43ilzCno4ZrzrEuATEQZd9rYo,1067
+aws_annoying-0.6.0.dist-info/RECORD,,

aws_annoying-0.5.0.dist-info/RECORD

@@ -1,31 +0,0 @@
-aws_annoying/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aws_annoying/mfa.py,sha256=m6-V1bWeUWsAmRddl-lv13mPCMnftoPzJoNnZ0kiaWQ,2007
-aws_annoying/variables.py,sha256=a9cMS9JU-XA2h1tztO7ofixoDEpqtS_eVEiWrQ75mTo,4761
-aws_annoying/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aws_annoying/cli/app.py,sha256=sp50uVoAl4D6Wk3DFpzKZzSsxmSxNYejFxm62b_Kxps,201
-aws_annoying/cli/ecs_task_definition_lifecycle.py,sha256=O36Bf5LBnVJNyYmdlUxhtsIHNoxky1t5YacAXiL9UEI,2803
-aws_annoying/cli/load_variables.py,sha256=eWNByUEc1ijF8uCe_egdAnjWxfMNCZeVr0vtTtQLe3Y,5086
-aws_annoying/cli/main.py,sha256=TSzPeMkgIgKFf3bom_vDkFYK0bHF1r5K9ADreZUV3k4,503
-aws_annoying/cli/mfa/__init__.py,sha256=rbEGhw5lOQZV_XAc3nSbo56JVhsSPpeOgEtiAy9qzEA,50
-aws_annoying/cli/mfa/_app.py,sha256=Ub7gxb6kGF3Ve1ucQSOjHmc4jAu8mxgegcXsIbOzLLQ,189
-aws_annoying/cli/mfa/configure.py,sha256=vsoHfTVFF2dPgiYsp2L-EkMwtAA0_-tVwFd6Wv6DscU,3746
-aws_annoying/cli/session_manager/__init__.py,sha256=FkT6jT6OXduOURN61d-U6hgd-XluQbvuVtKXXiXgSEk,105
-aws_annoying/cli/session_manager/_app.py,sha256=OVOHW0iyKzunvaqLhjoseHw1-WxJ1gGb7QmiyAEezyY,221
-aws_annoying/cli/session_manager/_common.py,sha256=u23F4mJOHWHphLYL1gOAh8J3a_Odyk4VVvI175KWmzg,1616
-aws_annoying/cli/session_manager/install.py,sha256=zcQi91xVFKhbSOD4VBc6YG9-fDnhymVyK63PlITdxug,1445
-aws_annoying/cli/session_manager/port_forward.py,sha256=J8_CIrTsbcOYRYOdHkdz81dkaNWxI_l70E8gyJ-Ukh8,4192
-aws_annoying/cli/session_manager/start.py,sha256=pPS0jKuURGTX-WTix3owqqisX-bmCydqfyqC0kFGnt8,1358
-aws_annoying/cli/session_manager/stop.py,sha256=ttU6nlbVgBkZDtY-DwUyCstv5TFtat5TljkyuY8QICU,1482
-aws_annoying/session_manager/__init__.py,sha256=IENviL3ux2LF7o9xFGYEiqaGw03hxnyNX2btbB1xyEU,318
-aws_annoying/session_manager/errors.py,sha256=YioKlRtZ-GUP0F_ts_ebw7-HYkxe8mTes6HK821Kuiw,353
-aws_annoying/session_manager/session_manager.py,sha256=myZxY_WE4akdlTsH1mOvf0Ublwg-hf1vEkEcmdZyYSU,12147
-aws_annoying/session_manager/shortcuts.py,sha256=uFRPGia_5gqfBDxwOjmLg7UFzhvkSFUqopWuzN5_kbA,1973
-aws_annoying/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aws_annoying/utils/debugger.py,sha256=UFllDCGI2gPtwo1XS5vqw0qyR6bYr7XknmBwSxalKIc,754
-aws_annoying/utils/downloader.py,sha256=aB5RzT-LpbFX24-2HXlAkdgVowc4TR9FWT_K8WwZ1BE,1923
-aws_annoying/utils/platform.py,sha256=h3DUWmTMM-_4TfTWNqY0uNqyVsBjAuMm2DEbG-daxe8,742
-aws_annoying-0.5.0.dist-info/METADATA,sha256=kHaGAHqfkZ8Ip4NzcLbE7Bh01oA1CvoTsUa3Ljx1ctU,1916
-aws_annoying-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-aws_annoying-0.5.0.dist-info/entry_points.txt,sha256=DcKE5V0WvVJ8wUOHxyUz1yLAJOuuJUgRPlMcQ4O7jEs,66
-aws_annoying-0.5.0.dist-info/licenses/LICENSE,sha256=Q5GkvYijQ2KTQ-QWhv43ilzCno4ZrzrEuATEQZd9rYo,1067
-aws_annoying-0.5.0.dist-info/RECORD,,