aap-demo 2.0.0.dev0__tar.gz → 2.0.0.dev1__tar.gz

{aap_demo-2.0.0.dev0 → aap_demo-2.0.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: aap-demo
-Version: 2.0.0.dev0
+Version: 2.0.0.dev1
 Summary: Deploy Ansible Automation Platform 2.7 to OpenShift Local (MicroShift or OpenShift preset)
 Project-URL: Homepage, https://github.com/RedHatOfficial/aap-demo
 Project-URL: Source, https://github.com/RedHatOfficial/aap-demo
@@ -52,26 +52,28 @@ Deploy AAP to a local MicroShift cluster in minutes.
 
 ## Install
 
-Python 3.9 or newer. While `v2` is in development, install that branch directly. No checkout is required. [pipx](https://pipx.pypa.io/) keeps the command isolated from the rest of your Python packages:
+Python 3.9 or newer. [pipx](https://pipx.pypa.io/) keeps the command isolated from the rest of your Python packages:
 
 ```bash
-pipx install "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
+pipx install aap-demo
 ```
 
-Pull the latest `v2` commit the same way:
+Update the installed command with:
 
 ```bash
-pipx install --force "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
+aap-demo update
 ```
 
-pip and uv install the same branch:
+That checks how this command was installed, then runs `pipx upgrade aap-demo`.
+
+pip and uv install the same release:
 
 ```bash
-pip install "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
-uv tool install "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
+pip install aap-demo
+uv tool install aap-demo
 ```
 
-The publish workflow uploads this beta to PyPI as a `.dev` release so the `aap-demo` name is reserved. `pip install aap-demo` does not install a `.dev` release. Keep using the git URL above. `pipx install aap-demo` is the command after the 2.0.0 release. Check out `v2` only if you are changing the code.
+This installs the published release of the v2 beta. Check out `v2` only if you are changing the code. If you already installed from the git URL, switch with `pipx install --force aap-demo`.
 
 ### Replace the bash v1 command
 
@@ -224,7 +226,7 @@ aap-demo repair              # Fix after sleep/wake issues
 
 # Maintenance
 aap-demo clean               # Remove AAP deployment (keeps cluster)
-aap-demo update              # Pull latest code and reinstall
+aap-demo update              # Update the pipx install to the latest release
 aap-demo help                # Full command reference
 ```
 

{aap_demo-2.0.0.dev0 → aap_demo-2.0.0.dev1}/README.md

@@ -10,26 +10,28 @@ Deploy AAP to a local MicroShift cluster in minutes.
 
 ## Install
 
-Python 3.9 or newer. While `v2` is in development, install that branch directly. No checkout is required. [pipx](https://pipx.pypa.io/) keeps the command isolated from the rest of your Python packages:
+Python 3.9 or newer. [pipx](https://pipx.pypa.io/) keeps the command isolated from the rest of your Python packages:
 
 ```bash
-pipx install "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
+pipx install aap-demo
 ```
 
-Pull the latest `v2` commit the same way:
+Update the installed command with:
 
 ```bash
-pipx install --force "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
+aap-demo update
 ```
 
-pip and uv install the same branch:
+That checks how this command was installed, then runs `pipx upgrade aap-demo`.
+
+pip and uv install the same release:
 
 ```bash
-pip install "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
-uv tool install "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
+pip install aap-demo
+uv tool install aap-demo
 ```
 
-The publish workflow uploads this beta to PyPI as a `.dev` release so the `aap-demo` name is reserved. `pip install aap-demo` does not install a `.dev` release. Keep using the git URL above. `pipx install aap-demo` is the command after the 2.0.0 release. Check out `v2` only if you are changing the code.
+This installs the published release of the v2 beta. Check out `v2` only if you are changing the code. If you already installed from the git URL, switch with `pipx install --force aap-demo`.
 
 ### Replace the bash v1 command
 
@@ -182,7 +184,7 @@ aap-demo repair              # Fix after sleep/wake issues
 
 # Maintenance
 aap-demo clean               # Remove AAP deployment (keeps cluster)
-aap-demo update              # Pull latest code and reinstall
+aap-demo update              # Update the pipx install to the latest release
 aap-demo help                # Full command reference
 ```
 

{aap_demo-2.0.0.dev0 → aap_demo-2.0.0.dev1}/addons/apme-eap/plugin_packs/apme-prototype-plugins-8593383-20260718025043.oci.tar.gz

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
-name: aap_demo-2.0.0.dev0/addons/apme-eap/plugin_packs/apme-prototype-plugins-8593383-20260718025043.oci.tar.gz
+name: aap_demo-2.0.0.dev1/addons/apme-eap/plugin_packs/apme-prototype-plugins-8593383-20260718025043.oci.tar.gz
 size: 37785090 bytes
 sha256: 943f67afce1f9d1852df09b74da0126ef73f861e1ffc066e5196cc3701f341c3

{aap_demo-2.0.0.dev0 → aap_demo-2.0.0.dev1}/docs/FULL-README.md

@@ -88,26 +88,28 @@ See [scripts/README.md](../scripts/README.md) for Linux-only details.
 
 ### Install
 
-Python 3.9 or newer. While `v2` is in development, install that branch directly. No checkout is required. [pipx](https://pipx.pypa.io/) keeps the command isolated from the rest of your Python packages:
+Python 3.9 or newer. [pipx](https://pipx.pypa.io/) keeps the command isolated from the rest of your Python packages:
 
 ```bash
-pipx install "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
+pipx install aap-demo
 ```
 
-Pull the latest `v2` commit the same way:
+Update the installed command with:
 
 ```bash
-pipx install --force "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
+aap-demo update
 ```
 
-pip and uv install the same branch:
+That checks how this command was installed, then runs `pipx upgrade aap-demo`.
+
+pip and uv install the same release:
 
 ```bash
-pip install "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
-uv tool install "git+https://github.com/RedHatOfficial/aap-demo.git@v2"
+pip install aap-demo
+uv tool install aap-demo
 ```
 
-`pipx install aap-demo` replaces the git URL after the package is published. Check out `v2` only if you are changing the code.
+This installs the published release of the v2 beta. Check out `v2` only if you are changing the code. If you already installed from the git URL, switch with `pipx install --force aap-demo`.
 
 `./install.sh` links `~/.local/bin/aap-demo` to the bash script. pipx installs v2 at that same path, so move or remove the old command before installing v2.
 
@@ -255,7 +257,7 @@ aap-demo must-gather /tmp/d  # Collect to specific directory
 
 # Maintenance
 aap-demo clean               # Remove AAP deployment (keeps cluster)
-aap-demo update              # Pull latest code and reinstall
+aap-demo update              # Update the pipx install to the latest release
 aap-demo help                # Full command reference
 ```
 

aap_demo-2.0.0.dev1/src/aap_demo/__init__.py

@@ -0,0 +1,6 @@
+"""aap-demo — deploy Ansible Automation Platform 2.7 to OpenShift Local."""
+
+# Development release published from the v2 branch.
+__version__ = "2.0.0.dev1"
+
+__all__ = ["__version__"]

{aap_demo-2.0.0.dev0 → aap_demo-2.0.0.dev1}/src/aap_demo/cli/ops.py

@@ -17,7 +17,6 @@ from aap_demo.core.context import AppContext
 from aap_demo.core.errors import (
     AapDemoError,
     ClusterUnreachableError,
-    NotImplementedYetError,
     UsageError,
 )
 from aap_demo.core.output import is_structured
@@ -375,4 +374,8 @@ def idle(ctx: AppContext, args: argparse.Namespace) -> int:
 
 
 def update(ctx: AppContext, args: argparse.Namespace) -> int:
-    raise NotImplementedYetError("update")
+    """Upgrade the pipx install of aap-demo."""
+    del args
+    from aap_demo.core import self_update
+
+    return self_update.run(ctx)

aap_demo-2.0.0.dev1/src/aap_demo/core/self_update.py

@@ -0,0 +1,145 @@
+"""Update the pipx install of aap-demo.
+
+``aap-demo update`` is the supported upgrade. It checks how this command was
+installed, then runs ``pipx upgrade aap-demo``. Later checks belong here, not
+in a second command.
+"""
+
+from __future__ import annotations
+
+import json
+import shutil
+import subprocess
+from typing import Any, Optional, Sequence
+
+from aap_demo.core.context import AppContext
+from aap_demo.core.errors import AapDemoError, PrerequisiteError
+from aap_demo.core.version import version_info
+from aap_demo.exec.runner import CompletedCommand
+
+PACKAGE = "aap-demo"
+LIST_TIMEOUT = 60.0
+UPGRADE_TIMEOUT = 600.0
+
+
+def run(ctx: AppContext) -> int:
+    """Upgrade the pipx install and report how this command was installed."""
+    info = version_info(ctx.runner)
+    ctx.console.out(f"Current: {info.version}")
+    if info.install_mode == "checkout":
+        ctx.console.out(
+            "This command is a source checkout. "
+            "The update applies to the pipx install, not this tree."
+        )
+
+    pipx = shutil.which("pipx")
+    if not pipx:
+        raise PrerequisiteError(
+            "pipx is not on PATH",
+            hint="Install pipx, then run: pipx install aap-demo",
+        )
+
+    source = _installed_source(ctx, pipx)
+    if _is_direct_source(source):
+        ctx.console.warn(f"This pipx install tracks {source}")
+        ctx.console.out("The published release is: pipx install --force aap-demo")
+
+    ctx.console.out("Upgrading the pipx install...")
+    result = _run_pipx(
+        ctx,
+        [pipx, "upgrade", PACKAGE],
+        timeout=UPGRADE_TIMEOUT,
+        capture=False,
+        action="upgrade",
+    )
+    if result.returncode != 0:
+        return result.returncode
+    ctx.console.out("Update complete. Run `aap-demo version` to see the installed release.")
+    return 0
+
+
+def _run_pipx(
+    ctx: AppContext,
+    argv: Sequence[str],
+    *,
+    timeout: float,
+    action: str,
+    capture: bool = True,
+) -> CompletedCommand:
+    """Run one pipx step. A stall becomes an ``aap-demo update`` error."""
+    try:
+        return ctx.runner.run(list(argv), capture=capture, timeout=timeout)
+    except subprocess.TimeoutExpired as exc:
+        raise _timeout_error(action, timeout) from exc
+    except AapDemoError as exc:
+        if "timed out" not in str(exc):
+            raise
+        raise _timeout_error(action, timeout) from exc
+
+
+def _timeout_error(action: str, timeout: float) -> AapDemoError:
+    return AapDemoError(
+        f"pipx {action} timed out after {int(timeout)}s",
+        hint="Check the network, then run aap-demo update again.",
+    )
+
+
+def _installed_source(ctx: AppContext, pipx: str) -> str:
+    """``package_or_url`` for the pipx app, or raise when pipx did not install it."""
+    listing = _run_pipx(ctx, [pipx, "list", "--json"], timeout=LIST_TIMEOUT, action="list")
+    if not listing.ok:
+        detail = (listing.stderr or listing.stdout or "").strip()
+        raise AapDemoError("Could not read the pipx install list", hint=detail or None)
+    try:
+        payload = json.loads(listing.stdout or "")
+    except json.JSONDecodeError as exc:
+        raise AapDemoError("Could not read the pipx install list") from exc
+    source, gaps = _package_record(payload)
+    if source is None:
+        raise AapDemoError(
+            "aap-demo is not installed with pipx",
+            hint="Install the published release with: pipx install aap-demo",
+        )
+    if gaps:
+        missing = " and ".join(gaps)
+        ctx.console.warn(f"pipx did not report {missing} for aap-demo")
+        ctx.console.out(
+            "The install is being treated as the published release. "
+            "If it tracks a git URL or a path, switch with: pipx install --force aap-demo"
+        )
+    return source
+
+
+def _package_record(payload: Any) -> tuple[Optional[str], list[str]]:
+    """``(package_or_url, missing field names)`` for the aap-demo pipx app."""
+    venvs = payload.get("venvs") if isinstance(payload, dict) else None
+    if not isinstance(venvs, dict):
+        return None, []
+    for name, env in venvs.items():
+        if not isinstance(env, dict):
+            continue
+        raw_metadata = env.get("metadata")
+        metadata = raw_metadata if isinstance(raw_metadata, dict) else {}
+        raw_main = metadata.get("main_package")
+        main = raw_main if isinstance(raw_main, dict) else {}
+        package_name = main.get("package")
+        gaps: list[str] = []
+        if not package_name:
+            gaps.append("package")
+            package_name = name
+        if str(package_name) != PACKAGE and name != PACKAGE:
+            continue
+        spec = main.get("package_or_url")
+        if not spec:
+            gaps.append("package_or_url")
+            spec = PACKAGE
+        return str(spec), gaps
+    return None, []
+
+
+def _is_direct_source(spec: str) -> bool:
+    """True when pipx installed from a URL or a path instead of the PyPI release."""
+    text = spec.strip()
+    if text in {"", PACKAGE}:
+        return False
+    return "://" in text or "/" in text or text.startswith((".", "~"))

aap_demo-2.0.0.dev1/tests/unit/test_self_update.py

@@ -0,0 +1,150 @@
+"""``aap-demo update`` upgrades the pipx install after checking how it was installed."""
+
+from __future__ import annotations
+
+import json
+import subprocess
+
+import pytest
+
+from aap_demo.core import self_update
+from aap_demo.core.errors import AapDemoError, PrerequisiteError
+from aap_demo.core.version import VersionInfo
+from aap_demo.exec.runner import FakeRunner
+
+PIPX = "/usr/bin/pipx"
+
+
+def _info(mode: str = "package") -> VersionInfo:
+    return VersionInfo(version="2.0.0.dev0", source="/tmp/aap-demo", install_mode=mode)
+
+
+def _listing(spec: str = "aap-demo") -> str:
+    return json.dumps(
+        {
+            "venvs": {
+                "aap-demo": {
+                    "metadata": {"main_package": {"package": "aap-demo", "package_or_url": spec}}
+                }
+            }
+        }
+    )
+
+
+def _runner(spec: str = "aap-demo", *, upgrade: bool = True) -> FakeRunner:
+    runner = FakeRunner()
+    runner.ok([PIPX, "list", "--json"], stdout=_listing(spec))
+    if upgrade:
+        runner.ok([PIPX, "upgrade", "aap-demo"])
+    return runner
+
+
+def test_update_upgrades_a_pypi_pipx_install(app_ctx, monkeypatch) -> None:
+    monkeypatch.setattr(self_update.shutil, "which", lambda _name: PIPX)
+    monkeypatch.setattr(self_update, "version_info", lambda _runner: _info())
+    app_ctx.runner = _runner()
+
+    assert self_update.run(app_ctx) == 0
+
+    assert app_ctx.runner.called([PIPX, "upgrade", "aap-demo"])
+    assert [call.timeout for call in app_ctx.runner.calls] == [
+        self_update.LIST_TIMEOUT,
+        self_update.UPGRADE_TIMEOUT,
+    ]
+    assert "Current: 2.0.0.dev0" in app_ctx.console.stdout
+    assert "Update complete" in app_ctx.console.stdout
+
+
+def test_update_warns_when_pipx_tracks_a_git_url(app_ctx, monkeypatch) -> None:
+    monkeypatch.setattr(self_update.shutil, "which", lambda _name: PIPX)
+    monkeypatch.setattr(self_update, "version_info", lambda _runner: _info())
+    app_ctx.runner = _runner("git+https://github.com/RedHatOfficial/aap-demo.git@v2")
+
+    assert self_update.run(app_ctx) == 0
+
+    assert "tracks git+https://" in app_ctx.console.stderr
+    assert "pipx install --force aap-demo" in app_ctx.console.stdout
+    assert app_ctx.runner.called([PIPX, "upgrade", "aap-demo"])
+
+
+def test_update_warns_for_a_relative_path_install(app_ctx, monkeypatch) -> None:
+    monkeypatch.setattr(self_update.shutil, "which", lambda _name: PIPX)
+    monkeypatch.setattr(self_update, "version_info", lambda _runner: _info())
+    app_ctx.runner = _runner("path/to/aap-demo")
+
+    assert self_update.run(app_ctx) == 0
+
+    assert "tracks path/to/aap-demo" in app_ctx.console.stderr
+    assert "pipx install --force aap-demo" in app_ctx.console.stdout
+
+
+def test_update_warns_when_pipx_omits_package_or_url(app_ctx, monkeypatch) -> None:
+    monkeypatch.setattr(self_update.shutil, "which", lambda _name: PIPX)
+    monkeypatch.setattr(self_update, "version_info", lambda _runner: _info())
+    payload = {"venvs": {"aap-demo": {"metadata": {"main_package": {"package": "aap-demo"}}}}}
+    runner = FakeRunner()
+    runner.ok([PIPX, "list", "--json"], stdout=json.dumps(payload))
+    runner.ok([PIPX, "upgrade", "aap-demo"])
+    app_ctx.runner = runner
+
+    assert self_update.run(app_ctx) == 0
+
+    assert "did not report package_or_url" in app_ctx.console.stderr
+    assert "treated as the published release" in app_ctx.console.stdout
+    assert runner.called([PIPX, "upgrade", "aap-demo"])
+
+
+def test_update_says_when_this_command_is_a_checkout(app_ctx, monkeypatch) -> None:
+    monkeypatch.setattr(self_update.shutil, "which", lambda _name: PIPX)
+    monkeypatch.setattr(self_update, "version_info", lambda _runner: _info("checkout"))
+    app_ctx.runner = _runner()
+
+    assert self_update.run(app_ctx) == 0
+
+    assert "source checkout" in app_ctx.console.stdout
+
+
+def test_update_requires_pipx(app_ctx, monkeypatch) -> None:
+    monkeypatch.setattr(self_update.shutil, "which", lambda _name: None)
+    monkeypatch.setattr(self_update, "version_info", lambda _runner: _info())
+
+    with pytest.raises(PrerequisiteError, match="pipx is not on PATH"):
+        self_update.run(app_ctx)
+
+
+def test_update_requires_a_pipx_install(app_ctx, monkeypatch) -> None:
+    monkeypatch.setattr(self_update.shutil, "which", lambda _name: PIPX)
+    monkeypatch.setattr(self_update, "version_info", lambda _runner: _info())
+    app_ctx.runner = FakeRunner().ok([PIPX, "list", "--json"], stdout='{"venvs": {}}')
+
+    with pytest.raises(AapDemoError, match="not installed with pipx"):
+        self_update.run(app_ctx)
+
+
+def test_update_reports_a_pipx_list_timeout(app_ctx, monkeypatch) -> None:
+    monkeypatch.setattr(self_update.shutil, "which", lambda _name: PIPX)
+    monkeypatch.setattr(self_update, "version_info", lambda _runner: _info())
+    runner = FakeRunner()
+    runner.register(
+        [PIPX, "list", "--json"],
+        AapDemoError("command timed out after 60s: /usr/bin/pipx list --json"),
+    )
+    app_ctx.runner = runner
+
+    with pytest.raises(AapDemoError, match="pipx list timed out after 60s"):
+        self_update.run(app_ctx)
+
+
+def test_update_reports_a_pipx_upgrade_timeout(app_ctx, monkeypatch) -> None:
+    monkeypatch.setattr(self_update.shutil, "which", lambda _name: PIPX)
+    monkeypatch.setattr(self_update, "version_info", lambda _runner: _info())
+    runner = FakeRunner()
+    runner.ok([PIPX, "list", "--json"], stdout=_listing())
+    runner.register(
+        [PIPX, "upgrade", "aap-demo"],
+        subprocess.TimeoutExpired(cmd=[PIPX, "upgrade", "aap-demo"], timeout=600),
+    )
+    app_ctx.runner = runner
+
+    with pytest.raises(AapDemoError, match="pipx upgrade timed out after 600s"):
+        self_update.run(app_ctx)

aap_demo-2.0.0.dev0/src/aap_demo/__init__.py

@@ -1,6 +0,0 @@
-"""aap-demo — deploy Ansible Automation Platform 2.7 to OpenShift Local."""
-
-# Development release published from the v2 branch. pip ignores ``.dev`` versions.
-__version__ = "2.0.0.dev0"
-
-__all__ = ["__version__"]