Chuyển đến nội dung chính

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

  • Bộ công cụ kiểm thử đầy đủ (bộ kiểm thử, kiểm thử trực tiếp, Docker): Kiểm thử
  • pnpm test:force: Dừng mọi tiến trình Gateway còn sót lại đang giữ cổng điều khiển mặc định, sau đó chạy toàn bộ bộ Vitest với một cổng Gateway biệt lập để các kiểm thử máy chủ không va chạm với một phiên bản đang chạy. Dùng lệnh này khi một lần chạy Gateway trước đó khiến cổng 18789 bị chiếm.
  • pnpm test:coverage: Chạy bộ đơn vị với coverage V8 (thông qua vitest.unit.config.ts). Đây là gate coverage đơn vị theo tệp đã tải, không phải coverage toàn bộ tệp trong toàn repo. Ngưỡng là 70% cho dòng/hàm/câu lệnh và 55% cho nhánh. Vì coverage.all là false, gate này đo các tệp được bộ coverage đơn vị tải thay vì xem mọi tệp nguồn thuộc lane đã tách là chưa được coverage.
  • pnpm test:coverage:changed: Chỉ chạy coverage đơn vị cho các tệp đã thay đổi kể từ origin/main.
  • pnpm test:changed: lần chạy kiểm thử thay đổi thông minh, chi phí thấp. Nó chạy các mục tiêu chính xác từ chỉnh sửa kiểm thử trực tiếp, các tệp *.test.ts cùng cấp, ánh xạ nguồn tường minh và đồ thị import cục bộ. Các thay đổi rộng/config/package bị bỏ qua trừ khi chúng ánh xạ đến các kiểm thử chính xác.
  • OPENCLAW_TEST_CHANGED_BROAD=1 pnpm test:changed: lần chạy kiểm thử thay đổi rộng tường minh. Dùng khi một chỉnh sửa về test harness/config/package nên rơi về hành vi kiểm thử thay đổi rộng hơn của Vitest.
  • pnpm changed:lanes: hiển thị các lane kiến trúc được kích hoạt bởi diff so với origin/main.
  • pnpm check:changed: chạy gate kiểm tra thay đổi thông minh cho diff so với origin/main. Nó chạy typecheck, lint và các lệnh guard cho các lane kiến trúc bị ảnh hưởng, nhưng không chạy kiểm thử Vitest. Dùng pnpm test:changed hoặc pnpm test <target> tường minh để có bằng chứng kiểm thử.
  • pnpm test: định tuyến các mục tiêu tệp/thư mục tường minh qua các lane Vitest có phạm vi. Các lần chạy không chỉ định mục tiêu dùng các nhóm shard cố định và mở rộng thành các cấu hình lá để thực thi song song cục bộ; nhóm plugin luôn mở rộng thành các cấu hình shard theo từng plugin thay vì một tiến trình root-project khổng lồ.
  • Các lần chạy test wrapper kết thúc bằng một tóm tắt ngắn dạng [test] passed|failed|skipped ... in .... Dòng thời lượng riêng của Vitest vẫn là chi tiết theo từng shard.
  • Trạng thái kiểm thử OpenClaw dùng chung: dùng src/test-utils/openclaw-test-state.ts từ Vitest khi một kiểm thử cần HOME, OPENCLAW_STATE_DIR, OPENCLAW_CONFIG_PATH, fixture cấu hình, workspace, thư mục agent hoặc kho auth-profile biệt lập.
  • Trình trợ giúp E2E tiến trình: dùng test/helpers/openclaw-test-instance.ts khi một kiểm thử E2E cấp tiến trình Vitest cần Gateway đang chạy, env CLI, thu thập log và dọn dẹp ở một nơi.
  • Trình trợ giúp E2E Docker/Bash: các lane source scripts/lib/docker-e2e-image.sh có thể truyền docker_e2e_test_state_shell_b64 <label> <scenario> vào container và giải mã bằng scripts/lib/openclaw-e2e-instance.sh; các script nhiều home có thể truyền docker_e2e_test_state_function_b64 và gọi openclaw_test_state_create <label> <scenario> trong từng luồng. Các caller cấp thấp hơn có thể dùng scripts/lib/openclaw-test-state.mjs shell --label <name> --scenario <name> cho một đoạn shell trong container, hoặc node scripts/lib/openclaw-test-state.mjs -- create --label <name> --scenario <name> --env-file <path> --json cho một tệp env host có thể source. Dấu -- trước create ngăn các runtime Node mới hơn xem --env-file là cờ Node. Các lane Docker/Bash khởi chạy Gateway có thể source scripts/lib/openclaw-e2e-instance.sh bên trong container để phân giải entrypoint, khởi động OpenAI giả lập, khởi chạy Gateway foreground/background, probe readiness, xuất env trạng thái, dump log và dọn dẹp tiến trình.
  • Các lần chạy shard đầy đủ, plugin và include-pattern cập nhật dữ liệu thời gian cục bộ trong .artifacts/vitest-shard-timings.json; các lần chạy toàn cấu hình sau đó dùng các thời gian này để cân bằng shard chậm và nhanh. Shard CI include-pattern thêm tên shard vào khóa thời gian, nhờ đó thời gian shard đã lọc vẫn hiển thị mà không thay thế dữ liệu thời gian toàn cấu hình. Đặt OPENCLAW_TEST_PROJECTS_TIMINGS=0 để bỏ qua artifact thời gian cục bộ.
  • Các tệp kiểm thử plugin-sdkcommands được chọn giờ định tuyến qua các lane nhẹ chuyên dụng chỉ giữ test/setup.ts, còn các trường hợp nặng về runtime vẫn nằm trên lane hiện có.
  • Các tệp nguồn có kiểm thử cùng cấp ánh xạ đến tệp cùng cấp đó trước khi rơi về các glob thư mục rộng hơn. Chỉnh sửa helper dưới src/channels/plugins/contracts/test-helpers, src/plugin-sdk/test-helperssrc/plugins/contracts dùng đồ thị import cục bộ để chạy các kiểm thử import chúng thay vì chạy rộng mọi shard khi đường dẫn phụ thuộc là chính xác.
  • auto-reply giờ cũng tách thành ba cấu hình chuyên dụng (core, top-level, reply) để harness reply không lấn át các kiểm thử trạng thái/token/helper top-level nhẹ hơn.
  • Cấu hình Vitest cơ sở giờ mặc định là pool: "threads"isolate: false, với runner không biệt lập dùng chung được bật trên các cấu hình repo.
  • pnpm test:channels chạy vitest.channels.config.ts.
  • pnpm test:extensionspnpm test extensions chạy tất cả shard plugin. Các plugin kênh nặng, plugin trình duyệt và OpenAI chạy như shard chuyên dụng; các nhóm plugin khác vẫn được gom lô. Dùng pnpm test extensions/<id> cho một lane plugin tích hợp sẵn.
  • pnpm test:perf:imports: bật báo cáo thời lượng import + phân tích import của Vitest, trong khi vẫn dùng định tuyến lane có phạm vi cho các mục tiêu tệp/thư mục tường minh.
  • pnpm test:perf:imports:changed: profiling import tương tự, nhưng chỉ cho các tệp đã thay đổi kể từ origin/main.
  • pnpm test:perf:changed:bench -- --ref <git-ref> benchmark đường dẫn changed-mode đã định tuyến so với lần chạy root-project native cho cùng một diff git đã commit.
  • pnpm test:perf:changed:bench -- --worktree benchmark tập thay đổi worktree hiện tại mà không cần commit trước.
  • pnpm test:perf:profile:main: ghi một CPU profile cho main thread của Vitest (.artifacts/vitest-main-profile).
  • pnpm test:perf:profile:runner: ghi CPU + heap profile cho runner đơn vị (.artifacts/vitest-runner-profile).
  • pnpm test:perf:groups --full-suite --allow-failures --output .artifacts/test-perf/baseline-before.json: chạy tuần tự mọi cấu hình lá Vitest full-suite và ghi dữ liệu thời lượng theo nhóm cùng các artifact JSON/log theo từng cấu hình. Test Performance Agent dùng dữ liệu này làm baseline trước khi thử sửa các kiểm thử chậm.
  • pnpm test:perf:groups:compare .artifacts/test-perf/baseline-before.json .artifacts/test-perf/after-agent.json: so sánh các báo cáo theo nhóm sau một thay đổi tập trung vào hiệu năng.
  • Tích hợp Gateway: bật tùy chọn qua OPENCLAW_TEST_INCLUDE_GATEWAY=1 pnpm test hoặc pnpm test:gateway.
  • pnpm test:e2e: Chạy các kiểm thử smoke end-to-end Gateway (ghép cặp nhiều phiên bản WS/HTTP/node). Mặc định dùng threads + isolate: false với worker thích ứng trong vitest.e2e.config.ts; tinh chỉnh bằng OPENCLAW_E2E_WORKERS=<n> và đặt OPENCLAW_E2E_VERBOSE=1 để có log chi tiết.
  • pnpm test:live: Chạy kiểm thử live của provider (minimax/zai). Yêu cầu khóa API và LIVE=1 (hoặc *_LIVE_TEST=1 theo từng provider) để bỏ skip.
  • pnpm test:docker:all: Build image live-test dùng chung, đóng gói OpenClaw một lần thành npm tarball, build/tái sử dụng một image runner Node/Git tối giản cùng một image chức năng cài tarball đó vào /app, rồi chạy các lane smoke Docker với OPENCLAW_SKIP_DOCKER_BUILD=1 qua một scheduler có trọng số. Image tối giản (OPENCLAW_DOCKER_E2E_BARE_IMAGE) được dùng cho các lane installer/update/plugin-dependency; các lane này mount tarball đã build sẵn thay vì dùng nguồn repo được sao chép. Image chức năng (OPENCLAW_DOCKER_E2E_FUNCTIONAL_IMAGE) được dùng cho các lane chức năng built-app thông thường. scripts/package-openclaw-for-docker.mjs là trình đóng gói package local/CI duy nhất và xác thực tarball cùng dist/postinstall-inventory.json trước khi Docker tiêu thụ. Định nghĩa lane Docker nằm trong scripts/lib/docker-e2e-scenarios.mjs; logic planner nằm trong scripts/lib/docker-e2e-plan.mjs; scripts/test-docker-all.mjs thực thi plan đã chọn. node scripts/test-docker-all.mjs --plan-json phát ra plan CI do scheduler sở hữu cho các lane được chọn, loại image, nhu cầu package/live-image, kịch bản trạng thái và kiểm tra credential mà không build hoặc chạy Docker. OPENCLAW_DOCKER_ALL_PARALLELISM=<n> điều khiển slot tiến trình và mặc định là 10; OPENCLAW_DOCKER_ALL_TAIL_PARALLELISM=<n> điều khiển tail pool nhạy với provider và mặc định là 10. Giới hạn lane nặng mặc định là OPENCLAW_DOCKER_ALL_LIVE_LIMIT=9, OPENCLAW_DOCKER_ALL_NPM_LIMIT=10OPENCLAW_DOCKER_ALL_SERVICE_LIMIT=7; giới hạn provider mặc định là một lane nặng cho mỗi provider qua OPENCLAW_DOCKER_ALL_LIVE_CLAUDE_LIMIT=4, OPENCLAW_DOCKER_ALL_LIVE_CODEX_LIMIT=4OPENCLAW_DOCKER_ALL_LIVE_GEMINI_LIMIT=4. Dùng OPENCLAW_DOCKER_ALL_WEIGHT_LIMIT hoặc OPENCLAW_DOCKER_ALL_DOCKER_LIMIT cho các host lớn hơn. Nếu một lane vượt quá trọng số hiệu dụng hoặc giới hạn tài nguyên trên host có mức song song thấp, nó vẫn có thể bắt đầu từ một pool trống và sẽ chạy một mình cho đến khi giải phóng dung lượng. Mặc định, thời điểm bắt đầu lane được giãn cách 2 giây để tránh bão tạo của daemon Docker cục bộ; ghi đè bằng OPENCLAW_DOCKER_ALL_START_STAGGER_MS=<ms>. Runner mặc định preflight Docker, dọn các container E2E OpenClaw cũ, phát trạng thái lane đang hoạt động mỗi 30 giây, chia sẻ cache công cụ CLI provider giữa các lane tương thích, thử lại lỗi provider live tạm thời một lần theo mặc định (OPENCLAW_DOCKER_ALL_LIVE_RETRIES=<n>) và lưu thời gian lane trong .artifacts/docker-tests/lane-timings.json để sắp xếp dài nhất trước trong các lần chạy sau. Dùng OPENCLAW_DOCKER_ALL_DRY_RUN=1 để in manifest lane mà không chạy Docker, OPENCLAW_DOCKER_ALL_STATUS_INTERVAL_MS=<ms> để tinh chỉnh đầu ra trạng thái, hoặc OPENCLAW_DOCKER_ALL_TIMINGS=0 để tắt tái sử dụng thời gian. Dùng OPENCLAW_DOCKER_ALL_LIVE_MODE=skip chỉ cho các lane tất định/cục bộ hoặc OPENCLAW_DOCKER_ALL_LIVE_MODE=only chỉ cho các lane provider live; alias package là pnpm test:docker:local:allpnpm test:docker:live:all. Chế độ chỉ live hợp nhất các lane live main và tail vào một pool dài nhất trước để các bucket provider có thể đóng gói công việc Claude, Codex và Gemini cùng nhau. Runner dừng lập lịch các lane pooled mới sau lỗi đầu tiên trừ khi đặt OPENCLAW_DOCKER_ALL_FAIL_FAST=0, và mỗi lane có timeout dự phòng 120 phút có thể ghi đè bằng OPENCLAW_DOCKER_ALL_LANE_TIMEOUT_MS; các lane live/tail được chọn dùng giới hạn chặt hơn theo từng lane. Các lệnh thiết lập Docker backend CLI có timeout riêng qua OPENCLAW_LIVE_CLI_BACKEND_SETUP_TIMEOUT_SECONDS (mặc định 180). Log theo từng lane, summary.json, failures.json và thời gian theo phase được ghi dưới .artifacts/docker-tests/<run-id>/; dùng pnpm test:docker:timings <summary.json> để kiểm tra các lane chậm và pnpm test:docker:rerun <run-id|summary.json|failures.json> để in các lệnh chạy lại có mục tiêu, chi phí thấp.
  • pnpm test:docker:browser-cdp-snapshot: Build một container E2E nguồn dựa trên Chromium, khởi động CDP thô cùng một Gateway biệt lập, chạy browser doctor --deep và xác minh snapshot vai trò CDP bao gồm URL liên kết, phần tử có thể nhấp được đẩy lên từ con trỏ, tham chiếu iframe và metadata frame.
  • Probe Docker live backend CLI có thể chạy như các lane tập trung, ví dụ pnpm test:docker:live-cli-backend:codex, pnpm test:docker:live-cli-backend:codex:resume hoặc pnpm test:docker:live-cli-backend:codex:mcp. Claude và Gemini có các alias :resume:mcp tương ứng.
  • pnpm test:docker:openwebui: Khởi động OpenClaw + Open WebUI trong Docker, đăng nhập qua Open WebUI, kiểm tra /api/models, rồi chạy một cuộc trò chuyện được proxy thật qua /api/chat/completions. Yêu cầu một khóa mô hình live dùng được (ví dụ OpenAI trong ~/.profile), kéo một image Open WebUI bên ngoài và không được kỳ vọng ổn định trong CI như các bộ unit/e2e thông thường.
  • pnpm test:docker:mcp-channels: Khởi động một container Gateway đã seed và một container client thứ hai spawn openclaw mcp serve, rồi xác minh khám phá cuộc hội thoại đã định tuyến, đọc transcript, metadata tệp đính kèm, hành vi hàng đợi sự kiện live, định tuyến gửi outbound và thông báo kênh + quyền kiểu Claude qua bridge stdio thật. Assertion thông báo Claude đọc trực tiếp các frame MCP stdio thô để smoke phản ánh đúng những gì bridge thực sự phát ra.

