You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 86cf640
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: nix/test-guest/README.md
+1-76Lines changed: 1 addition & 76 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,81 +63,6 @@ List the available distros and configurations:
63
63
nix run .#test-guest -- --list
64
64
```
65
65
66
-
## Run a host or test-guest E2E suite
67
-
68
-
[`e2e/run.sh`](../../e2e/run.sh) builds OpenShell from the current checkout, starts a gateway from a supplied TOML file, and runs one named host-side suite against it. This opt-in path is separate from `mise run e2e:vm`: `e2e/run.sh` selects where the gateway process runs, while the supplied gateway config selects the compute driver. It is not part of the default E2E task or CI graph.
69
-
70
-
Omit both `--vm` and `--with` to run the gateway on the host:
Set `OPENSHELL_E2E_EXPECT_SHUTDOWN_CLOSES=1` when a stacked change must
102
-
classify supervisor and relay transport closures as expected teardown events.
103
-
104
-
Supplying `--with` without `--vm` selects Ubuntu. `--with` is repeatable and configurations run in input order. Supplying `--vm` without `--with` boots the selected base image without adding software. The wrapper validates both values against the test-guest catalogs:
The wrapper always builds the tested binaries; it does not accept packages or use release artifacts. Both modes build a native host `openshell` CLI and a static Linux `openshell-sandbox` for the host architecture. Host mode also builds a native `openshell-gateway` with bundled Z3. VM mode builds a static Linux `openshell` and a Linux GNU `openshell-gateway` with bundled Z3 and a glibc 2.28 floor, then stages all three guest binaries through the VM runner's `--copy` interface.
125
-
126
-
The Linux targets match the host and guest architecture:
These cross-builds use the Zig and `cargo-zigbuild` versions pinned in [`mise.toml`](../../mise.toml). Install the repository's mise tools before running the wrapper. The wrapper also requires Python 3 and OpenSSL; VM mode requires `base64`. Cargo stores outputs in its normal target directory, so later runs reuse current artifacts. VM mode additionally requires the Nix, QEMU, and host-capacity prerequisites above; host mode does not invoke Nix, QEMU, or Ansible.
134
-
135
-
Gateway configs are ordinary, fully resolved TOML files under `e2e/configs/gateway/`. The wrapper does not inspect or rewrite them. It supplies only the bind address, gateway port, plaintext transport, and isolated XDG directories at launch. Use portable relative paths for host files. The initial Docker config points `supervisor_bin` at `.cache/openshell-e2e/bin/openshell-sandbox`; the wrapper stages that path under the repository in host mode and under `/home/openshell` in VM mode. It also generates and stages the local sandbox JWT material referenced by the initial config.
136
-
137
-
Suites are executable scripts under `e2e/suites/` and use lowercase letters, digits, and hyphens for their names. The wrapper exports the selected endpoint, isolated gateway registration, native host CLI path, mode metadata, source config path, and forwarded ports before executing a suite. Add new configs and suites without adding scenario branches to `e2e/run.sh`.
138
-
139
-
Set `OPENSHELL_E2E_KEEP=1` to retain wrapper state after a host-mode run. In VM mode the wrapper also passes `--keep` to the test-guest runner so its overlay and logs remain available.
140
-
141
66
## Open an interactive VM
142
67
143
68
Boot a base Ubuntu VM:
@@ -323,4 +248,4 @@ Use `--keep` to preserve the overlay, cloud-init seed, SSH key, and serial log f
323
248
- Prepared cache entries are architecture-specific and match the exact ordered configuration list.
324
249
- OCI pulls transfer a complete compressed standalone disk; incremental disk layers are not implemented.
325
250
- Guest ports are reachable from the host only when explicitly exposed with loopback-only `--forward-port`.
326
-
- The low-level VM runner does not build OpenShell, configure a gateway, or select an E2E test suite. Use `e2e/run.sh` for that orchestration.
251
+
- The runner does not build OpenShell, configure a gateway, or select an E2E test suite.
0 commit comments