automated-actions-cli 0.1.0__py3-none-any.whl

automated_actions_cli/__main__.py

@@ -0,0 +1,4 @@
+from automated_actions_cli.cli import app
+
+if __name__ == "__main__":
+    app()

automated_actions_cli/cli.py

@@ -0,0 +1,198 @@
+import atexit
+import contextlib
+import importlib
+import logging
+import os
+import sys
+from http.cookiejar import MozillaCookieJar
+from importlib.metadata import version
+from pathlib import Path
+from typing import Annotated, Any
+
+import httpx
+import typer
+from automated_actions_client import AuthenticatedClient, Client
+from automated_actions_client.api.v1.me import sync as api_v1_me
+from httpx_gssapi import OPTIONAL, HTTPSPNEGOAuth
+from rich import print as rich_print
+from rich.console import Console
+
+from automated_actions_cli.config import config
+from automated_actions_cli.formatter import JsonFormatter, OutputFormat, YamlFormatter
+from automated_actions_cli.utils import (
+    blend_text,
+    kerberos_available,
+    kinit,
+    progress_spinner,
+)
+
+app = typer.Typer(
+    pretty_exceptions_show_locals=False,
+    rich_markup_mode="rich",
+    epilog="Made with [red]:heart:[/red] by [blue]AppSRE[/blue]",
+)
+
+logger = logging.getLogger(__name__)
+
+console = Console(record=True, soft_wrap=True)
+
+BANNER = """
+    [o_o]
+    <)   )╯
+     | | |
+    (_|_)
+-------------------
+ AUTOMATED ACTIONS
+-------------------
+"""
+
+
+def version_callback(*, value: bool) -> None:
+    if value:
+        rich_print(f"Version: {version('automated-actions-cli')}")
+        raise typer.Exit
+
+
+class ClientWithCookieJar(Client):
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._cookiejar = MozillaCookieJar(filename=config.cookies_file)
+            with contextlib.suppress(FileNotFoundError):
+                self._cookiejar.load()
+
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookiejar,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __exit__(self, *args: object, **kwargs: Any) -> None:
+        # persist cookies
+        self._cookiejar.save()
+        super().__exit__(*args, **kwargs)
+        self._client = None
+
+
+@app.callback(no_args_is_help=True)
+def main(
+    ctx: typer.Context,
+    *,
+    url: Annotated[
+        str, typer.Option(help="Automated Action Server URL", envvar="AA_URL")
+    ] = "https://automated-actions.devshift.net",
+    debug: Annotated[
+        bool, typer.Option(help="Enable debug", envvar="AA_DEBUG")
+    ] = False,
+    screen_capture_file: Annotated[
+        Path | None,
+        typer.Option(
+            help="Capture screen recording as SVG",
+            writable=True,
+            envvar="AA_SCREEN_CAPTURE_FILE",
+        ),
+    ] = None,
+    version: Annotated[  # noqa: ARG001
+        bool | None, typer.Option(callback=version_callback, help="Display version")
+    ] = None,
+    quiet: Annotated[
+        bool, typer.Option(help="Don't print anything", envvar="AA_QUIET")
+    ] = False,
+    output: Annotated[
+        OutputFormat, typer.Option(help="Output format", envvar="AA_OUTPUT")
+    ] = OutputFormat.yaml,
+    color: Annotated[
+        bool, typer.Option(help="Use colored output", envvar="AA_COLOR")
+    ] = True,
+) -> None:
+    if "--help" in sys.argv:
+        rich_print(
+            blend_text(BANNER, (32, 32, 255), (255, 32, 255)),
+        )
+        # do not initialize the client and everything else if --help is passed
+        return
+
+    progress = None
+    if not quiet and not screen_capture_file:
+        progress = progress_spinner(console=console)
+        progress.start()
+        progress.add_task(description="Processing...", total=None)
+        atexit.register(progress.stop)
+
+    logging.basicConfig(
+        level="DEBUG" if debug else "INFO",
+        format="%(name)-20s: %(message)s",
+    )
+    logging.getLogger("httpx").setLevel(logging.WARNING)
+
+    if token := os.environ.get("AA_TOKEN"):
+        ctx.obj = {
+            "client": AuthenticatedClient(
+                base_url=str(url),
+                token=token,
+                raise_on_unexpected_status=True,
+                follow_redirects=True,
+            )
+        }
+
+    elif kerberos_available():
+        if progress:
+            progress.stop()
+        kinit()
+        if progress:
+            progress.start()
+
+        ctx.obj = {
+            "client": ClientWithCookieJar(
+                base_url=str(url),
+                raise_on_unexpected_status=True,
+                follow_redirects=True,
+                httpx_args={
+                    "auth": HTTPSPNEGOAuth(mutual_authentication=OPTIONAL),
+                },
+            )
+        }
+    else:
+        logger.error(
+            "No bearer token or Kerberos authentication available. Please set AA_TOKEN or install and configure Kerberos."
+        )
+        raise typer.Exit(1)
+
+    printer = console.print if color else print
+    match output:
+        case OutputFormat.json:
+            ctx.obj["formatter"] = JsonFormatter(printer=printer)
+        case OutputFormat.yaml:
+            ctx.obj["formatter"] = YamlFormatter(printer=printer)
+        case _:
+            raise ValueError("Invalid output format")
+
+    # enforce the user to login
+    api_v1_me(client=ctx.obj["client"])
+
+    if screen_capture_file is not None:
+        screen_capture_file = screen_capture_file.with_suffix(".svg")
+        rich_print(f"Screen recording: {screen_capture_file}")
+        # strip $0 and screen_capture_file option
+        args = sys.argv[3:]
+        console.print(f"$ automated-actions {' '.join(args)}")
+        # title = command sub_command
+        title = " ".join(args[0:2])
+        atexit.register(console.save_svg, str(screen_capture_file), title=title)
+
+
+def initialize_client_actions() -> None:
+    """Initialize typer commands from all available automated-actions-client actions."""
+    for action in dir(importlib.import_module("automated_actions_client.api.v1")):
+        if not action.startswith("_"):
+            app.add_typer(
+                importlib.import_module(f"automated_actions_client.api.v1.{action}").app
+            )
+
+
+initialize_client_actions()

