fix: strip ANSI escape codes in CLI tests for CI compatibility

Rich inserts ANSI escape sequences that split option names (e.g.
--api-key becomes \e[1;36m-\e[0m\e[1;36m-api\e[0m...) even with
NO_COLOR=1. Strip all ANSI codes from output before asserting.

Author: anneschuth

tests/test_cli.py

@@ -1,26 +1,39 @@
 """Tests for CLI entry point."""
 
 import os
+import re
 import subprocess
 import sys
 
-# Env that disables Rich ANSI codes so assertions can match plain text
-_PLAIN_ENV = {**os.environ, "NO_COLOR": "1"}
+# Env that disables Rich color codes (bold/dim may still appear)
+_PLAIN_ENV = {**os.environ, "NO_COLOR": "1", "TERM": "dumb"}
 
+_ANSI_RE = re.compile(r"\x1b\[[0-9;]*m")
 
-def test_help_exits_zero():
-    result = subprocess.run(
-        [sys.executable, "-m", "zad_cli", "--help"],
+
+def _strip_ansi(text: str) -> str:
+    return _ANSI_RE.sub("", text)
+
+
+def _run_help(*args: str) -> subprocess.CompletedProcess:
+    """Run a CLI command with --help and return the result."""
+    return subprocess.run(
+        [sys.executable, "-m", "zad_cli", *args, "--help"],
         capture_output=True,
         text=True,
         env=_PLAIN_ENV,
     )
+
+
+def test_help_exits_zero():
+    result = _run_help()
+    out = _strip_ansi(result.stdout)
     assert result.returncode == 0
-    assert "CLI for ZAD" in result.stdout
-    assert "--api-key" in result.stdout
-    assert "--project" in result.stdout
-    assert "ZAD_PROJECT_ID" in result.stdout
-    assert "--verbose" in result.stdout
+    assert "CLI for ZAD" in out
+    assert "--api-key" in out
+    assert "--project" in out
+    assert "ZAD_PROJECT_ID" in out
+    assert "--verbose" in out
 
 
 def test_version():
@@ -35,34 +48,26 @@ def test_version():
 
 
 def test_project_help_without_api_key():
-    result = subprocess.run(
-        [sys.executable, "-m", "zad_cli", "project", "--help"],
-        capture_output=True,
-        text=True,
-        env=_PLAIN_ENV,
-    )
+    result = _run_help("project")
+    out = _strip_ansi(result.stdout)
     assert result.returncode == 0
-    assert "list" in result.stdout
-    assert "status" in result.stdout
-    assert "delete" in result.stdout
-    assert "refresh" in result.stdout
-    assert "subdomains" in result.stdout
-    assert "check-subdomain" in result.stdout
+    assert "list" in out
+    assert "status" in out
+    assert "delete" in out
+    assert "refresh" in out
+    assert "subdomains" in out
+    assert "check-subdomain" in out
 
 
 def test_deployment_help_shows_create():
-    result = subprocess.run(
-        [sys.executable, "-m", "zad_cli", "deployment", "--help"],
-        capture_output=True,
-        text=True,
-        env=_PLAIN_ENV,
-    )
+    result = _run_help("deployment")
+    out = _strip_ansi(result.stdout)
     assert result.returncode == 0
-    assert "create" in result.stdout
-    assert "delete" in result.stdout
-    assert "update-image" in result.stdout
+    assert "create" in out
+    assert "delete" in out
+    assert "update-image" in out
     # check-subdomain was moved to project
-    assert "check-subdomain" not in result.stdout
+    assert "check-subdomain" not in out
 
 
 def test_deploy_create_takes_positional_name():
@@ -71,84 +76,61 @@ def test_deploy_create_takes_positional_name():
         [sys.executable, "-m", "zad_cli", "deployment", "create", "test"],
         capture_output=True,
         text=True,
-        env={"PATH": "/usr/bin:/bin", "NO_COLOR": "1"},
+        env={"PATH": "/usr/bin:/bin", "NO_COLOR": "1", "TERM": "dumb"},
     )
+    err = _strip_ansi(result.stderr)
     assert result.returncode != 0
     # Should fail on missing project/key or missing component args, not on argument parsing
-    assert "ZAD_PROJECT_ID" in result.stderr or "ZAD_API_KEY" in result.stderr or "--component" in result.stderr
+    assert "ZAD_PROJECT_ID" in err or "ZAD_API_KEY" in err or "--component" in err
 
 
 def test_component_help_shows_delete():
-    result = subprocess.run(
-        [sys.executable, "-m", "zad_cli", "component", "--help"],
-        capture_output=True,
-        text=True,
-        env=_PLAIN_ENV,
-    )
+    result = _run_help("component")
+    out = _strip_ansi(result.stdout)
     assert result.returncode == 0
-    assert "delete" in result.stdout
-    assert "add" in result.stdout
-    assert "list" in result.stdout
+    assert "delete" in out
+    assert "add" in out
+    assert "list" in out
 
 
 def test_service_help_shows_delete():
-    result = subprocess.run(
-        [sys.executable, "-m", "zad_cli", "service", "--help"],
-        capture_output=True,
-        text=True,
-        env=_PLAIN_ENV,
-    )
+    result = _run_help("service")
+    out = _strip_ansi(result.stdout)
     assert result.returncode == 0
-    assert "delete" in result.stdout
-    assert "add" in result.stdout
-    assert "types" in result.stdout
+    assert "delete" in out
+    assert "add" in out
+    assert "types" in out
 
 
 def test_task_list_uses_filter_project():
     """task list should use --filter-project to clearly distinguish from global -p."""
-    result = subprocess.run(
-        [sys.executable, "-m", "zad_cli", "task", "list", "--help"],
-        capture_output=True,
-        text=True,
-        env=_PLAIN_ENV,
-    )
+    result = _run_help("task", "list")
+    out = _strip_ansi(result.stdout)
     assert result.returncode == 0
-    assert "--filter-project" in result.stdout
+    assert "--filter-project" in out
 
 
 def test_deployment_create_has_yes_flag():
     """deployment create (upsert) should require confirmation via --yes."""
-    result = subprocess.run(
-        [sys.executable, "-m", "zad_cli", "deployment", "create", "--help"],
-        capture_output=True,
-        text=True,
-        env=_PLAIN_ENV,
-    )
+    result = _run_help("deployment", "create")
+    out = _strip_ansi(result.stdout)
     assert result.returncode == 0
-    assert "--yes" in result.stdout
+    assert "--yes" in out
 
 
 def test_logs_takes_positional_deployment():
     """logs should accept deployment as a positional argument."""
-    result = subprocess.run(
-        [sys.executable, "-m", "zad_cli", "logs", "--help"],
-        capture_output=True,
-        text=True,
-        env=_PLAIN_ENV,
-    )
+    result = _run_help("logs")
+    out = _strip_ansi(result.stdout)
     assert result.returncode == 0
-    assert "DEPLOYMENT" in result.stdout
+    assert "DEPLOYMENT" in out
 
 
 def test_clone_help_shows_check():
-    result = subprocess.run(
-        [sys.executable, "-m", "zad_cli", "clone", "--help"],
-        capture_output=True,
-        text=True,
-        env=_PLAIN_ENV,
-    )
+    result = _run_help("clone")
+    out = _strip_ansi(result.stdout)
     assert result.returncode == 0
-    assert "check" in result.stdout
+    assert "check" in out
 
 
 def test_all_subcommands_have_help():
@@ -169,10 +151,5 @@ def test_all_subcommands_have_help():
         "open",
     ]
     for cmd in subcommands:
-        result = subprocess.run(
-            [sys.executable, "-m", "zad_cli", cmd, "--help"],
-            capture_output=True,
-            text=True,
-            env=_PLAIN_ENV,
-        )
+        result = _run_help(cmd)
         assert result.returncode == 0, f"{cmd} --help failed: {result.stderr}"