aws-annoying 0.5.0__tar.gz → 0.7.0__tar.gz

{aws_annoying-0.5.0 → aws_annoying-0.7.0}/.devcontainer/onCreateCommand.sh

@@ -1,3 +1 @@
 #!/usr/bin/env bash
-
-make install

{aws_annoying-0.5.0 → aws_annoying-0.7.0}/.devcontainer/postAttachCommand.sh

@@ -6,3 +6,5 @@ echo 'alias aa="uv run aws-annoying"' >> ~/.bashrc
 sudo chown --recursive "$(id --user):$(id --group)" ~
 sudo chmod --recursive 600 ~/.config/op ~/.aws
 sudo chmod --recursive u=rwX,g=,o= ~/.config/op ~/.aws
+
+make install

{aws_annoying-0.5.0 → aws_annoying-0.7.0}/.github/workflows/ci.yaml

@@ -20,7 +20,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           version: latest
           enable-cache: true
@@ -52,7 +52,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           version: latest
           enable-cache: true
@@ -66,24 +66,28 @@ jobs:
       - name: Run tests (Ubuntu)
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
+          which session-manager-plugin || true
           sudo apt-get remove --yes session-manager-plugin
           uv run pytest
 
       - name: Run tests (macOS)
         if: ${{ matrix.os == 'macos-latest' }}
         run: |
+          which session-manager-plugin || true
           brew uninstall session-manager-plugin
-          uv run pytest -m macos
+          uv run pytest -m 'not docker'
 
       - name: Run tests (Windows)
         if: ${{ matrix.os == 'windows-latest' }}
         run: |
-          Invoke-WebRequest `
-            -Uri "https://raw.githubusercontent.com/aws/session-manager-plugin/refs/heads/mainline/Tools/src/update/windows/uninstall.bat" `
-            -OutFile "uninstall.bat"
+          Get-Command session-manager-plugin | Out-String -Width 2000
 
-          Start-Process "cmd.exe" -ArgumentList "/c uninstall.bat" -Wait
-          uv run pytest -m windows
+          $uri = 'https://s3.amazonaws.com/session-manager-downloads/plugin/latest/windows/SessionManagerPluginSetup.exe'
+          $outFile = 'C:\Windows\Temp\SessionManagerPluginSetup.exe'
+          Invoke-WebRequest -Uri "$uri" -OutFile "$outFile"
+          & "$outFile" /uninstall /quiet
+
+          uv run pytest -m 'not docker'
 
       - name: Upload test results to Codecov
         uses: codecov/codecov-action@v5

{aws_annoying-0.5.0 → aws_annoying-0.7.0}/.github/workflows/release.yaml

@@ -17,7 +17,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           version: latest
           enable-cache: true

{aws_annoying-0.5.0 → aws_annoying-0.7.0}/.pre-commit-config.yaml

@@ -28,6 +28,8 @@ repos:
           - "**/conftest.py"
           - --extend-exclude
           - "**/_*/**/*.py"
+          - --extend-exclude
+          - "**/_*.py"
       - id: preferred-suffix
         args: [--rename]
 

{aws_annoying-0.5.0 → aws_annoying-0.7.0}/.vscode/launch.json

@@ -8,6 +8,14 @@
       "program": "${file}",
       "console": "integratedTerminal",
       "justMyCode": true
-    }
+    },
+    {
+      "name": "Python: Application CLI",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "aws_annoying.cli.main",
+      "console": "integratedTerminal",
+      "justMyCode": true
+    },
   ]
 }

{aws_annoying-0.5.0 → aws_annoying-0.7.0}/.vscode/settings.json

@@ -10,7 +10,9 @@
   "cSpell.words": [
     "Deregistering",
     "localstack",
+    "pytestmark",
     "sessionmanagerplugin",
+    "Stubber",
     "Tampermonkey"
   ],
   "editor.formatOnSave": true,

