bestool 1.16.0

BES Deployment tooling
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

use std::path::{Path, PathBuf};
#[cfg(unix)]
use std::process::Stdio;

use bestool_kopia::{SnapshotSelectorArgs, short_id};
use clap::Parser;
use miette::{Context as _, IntoDiagnostic as _, Result};
#[cfg(not(unix))]
use miette::bail;

use super::{
	KopiaArgs,
	common::{current_hostname, kopia_binary},
};
use crate::actions::Context;

/// Mount a kopia snapshot read-only via FUSE.
///
/// Snapshot selection mirrors `restore`: explicit `--snapshot ID`, `--latest`
/// (which requires `--tag` or `--path`), or an interactive picker over the
/// filter flags when neither is given.
#[derive(Debug, Clone, Parser)]
pub struct MountArgs {
	/// Mountpoint. The directory must exist and be empty (kopia requirement).
	#[arg(value_name = "MOUNTPOINT")]
	pub mountpoint: PathBuf,

	#[command(flatten)]
	pub selector: SnapshotSelectorArgs,

	/// Detach the mount process and return immediately. Unix-only; on
	/// Windows the kopia mount stays in foreground regardless.
	#[arg(long)]
	pub background: bool,
}

pub async fn run(args: MountArgs, ctx: Context) -> Result<()> {
	let kopia = ctx.require::<KopiaArgs>();
	let bin = kopia_binary(kopia)?;

	let chosen = args
		.selector
		.resolve(&bin, current_hostname(), "Choose a snapshot to mount")?;

	if args.background {
		mount_background(&bin, &chosen.id, &args.mountpoint)
	} else {
		println!(
			"Mounting snapshot {} at {} (Ctrl+C to unmount)",
			short_id(&chosen.id),
			args.mountpoint.display()
		);
		mount_foreground(&bin, &chosen.id, &args.mountpoint)
	}
}

fn mount_foreground(bin: &Path, snapshot_id: &str, mountpoint: &Path) -> Result<()> {
	let status = std::process::Command::new(bin)
		.arg("mount")
		.arg(snapshot_id)
		.arg(mountpoint)
		.env("KOPIA_CHECK_FOR_UPDATES", "false")
		.status()
		.into_diagnostic()
		.wrap_err_with(|| format!("invoking {}", bin.display()))?;
	if !status.success() {
		std::process::exit(status.code().unwrap_or(1));
	}
	Ok(())
}

#[cfg(unix)]
fn mount_background(bin: &Path, snapshot_id: &str, mountpoint: &Path) -> Result<()> {
	// `setsid --fork` puts the spawned process in a new session AND forks once
	// so the resulting daemon isn't the session leader, which is the standard
	// recipe for detaching from a controlling terminal. setsid(1) is part of
	// util-linux and ships on every Linux distro.
	let child = std::process::Command::new("setsid")
		.arg("--fork")
		.arg(bin)
		.arg("mount")
		.arg(snapshot_id)
		.arg(mountpoint)
		.env("KOPIA_CHECK_FOR_UPDATES", "false")
		.stdin(Stdio::null())
		.stdout(Stdio::null())
		.stderr(Stdio::null())
		.spawn()
		.into_diagnostic()
		.wrap_err("spawning `setsid --fork`; install util-linux if missing")?;
	println!(
		"Mounted snapshot {} at {} in the background; the kopia process detached via setsid (parent setsid pid {})",
		short_id(snapshot_id),
		mountpoint.display(),
		child.id(),
	);
	Ok(())
}

#[cfg(not(unix))]
fn mount_background(_bin: &Path, _snapshot_id: &str, _mountpoint: &Path) -> Result<()> {
	bail!("--background mounts are only supported on Unix");
}