phoebus_os/docs/DEVELOPMENT.md
Phoebus b120c1e5e4 docs: record AI guidance, desktop reliability and snapshot verification
Update the status matrix, roadmap, changelog and handoff; add the WS4/WS3 VM
evidence and a concise real-VT desktop test procedure.
2026-09-20 05:03:37 -07:00

160 lines
5.4 KiB
Markdown

# Development
## Host requirements
Ubuntu/Debian host names (the development machine is Ubuntu 26.04):
```sh
sudo apt install qemu-system-x86 qemu-utils ovmf-generic seabios ipxe-qemu \
xorriso mtools dosfstools squashfs-tools cpio zstd python3-pexpect
# Rust quality gates (names may be versioned; check `apt search rustfmt`)
sudo apt install rust-clippy rustfmt
# or, if cargo is rustup-managed:
# rustup component add rustfmt clippy
```
Optional: `expect`, `cryptsetup`, `btrfs-progs`, `parted`, `kpartx` for offline
inspection of VM images. `7z`/`p7zip` is useful for reading the reference ISO.
## Reference media
The Gentoo LiveGUI ISO is a **reference artifact**, not source. It is ignored by
`.gitignore`. Keep it outside git; point the VM harness at it by path.
## Rust installer
The Bash prototype has been retired (see `docs/BASH-MIGRATION.md`); the Rust
workspace is the only installer.
```sh
cd installer-rs
cargo fmt --all -- --check
cargo clippy --workspace --all-targets
cargo test --workspace
cargo build --release -p phoebus-installer
# Static binary for the live environment:
RUSTFLAGS="-C target-feature=+crt-static" \
cargo build --release -p phoebus-installer --target x86_64-unknown-linux-gnu
```
Useful CLI invocations:
```sh
target/release/phoebus-installer --config FILE --plan
target/release/phoebus-installer --config FILE --dry-run --install
target/release/phoebus-installer --config FILE --install --yes \
--luks-passphrase-file /secure/luks.pw --user-password-file /secure/user.pw
```
## Disposable VM testing
Never point the harness at a physical disk. The target is always a qcow2 file.
`installer/tests/vm/serial-driver.py` drives QEMU over the serial console:
```sh
cd /path/to/serve
cp /path/to/phoebus_os/installer-rs/target/x86_64-unknown-linux-gnu/release/phoebus-installer .
cp /path/to/phoebus_os/installer/tests/vm/install.sh .
python3 -m http.server 8000 --bind 127.0.0.1
QEMU_BIN=qemu-system-x86_64 \
OVMF_CODE=/usr/share/OVMF/OVMF_CODE_4M.fd \
OVMF_VARS=/usr/share/OVMF/OVMF_VARS_4M.fd \
DISK=/tmp/phoebus/target.qcow2 \
ISO=/path/to/livegui-*.iso \
KERNEL=/tmp/live/boot/gentoo INITRD=/tmp/live/boot/gentoo.igz \
INSTALL_URL=http://10.0.2.2:8000/install.sh \
python3 installer/tests/vm/serial-driver.py install
# Then boot the disk alone (ISO detached):
DISK=/tmp/phoebus/target.qcow2 OVMF_CODE=... OVMF_VARS=... \
python3 installer/tests/vm/serial-driver.py boot
```
`installer/tests/vm/run-vm.sh` launches an interactive VM instead.
### Verifying the graphical stack
The serial-only VM has no logind seat, so wlroots' DRM backend cannot start
there. For headless verification use:
```sh
export WLR_BACKENDS=headless WLR_RENDERER=pixman WLR_RENDERER_ALLOW_SOFTWARE=1
dwl & # creates wayland-0
grim /tmp/shot.png # proves the compositor renders
```
On a real machine the installer writes `/usr/local/bin/phoebus-session`
(dwl + waybar + mako + swaybg + the polkit agent).
### Physical VT / real-seat check (needs a person)
The serial harness has no logind seat, so this must be done on real hardware or
a seat-providing VM. From a text VT (e.g. `Ctrl+Alt+F3`), log in and run:
```sh
/usr/local/bin/phoebus-session
```
Check, in order:
1. `dwl` starts and the screen shows the compositor (no `Failed to start a DRM
session`).
2. `waybar` and `mako` appear only after the compositor is up (they must not
log a failed Wayland connection).
3. Open a terminal: `kitty`. Run an X11 app to exercise XWayland (e.g.
`xterm` or `env -u WAYLAND_DISPLAY kitty` if no X app is installed).
4. Trigger a privilege prompt (e.g. `pkexec true` or a polkit-gnome dialog) and
confirm the authentication agent appears.
5. Log out (`Mod+Shift+e` for dwl). Confirm `waybar`, `mako`, `swaybg` and the
polkit agent are gone (`pgrep -a 'waybar|mako|swaybg|polkit-gnome'` prints
nothing) and that the session returns to the VT login.
6. Reboot and confirm the same result.
Record the result (date, kernel, GPU, pass/fail per step) in
`docs/VM-BOOT-VERIFICATION.md`. A headless wlroots session is not physical-seat
verification.
## Inspecting the reference ISO without booting
```sh
7z l livegui-*.iso
7z x livegui-*.iso image.squashfs boot/gentoo boot/gentoo.igz
unsquashfs -l image.squashfs # file listing
unsquashfs -d /tmp/root image.squashfs etc/portage/make.conf
```
## Make targets
`make help` lists the common tasks. `make context` prints a session briefing
(state, roadmap next steps, handoff), `make doctor` checks the host
prerequisites, and `make test`, `make check`, `make build`, `make static`,
`make hooks`, `make commit MSG="..."`, `make publish`, `make backup`,
`make forgejo-init`, `make public` and `make release TAG=...` wrap the rest.
## Continuous integration
`.forgejo/workflows/ci.yml` mirrors the local gates (`cargo fmt`, `cargo clippy`,
`cargo test`). It runs only once a Forgejo Actions runner is registered for the
repository; see Forgejo's documentation for `act_runner`. Until then, run
`make test` before pushing.
## Backups
The only remotes are self-hosted, so keep off-box copies:
```sh
make backup # writes ~/backups/phoebus/phoebus-<stamp>.bundle
```
Restore with `git clone /path/to/phoebus-<stamp>.bundle phoebus_os`.
## Quality gates before commit
1. `make test` (`cd installer-rs && cargo test --workspace`)
2. `cargo fmt --all -- --check` and `cargo clippy --workspace --all-targets`
3. Update `docs/CHANGELOG.md` and `docs/STATUS.md` when behavior changes.
4. Commit (see `docs/GIT-WORKFLOW.md`).