{aws_annoying-0.5.0 → aws_annoying-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws-annoying
-Version: 0.5.0
+Version: 0.7.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
@@ -16,19 +16,21 @@ Requires-Dist: tqdm<5,>=4
 Requires-Dist: typer<1,>=0
 Provides-Extra: dev
 Requires-Dist: boto3-stubs[ec2,ecs,secretsmanager,ssm,sts]>=1.37.1; extra == 'dev'
-Requires-Dist: mypy~=1.15.0; extra == 'dev'
+Requires-Dist: mypy<1.17,>=1.15; extra == 'dev'
 Requires-Dist: ruff<0.12.0,>=0.9.9; extra == 'dev'
 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.7.0/README.md

@@ -0,0 +1,51 @@
+# aws-annoying
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/lasuillard/aws-annoying/actions/workflows/ci.yaml/badge.svg)](https://github.com/lasuillard/aws-annoying/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/lasuillard/aws-annoying/graph/badge.svg?token=gbcHMVVz2k)](https://codecov.io/gh/lasuillard/aws-annoying)
+![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.7.0/aws_annoying/cli/app.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+import importlib.metadata
+import logging
+import logging.config
+from typing import Optional
+
+import typer
+from rich import print  # noqa: A004
+from rich.console import Console
+
+app = typer.Typer(
+    pretty_exceptions_short=True,
+    pretty_exceptions_show_locals=False,
+    rich_markup_mode="rich",
+    no_args_is_help=True,
+)
+
+
+def show_version(value: Optional[bool]) -> None:
+    """Show the version of the application."""
+    if not value:
+        return
+
+    print(importlib.metadata.version("aws-annoying"))
+    raise typer.Exit(0)
+
+
+@app.callback()
+def main(  # noqa: D103
+    ctx: typer.Context,
+    *,
+    version: Optional[bool] = typer.Option(  # noqa: ARG001
+        None,
+        "--version",
+        is_eager=True,
+        callback=show_version,
+        help="Show the version and exit.",
+    ),
+    quiet: bool = typer.Option(
+        False,  # noqa: FBT003
+        help="Disable outputs.",
+    ),
+    verbose: bool = typer.Option(
+        False,  # noqa: FBT003
+        help="Enable verbose outputs.",
+    ),
+    dry_run: bool = typer.Option(
+        False,  # noqa: FBT003
+        help="Enable dry-run mode. If enabled, certain commands will avoid making changes.",
+    ),
+) -> None:
+    log_level = logging.DEBUG if verbose else logging.INFO
+    console = Console(soft_wrap=True, emoji=False)
+    logging_config: logging.config._DictConfigArgs = {
+        "version": 1,
+        "disable_existing_loggers": False,
+        "formatters": {
+            "rich": {
+                "format": "%(message)s",
+                "datefmt": "[%X]",
+            },
+        },
+        "handlers": {
+            "null": {
+                "class": "logging.NullHandler",
+            },
+            "rich": {
+                "class": "aws_annoying.cli.logging_handler.RichLogHandler",
+                "formatter": "rich",
+                "console": console,
+            },
+        },
+        "root": {
+            "handlers": ["null"],
+        },
+        "loggers": {
+            "aws_annoying": {
+                "level": log_level,
+                "handlers": ["rich"],
+                "propagate": True,
+            },
+        },
+    }
+    if quiet:
+        logging_config["loggers"]["aws_annoying"]["level"] = logging.CRITICAL
+
+    logging.config.dictConfig(logging_config)
+
+    # Global flags
+    ctx.meta["dry_run"] = dry_run

aws_annoying-0.7.0/aws_annoying/cli/ecs/__init__.py

@@ -0,0 +1,3 @@
+from . import task_definition_lifecycle, wait_for_deployment
+
+__all__ = ("task_definition_lifecycle", "wait_for_deployment")

aws_annoying-0.7.0/aws_annoying/cli/ecs/_app.py

@@ -0,0 +1,9 @@
+import typer
+
+from aws_annoying.cli.app import app
+
+ecs_app = typer.Typer(
+    no_args_is_help=True,
+    help="ECS (Elastic Container Service) utility commands.",
+)
+app.add_typer(ecs_app, name="ecs")

aws_annoying-0.5.0/aws_annoying/cli/ecs_task_definition_lifecycle.py → aws_annoying-0.7.0/aws_annoying/cli/ecs/task_definition_lifecycle.py

@@ -1,21 +1,25 @@
 from __future__ import annotations
 
+import logging
 from typing import TYPE_CHECKING
 
 import boto3
 import typer
-from rich import print  # noqa: A004
 
-from .app import app
+from ._app import ecs_app
 
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
+
+logger = logging.getLogger(__name__)
+
 _DELETE_CHUNK_SIZE = 10
 
 
-@app.command()
-def ecs_task_definition_lifecycle(
+@ecs_app.command()
+def task_definition_lifecycle(
+    ctx: typer.Context,
     *,
     family: str = typer.Option(
         ...,
@@ -33,14 +37,11 @@ def ecs_task_definition_lifecycle(
         False,  # noqa: FBT003
         help="Delete the task definition after deregistering it.",
     ),
-    dry_run: bool = typer.Option(
-        False,  # noqa: FBT003
-        help="Do not perform any changes, only show what would be done.",
-    ),
 ) -> None:
     """Execute ECS task definition lifecycle."""
+    dry_run = ctx.meta["dry_run"]
     if dry_run:
-        print("⚠️ Dry run mode enabled. Will not perform any actual changes.")
+        logger.info("Dry run mode enabled. Will not perform any actual changes.")
 
     ecs = boto3.client("ecs")
 
@@ -59,23 +60,27 @@ def ecs_task_definition_lifecycle(
 
     # Keep the latest N task definitions
     expired_taskdef_arns = task_definition_arns[:-keep_latest]
-    print(f"⚠️ Deregistering {len(expired_taskdef_arns)} task definitions...")
+    logger.warning("Deregistering %d task definitions...", len(expired_taskdef_arns))
     for arn in expired_taskdef_arns:
         if not dry_run:
             ecs.deregister_task_definition(taskDefinition=arn)
 
         # ARN like: "arn:aws:ecs:<region>:<account-id>:task-definition/<family>:<revision>"
         _, family_revision = arn.split(":task-definition/")
-        print(f"✅ Deregistered task definition [yellow]{family_revision!r}[/yellow]")
+        logger.warning("Deregistered task definition [yellow]%r[/yellow]", family_revision)
 
     if delete and expired_taskdef_arns:
         # Delete the expired task definitions in chunks due to API limitation
-        print(f"⚠️ Deleting {len(expired_taskdef_arns)} task definitions in chunks of size {_DELETE_CHUNK_SIZE}...")
+        logger.warning(
+            "Deleting %d task definitions in chunks of size %d...",
+            len(expired_taskdef_arns),
+            _DELETE_CHUNK_SIZE,
+        )
         for idx, chunk in enumerate(_chunker(expired_taskdef_arns, _DELETE_CHUNK_SIZE)):
             if not dry_run:
                 ecs.delete_task_definitions(taskDefinitions=chunk)
 
-            print(f"✅ Deleted {len(chunk)} task definitions in {idx}-th batch.")
+            logger.warning("Deleted %d task definitions in %d-th batch.", len(chunk), idx)
 
 
 def _chunker(sequence: list, size: int) -> Iterator[list]:

aws_annoying-0.7.0/aws_annoying/cli/ecs/wait_for_deployment.py

@@ -0,0 +1,158 @@
+from __future__ import annotations
+
+import logging
+from datetime import datetime, timezone
+from typing import Optional
+
+import typer
+
+from aws_annoying.ecs import (
+    DeploymentFailedError,
+    ECSServiceRef,
+    ServiceTaskDefinitionAssertionError,
+    check_service_task_definition,
+    wait_for_deployment_complete,
+    wait_for_deployment_start,
+    wait_for_service_stability,
+)
+from aws_annoying.utils.timeout import OperationTimeoutError, Timeout
+
+from ._app import ecs_app
+
+logger = logging.getLogger(__name__)
+
+
+@ecs_app.command()
+def wait_for_deployment(  # noqa: PLR0913
+    *,
+    cluster: str = typer.Option(
+        ...,
+        help="The name of the ECS cluster.",
+        show_default=False,
+    ),
+    service: str = typer.Option(
+        ...,
+        help="The name of the ECS service.",
+        show_default=False,
+    ),
+    expected_task_definition: Optional[str] = typer.Option(
+        None,
+        help=(
+            "The service's task definition expected after deployment."
+            " If provided, it will be used to assert the service's task definition after deployment finished or timed out."  # noqa: E501
+        ),
+        show_default=False,
+    ),
+    polling_interval: int = typer.Option(
+        5,
+        help="The interval between any polling attempts, in seconds.",
+        min=1,
+    ),
+    timeout_seconds: Optional[int] = typer.Option(
+        None,
+        help=(
+            "The maximum time to wait for the deployment to complete, in seconds."
+            " If not provided, it will wait indefinitely."
+        ),
+        min=1,
+    ),
+    wait_for_start: bool = typer.Option(
+        True,  # noqa: FBT003
+        help=(
+            "Whether to wait for the deployment to start."
+            " Because there could be no deployment right after the deploy,"
+            " this option will wait for a new deployment to start if no running deployment is found."
+        ),
+    ),
+    wait_for_stability: bool = typer.Option(
+        False,  # noqa: FBT003
+        help="Whether to wait for the service to be stable after the deployment.",
+    ),
+) -> None:
+    """Wait for ECS deployment to complete."""
+    start = datetime.now(tz=timezone.utc)
+    try:
+        with Timeout(timeout_seconds):
+            _wait_for_deployment(
+                ECSServiceRef(cluster=cluster, service=service),
+                wait_for_start=wait_for_start,
+                polling_interval=polling_interval,
+                wait_for_stability=wait_for_stability,
+                expected_task_definition=expected_task_definition,
+            )
+    except OperationTimeoutError:
+        logger.error(  # noqa: TRY400
+            "Timeout reached after %s seconds. The deployment may not have finished.",
+            timeout_seconds,
+        )
+        raise typer.Exit(1) from None
+    except DeploymentFailedError as err:
+        elapsed = datetime.now(tz=timezone.utc) - start
+        logger.error(  # noqa: TRY400
+            "Deployment failed in [bold]%.2f[/bold] seconds with error: %s",
+            elapsed.total_seconds(),
+            err,
+        )
+        raise typer.Exit(1) from None
+    else:
+        elapsed = datetime.now(tz=timezone.utc) - start
+        logger.info(
+            "Deployment completed in [bold]%.2f[/bold] seconds.",
+            elapsed.total_seconds(),
+        )
+
+
+def _wait_for_deployment(
+    service_ref: ECSServiceRef,
+    *,
+    wait_for_start: bool,
+    polling_interval: int = 5,
+    wait_for_stability: bool,
+    expected_task_definition: str | None = None,
+) -> None:
+    # Find current deployment for the service
+    logger.info(
+        "Looking up running deployment for service %s",
+        service_ref.service,
+    )
+    latest_deployment_arn = wait_for_deployment_start(
+        service_ref,
+        wait_for_start=wait_for_start,
+        polling_interval=polling_interval,
+    )
+
+    # Polling for the deployment to finish (successfully or unsuccessfully)
+    logger.info(
+        "Start waiting for deployment %s to finish.",
+        latest_deployment_arn,
+    )
+    ok, status = wait_for_deployment_complete(latest_deployment_arn, polling_interval=polling_interval)
+    if ok:
+        logger.info(
+            "Deployment succeeded with status %s",
+            status,
+        )
+    else:
+        msg = f"Deployment failed with status: {status}"
+        raise DeploymentFailedError(msg)
+
+    # Wait for the service to be stable
+    if wait_for_stability:
+        logger.info(
+            "Start waiting for service %s to be stable.",
+            service_ref.service,
+        )
+        wait_for_service_stability(service_ref, polling_interval=polling_interval)
+
+    # Check if the service task definition matches the expected one
+    if expected_task_definition:
+        logger.info(
+            "Checking if the service task definition is the expected one: %s",
+            expected_task_definition,
+        )
+        ok, actual = check_service_task_definition(service_ref, expect=expected_task_definition)
+        if not ok:
+            msg = f"The service task definition is not the expected one; got: {actual!r}"
+            raise ServiceTaskDefinitionAssertionError(msg)
+
+        logger.info("The service task definition matches the expected one.")