ComfyUI-Manager/docs/dev/TEST-environment-setup.md
Dr.Lt.Data df072a101f test(deps): add manual test cases for unified dependency resolver
Add environment setup guide and 16 test cases covering:
- Normal batch resolution (TC-1), disabled state (TC-2)
- Fallback paths: uv unavailable (TC-3), compile fail (TC-4),
  install fail (TC-5), generic exception (TC-16)
- install.py preservation (TC-6), runtime defer (TC-13)
- Input sanitization: dangerous patterns (TC-7), path separators
  (TC-8), index-url separation (TC-9), credential redaction (TC-10)
- Disabled pack exclusion (TC-11), no-deps path (TC-12)
- Both unified resolver guard paths (TC-14), post-fallback (TC-15)

Includes API reference, traceability matrix, and out-of-scope items.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-14 07:40:34 +09:00

2.9 KiB

Test Environment Setup

Procedures for setting up a ComfyUI environment with ComfyUI-Manager installed for functional testing.

Prerequisites

  • Python 3.9+
  • Git
  • uv (pip alternative, install via pip install uv)

Environment Setup

1. ComfyUI Clone

COMFY_ROOT=$(mktemp -d)/ComfyUI
git clone https://github.com/comfyanonymous/ComfyUI.git "$COMFY_ROOT"
cd "$COMFY_ROOT"

2. Virtual Environment

cd "$COMFY_ROOT"
uv venv .venv
source .venv/bin/activate    # Linux/macOS
# .venv\Scripts\activate     # Windows

3. ComfyUI Dependencies

# GPU (CUDA)
uv pip install -r requirements.txt --extra-index-url https://download.pytorch.org/whl/cu121

# CPU only (lightweight, for functional testing)
uv pip install -r requirements.txt --extra-index-url https://download.pytorch.org/whl/cpu

4. ComfyUI-Manager Install (Development)

# MANAGER_ROOT = comfyui-manager-draft4 repository root
MANAGER_ROOT=/path/to/comfyui-manager-draft4

# Editable install from current source
uv pip install -e "$MANAGER_ROOT"

Note

: Editable mode (-e) reflects code changes without reinstalling. For production-like testing, use uv pip install "$MANAGER_ROOT" (non-editable).

5. ComfyUI Launch

cd "$COMFY_ROOT"
python main.py --enable-manager --cpu
Flag Purpose
--enable-manager Enable ComfyUI-Manager (disabled by default)
--cpu Run without GPU (for functional testing)
--enable-manager-legacy-ui Enable legacy UI (optional)
--listen Allow remote connections (optional)

Key Directories

Directory Path Description
ComfyUI root $COMFY_ROOT/ ComfyUI installation root
Manager data $COMFY_ROOT/user/__manager/ Manager config, startup scripts, snapshots
Config file $COMFY_ROOT/user/__manager/config.ini Manager settings (use_uv, use_unified_resolver, etc.)
custom_nodes $COMFY_ROOT/custom_nodes/ Installed node packs

The Manager data path is resolved via folder_paths.get_system_user_directory("manager"). Printed at startup: ** ComfyUI-Manager config path: <path>/config.ini

Startup Sequence

When Manager loads successfully, the following log lines appear:

[PRE] ComfyUI-Manager          # prestartup_script.py executed
[START] ComfyUI-Manager         # manager_server.py loaded

Cleanup

deactivate
rm -rf "$COMFY_ROOT"

Quick Reference (Copy-Paste)

# Full setup in one block
COMFY_ROOT=$(mktemp -d)/ComfyUI
MANAGER_ROOT=/path/to/comfyui-manager-draft4

git clone https://github.com/comfyanonymous/ComfyUI.git "$COMFY_ROOT"
cd "$COMFY_ROOT"
uv venv .venv && source .venv/bin/activate
uv pip install -r requirements.txt --extra-index-url https://download.pytorch.org/whl/cpu
uv pip install -e "$MANAGER_ROOT"
python main.py --enable-manager --cpu