Files
cleveragents-core/robot/helper_actor_cli_show.py
T
freemo f7993d7309
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 16s
CI / build (pull_request) Successful in 21s
CI / quality (pull_request) Successful in 32s
CI / security (pull_request) Successful in 33s
CI / typecheck (pull_request) Successful in 54s
CI / integration_tests (pull_request) Successful in 4m48s
CI / unit_tests (pull_request) Successful in 15m53s
CI / docker (pull_request) Successful in 14s
CI / benchmark-regression (pull_request) Successful in 17m19s
CI / coverage (pull_request) Successful in 26m43s
CI / lint (push) Successful in 13s
CI / build (push) Successful in 15s
CI / quality (push) Successful in 16s
CI / security (push) Successful in 28s
CI / typecheck (push) Successful in 44s
CI / benchmark-regression (push) Has been skipped
CI / integration_tests (push) Successful in 4m0s
CI / benchmark-publish (push) Successful in 12m5s
CI / unit_tests (push) Successful in 13m42s
CI / docker (push) Successful in 1m9s
CI / coverage (push) Has been cancelled
feat(cli): align actor commands to YAML
Align actor add/remove/list/show commands to YAML-first configs,
namespaced names, and --format json|yaml|plain output support.

Changes:
- Add --format option to list, show, add, and update commands
- Add --update flag to add command for updating existing actors
- Add _actor_spec_dict helper for structured output serialization
- Update _print_actor to support format_output rendering
- Add Behave feature tests for CLI format scenarios (11 scenarios)
- Add Robot Framework integration test for show output fields
- Add ASV benchmark for actor CLI parsing overhead
- Add CLI reference documentation for actor commands

ISSUES CLOSED: #288
2026-02-24 19:12:01 +00:00

129 lines
3.7 KiB
Python

"""Helper script for actor CLI show output fields Robot test."""
from __future__ import annotations
import json
import sys
from typing import Any
from unittest.mock import MagicMock, patch
from typer.testing import CliRunner
from cleveragents.cli.commands.actor import app as actor_app
from cleveragents.domain.models.core.actor import Actor
def _make_actor(
*,
name: str = "local/robot-actor",
provider: str = "openai",
model: str = "gpt-4",
config: dict[str, Any] | None = None,
unsafe: bool = False,
is_default: bool = False,
is_built_in: bool = False,
) -> Actor:
blob = config or {"provider": provider, "model": model}
return Actor(
id=1,
name=name,
provider=provider,
model=model,
config_blob=blob,
config_hash=Actor.compute_hash(blob),
unsafe=unsafe,
is_built_in=is_built_in,
is_default=is_default,
)
def test_show_json_fields() -> None:
"""Verify show --format json contains expected fields."""
runner = CliRunner()
actor = _make_actor()
with patch("cleveragents.cli.commands.actor._get_services") as mock_svc:
registry = MagicMock()
registry.get_actor.return_value = actor
mock_svc.return_value = (MagicMock(), registry)
result = runner.invoke(actor_app, ["show", actor.name, "--format", "json"])
assert result.exit_code == 0, (
f"exit_code={result.exit_code}, output={result.output}"
)
data = json.loads(result.output.strip())
required_fields = [
"name",
"provider",
"model",
"unsafe",
"is_default",
"is_built_in",
"config_hash",
"schema_version",
"updated_at",
]
missing = [f for f in required_fields if f not in data]
assert not missing, f"Missing fields: {missing}"
assert data["name"] == "local/robot-actor"
assert data["provider"] == "openai"
assert data["model"] == "gpt-4"
print("actor-cli-show-json-fields-ok")
def test_show_yaml_output() -> None:
"""Verify show --format yaml produces valid YAML."""
runner = CliRunner()
actor = _make_actor()
with patch("cleveragents.cli.commands.actor._get_services") as mock_svc:
registry = MagicMock()
registry.get_actor.return_value = actor
mock_svc.return_value = (MagicMock(), registry)
result = runner.invoke(actor_app, ["show", actor.name, "--format", "yaml"])
assert result.exit_code == 0
assert "name:" in result.output
assert "local/robot-actor" in result.output
print("actor-cli-show-yaml-output-ok")
def test_list_json_format() -> None:
"""Verify list --format json returns array of actors."""
runner = CliRunner()
actors = [
_make_actor(name="local/a1", provider="p1", model="m1"),
_make_actor(name="local/a2", provider="p2", model="m2"),
]
with patch("cleveragents.cli.commands.actor._get_services") as mock_svc:
registry = MagicMock()
registry.list_actors.return_value = actors
mock_svc.return_value = (MagicMock(), registry)
result = runner.invoke(actor_app, ["list", "--format", "json"])
assert result.exit_code == 0
data = json.loads(result.output.strip())
assert isinstance(data, list)
assert len(data) == 2
print("actor-cli-list-json-format-ok")
def main() -> None:
command = sys.argv[1] if len(sys.argv) > 1 else "show-json-fields"
dispatch = {
"show-json-fields": test_show_json_fields,
"show-yaml-output": test_show_yaml_output,
"list-json-format": test_list_json_format,
}
fn = dispatch.get(command)
if fn is None:
print(f"Unknown command: {command}", file=sys.stderr)
sys.exit(1)
fn()
if __name__ == "__main__":
main()