hermes-agent/tests/hermes_cli/test_post_setup_gating.py
Teknium 8f711f79a4
fix(tools): install cua-driver when Computer Use is enabled via 'hermes tools' (#22765)
Returning users who enabled '🖱️ Computer Use (macOS)' via 'hermes tools'
saw '✓ Saved configuration' but no install — cua-driver was never on
PATH and the toolset failed at first use. Two compounding causes:

1. _toolset_needs_configuration_prompt fell through to _toolset_has_keys,
   which returned True for any provider with empty env_vars. cua-driver
   has no env vars, so the gate skipped _configure_toolset entirely and
   _run_post_setup('cua_driver') never ran.

2. No stable CLI entry-point existed for re-running the install when
   the picker no-op'd it (e.g. when toggling the toolset off+on inside
   one picker session, where 'added' is empty).

Changes:

- hermes_cli/tools_config.py: add _POST_SETUP_INSTALLED registry
  mapping post_setup keys to installed-state predicates. The gate
  now returns True when any visible provider has a registered
  post_setup whose predicate fails. cua_driver is the only opt-in
  for now; other post_setup hooks keep their existing behaviour.
- hermes_cli/main.py: add 'hermes computer-use install' and
  'hermes computer-use status' as a stable docs target. install
  reuses the same _run_post_setup('cua_driver') path that the
  picker invokes; status reports whether cua-driver is on PATH.
- tools/computer_use/cua_backend.py: install hint now points users
  at 'hermes computer-use install' first.
- website/docs/user-guide/features/computer-use.md: document the
  new command as the primary install path.
- website/docs/reference/cli-commands.md: catalog 'hermes
  computer-use' alongside 'hermes tools'.
- tests/hermes_cli/test_post_setup_gating.py: regression coverage
  for the gate predicate (missing -> setup forced, installed ->
  setup skipped, broken predicate -> non-blocking, unregistered
  keys -> behaviour unchanged).

Fixes #22737. Reported by @f-trycua.
2026-05-09 13:02:25 -07:00

71 lines
3 KiB
Python

"""Tests for the post_setup install-state gate in `_toolset_needs_configuration_prompt`.
Regression coverage for the cua-driver silent-no-op bug (issue #22737).
When a no-key provider's only install side-effect is a `post_setup` hook
(cua-driver, etc.), the gate function used to fall through to the
`_toolset_has_keys` catch-all, which returned True for any provider with
empty `env_vars` — causing `hermes tools` to write the toolset to config
and exit `✓ Saved` without ever invoking the post_setup install. These
tests pin the new predicate-aware behaviour so the regression doesn't
sneak back in.
"""
from __future__ import annotations
class TestPostSetupGate:
def test_cua_driver_missing_forces_setup(self, monkeypatch, tmp_path):
"""When cua-driver isn't on PATH, the gate must return True so the
provider-setup flow runs and triggers `_run_post_setup`."""
from hermes_cli import tools_config
monkeypatch.setenv("HERMES_HOME", str(tmp_path))
monkeypatch.setattr(tools_config.shutil, "which", lambda name: None)
assert tools_config._toolset_needs_configuration_prompt(
"computer_use", {}
) is True
def test_cua_driver_installed_skips_setup(self, monkeypatch, tmp_path):
"""When cua-driver is already on PATH, the gate must return False
so a re-save through `hermes tools` doesn't re-prompt the user."""
from hermes_cli import tools_config
monkeypatch.setenv("HERMES_HOME", str(tmp_path))
monkeypatch.setattr(
tools_config.shutil,
"which",
lambda name: "/usr/local/bin/cua-driver" if name == "cua-driver" else None,
)
assert tools_config._toolset_needs_configuration_prompt(
"computer_use", {}
) is False
def test_post_setup_predicate_exception_does_not_block(self, monkeypatch):
"""A predicate that raises must be treated as 'satisfied' so a
broken check can't strand the user in an infinite setup loop."""
from hermes_cli import tools_config
def _boom():
raise RuntimeError("predicate broken")
monkeypatch.setitem(tools_config._POST_SETUP_INSTALLED, "cua_driver", _boom)
assert tools_config._post_setup_already_installed("cua_driver") is True
def test_unregistered_post_setup_treated_as_satisfied(self):
"""post_setup keys without a registered predicate must default to
'satisfied' so we don't change behaviour for hooks we haven't
explicitly opted in (kittentts, piper, agent_browser, etc.)."""
from hermes_cli import tools_config
assert tools_config._post_setup_already_installed("does_not_exist") is True
def test_cua_driver_predicate_registered(self):
"""Keep an explicit pin on the cua_driver entry so accidental
deletion of the registry row would fail this test rather than
silently restore the original silent-no-op bug."""
from hermes_cli import tools_config
assert "cua_driver" in tools_config._POST_SETUP_INSTALLED