Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
237 changes: 237 additions & 0 deletions tests/comfy_cli/fixtures/cli_command_inventory.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,237 @@
comfy _watch [hidden]
comfy _watch _watch-job
comfy agent
comfy agent allow
comfy agent deny
comfy agent permissions
comfy agent-review [hidden]
comfy assets
comfy assets library
comfy assets library ensure
comfy assets library ls
comfy assets library upload
comfy assets push
comfy auth
comfy auth list
comfy auth remove
comfy auth set
comfy build
comfy build blob [hidden]
comfy build blob ls
comfy build delete
comfy build init
comfy build ls
comfy build pull
comfy build push
comfy build quota
comfy build refs
comfy build refs base-images
comfy build refs build-targets
comfy build refs model-dirs
comfy build refs resolve
comfy build release
comfy build release create
comfy build release delete
comfy build release logs
comfy build release ls
comfy build release manifest
comfy build release show
comfy build show
comfy build status
comfy build update
comfy build validate
comfy cloud
comfy cloud login
comfy cloud logout
comfy cloud set-base-url
comfy cloud set-key
comfy cloud status
comfy cloud whoami
comfy code-search
comfy code-search-context
comfy cs [hidden]
comfy dependency [hidden]
comfy deploy
comfy deploy cancel
comfy deploy delete
comfy deploy events
comfy deploy history
comfy deploy logs
comfy deploy ls
comfy deploy promote
comfy deploy refs
comfy deploy refs compute
comfy deploy rename
comfy deploy rollback
comfy deploy run
comfy deploy scale
comfy deploy show
comfy deploy start
comfy deploy status
comfy deploy stop
comfy deploy up
comfy discover
comfy download
comfy env
comfy feedback
comfy free
comfy generate
comfy help
comfy install
comfy jobs
comfy jobs cancel
comfy jobs ls
comfy jobs status
comfy jobs wait
comfy jobs watch
comfy knowledge
comfy knowledge authoring
comfy knowledge pick
comfy knowledge resolve
comfy knowledge status
comfy launch
comfy logs
comfy manager
comfy manager clear
comfy manager disable
comfy manager disable-gui
comfy manager enable-gui
comfy manager enable-legacy-gui
comfy manager migrate-legacy
comfy manager uv-compile-default
comfy model
comfy model _download-worker [hidden]
comfy model download
comfy model download-cancel
comfy model download-status
comfy model downloads
comfy model list
comfy model list-folder
comfy model list-folders
comfy model remove
comfy model search
comfy model show
comfy model upload
comfy models [hidden]
comfy models list-folder
comfy models list-folders
comfy models search
comfy models show
comfy node
comfy node bisect
comfy node bisect bad
comfy node bisect good
comfy node bisect reset
comfy node bisect start
comfy node deps
comfy node deps-in-workflow
comfy node disable
comfy node enable
comfy node fix
comfy node init
comfy node install
comfy node install-deps
comfy node pack
comfy node publish
comfy node registry-install [hidden]
comfy node registry-list [hidden]
comfy node reinstall
comfy node restore-dependencies
comfy node restore-snapshot
comfy node save-snapshot
comfy node scaffold
comfy node show
comfy node simple-show
comfy node uninstall
comfy node update
comfy node update-cache
comfy node uv-sync
comfy node validate
comfy nodes
comfy nodes categories
comfy nodes downstream
comfy nodes ls
comfy nodes path
comfy nodes refresh
comfy nodes search
comfy nodes show
comfy nodes types
comfy nodes upstream
comfy nodes widget-catalog
comfy outdated
comfy pr-cache
comfy pr-cache clean
comfy pr-cache list
comfy preview
comfy project
comfy project init
comfy project status
comfy run
comfy run-cli
comfy run-template
comfy set-default
comfy setup
comfy skill [hidden]
comfy skill install
comfy skill list
comfy skill show
comfy skill status
comfy skill uninstall
comfy skill validate
comfy skills
comfy skills install
comfy skills list
comfy skills show
comfy skills status
comfy skills uninstall
comfy skills validate
comfy standalone
comfy stop
comfy system-stats
comfy templates
comfy templates _refresh-cache [hidden]
comfy templates check
comfy templates fetch
comfy templates get
comfy templates ls
comfy templates refresh
comfy templates show
comfy tracking
comfy tracking disable
comfy tracking enable
comfy update
comfy upload
comfy validate [hidden]
comfy which
comfy workflow
comfy workflow add-node
comfy workflow apply
comfy workflow capture
comfy workflow check
comfy workflow clear
comfy workflow compose
comfy workflow connect
comfy workflow decompose
comfy workflow delete
comfy workflow delete-node
comfy workflow delete-nodes
comfy workflow disconnect
comfy workflow foreach
comfy workflow fragment
comfy workflow fragment ls
comfy workflow fragment show
comfy workflow fragment validate
comfy workflow get
comfy workflow insert-workflow
comfy workflow list
comfy workflow ls-nodes
comfy workflow notes
comfy workflow print
comfy workflow reset-doc
comfy workflow save
comfy workflow set-node-field
comfy workflow set-slot
comfy workflow set-widget
comfy workflow slots
comfy workflow validate
comfy workflow vary
73 changes: 73 additions & 0 deletions tests/comfy_cli/test_cli_surface.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
"""CLI-surface guard: command-inventory snapshot.

Mirrors the MCP server's ``EXPECTED_TOOLS`` snapshot pattern for the CLI:
:func:`test_command_inventory_snapshot` snapshots the full command tree so any
surface addition/removal/hide shows up as an explicit diff in review.

Regenerate the snapshot after an intentional surface change with::

UPDATE_CLI_SNAPSHOT=1 pytest tests/comfy_cli/test_cli_surface.py

Help/hint strings that name nonexistent commands are linted separately by
``tests/comfy_cli/test_command_mentions.py``.
"""

