Simone/local-ci-cd-system
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(cli): rename vmgui command to vmware

Browse Source 
Rename the GUI launcher command from `vmgui` to `vmware` (`ci vmware ...`).
Updates the click command name, function, log-file prefix, __main__
registration, tests and runbook references. Behaviour unchanged.
This commit is contained in:
Simone
2026-06-08 00:32:13 +02:00
parent b74e854d48
commit de5348c36c
4 changed files with 45 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/RUNBOOK-PhaseC.md
+9 -9
View File
@@ -69,7 +69,7 @@ The script defines two helpers:
| `ci artifacts collect ...` | copy artifacts out of a guest | §4 |
| `ci vm remove --vmx ...` | stop + delete one clone | §4 |
| `ci vm cleanup` | sweep orphaned clones + stale locks | §4 / §6 |
| `ci vmgui --vmx ...` | open a VMX in the VMware Workstation GUI | §4 |
| `ci vmware --vmx ...` | open a VMX in the VMware Workstation GUI | §4 |
| `ci creds set --user ...` | store guest credentials in keyring | §5 |
| `ci template deploy-linux` | build the Linux template VM | §5 |
| `ci template prepare-linux` | provision Linux template over SSH | §5 |
@@ -217,19 +217,19 @@ Launches the **interactive** VMware Workstation GUI (not the headless vmrun path
so you can watch/poke a clone by hand.
On a normal desktop session it just works — `sudo` already forwards `DISPLAY`,
and `vmgui` behaves exactly like `sudo -u ci-runner vmware`:
and `vmware` behaves exactly like `sudo -u ci-runner vmware`:
```bash
ci vmgui # bare GUI, no VM
ci vmgui --vmx /var/lib/ci/build-vms/Clone_dbg-1_*/Clone_dbg-1_*.vmx
ci vmgui --vmx <path> --power-on # power it on (-x)
ci vmgui --vmx <path> --fullscreen # power on + fullscreen (-X)
ci vmware # bare GUI, no VM
ci vmware --vmx /var/lib/ci/build-vms/Clone_dbg-1_*/Clone_dbg-1_*.vmx
ci vmware --vmx <path> --power-on # power it on (-x)
ci vmware --vmx <path> --fullscreen # power on + fullscreen (-X)
```
Other flags: `--new-window` (`-n`), `--display :0` (force a display if `$DISPLAY`
isn't forwarded), `--vmware-path`. Spawns detached; prints PID + log path.
**Why it works**: VMware connects via the X **host ACL**, not the cookie. The
inherited `XAUTHORITY` (the desktop user's `~/.Xauthority`) is unreadable by
ci-runner, so `vmgui` drops it and relies on the xhost grant — which is normally
ci-runner, so `vmware` drops it and relies on the xhost grant — which is normally
already present (`xhost` lists `SI:localuser:ci-runner`).
**Only if you get `cannot open X display`**: the grant is missing. Add it from
@@ -237,8 +237,8 @@ the logged-in desktop user (not ci-runner):
```bash
xhost +SI:localuser:ci-runner
```
`vmgui` pre-flights the display (`xdpyinfo`) and prints this exact command on
failure instead of dying silently; the GUI's output is captured in `/tmp/vmgui-*.log`.
`vmware` pre-flights the display (`xdpyinfo`) and prints this exact command on
failure instead of dying silently; the GUI's output is captured in `/tmp/vmware-*.log`.
---