Gate PR cục bộ

Để chạy các kiểm tra land/gate PR cục bộ, hãy chạy:
  • pnpm check:changed
  • pnpm check
  • pnpm check:test-types
  • pnpm build
  • pnpm test
  • pnpm check:docs
Nếu pnpm test thất bại không ổn định trên một máy chủ đang tải cao, hãy chạy lại một lần trước khi coi đó là lỗi hồi quy, rồi cô lập bằng pnpm test <path/to/test>. Với các máy chủ bị hạn chế bộ nhớ, hãy dùng:
  • OPENCLAW_VITEST_MAX_WORKERS=1 pnpm test
  • OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/tmp/openclaw-vitest-cache pnpm test:changed

Benchmark độ trễ mô hình (khóa cục bộ)

Tập lệnh: scripts/bench-model.ts Cách dùng:
  • source ~/.profile && pnpm tsx scripts/bench-model.ts --runs 10
  • Biến môi trường tùy chọn: MINIMAX_API_KEY, MINIMAX_BASE_URL, MINIMAX_MODEL, ANTHROPIC_API_KEY
  • Lời nhắc mặc định: “Trả lời bằng một từ duy nhất: ok. Không dùng dấu câu hoặc văn bản bổ sung.”
Lần chạy gần nhất (2025-12-31, 20 lần chạy):
  • minimax trung vị 1279ms (tối thiểu 1114, tối đa 2431)
  • opus trung vị 2454ms (tối thiểu 1224, tối đa 3170)