from __future__ import annotations

import os
from pathlib import Path

import pytest

from comfy_cli.cmdline import app
from comfy_cli.help_json import build_help_json

SNAPSHOT_PATH = Path(__file__).resolve().parent / "fixtures" / "cli_command_inventory.txt"


def _command_inventory() -> list[str]:
"""Every command path (groups + leaves), sorted, with a ``[hidden]`` marker."""
doc = build_help_json(app)
out: list[str] = []

def walk(commands: dict, path: list[str]) -> None:
for name, entry in sorted(commands.items()):
fqp = " ".join(path + [name])
out.append(f"{fqp}\t[hidden]" if entry.get("hidden") else fqp)
subs = entry.get("subcommands")
if subs:
walk(subs, path + [name])

walk(doc["commands"], ["comfy"])
return out


def test_command_inventory_snapshot():
"""The registered command surface matches the committed snapshot."""
current = _command_inventory()
rendered = "\n".join(current) + "\n"

if os.environ.get("UPDATE_CLI_SNAPSHOT", "").strip().lower() in {"1", "true", "yes"}:
SNAPSHOT_PATH.write_text(rendered, encoding="utf-8")
pytest.skip(f"snapshot regenerated: {SNAPSHOT_PATH}")

assert SNAPSHOT_PATH.exists(), (
f"missing snapshot {SNAPSHOT_PATH}; regenerate with "
"`UPDATE_CLI_SNAPSHOT=1 pytest tests/comfy_cli/test_cli_surface.py`"
)
expected = SNAPSHOT_PATH.read_text(encoding="utf-8").splitlines()
if current != expected:
added = sorted(set(current) - set(expected))
removed = sorted(set(expected) - set(current))
detail = ""
if added:
detail += "\n added:\n" + "\n".join(f" + {p}" for p in added)
if removed:
detail += "\n removed:\n" + "\n".join(f" - {p}" for p in removed)
pytest.fail(
"CLI command inventory changed vs. the committed snapshot."
f"{detail}\n\n"
"If intentional, regenerate with "
"`UPDATE_CLI_SNAPSHOT=1 pytest tests/comfy_cli/test_cli_surface.py` "
"and review the diff."
)
1 change: 1 addition & 0 deletions tests/comfy_cli/test_command_mentions.py
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ def test_valid_mentions_pass(text, tree, globals_):
("text", "unknown"),
[
("comfy auth login", "login"), # the original regression itself
("comfy auth whoami", "whoami"), # sibling rot: removed in favour of `comfy cloud whoami`
("comfy cloud singin", "singin"),
("comfy nope", "nope"),
("comfy model downlaod --url x", "downlaod"),
Expand Down
Loading