automated_actions_cli/config.py

@@ -0,0 +1,20 @@
+from pathlib import Path
+
+from appdirs import AppDirs
+from pydantic_settings import BaseSettings
+
+
+class Config(BaseSettings):
+    # pydantic config
+    model_config = {"env_prefix": "aa_"}
+
+    appdirs: AppDirs = AppDirs("automated-actions", "app-sre")
+
+    @property
+    def cookies_file(self) -> Path:
+        user_cache_dir = Path(self.appdirs.user_cache_dir)
+        user_cache_dir.mkdir(parents=True, exist_ok=True)
+        return user_cache_dir / "cookies.txt"
+
+
+config = Config()

automated_actions_cli/formatter.py

@@ -0,0 +1,41 @@
+import json
+from collections.abc import Callable
+from enum import StrEnum
+from typing import Any
+
+import yaml
+
+
+class OutputFormat(StrEnum):
+    """Output format for the command line interface."""
+
+    json = "json"
+    yaml = "yaml"
+
+
+class JsonFormatter:
+    def __init__(self, printer: Callable[[str], None], indent: int = 4) -> None:
+        self._printer = printer
+        self._indent = indent
+
+    def __call__(self, data: Any) -> None:
+        """Format the data as JSON."""
+        self._printer(json.dumps(data, indent=self._indent, sort_keys=True))
+
+
+class YamlFormatter:
+    def __init__(self, printer: Callable[[str], None], indent: int = 2) -> None:
+        self._printer = printer
+        self._indent = indent
+
+    def __call__(self, data: Any) -> None:
+        """Format the data as yaml."""
+        self._printer(
+            yaml.dump(
+                data,
+                indent=self._indent,
+                sort_keys=True,
+                explicit_start=True,
+                default_flow_style=False,
+            )
+        )

automated_actions_cli/utils.py

