From 9d381d4530b9d8b0a6785accb2d4cd571b90b448 Mon Sep 17 00:00:00 2001 From: Vincent Koc <25068+vincentkoc@users.noreply.github.com> Date: Wed, 24 Jun 2026 13:47:52 +0800 Subject: [PATCH] docs(testing): document openshell e2e prerequisites --- docs/help/testing.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/help/testing.md b/docs/help/testing.md index af162a5c315f..32521725e082 100644 --- a/docs/help/testing.md +++ b/docs/help/testing.md @@ -740,17 +740,20 @@ Native dependency policy: - Command: `pnpm test:e2e:openshell` - File: `extensions/openshell/src/backend.e2e.test.ts` - Scope: - - Starts an isolated OpenShell gateway on the host via Docker + - Reuses an active local OpenShell gateway - Creates a sandbox from a temporary local Dockerfile - Exercises OpenClaw's OpenShell backend over real `sandbox ssh-config` + SSH exec - Verifies remote-canonical filesystem behavior through the sandbox fs bridge - Expectations: - Opt-in only; not part of the default `pnpm test:e2e` run - Requires a local `openshell` CLI plus a working Docker daemon - - Uses isolated `HOME` / `XDG_CONFIG_HOME`, then destroys the test gateway and sandbox + - Requires an active local OpenShell gateway and its config source + - Uses isolated `HOME` / `XDG_CONFIG_HOME`, then destroys the test sandbox - Useful overrides: - `OPENCLAW_E2E_OPENSHELL=1` to enable the test when running the broader e2e suite manually - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell` to point at a non-default CLI binary or wrapper script + - `OPENCLAW_E2E_OPENSHELL_CONFIG_HOME=/path/to/config` to expose the registered gateway config to the isolated test + - `OPENCLAW_E2E_OPENSHELL_HOST_IP=172.18.0.1` to override the Docker gateway IP used by the host policy fixture ### Live (real providers + real models)