mirror of
https://github.com/storytold/craft-libs.git
synced 2026-11-18 03:42:58 +00:00
storytold main 83cb1133dd (291 commits) into the integration head bab1a99b85; 47 conflicted files.
- Domain test files (metafile, prepress, pdf plates, settings store, heif, media-testkit, atomic): tests next cut stay cut; tests new on main are kept, as trials where the crate's test target runs trials.
- atomic: main's group-bits test and Faulty::set_group go to src/tests.rs. audio: main's GSM and SBC oracles join tests/main.rs. cms constructors, pdf knockout_backdrop and testing_pdf join their crates' one test binary; timeline's preflight tests become src/preflight_tests.rs trials.
- update: main's changes to detect, install (linux, macos) and the tests land in next's split modules. The app's own offer is inspected on a thread of its own, picked up by tick's polling; settle_for_tests settles offers too. Later on a ready update drops the close it asked for. updater_pin_tests.rs stays deleted; its new pin test is in tests/it/update.rs.
- craft-color: main added a different crate at crates/color (the colour tags of compositor and display frames); it is next's craft-color module `tags`, re-exported at the root.
- Old crates/ui (combo, docking, testing, README) and keymap's ui/view.rs stay deleted; main's new crates/ui/src/testing files are dropped with them.
- New crates in the craft facade: ai, control, dds, frame, ipc, media-source, palette, press-print, score, ssip. testkit and xtask are listed outside it.
- Cargo.lock: the union of both locks, resolved by cargo metadata. Workflow: main's nextest Windows leg, with next's --keep-going clippy.
806 lines
32 KiB
Rust
806 lines
32 KiB
Rust
//! Starting programs: the Craft Apps themselves, the file manager, and helper tools.
|
|
|
|
use std::ffi::OsStr;
|
|
use std::path::{Path, PathBuf};
|
|
use std::process::{Child, Command, ExitStatus, Stdio};
|
|
use std::sync::mpsc;
|
|
use std::time::{Duration, Instant};
|
|
|
|
/// A `Command` that won't flash a console window on Windows, and clears AppImage-injected
|
|
/// environment variables that corrupt system helper binaries and external applications.
|
|
pub fn command(program: impl AsRef<std::ffi::OsStr>) -> Command {
|
|
#[allow(unused_mut)]
|
|
let mut cmd = Command::new(program);
|
|
#[cfg(windows)]
|
|
{
|
|
use std::os::windows::process::CommandExt;
|
|
const CREATE_NO_WINDOW: u32 = 0x0800_0000;
|
|
cmd.creation_flags(CREATE_NO_WINDOW);
|
|
}
|
|
#[cfg(unix)]
|
|
clean_appimage_env(&mut cmd);
|
|
cmd
|
|
}
|
|
|
|
/// Cleans AppImage runtime environment variables so child processes don't load incompatible
|
|
/// libraries from the launcher's bundled AppImage.
|
|
#[cfg(unix)]
|
|
pub fn clean_appimage_env(cmd: &mut Command) {
|
|
if std::env::var_os("APPIMAGE").is_some() {
|
|
for var in [
|
|
"LD_LIBRARY_PATH",
|
|
"LD_PRELOAD",
|
|
"APPDIR",
|
|
"APPIMAGE",
|
|
"ARGV0",
|
|
"OWD",
|
|
"GDK_PIXBUF_MODULE_FILE",
|
|
"GIO_MODULE_DIR",
|
|
"GTK_PATH",
|
|
"PYTHONHOME",
|
|
"QT_PLUGIN_PATH",
|
|
] {
|
|
cmd.env_remove(var);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Runs a helper and returns its standard output when it succeeds within `timeout`.
|
|
pub fn capture(program: &str, args: &[&str], timeout: Duration) -> Option<String> {
|
|
run(program, args, timeout).ok()
|
|
}
|
|
|
|
/// Runs a helper and returns its standard output when it succeeds within `timeout`; otherwise
|
|
/// the reason, in the helper's own words (its standard error) where it gave one.
|
|
pub fn run(program: &str, args: &[&str], timeout: Duration) -> Result<String, String> {
|
|
let mut cmd = command(program);
|
|
cmd.args(args);
|
|
run_command(cmd, program, timeout)
|
|
}
|
|
|
|
/// How a helper failed: for a check, whether the helper reached an answer at all.
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
pub enum HelperFailure {
|
|
/// The helper ran to its end and exited with `code`. `reason` is in its own words where it
|
|
/// gave them.
|
|
Exited {
|
|
/// The helper's exit code.
|
|
code: i32,
|
|
/// Why it failed: its error output, else its exit status.
|
|
reason: String,
|
|
},
|
|
/// The helper gave no answer: it couldn't be started or read, a signal stopped it, or it ran
|
|
/// past its time limit.
|
|
Unfinished(String),
|
|
}
|
|
|
|
impl HelperFailure {
|
|
/// The reason in words, as [`run`] reports it.
|
|
pub fn into_reason(self) -> String {
|
|
match self {
|
|
Self::Exited { reason, .. } | Self::Unfinished(reason) => reason,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// [`run`], for a caller that needs to tell a helper's answer from a helper that gave none.
|
|
pub fn run_detailed(program: &str, args: &[&str], timeout: Duration) -> Result<String, HelperFailure> {
|
|
let mut cmd = command(program);
|
|
cmd.args(args);
|
|
run_command_detailed(cmd, program, timeout)
|
|
}
|
|
|
|
/// Runs a configured helper with bounded output and a timeout.
|
|
pub fn run_command(cmd: Command, program: &str, timeout: Duration) -> Result<String, String> {
|
|
run_command_detailed(cmd, program, timeout).map_err(HelperFailure::into_reason)
|
|
}
|
|
|
|
fn run_command_detailed(cmd: Command, program: &str, timeout: Duration) -> Result<String, HelperFailure> {
|
|
let mut start = None;
|
|
run_command_until(cmd, program, timeout, move |_| {
|
|
let start = *start.get_or_insert_with(Instant::now);
|
|
let more = within(start, Instant::now(), timeout);
|
|
if more {
|
|
std::thread::sleep(Duration::from_millis(15));
|
|
}
|
|
more
|
|
})
|
|
}
|
|
|
|
/// Whether a helper run that started waiting at `start` may still wait at `now`.
|
|
fn within(start: Instant, now: Instant, timeout: Duration) -> bool {
|
|
now.saturating_duration_since(start) < timeout
|
|
}
|
|
|
|
/// What a helper run still waits for when it asks whether to keep waiting.
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
|
enum Pending {
|
|
/// The helper is still running.
|
|
Helper,
|
|
/// The helper has exited, and a process it started still holds its output open.
|
|
Output,
|
|
}
|
|
|
|
/// [`run_command_detailed`], asking `keep_waiting` each time the run finds the helper or its
|
|
/// output unfinished. `keep_waiting` returns `false` when the time limit has passed; `timeout` is
|
|
/// the limit the error message names.
|
|
fn run_command_until(
|
|
mut cmd: Command,
|
|
program: &str,
|
|
timeout: Duration,
|
|
mut keep_waiting: impl FnMut(Pending) -> bool,
|
|
) -> Result<String, HelperFailure> {
|
|
let mut child = cmd
|
|
.stdin(Stdio::null())
|
|
.stdout(Stdio::piped())
|
|
.stderr(Stdio::piped())
|
|
.spawn()
|
|
.map_err(|e| HelperFailure::Unfinished(format!("couldn't start {program} ({e})")))?;
|
|
// Read both pipes while it runs, so a chatty helper can't block on a full one.
|
|
let readers = read_all(child.stdout.take()).and_then(|stdout| Ok((stdout, read_all(child.stderr.take())?)));
|
|
let (stdout, stderr) = match readers {
|
|
Ok(readers) => readers,
|
|
Err(e) => {
|
|
let _ = child.kill();
|
|
let _ = child.wait();
|
|
return Err(HelperFailure::Unfinished(format!("couldn't read the output of {program} ({e})")));
|
|
}
|
|
};
|
|
let timed_out = || HelperFailure::Unfinished(format!("{program} didn't finish within {} seconds", timeout.as_secs()));
|
|
let status = loop {
|
|
match child.try_wait() {
|
|
Ok(Some(status)) => break status,
|
|
Ok(None) if keep_waiting(Pending::Helper) => {}
|
|
_ => {
|
|
let _ = child.kill();
|
|
let _ = child.wait();
|
|
return Err(timed_out());
|
|
}
|
|
}
|
|
};
|
|
// A descendant may retain a pipe after the direct child exits. Keep reader completion
|
|
// under the same deadline; on timeout the readers detach, as in the child timeout path.
|
|
while !stdout.is_finished() || !stderr.is_finished() {
|
|
if !keep_waiting(Pending::Output) {
|
|
return Err(timed_out());
|
|
}
|
|
}
|
|
let text = |pipe: std::thread::JoinHandle<Vec<u8>>| String::from_utf8_lossy(&pipe.join().unwrap_or_default()).into_owned();
|
|
let (out, err) = (text(stdout), text(stderr));
|
|
if status.success() {
|
|
return Ok(out);
|
|
}
|
|
let reason = err.trim();
|
|
let reason = if reason.is_empty() { format!("{program} failed ({status})") } else { reason.to_string() };
|
|
Err(match status.code() {
|
|
Some(code) => HelperFailure::Exited { code, reason },
|
|
None => HelperFailure::Unfinished(reason),
|
|
})
|
|
}
|
|
|
|
/// Captures at most 8 MB of a child's pipe and drains the rest on its own thread.
|
|
fn read_all<R: std::io::Read + Send + 'static>(pipe: Option<R>) -> std::io::Result<std::thread::JoinHandle<Vec<u8>>> {
|
|
std::thread::Builder::new().name("helper-output".into()).spawn(move || {
|
|
let mut out = Vec::new();
|
|
if let Some(mut pipe) = pipe {
|
|
let _ = std::io::Read::read_to_end(&mut std::io::Read::take(&mut pipe, 8 << 20), &mut out);
|
|
// Keep reading without retaining more output: closing a full pipe early can make a
|
|
// successful helper fail with a broken pipe (SIGPIPE on Unix).
|
|
let _ = std::io::copy(&mut pipe, &mut std::io::sink());
|
|
}
|
|
out
|
|
})
|
|
}
|
|
|
|
/// Starts `cmd` without waiting for it.
|
|
///
|
|
/// On Unix the process is reaped when it exits: a thread that waits for the process starts
|
|
/// first and starts the process itself. When no thread can be started, the call returns an error
|
|
/// and does not start the process. On Windows the process starts on the calling thread, and no
|
|
/// thread waits for it.
|
|
pub fn spawn_detached(mut cmd: Command) -> Result<(), String> {
|
|
cmd.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null());
|
|
if cfg!(windows) {
|
|
return cmd.spawn().map(drop).map_err(|e| format!("couldn't start it ({e})"));
|
|
}
|
|
spawn_detached_with(
|
|
move || cmd.spawn(),
|
|
|wait| {
|
|
std::thread::Builder::new()
|
|
.name("reap-child".into())
|
|
.spawn(move || {
|
|
let _ = wait();
|
|
})
|
|
.map(drop)
|
|
},
|
|
)
|
|
}
|
|
|
|
/// The thread that [`spawn_detached`] starts on Unix: `start_thread` starts a thread that runs
|
|
/// the closure it is given, and that closure calls `spawn` and then waits for the process.
|
|
/// `spawn` is called on that thread only, so when `start_thread` fails nothing is started.
|
|
#[cfg_attr(windows, allow(dead_code))]
|
|
fn spawn_detached_with(
|
|
spawn: impl FnOnce() -> std::io::Result<Child> + Send + 'static,
|
|
start_thread: impl FnOnce(Box<dyn FnOnce() -> Option<ExitStatus> + Send>) -> std::io::Result<()>,
|
|
) -> Result<(), String> {
|
|
let (started, start_result) = mpsc::channel();
|
|
start_thread(Box::new(move || start_and_wait(spawn, &started))).map_err(|e| format!("couldn't start a thread to wait for it ({e})"))?;
|
|
match start_result.recv() {
|
|
Ok(Ok(())) => Ok(()),
|
|
Ok(Err(e)) => Err(format!("couldn't start it ({e})")),
|
|
Err(_) => Err("couldn't start it (its thread ended before starting it)".into()),
|
|
}
|
|
}
|
|
|
|
/// Calls `spawn`, sends whether that worked on `started`, and waits for the process to exit.
|
|
/// Returns its exit status, or `None` when it didn't start or couldn't be waited for.
|
|
#[cfg_attr(windows, allow(dead_code))]
|
|
fn start_and_wait(spawn: impl FnOnce() -> std::io::Result<Child>, started: &mpsc::Sender<std::io::Result<()>>) -> Option<ExitStatus> {
|
|
match spawn() {
|
|
Ok(mut child) => {
|
|
let _ = started.send(Ok(()));
|
|
child.wait().ok()
|
|
}
|
|
Err(e) => {
|
|
let _ = started.send(Err(e));
|
|
None
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Waits up to `timeout` for the process `pid` to exit, and says whether it has. A process that
|
|
/// can't be opened, because it's gone or never was, counts as exited.
|
|
#[cfg(windows)]
|
|
pub fn wait_for_exit(pid: u32, timeout: Duration) -> bool {
|
|
use winsafe::{HPROCESS, co};
|
|
let Ok(process) = HPROCESS::OpenProcess(co::PROCESS::SYNCHRONIZE, false, pid) else { return true };
|
|
// u32::MAX would mean INFINITE.
|
|
let ms = u32::try_from(timeout.as_millis()).unwrap_or(u32::MAX - 1);
|
|
process.WaitForSingleObject(Some(ms)).is_ok_and(|w| w == co::WAIT::OBJECT_0)
|
|
}
|
|
|
|
/// Whether this process is running inside a Flatpak container sandbox.
|
|
pub fn in_sandbox() -> bool {
|
|
std::env::var_os("FLATPAK_ID").is_some() || Path::new("/.flatpak-info").exists()
|
|
}
|
|
|
|
/// A command to run `flatpak`, delegating to the host via `flatpak-spawn --host` if inside a sandbox.
|
|
pub fn flatpak_command() -> Command {
|
|
if in_sandbox() {
|
|
let mut cmd = command("flatpak-spawn");
|
|
cmd.args(["--host", "flatpak"]);
|
|
cmd
|
|
} else {
|
|
command("flatpak")
|
|
}
|
|
}
|
|
|
|
/// [`flatpak_command`] in the C locale, for output this code reads: Flatpak translates its messages.
|
|
pub fn flatpak_command_c() -> Command {
|
|
if in_sandbox() {
|
|
let mut cmd = command("flatpak-spawn");
|
|
cmd.args(["--host", "--env=LC_ALL=C", "flatpak"]);
|
|
cmd
|
|
} else {
|
|
let mut cmd = command("flatpak");
|
|
cmd.env("LC_ALL", "C");
|
|
cmd
|
|
}
|
|
}
|
|
|
|
/// Runs a flatpak command and captures its standard output.
|
|
pub fn capture_flatpak(args: &[&str], timeout: Duration) -> Option<String> {
|
|
if in_sandbox() {
|
|
let mut spawn_args = vec!["--host", "flatpak"];
|
|
spawn_args.extend_from_slice(args);
|
|
capture("flatpak-spawn", &spawn_args, timeout)
|
|
} else {
|
|
capture("flatpak", args, timeout)
|
|
}
|
|
}
|
|
|
|
/// Whether Flatpak is available on the machine (or on the host when sandboxed).
|
|
pub fn is_flatpak_available() -> bool {
|
|
if in_sandbox() {
|
|
capture("flatpak-spawn", &["--host", "flatpak", "--version"], Duration::from_secs(3)).is_some()
|
|
} else {
|
|
which_on_path("flatpak").is_some()
|
|
}
|
|
}
|
|
|
|
fn which_on_path(name: &str) -> Option<std::path::PathBuf> {
|
|
let path = std::env::var_os("PATH")?;
|
|
std::env::split_paths(&path).map(|d| d.join(name)).find(|p| p.is_file())
|
|
}
|
|
|
|
/// Starts an app binary from its own folder.
|
|
pub fn launch_binary(exe: &Path, args: &[&str]) -> Result<(), String> {
|
|
let mut cmd = if in_sandbox() {
|
|
let mut c = command("flatpak-spawn");
|
|
c.arg("--host").arg(exe);
|
|
c
|
|
} else {
|
|
command(exe)
|
|
};
|
|
cmd.args(args);
|
|
if let Some(dir) = exe.parent() {
|
|
cmd.current_dir(dir);
|
|
}
|
|
spawn_detached(cmd)
|
|
}
|
|
|
|
/// Opens a file, folder or URL with the system's default handler.
|
|
pub fn open(target: &std::ffi::OsStr) -> Result<(), String> {
|
|
spawn_detached(opener(target)?)
|
|
}
|
|
|
|
/// The system's default opener for `target`: `explorer` on Windows, `open` on macOS, and
|
|
/// `xdg-open` elsewhere (on the host, through `flatpak-spawn --host`, inside the sandbox).
|
|
fn opener(target: &std::ffi::OsStr) -> Result<Command, String> {
|
|
let mut cmd = if cfg!(target_os = "macos") {
|
|
command("open")
|
|
} else if cfg!(windows) {
|
|
command(windows_system_program("explorer.exe")?)
|
|
} else if in_sandbox() {
|
|
let mut c = command("flatpak-spawn");
|
|
c.arg("--host").arg("xdg-open");
|
|
c
|
|
} else {
|
|
command("xdg-open")
|
|
};
|
|
cmd.arg(target);
|
|
Ok(cmd)
|
|
}
|
|
|
|
/// Opens `primary_url` with the system's default handler. If opening fails (for example,
|
|
/// if a custom scheme handler is not found or fails to execute), falls back to `fallback_url`.
|
|
pub fn open_url_with_fallback(primary_url: &str, fallback_url: &str) {
|
|
let primary = primary_url.to_string();
|
|
let fallback = fallback_url.to_string();
|
|
let opener = std::thread::Builder::new().name("open-url".into()).spawn(move || {
|
|
if !open_and_wait_success(&primary, Duration::from_millis(1500)) {
|
|
log::warn!("couldn't open a link; opening its fallback");
|
|
let _ = open(std::ffi::OsStr::new(&fallback));
|
|
}
|
|
});
|
|
if let Err(e) = opener {
|
|
log::warn!("couldn't start a thread to open a link ({e})");
|
|
}
|
|
}
|
|
|
|
/// Starts the default system opener for `target` and returns `true` unless it fails to start
|
|
/// or exits in error within `timeout`. An opener still running after `timeout` counts as
|
|
/// success, and the call waits for it to exit before returning. An opener whose state can't be
|
|
/// read is stopped and waited for, and counts as a failure. [`open_url_with_fallback`] calls this
|
|
/// on its own `open-url` thread.
|
|
///
|
|
/// `explorer` exits with an error status even when it opens the target, so on Windows only a
|
|
/// failure to start counts; the scheme check covers the rest.
|
|
fn open_and_wait_success(target: &str, timeout: Duration) -> bool {
|
|
let mut cmd = match opener(std::ffi::OsStr::new(target)) {
|
|
Ok(cmd) => cmd,
|
|
Err(error) => {
|
|
log::warn!("couldn't resolve the system opener: {error}");
|
|
return false;
|
|
}
|
|
};
|
|
if cfg!(windows) {
|
|
return spawn_detached(cmd).is_ok();
|
|
}
|
|
let mut child = match cmd.stdin(Stdio::null()).stdout(Stdio::null()).stderr(Stdio::null()).spawn() {
|
|
Ok(c) => c,
|
|
Err(e) => {
|
|
log::warn!("couldn't start the system opener: {e}");
|
|
return false;
|
|
}
|
|
};
|
|
let start = Instant::now();
|
|
loop {
|
|
match child.try_wait() {
|
|
Ok(Some(status)) => return status.success(),
|
|
Ok(None) if start.elapsed() < timeout => std::thread::sleep(Duration::from_millis(25)),
|
|
Ok(None) => {
|
|
let _ = child.wait();
|
|
return true;
|
|
}
|
|
Err(_) => {
|
|
let _ = child.kill();
|
|
let _ = child.wait();
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Shows `path` selected in the file manager.
|
|
pub fn reveal(path: &Path) -> Result<(), String> {
|
|
if cfg!(target_os = "macos") {
|
|
let mut cmd = command("open");
|
|
cmd.arg("-R").arg(path);
|
|
spawn_detached(cmd)
|
|
} else if cfg!(windows) {
|
|
reveal_in_explorer(path)
|
|
} else {
|
|
open(path.parent().unwrap_or(path).as_os_str())
|
|
}
|
|
}
|
|
|
|
#[cfg(windows)]
|
|
fn reveal_in_explorer(path: &Path) -> Result<(), String> {
|
|
use std::os::windows::process::CommandExt;
|
|
let mut cmd = command(windows_system_program("explorer.exe")?);
|
|
// Passed raw: `arg` would wrap all of `/select,...` in quotes when the path has a space
|
|
// (`C:\Program Files\...`), and Explorer then ignores the switch and opens Documents.
|
|
// A quote in the path would end the quoted part early and let the rest reach Explorer as
|
|
// switches; no Windows path has one, so refuse it.
|
|
let arg = explorer_select_arg(path).ok_or_else(|| format!("{} isn't a usable path", path.display()))?;
|
|
cmd.raw_arg(arg);
|
|
spawn_detached(cmd)
|
|
}
|
|
|
|
#[cfg(not(windows))]
|
|
fn reveal_in_explorer(_path: &Path) -> Result<(), String> {
|
|
Err("Explorer is only on Windows".into())
|
|
}
|
|
|
|
/// Explorer's `/select,"<path>"` argument as it goes on the command line: only the path is quoted,
|
|
/// and forward slashes become backslashes, which Explorer needs to find the item. `None` for a path
|
|
/// with a `"` in it.
|
|
#[cfg_attr(not(windows), allow(dead_code))]
|
|
fn explorer_select_arg(path: &Path) -> Option<std::ffi::OsString> {
|
|
let s = path.to_str()?;
|
|
if s.contains('"') {
|
|
return None;
|
|
}
|
|
let mut arg = std::ffi::OsString::from("/select,\"");
|
|
arg.push(s.replace('/', "\\"));
|
|
arg.push("\"");
|
|
Some(arg)
|
|
}
|
|
|
|
/// Whether a process started from inside `path` (an exe, an AppImage, or a `.app`) is running.
|
|
pub fn is_running(path: &Path) -> bool {
|
|
running(path).unwrap_or(false)
|
|
}
|
|
|
|
/// Whether a process started from inside `path` (an exe, an AppImage, or a `.app`) is running.
|
|
/// On macOS, `Err` gives the reason the check got no answer. On other systems a check that gets
|
|
/// no answer counts as "not running", since `pgrep` isn't installed on every Linux system.
|
|
pub fn running(path: &Path) -> Result<bool, String> {
|
|
if cfg!(target_os = "macos") {
|
|
let p = path.to_str().ok_or("unusual characters in the app's path")?;
|
|
return pgrep_answer(run_detailed("/usr/bin/pgrep", &["-f", "--", &pgrep_pattern(p)], Duration::from_secs(30)));
|
|
}
|
|
if cfg!(windows) {
|
|
let Some(name) = path.file_name().and_then(OsStr::to_str) else { return Ok(false) };
|
|
let filter = format!("IMAGENAME eq {name}");
|
|
let Ok(tasklist) = windows_system_program(r"System32\tasklist.exe") else { return Ok(false) };
|
|
let mut cmd = command(tasklist);
|
|
cmd.args(["/FI", &filter, "/NH", "/FO", "CSV"]);
|
|
Ok(run_command(cmd, "tasklist", Duration::from_secs(5)).ok().is_some_and(|out| out.to_ascii_lowercase().contains(&name.to_ascii_lowercase())))
|
|
} else {
|
|
let Some(p) = path.to_str() else { return Ok(false) };
|
|
let pattern = pgrep_pattern(p);
|
|
// pgrep exits 0 when something matches; it never matches itself.
|
|
Ok(if in_sandbox() {
|
|
capture("flatpak-spawn", &["--host", "pgrep", "-f", "--", &pattern], Duration::from_secs(5)).is_some()
|
|
} else {
|
|
capture("pgrep", &["-f", "--", &pattern], Duration::from_secs(5)).is_some()
|
|
})
|
|
}
|
|
}
|
|
|
|
/// What a `pgrep` run says: exit 0 is a match and exit 1 is no match. Anything else gave no answer.
|
|
fn pgrep_answer(output: Result<String, HelperFailure>) -> Result<bool, String> {
|
|
match output {
|
|
Ok(_) => Ok(true),
|
|
Err(HelperFailure::Exited { code: 1, .. }) => Ok(false),
|
|
Err(failure) => Err(failure.into_reason()),
|
|
}
|
|
}
|
|
|
|
fn windows_system_program(relative: &str) -> Result<PathBuf, String> {
|
|
let root = std::env::var_os("SystemRoot")
|
|
.filter(|root| !root.is_empty())
|
|
.map(PathBuf::from)
|
|
.ok_or_else(|| "Windows didn't provide its system folder".to_string())?;
|
|
if !root.is_absolute() {
|
|
return Err("Windows provided a non-absolute system folder".into());
|
|
}
|
|
Ok(root.join(relative))
|
|
}
|
|
|
|
/// Quote the path's metacharacters for pgrep's extended regular expression.
|
|
fn pgrep_pattern(path: &str) -> String {
|
|
let mut pattern = String::with_capacity(path.len());
|
|
for c in path.chars() {
|
|
if matches!(c, '.' | '^' | '$' | '*' | '+' | '?' | '(' | ')' | '[' | ']' | '{' | '}' | '|' | '\\') {
|
|
pattern.push('\\');
|
|
}
|
|
pattern.push(c);
|
|
}
|
|
pattern
|
|
}
|
|
|
|
#[cfg(test)]
|
|
#[cfg(unix)]
|
|
pub(crate) mod tests {
|
|
use std::io::{BufRead, BufReader};
|
|
use std::process::Child;
|
|
|
|
use super::*;
|
|
|
|
/// A process whose command line is `path`, as `pgrep -f` sees it, until dropped.
|
|
pub(crate) struct RunningProbe(Child);
|
|
|
|
impl RunningProbe {
|
|
pub(crate) fn start(path: &str) -> Self {
|
|
let child = command("/bin/sh")
|
|
.args(["-c", "printf 'ready\\n'; read line", path])
|
|
.stdin(Stdio::piped())
|
|
.stdout(Stdio::piped())
|
|
.stderr(Stdio::null())
|
|
.spawn()
|
|
.unwrap();
|
|
let mut probe = Self(child);
|
|
let mut ready = String::new();
|
|
BufReader::new(probe.0.stdout.take().unwrap()).read_line(&mut ready).unwrap();
|
|
assert_eq!(ready, "ready\n");
|
|
probe
|
|
}
|
|
}
|
|
|
|
impl Drop for RunningProbe {
|
|
fn drop(&mut self) {
|
|
let _ = self.0.kill();
|
|
let _ = self.0.wait();
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod run_tests {
|
|
use super::*;
|
|
|
|
#[cfg(unix)]
|
|
#[craft_ui::testing::trial]
|
|
fn successful_helpers_can_write_past_the_stdout_capture_limit() {
|
|
let out = run("/bin/sh", &["-c", "head -c 9437184 /dev/zero"], Duration::from_secs(10)).unwrap();
|
|
assert_eq!(out.len(), 8 << 20);
|
|
}
|
|
|
|
/// A shell command line, for the platform's shell.
|
|
fn shell(script: &str) -> (&'static str, [&str; 2]) {
|
|
if cfg!(windows) { ("cmd", ["/C", script]) } else { ("/bin/sh", ["-c", script]) }
|
|
}
|
|
|
|
/// Long enough that no helper in these tests reaches it.
|
|
#[cfg(unix)]
|
|
const NO_LIMIT: Duration = Duration::from_secs(86_400);
|
|
|
|
#[craft_ui::testing::trial]
|
|
fn a_time_limit_ends_when_its_length_has_passed() {
|
|
let start = Instant::now();
|
|
let second = Duration::from_secs(1);
|
|
assert!(within(start, start, second));
|
|
assert!(within(start, start + Duration::from_millis(999), second));
|
|
assert!(!within(start, start + second, second));
|
|
assert!(!within(start, start + Duration::from_secs(60), second));
|
|
assert!(!within(start, start, Duration::ZERO));
|
|
}
|
|
|
|
/// Callers such as the signature check read an exit code as the helper's answer, so a helper
|
|
/// that timed out, couldn't start or was stopped by a signal must not look like one.
|
|
#[cfg(unix)]
|
|
#[craft_ui::testing::trial]
|
|
fn only_a_helper_that_exits_gives_an_answer() {
|
|
// A time limit of zero expires at the first look, so the test doesn't wait for it.
|
|
let mut cmd = command("/bin/sh");
|
|
cmd.args(["-c", "exec sleep 86400"]);
|
|
let timed_out = run_command_detailed(cmd, "the helper", Duration::ZERO);
|
|
let not_found = run_detailed("/nonexistent/helper", &[], NO_LIMIT);
|
|
let killed = run_detailed("/bin/sh", &["-c", "kill -9 $$"], NO_LIMIT);
|
|
for unfinished in [timed_out, not_found, killed] {
|
|
assert!(matches!(unfinished, Err(HelperFailure::Unfinished(_))), "{unfinished:?}");
|
|
}
|
|
let exited = run_detailed("/bin/sh", &["-c", "echo it failed >&2; exit 3"], NO_LIMIT);
|
|
assert_eq!(exited, Err(HelperFailure::Exited { code: 3, reason: "it failed".into() }));
|
|
}
|
|
|
|
/// When no thread can be started to wait for a process, the process is not started and the
|
|
/// call says why.
|
|
#[craft_ui::testing::trial]
|
|
fn no_process_starts_without_a_thread_to_wait_for_it() {
|
|
let (program, args) = shell("exit 0");
|
|
let mut cmd = command(program);
|
|
cmd.args(args);
|
|
let spawned = std::sync::Arc::new(std::sync::atomic::AtomicBool::new(false));
|
|
let spawn_called = std::sync::Arc::clone(&spawned);
|
|
let result = spawn_detached_with(
|
|
move || {
|
|
spawn_called.store(true, std::sync::atomic::Ordering::SeqCst);
|
|
cmd.spawn()
|
|
},
|
|
|_wait| Err(std::io::Error::other("no threads")),
|
|
);
|
|
assert_eq!(result, Err("couldn't start a thread to wait for it (no threads)".into()));
|
|
assert!(!spawned.load(std::sync::atomic::Ordering::SeqCst), "the process was started");
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod inherited_pipe_tests {
|
|
use super::*;
|
|
use craft_ui::testing::trial;
|
|
use std::io::{BufRead, BufReader, Read, Write};
|
|
use std::net::{TcpListener, TcpStream};
|
|
|
|
fn fixture_args(name: &str, marker: &str) -> Vec<String> {
|
|
let (_, module) = module_path!().split_once("::").unwrap();
|
|
// libtest accepts arbitrary skip filters; this one carries the test's address.
|
|
vec!["--ignored".into(), "--exact".into(), format!("{module}::{name}"), "--nocapture".into(), "--skip".into(), marker.into()]
|
|
}
|
|
|
|
fn fixture_address() -> String {
|
|
let args: Vec<String> = std::env::args().collect();
|
|
args[args.iter().position(|arg| arg == "--skip").unwrap() + 1].clone()
|
|
}
|
|
|
|
/// Stops a broken test: how long the descendant holds the pipes when the test neither answers
|
|
/// nor closes its connection, as when a capture waits for the pipes instead of timing out, and
|
|
/// how long the test waits for each step of the fixtures.
|
|
const HOLD: Duration = Duration::from_secs(60);
|
|
|
|
#[trial]
|
|
#[ignore = "self-spawned subprocess fixture"]
|
|
fn pipe_holder() {
|
|
let mut test = TcpStream::connect(fixture_address()).unwrap();
|
|
let buffer = [b'x'; 64 << 10];
|
|
// Both streams exceed the capture cap before the test lets the time limit pass.
|
|
for _ in 0..144 {
|
|
std::io::stdout().write_all(&buffer).unwrap();
|
|
std::io::stderr().write_all(&buffer).unwrap();
|
|
}
|
|
std::io::stdout().flush().unwrap();
|
|
test.write_all(b"ready\n").unwrap();
|
|
// Holds the pipes until the test closes its side of the connection. Closing this side
|
|
// tells the test that the pipes are about to close.
|
|
test.set_read_timeout(Some(HOLD)).unwrap();
|
|
let _ = test.read(&mut [0; 1]);
|
|
drop(test);
|
|
}
|
|
|
|
#[trial]
|
|
#[ignore = "self-spawned subprocess fixture"]
|
|
fn pipe_parent() {
|
|
let address = fixture_address();
|
|
// Dropping Child leaves the descendant running with the inherited stdout and stderr.
|
|
drop(command(std::env::current_exe().unwrap()).args(fixture_args("pipe_holder", &address)).spawn().unwrap());
|
|
}
|
|
|
|
#[trial]
|
|
fn exited_helper_does_not_wait_past_deadline_for_inherited_pipes() {
|
|
let listener = TcpListener::bind("127.0.0.1:0").unwrap();
|
|
listener.set_nonblocking(true).unwrap();
|
|
let mut cmd = command(std::env::current_exe().unwrap());
|
|
cmd.args(fixture_args("pipe_parent", &listener.local_addr().unwrap().to_string()));
|
|
let mut holder = None;
|
|
// Only stops a broken test: a direct child that never exits, or a descendant that never
|
|
// connects.
|
|
let guard = Instant::now();
|
|
let result = run_command_until(cmd, "the fixture", Duration::from_secs(5), |pending| match pending {
|
|
Pending::Helper => {
|
|
std::thread::yield_now();
|
|
guard.elapsed() < HOLD
|
|
}
|
|
// The direct child has exited and the descendant holds the helper's pipes. Once the
|
|
// descendant has filled both, the time limit passes.
|
|
Pending::Output => {
|
|
assert!(holder.is_none(), "the run kept waiting after its time limit passed");
|
|
let stream = loop {
|
|
match listener.accept() {
|
|
Ok((stream, _)) => break stream,
|
|
Err(e) if e.kind() == std::io::ErrorKind::WouldBlock && guard.elapsed() < HOLD => std::thread::yield_now(),
|
|
Err(e) => panic!("the descendant didn't connect ({e})"),
|
|
}
|
|
};
|
|
stream.set_nonblocking(false).unwrap();
|
|
stream.set_read_timeout(Some(HOLD)).unwrap();
|
|
let mut ready = String::new();
|
|
BufReader::new(&stream).read_line(&mut ready).unwrap();
|
|
assert_eq!(ready, "ready\n");
|
|
holder = Some(stream);
|
|
false
|
|
}
|
|
});
|
|
// The output is more than 8 MB, so a failure shows only its length.
|
|
assert_eq!(result.map(|output| output.len()), Err(HelperFailure::Unfinished("the fixture didn't finish within 5 seconds".into())));
|
|
// Lets the descendant go and waits until it has closed its end. The read time limit only
|
|
// stops a broken test.
|
|
let mut holder = holder.expect("the direct child didn't exit while the descendant held its output");
|
|
holder.shutdown(std::net::Shutdown::Write).unwrap();
|
|
holder.set_read_timeout(Some(HOLD)).unwrap();
|
|
assert_eq!(holder.read_to_end(&mut Vec::new()).unwrap(), 0);
|
|
}
|
|
}
|
|
|
|
/// Runs a helper while polling cancellation and draining its bounded output.
|
|
#[cfg(target_os = "linux")]
|
|
pub(crate) fn cancellable_output(mut cmd: Command, check: impl Fn() -> Result<(), String>) -> Result<std::process::Output, String> {
|
|
check()?;
|
|
let mut child =
|
|
cmd.stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::piped()).spawn().map_err(|e| format!("couldn't run flatpak ({e})"))?;
|
|
let stdout = read_all(child.stdout.take()).map_err(|e| format!("couldn't read flatpak output ({e})"))?;
|
|
let stderr = read_all(child.stderr.take()).map_err(|e| format!("couldn't read flatpak output ({e})"))?;
|
|
let started = Instant::now();
|
|
let status = loop {
|
|
if started.elapsed() >= Duration::from_secs(60 * 60) {
|
|
let _ = child.kill();
|
|
let _ = child.wait();
|
|
return Err("Flatpak did not finish within one hour".into());
|
|
}
|
|
if let Err(e) = check() {
|
|
let _ = child.kill();
|
|
let _ = child.wait();
|
|
return Err(e);
|
|
}
|
|
match child.try_wait() {
|
|
Ok(Some(status)) => break status,
|
|
Ok(None) => std::thread::sleep(Duration::from_millis(25)),
|
|
Err(e) => {
|
|
let _ = child.kill();
|
|
let _ = child.wait();
|
|
return Err(format!("couldn't wait for flatpak ({e})"));
|
|
}
|
|
}
|
|
};
|
|
let deadline = Instant::now();
|
|
while !stdout.is_finished() || !stderr.is_finished() {
|
|
check()?;
|
|
if deadline.elapsed() > Duration::from_secs(5) {
|
|
return Err("Flatpak output did not close after completion".into());
|
|
}
|
|
std::thread::sleep(Duration::from_millis(25));
|
|
}
|
|
Ok(std::process::Output { status, stdout: stdout.join().unwrap_or_default(), stderr: stderr.join().unwrap_or_default() })
|
|
}
|
|
|
|
#[cfg(all(test, target_os = "linux"))]
|
|
mod update_cancel_tests {
|
|
use super::*;
|
|
use craft_ui::testing::trial;
|
|
|
|
#[trial]
|
|
fn cancels_a_running_helper_promptly() {
|
|
let mut cmd = command("sleep");
|
|
cmd.arg("30");
|
|
let start = Instant::now();
|
|
let result = cancellable_output(cmd, || if start.elapsed() >= Duration::from_millis(100) { Err("cancelled".into()) } else { Ok(()) });
|
|
assert_eq!(result.unwrap_err(), "cancelled");
|
|
assert!(start.elapsed() < Duration::from_secs(5));
|
|
}
|
|
|
|
/// A descendant that outlives the helper keeps the pipes open; the caller gets an error at
|
|
/// the deadline instead of waiting for it.
|
|
#[trial]
|
|
fn output_held_open_by_a_descendant_fails_at_the_deadline() {
|
|
let mut cmd = command("sh");
|
|
cmd.args(["-c", "sleep 8 &"]);
|
|
let start = Instant::now();
|
|
let err = cancellable_output(cmd, || Ok(())).expect_err("a descendant holding the pipes should time out");
|
|
assert!(err.contains("did not close after completion"), "{err}");
|
|
assert!(start.elapsed() < Duration::from_secs(8), "{:?}", start.elapsed());
|
|
}
|
|
|
|
#[trial]
|
|
fn retains_both_output_streams_and_exit_status() {
|
|
let mut cmd = command("sh");
|
|
cmd.args(["-c", "printf output; printf error >&2; exit 7"]);
|
|
let output = cancellable_output(cmd, || Ok(())).unwrap();
|
|
assert_eq!(output.status.code(), Some(7));
|
|
assert_eq!(output.stdout, b"output");
|
|
assert_eq!(output.stderr, b"error");
|
|
}
|
|
}
|