feat: show why units failed, with their last journal lines
Failed jobs keep their kind: units that broke or timed out get a failure panel entry with the reason systemd reports (exit status, signal, timeout, start limit, status text) and their last journal lines read through libsystemd. Units that failed only through a dependency are dimmed and left out of the panel, and units that crash after starting count as failed. Restructure the repository around this: - move the library and binary into bootvine/ and the scripted demos into their own unpublished scripted-demos crate, with their VHS tapes - move the crane builds and NixOS module into nix/ - group each sample VM with its check under vm-tests/, adding text-console, scripted-initrd, encrypted-volume and failures machines and a vm-failures check - add docs/guide.md walking through the screen with every recording, keep one recording in the README, and re-render all recordings
This commit is contained in:
1 parent
f2544a964a
commit
7e95cbd8e9
96 files changed
+2027
-462
No files matched your search
@@ -0,0 +1,195 @@
|
||||
use std::{io, time::Duration};
|
||||
|
||||
use bootvine::boot_model::Phase;
|
||||
use scripted_demos::scripted_boot::{Scenario, ScriptedFailure, Step, failing, play, step};
|
||||
|
||||
const INITRD: &[Step] = &[
|
||||
step(
|
||||
"initrd.target",
|
||||
&["initrd-fs.target", "initrd-root-device.target"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step("initrd-fs.target", &["sysroot.mount"], Duration::ZERO),
|
||||
step(
|
||||
"initrd-root-device.target",
|
||||
&["dev-disk-by\\x2dlabel-nixos.device"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
"sysroot.mount",
|
||||
&["systemd-fsck-root.service"],
|
||||
Duration::from_millis(300),
|
||||
),
|
||||
step(
|
||||
"systemd-fsck-root.service",
|
||||
&["dev-disk-by\\x2dlabel-nixos.device"],
|
||||
Duration::from_millis(500),
|
||||
),
|
||||
step(
|
||||
"dev-disk-by\\x2dlabel-nixos.device",
|
||||
&[],
|
||||
Duration::from_millis(1200),
|
||||
),
|
||||
step("systemd-udevd.service", &[], Duration::from_millis(400)),
|
||||
step(
|
||||
"demo-initrd-probe.service",
|
||||
&[],
|
||||
Duration::from_millis(2500),
|
||||
),
|
||||
];
|
||||
|
||||
const HOST: &[Step] = &[
|
||||
step(
|
||||
"graphical.target",
|
||||
&["multi-user.target", "display-manager.service"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
"display-manager.service",
|
||||
&["multi-user.target"],
|
||||
Duration::from_millis(400),
|
||||
),
|
||||
step(
|
||||
"multi-user.target",
|
||||
&[
|
||||
"basic.target",
|
||||
"NetworkManager-wait-online.service",
|
||||
"docker.service",
|
||||
"tailscaled.service",
|
||||
"nvidia-powerd.service",
|
||||
"systemd-rfkill.service",
|
||||
],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step("basic.target", &["sysinit.target"], Duration::ZERO),
|
||||
step(
|
||||
"sysinit.target",
|
||||
&[
|
||||
"systemd-tmpfiles-setup.service",
|
||||
"systemd-udev-trigger.service",
|
||||
],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
"systemd-tmpfiles-setup.service",
|
||||
&[],
|
||||
Duration::from_millis(600),
|
||||
),
|
||||
step(
|
||||
"systemd-udev-trigger.service",
|
||||
&[],
|
||||
Duration::from_millis(900),
|
||||
),
|
||||
step(
|
||||
"NetworkManager.service",
|
||||
&["basic.target"],
|
||||
Duration::from_millis(1500),
|
||||
),
|
||||
step(
|
||||
"NetworkManager-wait-online.service",
|
||||
&["NetworkManager.service"],
|
||||
Duration::from_millis(3500),
|
||||
),
|
||||
step(
|
||||
"network-online.target",
|
||||
&["NetworkManager-wait-online.service"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
"tailscaled.service",
|
||||
&["network-online.target"],
|
||||
Duration::from_millis(1200),
|
||||
),
|
||||
step(
|
||||
"containerd.service",
|
||||
&["basic.target"],
|
||||
Duration::from_millis(800),
|
||||
),
|
||||
step(
|
||||
"docker.socket",
|
||||
&["basic.target"],
|
||||
Duration::from_millis(200),
|
||||
),
|
||||
step("var-lib-docker.mount", &[], Duration::from_millis(1800)),
|
||||
step(
|
||||
"docker.service",
|
||||
&[
|
||||
"containerd.service",
|
||||
"docker.socket",
|
||||
"var-lib-docker.mount",
|
||||
"network-online.target",
|
||||
],
|
||||
Duration::from_millis(1500),
|
||||
),
|
||||
failing(
|
||||
"nvidia-powerd.service",
|
||||
&["basic.target"],
|
||||
Duration::from_millis(700),
|
||||
ScriptedFailure {
|
||||
reason: "exited with status 1",
|
||||
log_lines: &[
|
||||
"nvidia-powerd version:1.0(build 1)",
|
||||
"ERROR! Failed to get system power limits",
|
||||
"ERROR! Client (presumably SBIOS) has not registered for D-Notify events",
|
||||
],
|
||||
},
|
||||
),
|
||||
step(
|
||||
"sys-devices-virtual-misc-rfkill.device",
|
||||
&[],
|
||||
Duration::from_millis(7000),
|
||||
)
|
||||
.timing_out_after(Duration::from_secs(90)),
|
||||
step(
|
||||
"systemd-rfkill.service",
|
||||
&["sys-devices-virtual-misc-rfkill.device"],
|
||||
Duration::from_millis(300),
|
||||
),
|
||||
];
|
||||
|
||||
fn description(unit: &str) -> Option<&'static str> {
|
||||
let description = match unit {
|
||||
"initrd.target" => "Initrd Default Target",
|
||||
"initrd-fs.target" => "Initrd File Systems",
|
||||
"initrd-root-device.target" => "Initrd Root Device",
|
||||
"sysroot.mount" => "/sysroot",
|
||||
"systemd-fsck-root.service" => "File System Check on Root Device",
|
||||
"dev-disk-by\\x2dlabel-nixos.device" => "/dev/disk/by-label/nixos",
|
||||
"systemd-udevd.service" => "Rule-based Manager for Device Events and Files",
|
||||
"demo-initrd-probe.service" => "Slow hardware probe",
|
||||
"graphical.target" => "Graphical Interface",
|
||||
"display-manager.service" => "Display Manager",
|
||||
"multi-user.target" => "Multi-User System",
|
||||
"basic.target" => "Basic System",
|
||||
"sysinit.target" => "System Initialization",
|
||||
"systemd-tmpfiles-setup.service" => "Create System Files and Directories",
|
||||
"systemd-udev-trigger.service" => "Coldplug All udev Devices",
|
||||
"NetworkManager.service" => "Network Manager",
|
||||
"NetworkManager-wait-online.service" => "Network Manager Wait Online",
|
||||
"network-online.target" => "Network is Online",
|
||||
"tailscaled.service" => "Tailscale node agent",
|
||||
"containerd.service" => "containerd container runtime",
|
||||
"docker.socket" => "Docker Socket for the API",
|
||||
"docker.service" => "Docker Application Container Engine",
|
||||
"var-lib-docker.mount" => "/var/lib/docker",
|
||||
"nvidia-powerd.service" => "NVIDIA Dynamic Boost",
|
||||
"sys-devices-virtual-misc-rfkill.device" => "/sys/devices/virtual/misc/rfkill",
|
||||
"systemd-rfkill.service" => "Load/Save RF Kill Switch Status",
|
||||
_ => return None,
|
||||
};
|
||||
Some(description)
|
||||
}
|
||||
|
||||
fn main() -> io::Result<()> {
|
||||
ratatui::run(|terminal| {
|
||||
play(
|
||||
terminal,
|
||||
&Scenario {
|
||||
phase: Phase::Initrd,
|
||||
steps: INITRD,
|
||||
after_switch_root: HOST,
|
||||
describe: description,
|
||||
},
|
||||
)
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1,203 @@
|
||||
use std::{io, time::Duration};
|
||||
|
||||
use bootvine::boot_model::Phase;
|
||||
use scripted_demos::scripted_boot::{Scenario, Step, play, step, unlocking};
|
||||
|
||||
const ROOT_PARTITION: &str =
|
||||
"dev-disk-by\\x2duuid-7c2e9f4a\\x2d1b3d\\x2d4e8f\\x2d9a6c\\x2d2d5b8e1f0c3a.device";
|
||||
|
||||
const INITRD: &[Step] = &[
|
||||
step(
|
||||
"initrd.target",
|
||||
&["initrd-fs.target", "initrd-root-fs.target"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
"initrd-fs.target",
|
||||
&["initrd-root-fs.target"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step("initrd-root-fs.target", &["sysroot.mount"], Duration::ZERO),
|
||||
step(
|
||||
"sysroot.mount",
|
||||
&["systemd-fsck-root.service"],
|
||||
Duration::from_millis(400),
|
||||
),
|
||||
step(
|
||||
"systemd-fsck-root.service",
|
||||
&["initrd-root-device.target"],
|
||||
Duration::from_millis(600),
|
||||
),
|
||||
step(
|
||||
"initrd-root-device.target",
|
||||
&["dev-mapper-cryptroot.device"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
"dev-mapper-cryptroot.device",
|
||||
&["cryptsetup.target"],
|
||||
Duration::from_millis(100),
|
||||
),
|
||||
step(
|
||||
"cryptsetup.target",
|
||||
&["systemd-cryptsetup@cryptroot.service"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
unlocking(
|
||||
"systemd-cryptsetup@cryptroot.service",
|
||||
&["cryptsetup-pre.target", ROOT_PARTITION],
|
||||
"Please enter passphrase for disk Samsung SSD 980 PRO 1TB (cryptroot):",
|
||||
Duration::from_millis(2000),
|
||||
),
|
||||
step(
|
||||
"cryptsetup-pre.target",
|
||||
&["systemd-udevd.service"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
ROOT_PARTITION,
|
||||
&["systemd-udev-trigger.service"],
|
||||
Duration::from_millis(1100),
|
||||
),
|
||||
step(
|
||||
"systemd-udev-trigger.service",
|
||||
&["systemd-udevd.service"],
|
||||
Duration::from_millis(500),
|
||||
),
|
||||
step(
|
||||
"systemd-udevd.service",
|
||||
&["systemd-tmpfiles-setup-dev.service"],
|
||||
Duration::from_millis(200),
|
||||
),
|
||||
step(
|
||||
"systemd-tmpfiles-setup-dev.service",
|
||||
&["kmod-static-nodes.service"],
|
||||
Duration::from_millis(100),
|
||||
),
|
||||
step("kmod-static-nodes.service", &[], Duration::from_millis(100)),
|
||||
step("systemd-journald.service", &[], Duration::from_millis(300)),
|
||||
step(
|
||||
"systemd-modules-load.service",
|
||||
&[],
|
||||
Duration::from_millis(900),
|
||||
),
|
||||
step(
|
||||
"systemd-vconsole-setup.service",
|
||||
&["systemd-modules-load.service"],
|
||||
Duration::from_millis(200),
|
||||
),
|
||||
step(
|
||||
"systemd-sysctl.service",
|
||||
&["systemd-modules-load.service"],
|
||||
Duration::from_millis(100),
|
||||
),
|
||||
];
|
||||
|
||||
const HOST: &[Step] = &[
|
||||
step(
|
||||
"graphical.target",
|
||||
&["multi-user.target", "display-manager.service"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
"display-manager.service",
|
||||
&["systemd-logind.service"],
|
||||
Duration::from_millis(600),
|
||||
),
|
||||
step(
|
||||
"multi-user.target",
|
||||
&[
|
||||
"basic.target",
|
||||
"NetworkManager.service",
|
||||
"systemd-logind.service",
|
||||
"systemd-timesyncd.service",
|
||||
],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step("basic.target", &["sysinit.target"], Duration::ZERO),
|
||||
step(
|
||||
"sysinit.target",
|
||||
&[
|
||||
"systemd-tmpfiles-setup.service",
|
||||
"systemd-udev-trigger.service",
|
||||
"home.mount",
|
||||
],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
"systemd-tmpfiles-setup.service",
|
||||
&[],
|
||||
Duration::from_millis(400),
|
||||
),
|
||||
step(
|
||||
"systemd-udev-trigger.service",
|
||||
&[],
|
||||
Duration::from_millis(800),
|
||||
),
|
||||
step("home.mount", &[], Duration::from_millis(300)),
|
||||
step(
|
||||
"systemd-logind.service",
|
||||
&["basic.target"],
|
||||
Duration::from_millis(300),
|
||||
),
|
||||
step(
|
||||
"NetworkManager.service",
|
||||
&["basic.target"],
|
||||
Duration::from_millis(1400),
|
||||
),
|
||||
step(
|
||||
"systemd-timesyncd.service",
|
||||
&["basic.target"],
|
||||
Duration::from_millis(500),
|
||||
),
|
||||
];
|
||||
|
||||
fn description(unit: &str) -> Option<&'static str> {
|
||||
let description = match unit {
|
||||
"initrd.target" => "Initrd Default Target",
|
||||
"initrd-fs.target" => "Initrd File Systems",
|
||||
"initrd-root-fs.target" => "Initrd Root File System",
|
||||
"initrd-root-device.target" => "Initrd Root Device",
|
||||
"sysroot.mount" => "/sysroot",
|
||||
"systemd-fsck-root.service" => "File System Check on /dev/mapper/cryptroot",
|
||||
"dev-mapper-cryptroot.device" => "/dev/mapper/cryptroot",
|
||||
"cryptsetup.target" => "Local Encrypted Volumes",
|
||||
"cryptsetup-pre.target" => "Local Encrypted Volumes (Pre)",
|
||||
"systemd-cryptsetup@cryptroot.service" => "Cryptography Setup for cryptroot",
|
||||
ROOT_PARTITION => "Samsung SSD 980 PRO 1TB cryptroot",
|
||||
"systemd-udev-trigger.service" => "Coldplug All udev Devices",
|
||||
"systemd-udevd.service" => "Rule-based Manager for Device Events and Files",
|
||||
"systemd-tmpfiles-setup-dev.service" => "Create Static Device Nodes in /dev",
|
||||
"kmod-static-nodes.service" => "Create List of Static Device Nodes",
|
||||
"systemd-journald.service" => "Journal Service",
|
||||
"systemd-modules-load.service" => "Load Kernel Modules",
|
||||
"systemd-vconsole-setup.service" => "Virtual Console Setup",
|
||||
"systemd-sysctl.service" => "Apply Kernel Variables",
|
||||
"graphical.target" => "Graphical Interface",
|
||||
"display-manager.service" => "Display Manager",
|
||||
"multi-user.target" => "Multi-User System",
|
||||
"basic.target" => "Basic System",
|
||||
"sysinit.target" => "System Initialization",
|
||||
"systemd-tmpfiles-setup.service" => "Create System Files and Directories",
|
||||
"home.mount" => "/home",
|
||||
"systemd-logind.service" => "User Login Management",
|
||||
"NetworkManager.service" => "Network Manager",
|
||||
"systemd-timesyncd.service" => "Network Time Synchronization",
|
||||
_ => return None,
|
||||
};
|
||||
Some(description)
|
||||
}
|
||||
|
||||
fn main() -> io::Result<()> {
|
||||
ratatui::run(|terminal| {
|
||||
play(
|
||||
terminal,
|
||||
&Scenario {
|
||||
phase: Phase::Initrd,
|
||||
steps: INITRD,
|
||||
after_switch_root: HOST,
|
||||
describe: description,
|
||||
},
|
||||
)
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1,97 @@
|
||||
use std::{io, time::Duration};
|
||||
|
||||
use bootvine::boot_model::Phase;
|
||||
use scripted_demos::scripted_boot::{Scenario, Step, play, step, stopping};
|
||||
|
||||
const SHUTDOWN: &[Step] = &[
|
||||
step(
|
||||
"poweroff.target",
|
||||
&["systemd-poweroff.service"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
"systemd-poweroff.service",
|
||||
&["final.target"],
|
||||
Duration::from_millis(300),
|
||||
),
|
||||
step("final.target", &["umount.target"], Duration::ZERO),
|
||||
step(
|
||||
"umount.target",
|
||||
&["shutdown.target", "var-lib-docker.mount", "home.mount"],
|
||||
Duration::ZERO,
|
||||
),
|
||||
step(
|
||||
"shutdown.target",
|
||||
&[
|
||||
"display-manager.service",
|
||||
"user@1000.service",
|
||||
"docker.service",
|
||||
"containerd.service",
|
||||
"tailscaled.service",
|
||||
"NetworkManager.service",
|
||||
],
|
||||
Duration::ZERO,
|
||||
),
|
||||
stopping("display-manager.service", &[], Duration::from_millis(900)),
|
||||
stopping(
|
||||
"user@1000.service",
|
||||
&["display-manager.service"],
|
||||
Duration::from_millis(1600),
|
||||
),
|
||||
stopping("docker.service", &[], Duration::from_millis(6500))
|
||||
.timing_out_after(Duration::from_secs(90)),
|
||||
stopping(
|
||||
"containerd.service",
|
||||
&["docker.service"],
|
||||
Duration::from_millis(700),
|
||||
),
|
||||
stopping("tailscaled.service", &[], Duration::from_millis(1100)),
|
||||
stopping(
|
||||
"NetworkManager.service",
|
||||
&["tailscaled.service", "docker.service"],
|
||||
Duration::from_millis(600),
|
||||
),
|
||||
stopping(
|
||||
"var-lib-docker.mount",
|
||||
&["docker.service", "containerd.service"],
|
||||
Duration::from_millis(400),
|
||||
),
|
||||
stopping(
|
||||
"home.mount",
|
||||
&["user@1000.service"],
|
||||
Duration::from_millis(500),
|
||||
),
|
||||
];
|
||||
|
||||
fn description(unit: &str) -> Option<&'static str> {
|
||||
let description = match unit {
|
||||
"poweroff.target" | "systemd-poweroff.service" => "System Power Off",
|
||||
"final.target" => "Late Shutdown Services",
|
||||
"umount.target" => "Unmount All Filesystems",
|
||||
"shutdown.target" => "System Shutdown",
|
||||
"display-manager.service" => "Display Manager",
|
||||
"user@1000.service" => "User Manager for UID 1000",
|
||||
"docker.service" => "Docker Application Container Engine",
|
||||
"containerd.service" => "containerd container runtime",
|
||||
"tailscaled.service" => "Tailscale node agent",
|
||||
"NetworkManager.service" => "Network Manager",
|
||||
"var-lib-docker.mount" => "/var/lib/docker",
|
||||
"home.mount" => "/home",
|
||||
_ => return None,
|
||||
};
|
||||
Some(description)
|
||||
}
|
||||
|
||||
fn main() -> io::Result<()> {
|
||||
ratatui::run(|terminal| {
|
||||
play(
|
||||
terminal,
|
||||
&Scenario {
|
||||
phase: Phase::Shutdown,
|
||||
steps: SHUTDOWN,
|
||||
after_switch_root: &[],
|
||||
describe: description,
|
||||
},
|
||||
)
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
pub mod scripted_boot;
|
||||
@@ -0,0 +1,519 @@
|
||||
use std::{
|
||||
collections::{HashMap, HashSet},
|
||||
io,
|
||||
iter::once,
|
||||
mem,
|
||||
ops::ControlFlow,
|
||||
time::Duration,
|
||||
};
|
||||
|
||||
use bootvine::{
|
||||
boot_model::{
|
||||
ActiveState, Activity, BootChange, BootState, FailureCause, JobKind, JobResult, Phase,
|
||||
UnitFacts, UnitTimeouts, boot_origin::BootOrigin,
|
||||
},
|
||||
boot_view::PasswordPrompt,
|
||||
console_session::{
|
||||
passphrase_input,
|
||||
stream_sources::{frame_inputs, key_inputs},
|
||||
watch_screen::{ConsoleDesk, WatchEnding, WatchScreen, watch_until_ending},
|
||||
},
|
||||
screen_settings::{color_scheme::Colors, config_file::Timing},
|
||||
systemd_link::monotonic_clock::monotonic_now,
|
||||
};
|
||||
use futures::stream;
|
||||
use ratatui::{DefaultTerminal, crossterm::event::Event};
|
||||
use tokio::runtime::Builder;
|
||||
use zeroize::Zeroizing;
|
||||
|
||||
const FINAL_FRAME: Duration = Duration::from_secs(3);
|
||||
|
||||
pub const DEMO_PASSPHRASE: &str = "demo";
|
||||
const DEMO_PASSPHRASE_HINT: &str = "This demo unlocks with the passphrase \"demo\"";
|
||||
|
||||
#[derive(Clone, Copy)]
|
||||
pub struct ScriptedFailure {
|
||||
pub reason: &'static str,
|
||||
pub log_lines: &'static [&'static str],
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy)]
|
||||
enum StepEnding {
|
||||
Succeeds,
|
||||
Fails(ScriptedFailure),
|
||||
}
|
||||
|
||||
pub struct Step {
|
||||
unit: &'static str,
|
||||
after: &'static [&'static str],
|
||||
work: Duration,
|
||||
ending: StepEnding,
|
||||
stops: bool,
|
||||
asks: Option<&'static str>,
|
||||
timeout: Option<Duration>,
|
||||
}
|
||||
|
||||
impl Step {
|
||||
#[must_use]
|
||||
pub const fn timing_out_after(self, limit: Duration) -> Self {
|
||||
Self {
|
||||
timeout: Some(limit),
|
||||
..self
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[must_use]
|
||||
pub const fn step(unit: &'static str, after: &'static [&'static str], work: Duration) -> Step {
|
||||
Step {
|
||||
unit,
|
||||
after,
|
||||
work,
|
||||
ending: StepEnding::Succeeds,
|
||||
stops: false,
|
||||
asks: None,
|
||||
timeout: None,
|
||||
}
|
||||
}
|
||||
|
||||
#[must_use]
|
||||
pub const fn failing(
|
||||
unit: &'static str,
|
||||
after: &'static [&'static str],
|
||||
work: Duration,
|
||||
failure: ScriptedFailure,
|
||||
) -> Step {
|
||||
Step {
|
||||
ending: StepEnding::Fails(failure),
|
||||
..step(unit, after, work)
|
||||
}
|
||||
}
|
||||
|
||||
#[must_use]
|
||||
pub const fn stopping(unit: &'static str, after: &'static [&'static str], work: Duration) -> Step {
|
||||
Step {
|
||||
stops: true,
|
||||
..step(unit, after, work)
|
||||
}
|
||||
}
|
||||
|
||||
#[must_use]
|
||||
pub const fn unlocking(
|
||||
unit: &'static str,
|
||||
after: &'static [&'static str],
|
||||
message: &'static str,
|
||||
key_derivation: Duration,
|
||||
) -> Step {
|
||||
Step {
|
||||
asks: Some(message),
|
||||
..step(unit, after, key_derivation)
|
||||
}
|
||||
}
|
||||
|
||||
pub struct Scenario {
|
||||
pub phase: Phase,
|
||||
pub steps: &'static [Step],
|
||||
pub after_switch_root: &'static [Step],
|
||||
pub describe: fn(&str) -> Option<&'static str>,
|
||||
}
|
||||
|
||||
struct ScriptedJob {
|
||||
id: u32,
|
||||
step: &'static Step,
|
||||
}
|
||||
|
||||
impl ScriptedJob {
|
||||
fn facts(&self, steps: &[Step], describe: fn(&str) -> Option<&'static str>) -> UnitFacts {
|
||||
let is_stopping = |unit: &&str| steps.iter().any(|step| step.unit == *unit && step.stops);
|
||||
let (before, after): (Vec<&str>, Vec<&str>) =
|
||||
self.step.after.iter().copied().partition(is_stopping);
|
||||
UnitFacts {
|
||||
name: self.step.unit.to_owned(),
|
||||
description: describe(self.step.unit).map(str::to_owned),
|
||||
after: after.into_iter().map(ToString::to_string).collect(),
|
||||
before: before.into_iter().map(ToString::to_string).collect(),
|
||||
timeouts: UnitTimeouts {
|
||||
job_running: self.step.timeout,
|
||||
..UnitTimeouts::default()
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
fn kind(&self) -> JobKind {
|
||||
if self.step.stops {
|
||||
JobKind::TakesDown
|
||||
} else {
|
||||
JobKind::BringsUp
|
||||
}
|
||||
}
|
||||
|
||||
fn outcome(&self) -> JobResult {
|
||||
if matches!(self.step.ending, StepEnding::Fails(_)) {
|
||||
JobResult::Failed
|
||||
} else {
|
||||
JobResult::Done
|
||||
}
|
||||
}
|
||||
|
||||
fn explanation(&self) -> Option<BootChange> {
|
||||
let StepEnding::Fails(failure) = self.step.ending else {
|
||||
return None;
|
||||
};
|
||||
Some(BootChange::ExplainFailure {
|
||||
unit: self.step.unit.to_owned(),
|
||||
cause: FailureCause {
|
||||
reason: failure.reason.to_owned(),
|
||||
log_lines: failure.log_lines.iter().map(ToString::to_string).collect(),
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
fn initial_activity(&self) -> Activity {
|
||||
Activity {
|
||||
state: self.step.stops.then_some(ActiveState::Active),
|
||||
..Activity::default()
|
||||
}
|
||||
}
|
||||
|
||||
fn started_activity(&self, now: Duration) -> Activity {
|
||||
if self.step.stops {
|
||||
Activity {
|
||||
state: Some(ActiveState::Deactivating),
|
||||
active_exit: Some(now),
|
||||
..Activity::default()
|
||||
}
|
||||
} else {
|
||||
Activity {
|
||||
state: Some(ActiveState::Activating),
|
||||
inactive_exit: Some(now),
|
||||
..Activity::default()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn settled_activity(&self, now: Duration) -> Activity {
|
||||
let state = if matches!(self.step.ending, StepEnding::Fails(_)) {
|
||||
ActiveState::Failed
|
||||
} else if self.step.stops {
|
||||
ActiveState::Inactive
|
||||
} else {
|
||||
ActiveState::Active
|
||||
};
|
||||
Activity {
|
||||
state: Some(state),
|
||||
active_enter: (!self.step.stops).then_some(now),
|
||||
..Activity::default()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
struct Script {
|
||||
steps: &'static [Step],
|
||||
jobs: Vec<ScriptedJob>,
|
||||
started: HashMap<&'static str, Duration>,
|
||||
finished: HashSet<&'static str>,
|
||||
answer: Option<Answer>,
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy)]
|
||||
struct Answer {
|
||||
checked_at: Duration,
|
||||
unlocks: bool,
|
||||
}
|
||||
|
||||
impl Script {
|
||||
fn begin(steps: &'static [Step], first_job: u32) -> Self {
|
||||
Self {
|
||||
steps,
|
||||
jobs: steps
|
||||
.iter()
|
||||
.zip(first_job..)
|
||||
.map(|(step, id)| ScriptedJob { id, step })
|
||||
.collect(),
|
||||
started: HashMap::new(),
|
||||
finished: HashSet::new(),
|
||||
answer: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn opening_changes(
|
||||
&self,
|
||||
describe: fn(&str) -> Option<&'static str>,
|
||||
now: Duration,
|
||||
) -> Vec<BootChange> {
|
||||
once(BootChange::SetRoot(self.steps[0].unit.to_owned()))
|
||||
.chain(self.jobs.iter().map(|job| BootChange::TrackUnit {
|
||||
facts: job.facts(self.steps, describe),
|
||||
activity: job.initial_activity(),
|
||||
}))
|
||||
.chain(self.jobs.iter().map(|job| BootChange::QueueJob {
|
||||
id: job.id,
|
||||
unit: job.step.unit.to_owned(),
|
||||
kind: job.kind(),
|
||||
at: now,
|
||||
}))
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn asking(&self) -> Option<&'static Step> {
|
||||
self.jobs.iter().map(|job| job.step).find(|step| {
|
||||
step.asks.is_some()
|
||||
&& self.started.contains_key(step.unit)
|
||||
&& !self.finished.contains(step.unit)
|
||||
})
|
||||
}
|
||||
|
||||
fn is_checking(&self, now: Duration) -> bool {
|
||||
self.answer.is_some_and(|answer| now < answer.checked_at)
|
||||
}
|
||||
|
||||
fn was_rejected(&self, now: Duration) -> bool {
|
||||
self.answer
|
||||
.is_some_and(|answer| !answer.unlocks && now >= answer.checked_at)
|
||||
}
|
||||
|
||||
fn prompt(&self, typed: &str, now: Duration) -> Option<PasswordPrompt<'static>> {
|
||||
Some(PasswordPrompt {
|
||||
message: self.asking()?.asks?,
|
||||
hint: Some(DEMO_PASSPHRASE_HINT),
|
||||
input: passphrase_input::masked(typed),
|
||||
sent: self.is_checking(now),
|
||||
rejected: self.was_rejected(now),
|
||||
})
|
||||
}
|
||||
|
||||
fn answer(&mut self, submitted: &str, now: Duration) {
|
||||
let Some(step) = self.asking() else {
|
||||
return;
|
||||
};
|
||||
self.answer = Some(Answer {
|
||||
checked_at: now + step.work,
|
||||
unlocks: submitted == DEMO_PASSPHRASE,
|
||||
});
|
||||
}
|
||||
|
||||
fn is_ready(&self, job: &ScriptedJob) -> bool {
|
||||
!self.started.contains_key(job.step.unit)
|
||||
&& job
|
||||
.step
|
||||
.after
|
||||
.iter()
|
||||
.all(|dependency| self.finished.contains(dependency))
|
||||
}
|
||||
|
||||
fn is_done(&self) -> bool {
|
||||
self.finished.len() == self.jobs.len()
|
||||
}
|
||||
|
||||
fn is_due(&self, job: &ScriptedJob, now: Duration) -> bool {
|
||||
let done_at = match job.step.asks {
|
||||
Some(_) => self
|
||||
.answer
|
||||
.filter(|answer| answer.unlocks)
|
||||
.map(|answer| answer.checked_at),
|
||||
None => self
|
||||
.started
|
||||
.get(job.step.unit)
|
||||
.map(|started| *started + job.step.work),
|
||||
};
|
||||
!self.finished.contains(job.step.unit) && done_at.is_some_and(|done_at| now >= done_at)
|
||||
}
|
||||
|
||||
fn advance(&mut self, now: Duration) -> Vec<BootChange> {
|
||||
let starting: HashSet<&'static str> = self
|
||||
.jobs
|
||||
.iter()
|
||||
.filter(|job| self.is_ready(job))
|
||||
.map(|job| job.step.unit)
|
||||
.collect();
|
||||
self.started
|
||||
.extend(starting.iter().map(|unit| (*unit, now)));
|
||||
let due: HashSet<&'static str> = self
|
||||
.jobs
|
||||
.iter()
|
||||
.filter(|job| self.is_due(job, now))
|
||||
.map(|job| job.step.unit)
|
||||
.collect();
|
||||
let changes = self
|
||||
.jobs
|
||||
.iter()
|
||||
.filter(|job| starting.contains(job.step.unit))
|
||||
.map(|job| BootChange::UpdateActivity {
|
||||
unit: job.step.unit.to_owned(),
|
||||
activity: job.started_activity(now),
|
||||
})
|
||||
.chain(
|
||||
self.jobs
|
||||
.iter()
|
||||
.filter(|job| due.contains(job.step.unit))
|
||||
.flat_map(|job| {
|
||||
[
|
||||
BootChange::UpdateActivity {
|
||||
unit: job.step.unit.to_owned(),
|
||||
activity: job.settled_activity(now),
|
||||
},
|
||||
BootChange::FinishJob {
|
||||
id: job.id,
|
||||
result: job.outcome(),
|
||||
at: now,
|
||||
},
|
||||
]
|
||||
.into_iter()
|
||||
.chain(job.explanation())
|
||||
}),
|
||||
)
|
||||
.collect();
|
||||
self.finished.extend(due);
|
||||
changes
|
||||
}
|
||||
}
|
||||
|
||||
struct DemoDesk {
|
||||
script: Script,
|
||||
describe: fn(&str) -> Option<&'static str>,
|
||||
next_stage: &'static [Step],
|
||||
settled_at: Option<Duration>,
|
||||
typed: Zeroizing<String>,
|
||||
}
|
||||
|
||||
impl DemoDesk {
|
||||
fn enter_next_stage(&mut self, now: Duration) -> Vec<BootChange> {
|
||||
if !self.script.is_done() || self.next_stage.is_empty() {
|
||||
return Vec::new();
|
||||
}
|
||||
self.script = Script::begin(mem::take(&mut self.next_stage), 1000);
|
||||
once(BootChange::SwitchRoot { at: now })
|
||||
.chain(self.script.opening_changes(self.describe, now))
|
||||
.collect()
|
||||
}
|
||||
}
|
||||
|
||||
impl ConsoleDesk for DemoDesk {
|
||||
fn frame_passed(&mut self, now: Duration) -> ControlFlow<WatchEnding, Vec<BootChange>> {
|
||||
let changes: Vec<BootChange> = self
|
||||
.script
|
||||
.advance(now)
|
||||
.into_iter()
|
||||
.chain(self.enter_next_stage(now))
|
||||
.collect();
|
||||
if !self.script.is_done() {
|
||||
return ControlFlow::Continue(changes);
|
||||
}
|
||||
let settled_at = *self.settled_at.get_or_insert(now);
|
||||
if now.saturating_sub(settled_at) >= FINAL_FRAME {
|
||||
ControlFlow::Break(WatchEnding::BootCompleted)
|
||||
} else {
|
||||
ControlFlow::Continue(changes)
|
||||
}
|
||||
}
|
||||
|
||||
fn prompt(&self, now: Duration) -> Option<PasswordPrompt<'_>> {
|
||||
self.script.prompt(&self.typed, now)
|
||||
}
|
||||
|
||||
fn press_key(&mut self, event: &Event, now: Duration) -> ControlFlow<WatchEnding> {
|
||||
let asking = self.script.asking().is_some();
|
||||
if passphrase_input::asks_to_quit(event, asking) {
|
||||
return ControlFlow::Break(WatchEnding::ViewerLeft);
|
||||
}
|
||||
if asking
|
||||
&& !self.script.is_checking(now)
|
||||
&& let Some(submitted) = passphrase_input::type_key(&mut self.typed, event)
|
||||
{
|
||||
self.script.answer(&submitted, now);
|
||||
}
|
||||
ControlFlow::Continue(())
|
||||
}
|
||||
}
|
||||
|
||||
fn demo_origin() -> BootOrigin {
|
||||
BootOrigin {
|
||||
host: "demo".to_owned(),
|
||||
system: Some("NixOS 26.11.20261007.39ad350".to_owned()),
|
||||
generation: Some("42".to_owned()),
|
||||
kernel: "Linux 7.2.9".to_owned(),
|
||||
}
|
||||
}
|
||||
|
||||
async fn play_scenario(terminal: &mut DefaultTerminal, scenario: &Scenario) -> io::Result<()> {
|
||||
let script = Script::begin(scenario.steps, 1);
|
||||
let mut state = BootState::new(scenario.phase);
|
||||
script
|
||||
.opening_changes(scenario.describe, Duration::ZERO)
|
||||
.into_iter()
|
||||
.for_each(|change| state.apply(change));
|
||||
let desk = DemoDesk {
|
||||
script,
|
||||
describe: scenario.describe,
|
||||
next_stage: scenario.after_switch_root,
|
||||
settled_at: None,
|
||||
typed: passphrase_input::empty(),
|
||||
};
|
||||
let mut screen = WatchScreen::new(
|
||||
state,
|
||||
desk,
|
||||
demo_origin,
|
||||
Colors::default(),
|
||||
Timing::default(),
|
||||
monotonic_now(),
|
||||
);
|
||||
let inputs = stream::select(frame_inputs(), key_inputs()?);
|
||||
match watch_until_ending(&mut screen, terminal, inputs).await {
|
||||
WatchEnding::Failed(error) => Err(io::Error::other(error)),
|
||||
WatchEnding::BootCompleted | WatchEnding::ViewerLeft => Ok(()),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn play(terminal: &mut DefaultTerminal, scenario: &Scenario) -> io::Result<()> {
|
||||
Builder::new_current_thread()
|
||||
.enable_io()
|
||||
.enable_time()
|
||||
.build()?
|
||||
.block_on(play_scenario(terminal, scenario))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
const KEY_DERIVATION: Duration = Duration::from_millis(500);
|
||||
const UNLOCK_ONLY: &[Step] = &[unlocking(
|
||||
"systemd-cryptsetup@root.service",
|
||||
&[],
|
||||
"Please enter passphrase for disk root:",
|
||||
KEY_DERIVATION,
|
||||
)];
|
||||
|
||||
fn asking_demo() -> Script {
|
||||
let mut script = Script::begin(UNLOCK_ONLY, 1);
|
||||
script.advance(Duration::ZERO);
|
||||
script
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_hint_names_the_demo_passphrase() {
|
||||
assert!(DEMO_PASSPHRASE_HINT.contains(&format!("\"{DEMO_PASSPHRASE}\"")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_wrong_answer_is_checked_then_called_out() {
|
||||
let mut script = asking_demo();
|
||||
let asked = script.prompt("", Duration::ZERO).expect("asking");
|
||||
assert_eq!(asked.hint, Some(DEMO_PASSPHRASE_HINT));
|
||||
assert!(!asked.rejected);
|
||||
script.answer("wrong", Duration::ZERO);
|
||||
let checking = script.prompt("", KEY_DERIVATION / 2).expect("asking");
|
||||
assert!(checking.sent && !checking.rejected);
|
||||
let rejected = script.prompt("", KEY_DERIVATION).expect("asking again");
|
||||
assert!(rejected.rejected && !rejected.sent);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_right_answer_unlocks_and_closes_the_prompt() {
|
||||
let mut script = asking_demo();
|
||||
script.answer(DEMO_PASSPHRASE, Duration::ZERO);
|
||||
script.advance(KEY_DERIVATION);
|
||||
assert!(script.is_done());
|
||||
assert!(script.prompt("", KEY_DERIVATION).is_none());
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user