@@ -0,0 +1,51 @@
+import logging
+import shutil
+import subprocess
+
+from rich.console import Console
+from rich.progress import Progress, SpinnerColumn, TextColumn
+from rich.text import Text
+
+logger = logging.getLogger(__name__)
+
+
+def blend_text(
+    message: str, color1: tuple[int, int, int], color2: tuple[int, int, int]
+) -> Text:
+    """Blend text from one color to another."""
+    text = Text(message)
+    r1, g1, b1 = color1
+    r2, g2, b2 = color2
+    dr = r2 - r1
+    dg = g2 - g1
+    db = b2 - b1
+    size = len(text)
+    for index in range(size):
+        blend = index / size
+        color = f"#{int(r1 + dr * blend):2X}{int(g1 + dg * blend):2X}{int(b1 + db * blend):2X}"
+        text.stylize(color, index, index + 1)
+    return text
+
+
+def progress_spinner(console: Console) -> Progress:
+    """Display shiny progress spinner."""
+    return Progress(
+        SpinnerColumn(),
+        TextColumn("[progress.description]{task.description}"),
+        console=console,
+        transient=True,
+    )
+
+
+def kerberos_available() -> bool:
+    return bool(shutil.which("kinit"))
+
+
+def kinit() -> None:
+    """Acquire a kerberos ticket if needed."""
+    try:
+        # Check if the kerberos ticket is valid
+        subprocess.run(["klist", "-s"], check=True, capture_output=True)
+    except subprocess.CalledProcessError:
+        # If the ticket is not valid, acquire a new one
+        subprocess.run(["kinit"], check=True, capture_output=False)