Benchmark khởi động CLI

Tập lệnh: scripts/bench-cli-startup.ts Cách dùng:
  • pnpm test:startup:bench
  • pnpm test:startup:bench:smoke
  • pnpm test:startup:bench:save
  • pnpm test:startup:bench:update
  • pnpm test:startup:bench:check
  • pnpm tsx scripts/bench-cli-startup.ts
  • pnpm tsx scripts/bench-cli-startup.ts --runs 12
  • pnpm tsx scripts/bench-cli-startup.ts --preset real
  • pnpm tsx scripts/bench-cli-startup.ts --preset real --case status --case gatewayStatus --runs 3
  • pnpm tsx scripts/bench-cli-startup.ts --preset real --case tasksJson --case tasksListJson --case tasksAuditJson --runs 3
  • pnpm tsx scripts/bench-cli-startup.ts --entry openclaw.mjs --entry-secondary dist/entry.js --preset all
  • pnpm tsx scripts/bench-cli-startup.ts --preset all --output .artifacts/cli-startup-bench-all.json
  • pnpm tsx scripts/bench-cli-startup.ts --preset real --case gatewayStatusJson --output .artifacts/cli-startup-bench-smoke.json
  • pnpm tsx scripts/bench-cli-startup.ts --preset real --cpu-prof-dir .artifacts/cli-cpu
  • pnpm tsx scripts/bench-cli-startup.ts --json
