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

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

@@ -44,16 +44,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
-        # TODO(lasuillard): Simplified matrix for macOS and Windows for testing
-        include:
-          - os: macos-latest
-            python-version: "3.9"
-          - os: windows-latest
-            python-version: "3.9"
-
     steps:
       - name: Checkout
         uses: actions/checkout@v4

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

@@ -19,8 +19,6 @@ repos:
           - --extend-exclude
           - utils/debugger.py
           - --extend-exclude
-          - main.py
-          - --extend-exclude
           - "**/_*.py"
       - id: test-matching-source
         args:
@@ -29,7 +27,7 @@ repos:
           - --extend-exclude
           - "**/conftest.py"
           - --extend-exclude
-          - _*/**/*.py
+          - "**/_*/**/*.py"
       - id: preferred-suffix
         args: [--rename]
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws-annoying
-Version: 0.3.0
+Version: 0.5.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
@@ -9,11 +9,11 @@ Author-email: Yuchan Lee <lasuillard@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
 Requires-Python: <4.0,>=3.9
-Requires-Dist: boto3>=1.37.1
-Requires-Dist: pydantic>=2.10.6
-Requires-Dist: requests>=2.32.3
-Requires-Dist: tqdm>=4.67.1
-Requires-Dist: typer>=0.15.1
+Requires-Dist: boto3<2,>=1
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: requests<3,>=2
+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'

aws_annoying-0.5.0/aws_annoying/cli/load_variables.py

@@ -0,0 +1,139 @@
+# flake8: noqa: B008
+from __future__ import annotations
+
+import os
+import subprocess
+from typing import NoReturn, Optional
+
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from aws_annoying.variables import VariableLoader
+
+from .app import app
+
+
+@app.command(
+    context_settings={
+        # Allow extra arguments for user provided command
+        "allow_extra_args": True,
+        "ignore_unknown_options": True,
+    },
+)
+def load_variables(  # noqa: PLR0913
+    *,
+    ctx: typer.Context,
+    arns: list[str] = typer.Option(
+        [],
+        metavar="ARN",
+        help=(
+            "ARNs of the secret or parameter to load."
+            " The variables are loaded in the order of the ARNs,"
+            " overwriting the variables with the same name in the order of the ARNs."
+        ),
+    ),
+    env_prefix: Optional[str] = typer.Option(
+        None,
+        help="Prefix of the environment variables to load the ARNs from.",
+        show_default=False,
+    ),
+    overwrite_env: bool = typer.Option(
+        False,  # noqa: FBT003
+        help="Overwrite the existing environment variables with the same name.",
+    ),
+    quiet: bool = typer.Option(
+        False,  # noqa: FBT003
+        help="Suppress all outputs from this command.",
+    ),
+    dry_run: bool = typer.Option(
+        False,  # noqa: FBT003
+        help="Print the progress only. Neither load variables nor run the command.",
+    ),
+    replace: bool = typer.Option(
+        True,  # noqa: FBT003
+        help=(
+            "Replace the current process (`os.execvpe`) with the command."
+            " If disabled, run the command as a `subprocess`."
+        ),
+    ),
+) -> NoReturn:
+    """Wrapper command to run command with variables from AWS resources injected as environment variables.
+
+    This script is intended to be used in the ECS environment, where currently AWS does not support
+    injecting whole JSON dictionary of secrets or parameters as environment variables directly.
+
+    It first loads the variables from the AWS sources then runs the command with the variables injected as environment variables.
+
+    In addition to `--arns` option, you can provide ARNs as the environment variables by providing `--env-prefix`.
+    For example, if you have the following environment variables:
+
+    ```shell
+    export LOAD_AWS_CONFIG__001_app_config=arn:aws:secretsmanager:...
+    export LOAD_AWS_CONFIG__002_db_config=arn:aws:ssm:...
+    ```
+
+    You can run the following command:
+
+    ```shell
+    aws-annoying load-variables --env-prefix LOAD_AWS_CONFIG__ -- ...
+    ```
+
+    The variables are loaded in the order of option provided, overwriting the variables with the same name in the order of the ARNs.
+    Existing environment variables are preserved by default, unless `--overwrite-env` is provided.
+    """  # noqa: E501
+    console = Console(quiet=quiet, emoji=False)
+
+    command = ctx.args
+    if not command:
+        console.print("⚠️ No command provided. Exiting...")
+        raise typer.Exit(0)
+
+    # Mapping of the ARNs by index (index used for ordering)
+    map_arns_by_index = {str(idx): arn for idx, arn in enumerate(arns)}
+    if env_prefix:
+        console.print(f"🔍 Loading ARNs from environment variables with prefix: {env_prefix!r}")
+        arns_env = {
+            key.removeprefix(env_prefix): value for key, value in os.environ.items() if key.startswith(env_prefix)
+        }
+        console.print(f"🔍 Found {len(arns_env)} sources from environment variables.")
+        map_arns_by_index = arns_env | map_arns_by_index
+
+    # Briefly show the ARNs
+    table = Table("Index", "ARN")
+    for idx, arn in sorted(map_arns_by_index.items()):
+        table.add_row(idx, arn)
+
+    console.print(table)
+
+    # Retrieve the variables
+    loader = VariableLoader(dry_run=dry_run)
+    console.print("🔍 Retrieving variables from AWS resources...")
+    if dry_run:
+        console.print("⚠️ Dry run mode enabled. Variables won't be loaded from AWS.")
+
+    try:
+        variables, load_stats = loader.load(map_arns_by_index)
+    except Exception as exc:  # noqa: BLE001
+        console.print(f"❌ Failed to load the variables: {exc!s}")
+        raise typer.Exit(1) from None
+
+    console.print(f"✅ Retrieved {load_stats['secrets']} secrets and {load_stats['parameters']} parameters.")
+
+    # Prepare the environment variables
+    env = os.environ.copy()
+    if overwrite_env:
+        env.update(variables)
+    else:
+        # Update variables, preserving the existing ones
+        for key, value in variables.items():
+            env.setdefault(key, str(value))
+
+    # Run the command with the variables injected as environment variables, replacing current process
+    console.print(f"🚀 Running the command: [bold orchid]{' '.join(command)}[/bold orchid]")
+    if replace:  # pragma: no cover (not coverable)
+        os.execvpe(command[0], command, env=env)  # noqa: S606
+        # The above line should never return
+
+    result = subprocess.run(command, env=env, check=False)  # noqa: S603
+    raise typer.Exit(result.returncode)