automated_actions_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: automated-actions-cli
+Version: 0.1.0
+Summary: Automated Actions Client
+Project-URL: homepage, https://github.com/app-sre/automated-actions
+Project-URL: repository, https://github.com/app-sre/automated-actions
+Project-URL: documentation, https://github.com/app-sre/automated-actions
+Author-email: AppSRE <sd-app-sre@redhat.com>
+License: Apache 2.0
+Requires-Python: ~=3.12.0
+Requires-Dist: appdirs==1.4.4
+Requires-Dist: automated-actions-client
+Requires-Dist: httpx-gssapi==0.4
+Requires-Dist: pydantic-settings==2.9.1
+Requires-Dist: pyyaml==6.0.2
+Requires-Dist: rich==14.0.0
+Requires-Dist: typer==0.16.0
+Description-Content-Type: text/markdown
+
+# `automated_actions_cli` Package 💻🚀
+
+Welcome, developer, to the `automated_actions_cli` package! This is the command-line interface (CLI) for interacting with the Automated Actions system. It allows users (tenants, SREs) to trigger actions, check their status, and manage other aspects of the system directly from their terminal.
+
+## 🎯 Overview
+
+The `automated_actions_cli` provides a user-friendly way to:
+
+* List available automated actions.
+* Trigger predefined actions with necessary parameters.
+* Query the status and results of submitted actions.
+* Perform administrative tasks (e.g., token generation for service accounts, if applicable).
+
+## ✨ Key Technologies
+
+* **[Typer](https://typer.tiangolo.com/):** The CLI is built using Typer, which makes it easy to create modern, user-friendly command-line applications with excellent support for type hints, auto-completion, and help generation.
+* **`automated_actions_client`:** This CLI heavily relies on the `automated_actions_client` package. The client package provides the actual Python functions and Pydantic models for making HTTP requests to the `automated_actions` API server.
+
+## ⚙️ Core Functionality
+
+The CLI acts as a wrapper around the `automated_actions_client`. When a user executes a CLI command:
+
+1. Typer parses the command, subcommands, arguments, and options.
+2. Authentication is handled (see [Authentication](#-authentication) section below).
+3. The appropriate function from `automated_actions_client` is called with the user-provided parameters.
+4. The response from the API (via the client) is then processed and presented to the user in a human-readable format.
+
+Commands are typically structured in a hierarchical way, for example:
+`automated-actions <command> [arguments_and_options]`
+
+## 🔑 Authentication (Kerberos)
+
+Authentication with the `automated_actions` API server is primarily handled via Red Hat SSO. Users are expected to have a valid Kerberos ticket-granting ticket (TGT) before using the CLI. This is typically obtained by running `kinit` and available on all Red Hat managed systems.
+
+The CLI does execute `kinit` directly if the user has not already obtained a ticket. This is done using the `kinit` command, which prompts the user for their Kerberos password.
+
+From the user's perspective, if they have a valid Kerberos ticket, authentication should be seamless. The CLI will automatically use the ticket to authenticate API requests. If no ticket is present or it's invalid, API calls will likely fail with an authentication error.
+
+## 💡 Usage Examples
+
+**1. Listing all user available action:**
+
+```bash
+$ automated-actions me
+---
+allowed_actions:
+- action-cancel
+- action-detail
+- action-list
+- create-token
+- me
+- openshift-workload-restart-unthrottled
+created_at: 1747919185.209177
+email: your-email@address.com
+name: Your Name
+updated_at: 1747996842.377609
+username: your-username
+```
+
+**2. List all past actions:**
+
+```bash
+$ automated-actions action-list
+---
+- action_id: b8ff9963-516f-437a-b93c-b7354cd5225d
+  created_at: 1747919261.038378
+  name: openshift-workload-restart
+  owner: your-username
+  result: ok
+  status: SUCCESS
+  task_args:
+    cluster: cluster-1
+    kind: Pod
+    name: example-74d78dbfbf-89rl2
+    namespace: namespace-dev
+  updated_at: 1747919261.962519
+...
+```
+
+**2. Triggering an action (e.g., restarting an OpenShift deployment):**
+
+```bash
+$ automated-actions openshift-workload-restart --cluster "my-cluster" --namespace "my-namespace" --kind Deployment --name "my-app"
+---
+- action_id: b8ff9963-516f-437a-b93c-b7354cd5225d
+  created_at: 1747919261.038378
+  name: openshift-workload-restart
+  owner: your-username
+  result: ok
+  status: PENDING
+  task_args:
+    cluster: my-cluster
+    kind: Deployment
+    name: my-app
+    namespace: my-namespac
+  updated_at: 1747919261.962519
+```
+
+## 🧑‍💻 Development
+
+See the main project `README.md` for general development instructions.
+
+### Running the CLI Locally
+
+During development, you can invoke the CLI directly using `automated-actions`:
+
+```bash
+automated-actions --help
+```
+
+### Relationship with `automated_actions_client`
+
+* **Generated Code:** Many CLI commands in this package might be **auto-generated** based on the OpenAPI specification, similar to how `automated_actions_client` is generated. This is often done using custom templates with `openapi-python-client` that output Typer application structures.
+* **Manual Wrappers:** Alternatively, or in addition, there might be manually written Typer commands in this package that import and use functions and models from `automated_actions_client`.
+* **Updates:** If the `automated_actions_client` is regenerated due to API changes, the CLI commands (especially auto-generated ones) might also need to be regenerated or updated to reflect those changes. The `make generate-client` (or a similar target like `make generate-cli`) from the project root should handle this.
+
+### Testing
+
+Tests for this package are located within its `tests/` directory. These typically involve:
+
+* Using Typer's `CliRunner` to invoke CLI commands and assert their output and exit codes.
+* Mocking the `automated_actions_client` to avoid making real API calls during unit tests.
+* Integration tests that do make real API calls to a test instance of the server.
+
+To run tests specifically for this package:
+
+```bash
+make test
+```
+
+## 🤝 Contributing to this Package
+
+* Follow the general contributing guidelines in the main project `README.md`.
+* Ensure new CLI commands are intuitive and provide helpful error messages.
+* Add or update tests for any new or modified commands.
+* Keep Typer's auto-completion features in mind for a good user experience.

automated_actions_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+automated_actions_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+automated_actions_cli/__main__.py,sha256=bAFyKcKeh2Z8JbQa1vp7_iEn9YeSKgFOnpaBigMnNbk,80
+automated_actions_cli/cli.py,sha256=Y5RGwlAGVFfJowIN9gwPR4yvDRA7zCbbh5PmEMP_3HA,6178
+automated_actions_cli/config.py,sha256=72RB43l4-xGJod6omBSxp2NuTXbfUU36v0NeQ8bcJBo,488
+automated_actions_cli/formatter.py,sha256=zc8Botw86QUvQjMQG7drhAE0hJ2OMtgv7TfPZ6wIRP8,1049
+automated_actions_cli/utils.py,sha256=w5_w5WLuW6pAtABvVMW1IOvx1tSPe-yZzw0u1-sLkBc,1426
+automated_actions_cli-0.1.0.dist-info/METADATA,sha256=GgSoI7Bf-xEu5FDSAFHhzvKZHH191751NuMHN3oqBMs,6372
+automated_actions_cli-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+automated_actions_cli-0.1.0.dist-info/entry_points.txt,sha256=kF-Yau0YT1omwWd5Rke2MfI_L3pe-zhl_XF6EU88E0s,73
+automated_actions_cli-0.1.0.dist-info/RECORD,,

automated_actions_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

automated_actions_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+automated-actions = automated_actions_cli.__main__:app