aws-annoying 0.7.0__py3-none-any.whl → 0.8.0__py3-none-any.whl

aws_annoying/cli/app.py

@@ -8,6 +8,10 @@ from typing import Optional
 import typer
 from rich import print  # noqa: A004
 from rich.console import Console
+from rich.highlighter import ReprHighlighter
+from rich.theme import Theme
+
+logger = logging.getLogger(__name__)
 
 app = typer.Typer(
     pretty_exceptions_short=True,
@@ -51,7 +55,7 @@ def main(  # noqa: D103
     ),
 ) -> None:
     log_level = logging.DEBUG if verbose else logging.INFO
-    console = Console(soft_wrap=True, emoji=False)
+    console = _get_console()
     logging_config: logging.config._DictConfigArgs = {
         "version": 1,
         "disable_existing_loggers": False,
@@ -89,3 +93,28 @@ def main(  # noqa: D103
 
     # Global flags
     ctx.meta["dry_run"] = dry_run
+    if dry_run:
+        logger.warning("Dry run mode enabled. Some operation may behave differently to avoid making changes.")
+
+
+def _get_console() -> Console:
+    theme = Theme(
+        {
+            "repr.arn": "bold orange3",
+            "repr.constant": "bold blue",
+        },
+    )
+    return Console(soft_wrap=True, emoji=False, highlighter=CustomHighlighter(), theme=theme)
+
+
+class CustomHighlighter(ReprHighlighter):
+    """Custom highlighter to handle additional patterns."""
+
+    highlights = [  # noqa: RUF012
+        *ReprHighlighter.highlights,
+        # AWS Resource Name; https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
+        # NOTE: Quite simplified regex, may not cover all cases.
+        r"(?P<arn>\barn:[0-9a-zA-Z/+=,\.@_\-:]+\b)",
+        # Constants
+        r"(?P<constant>\b[A-Z_]+\b)",
+    ]

aws_annoying/cli/ecs/task_definition_lifecycle.py

@@ -40,9 +40,6 @@ def task_definition_lifecycle(
 ) -> None:
     """Execute ECS task definition lifecycle."""
     dry_run = ctx.meta["dry_run"]
-    if dry_run:
-        logger.info("Dry run mode enabled. Will not perform any actual changes.")
-
     ecs = boto3.client("ecs")
 
     # Get all task definitions for the family

aws_annoying/cli/logging_handler.py

@@ -15,10 +15,10 @@ class RichLogHandler(logging.Handler):
 
     _level_emojis: Final[dict[str, str]] = {
         "DEBUG": "🔍",
-        "INFO": "ℹ️",  # noqa: RUF001
+        "INFO": "🔔",
         "WARNING": "⚠️",
-        "ERROR": "❗",
-        "CRITICAL": "🚨",
+        "ERROR": "🚨",
+        "CRITICAL": "🔥",
     }
 
     def __init__(self, console: Console, *args: Any, **kwargs: Any) -> None:

aws_annoying/cli/mfa/configure.py

@@ -17,6 +17,7 @@ logger = logging.getLogger(__name__)
 
 @mfa_app.command()
 def configure(  # noqa: PLR0913
+    ctx: typer.Context,
     *,
     mfa_profile: Optional[str] = typer.Option(
         None,
@@ -54,6 +55,8 @@ def configure(  # noqa: PLR0913
     ),
 ) -> None:
     """Configure AWS profile for MFA."""
+    dry_run = ctx.meta["dry_run"]
+
     # Expand user home directory
     aws_credentials = aws_credentials.expanduser()
     aws_config = aws_config.expanduser()
@@ -102,13 +105,14 @@ def configure(  # noqa: PLR0913
         mfa_profile,
         aws_credentials,
     )
-    update_credentials(
-        aws_credentials,
-        mfa_profile,  # type: ignore[arg-type]
-        access_key=credentials["AccessKeyId"],
-        secret_key=credentials["SecretAccessKey"],
-        session_token=credentials["SessionToken"],
-    )
+    if not dry_run:
+        update_credentials(
+            aws_credentials,
+            mfa_profile,  # type: ignore[arg-type]
+            access_key=credentials["AccessKeyId"],
+            secret_key=credentials["SecretAccessKey"],
+            session_token=credentials["SessionToken"],
+        )
 
     # Persist MFA configuration
     if persist:
@@ -120,6 +124,7 @@ def configure(  # noqa: PLR0913
         mfa_config.mfa_profile = mfa_profile
         mfa_config.mfa_source_profile = mfa_source_profile
         mfa_config.mfa_serial_number = mfa_serial_number
-        mfa_config.save_ini_file(aws_config, aws_config_section)
+        if not dry_run:
+            mfa_config.save_ini_file(aws_config, aws_config_section)
     else:
         logger.warning("MFA configuration not persisted.")

aws_annoying/cli/session_manager/install.py

@@ -15,12 +15,15 @@ logger = logging.getLogger(__name__)
 # https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html
 @session_manager_app.command()
 def install(
-    yes: bool = typer.Option(  # noqa: FBT001
+    ctx: typer.Context,
+    *,
+    yes: bool = typer.Option(
         False,  # noqa: FBT003
         help="Do not ask confirmation for installation.",
     ),
 ) -> None:
     """Install AWS Session Manager plugin."""
+    dry_run = ctx.meta["dry_run"]
     session_manager = SessionManager()
 
     # Check session-manager-plugin already installed
@@ -31,7 +34,8 @@ def install(
 
     # Install session-manager-plugin
     logger.warning("Installing AWS Session Manager plugin. You could be prompted for admin privileges request.")
-    session_manager.install(confirm=yes, downloader=TQDMDownloader())
+    if not dry_run:
+        session_manager.install(confirm=yes, downloader=TQDMDownloader())
 
     # Verify installation
     is_installed, binary_path, version = session_manager.verify_installation()

aws_annoying/cli/session_manager/port_forward.py

@@ -19,6 +19,8 @@ logger = logging.getLogger(__name__)
 # https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html
 @session_manager_app.command()
 def port_forward(  # noqa: PLR0913
+    ctx: typer.Context,
+    *,
     # TODO(lasuillard): Add `--local-host` option, redirect the traffic to non-localhost bind (unsupported by AWS)
     local_port: int = typer.Option(
         ...,
@@ -48,7 +50,7 @@ def port_forward(  # noqa: PLR0913
         "./session-manager-plugin.pid",
         help="The path to the PID file to store the process ID of the session manager plugin.",
     ),
-    terminate_running_process: bool = typer.Option(  # noqa: FBT001
+    terminate_running_process: bool = typer.Option(
         False,  # noqa: FBT003
         help="Terminate the process in the PID file if it already exists.",
     ),
@@ -58,6 +60,7 @@ def port_forward(  # noqa: PLR0913
     ),
 ) -> None:
     """Start a port forwarding session using AWS Session Manager."""
+    dry_run = ctx.meta["dry_run"]
     session_manager = SessionManager()
 
     # Check if the PID file already exists
@@ -86,7 +89,7 @@ def port_forward(  # noqa: PLR0913
         logger.info("Instance ID resolved: [bold]%s[/bold]", instance_id)
         target = instance_id
     else:
-        logger.info("Instance with name '%s' not found.", through)
+        logger.error("Instance with name '%s' not found.", through)
         raise typer.Exit(1)
 
     # Initiate the session
@@ -111,19 +114,26 @@ def port_forward(  # noqa: PLR0913
         through,
         reason,
     )
-    proc = subprocess.Popen(  # noqa: S603
-        command,
-        stdout=stdout,
-        stderr=subprocess.STDOUT,
-        text=True,
-        close_fds=False,  # FD inherited from parent process
-    )
+    if not dry_run:
+        proc = subprocess.Popen(  # noqa: S603
+            command,
+            stdout=stdout,
+            stderr=subprocess.STDOUT,
+            text=True,
+            close_fds=False,  # FD inherited from parent process
+        )
+        pid = proc.pid
+    else:
+        pid = -1
+
     logger.info(
         "Session Manager Plugin started with PID %d. Outputs will be logged to %s.",
-        proc.pid,
+        pid,
         log_file.absolute(),
     )
 
     # Write the PID to the file
-    pid_file.write_text(str(proc.pid))
+    if not dry_run:
+        pid_file.write_text(str(pid))
+
     logger.info("PID file written to %s.", pid_file.absolute())

aws_annoying/cli/session_manager/start.py

@@ -18,6 +18,8 @@ logger = logging.getLogger(__name__)
 
 @session_manager_app.command()
 def start(
+    ctx: typer.Context,
+    *,
     target: str = typer.Option(
         ...,
         show_default=False,
@@ -29,6 +31,7 @@ def start(
     ),
 ) -> None:
     """Start new session."""
+    dry_run = ctx.meta["dry_run"]
     session_manager = SessionManager()
 
     # Resolve the instance name or ID
@@ -52,4 +55,5 @@ def start(
         parameters={},
         reason=reason,
     )
-    os.execvp(command[0], command)  # noqa: S606
+    if not dry_run:
+        os.execvp(command[0], command)  # noqa: S606

aws_annoying/cli/session_manager/stop.py

@@ -14,16 +14,20 @@ logger = logging.getLogger(__name__)
 
 @session_manager_app.command()
 def stop(
+    ctx: typer.Context,
+    *,
     pid_file: Path = typer.Option(  # noqa: B008
         "./session-manager-plugin.pid",
         help="The path to the PID file to store the process ID of the session manager plugin.",
     ),
-    remove: bool = typer.Option(  # noqa: FBT001
+    remove: bool = typer.Option(
         True,  # noqa: FBT003
         help="Remove the PID file after stopping the session.",
     ),
 ) -> None:
     """Stop running session for PID file."""
+    dry_run = ctx.meta["dry_run"]
+
     # Check if PID file exists
     if not pid_file.is_file():
         logger.error("PID file not found: %s", pid_file)
@@ -40,13 +44,15 @@ def stop(
     # Send SIGTERM to the process
     try:
         logger.warning("Terminating running process with PID %d.", pid)
-        os.kill(pid, signal.SIGTERM)
+        if not dry_run:
+            os.kill(pid, signal.SIGTERM)
     except ProcessLookupError:
         logger.warning("Tried to terminate process with PID %d but does not exist.", pid)
 
     # Remove the PID file
     if remove:
         logger.info("Removed the PID file %s.", pid_file)
-        pid_file.unlink()
+        if not dry_run:
+            pid_file.unlink()
 
     logger.info("Terminated the session successfully.")

{aws_annoying-0.7.0.dist-info → aws_annoying-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws-annoying
-Version: 0.7.0
+Version: 0.8.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

{aws_annoying-0.7.0.dist-info → aws_annoying-0.8.0.dist-info}/RECORD

@@ -2,24 +2,24 @@ 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/app.py,sha256=W0FPz0N7okjENwaGpdoWRhcei5Xs-uxSMRaYldaza3M,3295
 aws_annoying/cli/load_variables.py,sha256=n5CIci_uAoGaOZ4EKIKEEfcyMq81Hjy9AFOXq1-Hbh0,4896
-aws_annoying/cli/logging_handler.py,sha256=JPsZePV3YH9e1nLv0Q3fqSeXSEfZ5cGJo6eLK2F4oxE,1426
+aws_annoying/cli/logging_handler.py,sha256=z2fBHChHiyzQeKtKjykX-JvuWm57gARB3VDmpQSdu6U,1409
 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/task_definition_lifecycle.py,sha256=COGYy5o9N6J7tv6aA7qhT-4WsAoxbyPC1UMPtKKrPpg,2704
 aws_annoying/cli/ecs/wait_for_deployment.py,sha256=yBl-KMOya8ZSgpZLcEB0UqtsZfK5ezKPJWNaOdMRRcY,5234
 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/mfa/configure.py,sha256=Lfmc4VKkUGngbrbxLRrgcEv-vyPM_-1ne_G4U-Vh7Mg,4092
 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/cli/session_manager/install.py,sha256=QA88qIu7aYTlBN0tqU-lEN5nMGpshXF3jddBBCZixV8,1550
+aws_annoying/cli/session_manager/port_forward.py,sha256=7tSaGlcoSpJ9G2NYHvcC-PpmVqz-I4B4T8e4Xe45BE8,4495
+aws_annoying/cli/session_manager/start.py,sha256=p4vGUIT4IivJp_Sr7yYljRuYTDHBWULt2Av6AzAjL1I,1536
+aws_annoying/cli/session_manager/stop.py,sha256=SrjGJdodTmcGK1OPyFX61vWzJTqgfsuBRFvScIdYJCU,1641
 aws_annoying/ecs/__init__.py,sha256=G9vVNkbDg-fY3G0Qc7yOGZOnsVp4VtiwzzEgjr6S5Kw,666
 aws_annoying/ecs/check.py,sha256=mxkW8MWCJYng60VKwq3Ws9PEvI1u0aVPdbs4p6SY2j4,1233
 aws_annoying/ecs/common.py,sha256=TvP27SEvdIBnA92Oude-oDCy1SuaYNdtpokkbpZmdzo,139
@@ -35,8 +35,8 @@ aws_annoying/utils/downloader.py,sha256=bAh8Hu55L3F8Fyd1s4NBsyB_L0U-lk7SfKsS00Rp
 aws_annoying/utils/ec2.py,sha256=VsOrnFQDSNplWQ_s-uT11IfiD2mi-74uLbSVoaeXynI,1055
 aws_annoying/utils/platform.py,sha256=TBIzCzYiFj36HmndZedegvFlxPSNtBQyAxzuwelvxNg,985
 aws_annoying/utils/timeout.py,sha256=9eCSqhkEp7f7wBoLzkyqfyUKAgY9irwL6LIWBvIvmFI,2394
-aws_annoying-0.7.0.dist-info/METADATA,sha256=eUE6FIYZGklV_MNFNBDH9CSLQXLXZN5KlNYYkF4cifw,3507
-aws_annoying-0.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-aws_annoying-0.7.0.dist-info/entry_points.txt,sha256=DcKE5V0WvVJ8wUOHxyUz1yLAJOuuJUgRPlMcQ4O7jEs,66
-aws_annoying-0.7.0.dist-info/licenses/LICENSE,sha256=Q5GkvYijQ2KTQ-QWhv43ilzCno4ZrzrEuATEQZd9rYo,1067
-aws_annoying-0.7.0.dist-info/RECORD,,
+aws_annoying-0.8.0.dist-info/METADATA,sha256=PDr5RneXMjRUQglP8tSmNSpBatkPyK3uJilJpm1RISo,3507
+aws_annoying-0.8.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+aws_annoying-0.8.0.dist-info/entry_points.txt,sha256=DcKE5V0WvVJ8wUOHxyUz1yLAJOuuJUgRPlMcQ4O7jEs,66
+aws_annoying-0.8.0.dist-info/licenses/LICENSE,sha256=Q5GkvYijQ2KTQ-QWhv43ilzCno4ZrzrEuATEQZd9rYo,1067
+aws_annoying-0.8.0.dist-info/RECORD,,