Các cấu hình đặt sẵn:
  • startup: --version, --help, health, health --json, status --json, status
  • real: health, status, status --json, sessions, sessions --json, tasks --json, tasks list --json, tasks audit --json, agents list --json, gateway status, gateway status --json, gateway health --json, config get gateway.port
  • all: cả hai cấu hình đặt sẵn
Đầu ra bao gồm sampleCount, trung bình, p50, p95, tối thiểu/tối đa, phân bố mã thoát/tín hiệu và tóm tắt RSS tối đa cho từng lệnh. --cpu-prof-dir / --heap-prof-dir tùy chọn ghi hồ sơ V8 cho mỗi lần chạy để phép đo thời gian và việc thu thập hồ sơ dùng cùng một bộ công cụ. Quy ước đầu ra đã lưu:
  • pnpm test:startup:bench:smoke ghi artifact smoke được nhắm mục tiêu tại .artifacts/cli-startup-bench-smoke.json
  • pnpm test:startup:bench:save ghi artifact bộ đầy đủ tại .artifacts/cli-startup-bench-all.json bằng runs=5warmup=1
  • pnpm test:startup:bench:update làm mới fixture baseline đã được đưa vào repo tại test/fixtures/cli-startup-bench.json bằng runs=5warmup=1
Fixture đã được đưa vào repo:
  • test/fixtures/cli-startup-bench.json
  • Làm mới bằng pnpm test:startup:bench:update
  • So sánh kết quả hiện tại với fixture bằng pnpm test:startup:bench:check

Onboarding E2E (Docker)

Docker là tùy chọn; mục này chỉ cần cho các kiểm thử smoke onboarding trong container. Luồng khởi động nguội đầy đủ trong một container Linux sạch:
scripts/e2e/onboard-docker.sh
Tập lệnh này điều khiển trình hướng dẫn tương tác qua pseudo-tty, xác minh các tệp cấu hình/không gian làm việc/phiên, sau đó khởi động Gateway và chạy openclaw health.

Smoke nhập QR (Docker)

Đảm bảo helper runtime QR được bảo trì tải được dưới các runtime Docker Node được hỗ trợ (mặc định Node 24, tương thích Node 22):
pnpm test:docker:qr

Liên quan