{aws_annoying-0.3.0/aws_annoying → aws_annoying-0.5.0/aws_annoying/cli}/main.py

@@ -1,10 +1,10 @@
 # flake8: noqa: F401
 from __future__ import annotations
 
-import aws_annoying.ecs_task_definition_lifecycle
-import aws_annoying.load_variables
-import aws_annoying.mfa
-import aws_annoying.session_manager
+import aws_annoying.cli.ecs_task_definition_lifecycle
+import aws_annoying.cli.load_variables
+import aws_annoying.cli.mfa
+import aws_annoying.cli.session_manager
 from aws_annoying.utils.debugger import input_as_args
 
 # App with all commands registered

{aws_annoying-0.3.0/aws_annoying → aws_annoying-0.5.0/aws_annoying/cli}/mfa/_app.py

@@ -1,6 +1,6 @@
 import typer
 
-from aws_annoying.app import app
+from aws_annoying.cli.app import app
 
 mfa_app = typer.Typer(
     no_args_is_help=True,

{aws_annoying-0.3.0/aws_annoying → aws_annoying-0.5.0/aws_annoying/cli}/mfa/configure.py

@@ -1,15 +1,15 @@
 from __future__ import annotations
 
-import configparser
 from pathlib import Path  # noqa: TC003
 from typing import Optional
 
 import boto3
 import typer
-from pydantic import BaseModel, ConfigDict
 from rich import print  # noqa: A004
 from rich.prompt import Prompt
 
+from aws_annoying.mfa import MfaConfig, update_credentials
+
 from ._app import mfa_app
 
 _CONFIG_INI_SECTION = "aws-annoying:mfa"
@@ -55,7 +55,7 @@ def configure(  # noqa: PLR0913
     aws_config = aws_config.expanduser()
 
     # Load configuration
-    mfa_config, exists = _MfaConfig.from_ini_file(aws_config, _CONFIG_INI_SECTION)
+    mfa_config, exists = MfaConfig.from_ini_file(aws_config, _CONFIG_INI_SECTION)
     if exists:
         print(f"⚙️ Loaded MFA configuration from AWS config ({aws_config}).")
 
@@ -94,7 +94,7 @@ def configure(  # noqa: PLR0913
 
     # Update MFA profile in AWS credentials
     print(f"✅ Updating MFA profile ([bold]{mfa_profile}[/bold]) to AWS credentials ({aws_credentials})")
-    _update_credentials(
+    update_credentials(
         aws_credentials,
         mfa_profile,  # type: ignore[arg-type]
         access_key=credentials["AccessKeyId"],
@@ -114,44 +114,3 @@ def configure(  # noqa: PLR0913
         mfa_config.save_ini_file(aws_config, _CONFIG_INI_SECTION)
     else:
         print("⚠️ MFA configuration not persisted.")
-
-
-class _MfaConfig(BaseModel):
-    model_config = ConfigDict(extra="ignore")
-
-    mfa_profile: Optional[str] = None
-    mfa_source_profile: Optional[str] = None
-    mfa_serial_number: Optional[str] = None
-
-    def save_ini_file(self, path: Path, section_key: str) -> None:
-        """Save configuration to an AWS config file."""
-        config_ini = configparser.ConfigParser()
-        config_ini.read(path)
-        config_ini.setdefault(section_key, {})
-        for k, v in self.model_dump(exclude_none=True).items():
-            config_ini[section_key][k] = v
-
-        with path.open("w") as f:
-            config_ini.write(f)
-
-    @classmethod
-    def from_ini_file(cls, path: Path, section_key: str) -> tuple[_MfaConfig, bool]:
-        """Load configuration from an AWS config file, with boolean indicating if the config already exists."""
-        config_ini = configparser.ConfigParser()
-        config_ini.read(path)
-        if config_ini.has_section(section_key):
-            section = dict(config_ini.items(section_key))
-            return cls.model_validate(section), True
-
-        return cls(), False
-
-
-def _update_credentials(path: Path, profile: str, *, access_key: str, secret_key: str, session_token: str) -> None:
-    credentials_ini = configparser.ConfigParser()
-    credentials_ini.read(path)
-    credentials_ini.setdefault(profile, {})
-    credentials_ini[profile]["aws_access_key_id"] = access_key
-    credentials_ini[profile]["aws_secret_access_key"] = secret_key
-    credentials_ini[profile]["aws_session_token"] = session_token
-    with path.open("w") as f:
-        credentials_ini.write(f)

{aws_annoying-0.3.0/aws_annoying → aws_annoying-0.5.0/aws_annoying/cli}/session_manager/_app.py

@@ -1,6 +1,6 @@
 import typer
 
-from aws_annoying.app import app
+from aws_annoying.cli.app import app
 
 session_manager_app = typer.Typer(
     no_args_is_help=True,

aws_annoying-0.5.0/aws_annoying/cli/session_manager/_common.py

@@ -0,0 +1,54 @@
+# TODO(lasuillard): Using this file until split CLI from library codebase
+from __future__ import annotations
+
+import re
+from typing import Any
+
+import boto3
+import typer
+from rich.prompt import Confirm
+
+from aws_annoying.session_manager import SessionManager as _SessionManager
+
+
+# Custom session manager with console interactivity
+class SessionManager(_SessionManager):
+    def before_install(self, command: list[str]) -> None:
+        if self._confirm:
+            return
+
+        confirm = Confirm.ask(f"⚠️ Will run the following command: [bold red]{' '.join(command)}[/bold red]. Proceed?")
+        if not confirm:
+            raise typer.Abort
+
+    def install(self, *args: Any, confirm: bool = False, **kwargs: Any) -> None:
+        self._confirm = confirm
+        return super().install(*args, **kwargs)
+
+
+def get_instance_id_by_name(name_or_id: str) -> str | None:
+    """Get the EC2 instance ID by name or ID.
+
+    Be aware that this function will only return the first instance found
+    with the given name, no matter how many instances are found.
+
+    Args:
+        name_or_id: The name or ID of the EC2 instance.
+
+    Returns:
+        The instance ID if found, otherwise `None`.
+    """
+    if re.match(r"m?i-.+", name_or_id):
+        return name_or_id
+
+    ec2 = boto3.client("ec2")
+    response = ec2.describe_instances(Filters=[{"Name": "tag:Name", "Values": [name_or_id]}])
+    reservations = response["Reservations"]
+    if not reservations:
+        return None
+
+    instances = reservations[0]["Instances"]
+    if not instances:
+        return None
+
+    return str(instances[0]["InstanceId"])

{aws_annoying-0.3.0/aws_annoying → aws_annoying-0.5.0/aws_annoying/cli}/session_manager/install.py

@@ -18,7 +18,7 @@ def install(
     ),
 ) -> None:
     """Install AWS Session Manager plugin."""
-    session_manager = SessionManager(downloader=TQDMDownloader())
+    session_manager = SessionManager()
 
     # Check session-manager-plugin already installed
     is_installed, binary_path, version = session_manager.verify_installation()
@@ -28,7 +28,7 @@ def install(
 
     # Install session-manager-plugin
     print("⬇️ Installing AWS Session Manager plugin. You could be prompted for admin privileges request.")
-    session_manager.install(confirm=yes)
+    session_manager.install(confirm=yes, downloader=TQDMDownloader())
 
     # Verify installation
     is_installed, binary_path, version = session_manager.verify_installation()

{aws_annoying-0.3.0/aws_annoying → aws_annoying-0.5.0/aws_annoying/cli}/session_manager/port_forward.py

@@ -1,18 +1,15 @@
 from __future__ import annotations
 
 import os
-import re
 import signal
+import subprocess
 from pathlib import Path  # noqa: TC003
 
-import boto3
 import typer
 from rich import print  # noqa: A004
 
-from aws_annoying.utils.downloader import TQDMDownloader
-
 from ._app import session_manager_app
-from ._common import SessionManager
+from ._common import SessionManager, get_instance_id_by_name
 
 
 # https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html
@@ -57,7 +54,7 @@ def port_forward(  # noqa: PLR0913
     ),
 ) -> None:
     """Start a port forwarding session using AWS Session Manager."""
-    session_manager = SessionManager(downloader=TQDMDownloader())
+    session_manager = SessionManager()
 
     # Check if the PID file already exists
     if pid_file.exists():
@@ -80,21 +77,16 @@ def port_forward(  # noqa: PLR0913
             print(f"⚠️ Tried to terminate process with PID {existing_pid} but does not exist.")
 
     # Resolve the instance name or ID
-    if re.match(r"m?i-.+", through):
-        target = through
-    else:
-        # If the instance name is provided, get the instance ID
-        instance_id = _get_instance_id_by_name(through)
-        if instance_id:
-            print(f"❗ Instance ID resolved: [bold]{instance_id}[/bold]")
-        else:
-            print(f"🚫 Instance with name '{through}' not found.")
-            raise typer.Exit(1)
-
+    instance_id = get_instance_id_by_name(through)
+    if instance_id:
+        print(f"❗ Instance ID resolved: [bold]{instance_id}[/bold]")
         target = instance_id
+    else:
+        print(f"🚫 Instance with name '{through}' not found.")
+        raise typer.Exit(1)
 
     # Initiate the session
-    proc = session_manager.start(
+    command = session_manager.build_command(
         target=target,
         document_name="AWS-StartPortForwardingSessionToRemoteHost",
         parameters={
@@ -104,23 +96,24 @@ def port_forward(  # noqa: PLR0913
         },
         reason=reason,
     )
+    stdout: subprocess._FILE
+    if log_file is not None:  # noqa: SIM108
+        stdout = log_file.open(mode="at+", buffering=1)
+    else:
+        stdout = subprocess.DEVNULL
+
+    print(
+        f"🚀 Starting port forwarding session through [bold]{through}[/bold] with reason: [italic]{reason!r}[/italic].",
+    )
+    proc = subprocess.Popen(  # noqa: S603
+        command,
+        stdout=stdout,
+        stderr=subprocess.STDOUT,
+        text=True,
+        close_fds=False,  # FD inherited from parent process
+    )
     print(f"✅ Session Manager Plugin started with PID {proc.pid}. Outputs will be logged to {log_file.absolute()}.")
 
     # Write the PID to the file
     pid_file.write_text(str(proc.pid))
     print(f"💾 PID file written to {pid_file.absolute()}.")
-
-
-def _get_instance_id_by_name(name: str) -> str | None:
-    """Get the EC2 instance ID by name."""
-    ec2 = boto3.client("ec2")
-    response = ec2.describe_instances(Filters=[{"Name": "tag:Name", "Values": [name]}])
-    reservations = response["Reservations"]
-    if not reservations:
-        return None
-
-    instances = reservations[0]["Instances"]
-    if not instances:
-        return None
-
-    return str(instances[0]["InstanceId"])

aws_annoying-0.5.0/aws_annoying/cli/session_manager/start.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+import os
+
+import typer
+from rich import print  # noqa: A004
+
+from ._app import session_manager_app
+from ._common import SessionManager, get_instance_id_by_name
+
+# TODO(lasuillard): ECS support (#24)
+# TODO(lasuillard): Interactive instance selection
+
+
+@session_manager_app.command()
+def start(
+    target: str = typer.Option(
+        ...,
+        show_default=False,
+        help="The name or ID of the EC2 instance to connect to.",
+    ),
+    reason: str = typer.Option(
+        "",
+        help="The reason for starting the session.",
+    ),
+) -> None:
+    """Start new session."""
+    session_manager = SessionManager()
+
+    # Resolve the instance name or ID
+    instance_id = get_instance_id_by_name(target)
+    if instance_id:
+        print(f"❗ Instance ID resolved: [bold]{instance_id}[/bold]")
+        target = instance_id
+    else:
+        print(f"🚫 Instance with name '{target}' not found.")
+        raise typer.Exit(1)
+
+    # Start the session, replacing the current process
+    print(f"🚀 Starting session to target [bold]{target}[/bold] with reason: [italic]{reason!r}[/italic].")
+    command = session_manager.build_command(
+        target=target,
+        document_name="SSM-SessionManagerRunShell",
+        parameters={},
+        reason=reason,
+    )
+    os.execvp(command[0], command)  # noqa: S606

aws_annoying-0.5.0/aws_annoying/mfa.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import configparser
+from pathlib import Path  # noqa: TC003
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict
+
+# TODO(lasuillard): Need some refactoring (configurator class)
+# TODO(lasuillard): Put some logging
+
+
+class MfaConfig(BaseModel):
+    """MFA configuration for AWS profiles."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    mfa_profile: Optional[str] = None
+    mfa_source_profile: Optional[str] = None
+    mfa_serial_number: Optional[str] = None
+
+    def save_ini_file(self, path: Path, section_key: str) -> None:
+        """Save configuration to an AWS config file."""
+        config_ini = configparser.ConfigParser()
+        config_ini.read(path)
+        config_ini.setdefault(section_key, {})
+        for k, v in self.model_dump(exclude_none=True).items():
+            config_ini[section_key][k] = v
+
+        with path.open("w") as f:
+            config_ini.write(f)
+
+    @classmethod
+    def from_ini_file(cls, path: Path, section_key: str) -> tuple[MfaConfig, bool]:
+        """Load configuration from an AWS config file, with boolean indicating if the config already exists."""
+        config_ini = configparser.ConfigParser()
+        config_ini.read(path)
+        if config_ini.has_section(section_key):
+            section = dict(config_ini.items(section_key))
+            return cls.model_validate(section), True
+
+        return cls(), False
+
+
+def update_credentials(path: Path, profile: str, *, access_key: str, secret_key: str, session_token: str) -> None:
+    """Update AWS credentials file with the provided profile and credentials."""
+    credentials_ini = configparser.ConfigParser()
+    credentials_ini.read(path)
+    credentials_ini.setdefault(profile, {})
+    credentials_ini[profile]["aws_access_key_id"] = access_key
+    credentials_ini[profile]["aws_secret_access_key"] = secret_key
+    credentials_ini[profile]["aws_session_token"] = session_token
+    with path.open("w") as f:
+        credentials_ini.write(f)

aws_annoying-0.5.0/aws_annoying/session_manager/__init__.py

@@ -0,0 +1,11 @@
+from .errors import PluginNotInstalledError, SessionManagerError, UnsupportedPlatformError
+from .session_manager import SessionManager
+from .shortcuts import port_forward
+
+__all__ = (
+    "PluginNotInstalledError",
+    "SessionManager",
+    "SessionManagerError",
+    "UnsupportedPlatformError",
+    "port_forward",
+)