Skip to main content

max / makenotwork

150.5 KB · 3605 lines History Blame Raw
1 //! Rhai recipe engine + host-function API.
2 //!
3 //! A `(app, target)` resolves to a `.rhai` recipe composed from a shared step
4 //! vocabulary. The daemon embeds Rhai and registers the host functions recipes
5 //! call; the recipe is the orchestration, the host functions are the
6 //! privileged primitives (run a command, read a secret, collect artifacts,
7 //! publish). Recipes are otherwise sandboxed — no arbitrary FS/network except
8 //! through these functions — matching the Balanced Breakfast plugin model.
9 //!
10 //! Rhai is synchronous; the engine runs each recipe on a blocking thread
11 //! (`spawn_blocking`, see [`crate::runner`]) and host functions bridge to async
12 //! work via `Handle::block_on`. That is sound only off a runtime worker thread,
13 //! which `spawn_blocking` guarantees.
14
15 use crate::config::Config;
16 use crate::domain::{AppId, Status, Step, StepRunId, Target, Version};
17 use crate::events::{self, Event, EventTx};
18 use crate::ota::{OtaRegistry, PublishAuthority, Release};
19 use crate::state::ExecutorMap;
20 use crate::topology::{DeployTarget, Kind};
21 use anyhow::{Context as _, Result};
22 use ops_core::live_log::LiveLog;
23 use ops_exec::{Action, Executor, ObserveKind, Step as OpStep, SyncOpts};
24 use rhai::{Engine, EvalAltResult, Map};
25 use sha2::{Digest, Sha256};
26 use sqlx::SqlitePool;
27 use std::collections::HashMap;
28 use std::path::{Path, PathBuf};
29 use std::sync::atomic::{AtomicBool, Ordering};
30 use std::sync::{Arc, Mutex};
31 use tokio::runtime::Handle;
32 use tokio::sync::Mutex as AsyncMutex;
33
34 /// The capability label for a command, derived from the open recipe step. A
35 /// recipe's `sh("mbp", …)` under `step("sign")` becomes an `Action::Sign`, gated
36 /// by the mac host's `sign` grant — so recipes stay unchanged while every command
37 /// is capability-checked at its transport. `Verify` is read-only (an observe).
38 /// The capability a step's commands are gated on.
39 ///
40 /// `Verify` depends on what is being released, which is the one place this is
41 /// not a property of the step alone. An app's verify is a Gatekeeper check on a
42 /// signed bundle, and the `gatekeeper` observe is granted implicitly to hosts
43 /// that can `sign` (`CapabilitySet::from_tokens`) precisely so that pairing
44 /// holds. A library's verify is a crate preflight: it runs `cargo` on the build
45 /// host and asks the registry a question. Gating that on Gatekeeper asks a Linux
46 /// host for a macOS code-signing capability it can never honestly hold, and the
47 /// only way to satisfy it would be to declare the capability falsely.
48 fn action_for(step: Step, kind: Kind) -> Action {
49 match step {
50 Step::Checkout | Step::Prebuild | Step::Build => Action::Build,
51 Step::Sign => Action::Sign,
52 Step::Notarize => Action::Notarize,
53 Step::Staple => Action::Staple,
54 Step::Package => Action::Package,
55 Step::Verify => match kind {
56 Kind::App => Action::Observe(ObserveKind::Custom("gatekeeper".into())),
57 // Running the build toolchain to inspect a crate or a service
58 // binary, which is what `build` means on a host. Neither has a
59 // bundle for Gatekeeper to have an opinion about.
60 Kind::Library | Kind::Service => Action::Build,
61 },
62 // Publish/Collect/Handoff run on the daemon, not through a host
63 // executor; this label only applies if a recipe runs a bare `sh` while
64 // one is open. `handoff` is the daemon's own post-recipe motion and no
65 // recipe should open it at all — naming it here costs nothing and beats
66 // a wildcard that would silently absorb the next step somebody adds.
67 Step::Publish | Step::Collect | Step::Handoff => Action::Package,
68 // The one step that dispatches to a host OUTSIDE the build topology.
69 // Every command a recipe runs while `deploy` is open — the install, the
70 // restart, the health assertion — carries this action, so it reaches the
71 // service host only through the deploy grant and reaches a build host
72 // not at all (no build host is granted `deploy`).
73 Step::Deploy => Action::Deploy,
74 }
75 }
76
77 /// The currently-open step within a recipe run: its DB row id, which step it
78 /// is, and the live-log sink that `sh`/`log` stream into.
79 struct StepState {
80 run_id: StepRunId,
81 step: Step,
82 log: Arc<AsyncMutex<LiveLog>>,
83 /// Set when something in the step recorded a hard failure the recipe did
84 /// not abort on (e.g. `verify_gatekeeper` rejected the artifact but the
85 /// recipe ignored the bool). Forces the step's recorded status to `Failed`
86 /// and bars `publish` (the step-success ledger).
87 failed: bool,
88 /// Wall-clock deadline for this step. A command that runs past it fails the
89 /// step (and unwinds the recipe) rather than wedging under the old
90 /// whole-build guillotine, which a legitimate 5-target fan-out plus notary
91 /// queueing could trip — mismarking every target failed while the blocking
92 /// recipe bodies kept signing.
93 deadline: std::time::Instant,
94 }
95
96 /// Per-step wall-clock budget: a generous ceiling that catches a wedged command
97 /// (a hung ssh, a stuck notary poll) without killing legitimately slow work.
98 /// The old design bounded the whole build at 2h; this bounds each step so one
99 /// slow step can't be blamed on another and a fan-out of slow-but-fine targets
100 /// isn't guillotined. `Config::step_timeout_secs` overrides these per-kind
101 /// defaults for every step; see [`RecipeCtx::step_budget`].
102 fn default_step_budget(step: Step) -> std::time::Duration {
103 use std::time::Duration;
104 let mins = match step {
105 Step::Checkout => 10,
106 // clippy + full test suite, cold, on a workspace.
107 Step::Prebuild => 45,
108 // cargo tauri build, cold, universal bundles.
109 Step::Build => 90,
110 Step::Sign => 15,
111 // Apple's notary queue + this step's bounded retries.
112 Step::Notarize => 60,
113 Step::Staple => 10,
114 Step::Package => 30,
115 Step::Verify => 10,
116 // rsync of multi-GiB artifacts off the build host.
117 Step::Collect => 30,
118 Step::Publish => 20,
119 // A binary push, an install, a unit restart, and a health poll. Minutes
120 // of work; the ceiling is for a wedged transport, not slow work.
121 Step::Deploy => 15,
122 // Unused by any recipe — the daemon runs the handoff itself, outside a
123 // step's clock — and matched to `collect`, since it moves the same
124 // bytes the same way and would wedge for the same reasons.
125 Step::Handoff => 30,
126 };
127 Duration::from_secs(mins * 60)
128 }
129
130 /// Where a service's binary is staged on the host that will run it, before the
131 /// privileged installer moves it into place.
132 ///
133 /// A fixed, unguessable-by-accident path rather than a recipe-chosen one,
134 /// because the installer refuses any source outside it. That refusal is the
135 /// only thing standing between the NOPASSWD sudo grant and `install`-as-root to
136 /// an arbitrary path, so both ends have to name the same constant. `/var/tmp`
137 /// rather than `/tmp` so a staged binary survives a `PrivateTmp` unit and a
138 /// systemd tmpfiles sweep between staging and install.
139 pub const DEPLOY_STAGING_ROOT: &str = "/var/tmp/bento-deploy";
140
141 /// Everything a recipe's host functions need, shared (Arc) into each closure.
142 pub struct RecipeCtx {
143 pub app: AppId,
144 pub version: Version,
145 pub target: Target,
146 /// Name of the host this target builds on (resolved from the topology by the
147 /// runner). Recipes read it via `build_host()` so one per-platform recipe can
148 /// dispatch to the right host across arches (linux x86_64 -> fw13, aarch64 ->
149 /// astra) without hard-coding a host name.
150 pub build_host: String,
151 /// The build host's SSH destination (topology `ssh`), as opposed to its
152 /// name. Deploy compares it against the service host's to tell "build and
153 /// run on the same box" from "two hosts that need a transfer" — a question
154 /// the host NAMES cannot answer, since a build host and a deploy
155 /// destination are declared in different files and need not agree on one.
156 pub build_host_ssh: String,
157 /// This release's git tag, rendered from the app's `tag_format`. Held here
158 /// rather than derived from the version because a repo holding several
159 /// products spells it per product (`pom-v0.4.1`), and the recipe, the
160 /// preflight barrier and the failure message all have to agree on it.
161 pub tag: String,
162 /// The app's default checkout path (topology `repo`, `~`-prefixed). Read it
163 /// through [`RecipeCtx::repo_for`] for anything that runs on a build host;
164 /// this field alone is the daemon-local answer.
165 pub repo: String,
166 /// Per-host checkout overrides (topology `repo_by_host`). Empty for every app
167 /// that has not declared one, which is all of them but the Windows-shipping
168 /// ones.
169 pub repo_by_host: HashMap<String, String>,
170 /// Cargo features this app's release builds enable (topology `features`).
171 /// Recipes read it via `feature_flags()`.
172 pub features: Vec<String>,
173 /// App or library. Decides which capability a `verify` step is gated on;
174 /// see [`action_for`].
175 pub kind: Kind,
176 pub target_run_id: i64,
177 /// Capability-scoped executor per build host. Recipe commands dispatch
178 /// through these — the transport (local / ssh / in-session agent) and the
179 /// capability gate are the executor's, not the engine's.
180 pub execs: Arc<ExecutorMap>,
181 /// Sync transport per build host, used only by `collect` to pull artifacts
182 /// back. Never the agent, even for an agent host — see `state::build_sync`.
183 /// Not an execution path.
184 pub syncs: Arc<ExecutorMap>,
185 /// Where this target installs, for a `kind = "service"` app. `None` for an
186 /// app or a library, which makes every deploy host function fail with that
187 /// as the reason rather than with a missing-host error.
188 ///
189 /// The runner resolves it from the app manifest's `[[deploy]]` table and
190 /// registers its executor into `execs` under the destination's host string,
191 /// so `sh_ok(deploy_host(), ...)` reaches the service host through the same
192 /// capability gate as everything else.
193 pub deploy: Option<DeployTarget>,
194 pub pool: SqlitePool,
195 pub events: EventTx,
196 pub cfg: Arc<Config>,
197 pub ota: Arc<OtaRegistry>,
198 pub rt: Handle,
199 current: Mutex<Option<StepState>>,
200 /// Gatekeeper verdict recorded by `verify_gatekeeper`: `None` = never run,
201 /// `Some(false)` = ran and rejected, `Some(true)` = accepted. `publish`
202 /// requires `Some(true)` for a macOS/iOS artifact (the proof it is signed +
203 /// notarized).
204 gatekeeper_ok: Mutex<Option<bool>>,
205 /// Steps finalized as `Failed` during this run. A non-empty ledger bars
206 /// `publish` — an artifact is never shipped after a step failed, even if the
207 /// recipe ignored the failure and ran on.
208 failed_steps: Mutex<Vec<Step>>,
209 /// Set when a newer build supersedes this run. Checked at step boundaries
210 /// and before publish so a superseded recipe stops promptly rather than
211 /// running to completion (the blocking Rhai body can't be `abort()`ed).
212 cancel: Arc<AtomicBool>,
213 /// The all-targets-green publish gate (topology `require_all_targets`).
214 /// `Some(declared)` ⇒ `publish` refuses unless every one of `declared` has a
215 /// successful latest run for this `(app, version)`. `None` ⇒ gate off, each
216 /// target publishes independently.
217 all_green_required: Option<Vec<Target>>,
218 /// sha256 of each artifact hashed at `collect`, keyed by file name. `publish`
219 /// reads it to record `releases.artifact_hash` for the bytes it ships, so the
220 /// hash is the one computed when the artifact landed rather than a re-read
221 /// that could see a different file. Absent ⇒ `publish` hashes on demand.
222 artifact_hashes: Mutex<HashMap<String, String>>,
223 }
224
225 impl RecipeCtx {
226 /// Versions of `name` already on crates.io. A network failure yields an
227 /// empty list: preflight then cannot claim a version is a duplicate, and
228 /// `cargo publish` still refuses one, so the check degrades to advisory
229 /// rather than blocking a release on registry availability.
230 fn published_versions(name: &str) -> Vec<String> {
231 let url = format!("https://crates.io/api/v1/crates/{name}");
232 let Ok(out) = std::process::Command::new("curl")
233 .args([
234 "-sS",
235 "--max-time",
236 "15",
237 "-H",
238 "User-Agent: bento-preflight",
239 &url,
240 ])
241 .output()
242 else {
243 return Vec::new();
244 };
245 let Ok(v) = serde_json::from_slice::<serde_json::Value>(&out.stdout) else {
246 return Vec::new();
247 };
248 v.get("versions")
249 .and_then(|x| x.as_array())
250 .map(|a| {
251 a.iter()
252 .filter_map(|x| x.get("num").and_then(|n| n.as_str()).map(str::to_string))
253 .collect()
254 })
255 .unwrap_or_default()
256 }
257
258 #[allow(clippy::too_many_arguments)]
259 pub fn new(
260 app: AppId,
261 version: Version,
262 target: Target,
263 build_host: String,
264 build_host_ssh: String,
265 tag: String,
266 repo: String,
267 features: Vec<String>,
268 kind: Kind,
269 target_run_id: i64,
270 execs: Arc<ExecutorMap>,
271 syncs: Arc<ExecutorMap>,
272 deploy: Option<DeployTarget>,
273 pool: SqlitePool,
274 events: EventTx,
275 cfg: Arc<Config>,
276 ota: Arc<OtaRegistry>,
277 rt: Handle,
278 cancel: Arc<AtomicBool>,
279 all_green_required: Option<Vec<Target>>,
280 ) -> Self {
281 Self {
282 app,
283 version,
284 target,
285 build_host,
286 build_host_ssh,
287 tag,
288 repo,
289 repo_by_host: HashMap::new(),
290 features,
291 kind,
292 target_run_id,
293 execs,
294 syncs,
295 deploy,
296 pool,
297 events,
298 cfg,
299 ota,
300 rt,
301 current: Mutex::new(None),
302 gatekeeper_ok: Mutex::new(None),
303 failed_steps: Mutex::new(Vec::new()),
304 cancel,
305 all_green_required,
306 artifact_hashes: Mutex::new(HashMap::new()),
307 }
308 }
309
310 /// Declare the app's per-host checkout overrides (topology `repo_by_host`).
311 ///
312 /// Separate from `new` because it is empty for every app that has not opted
313 /// in, and `new` already carries twenty arguments no test wants a
314 /// twenty-first of.
315 #[must_use]
316 pub fn with_repo_by_host(mut self, repo_by_host: HashMap<String, String>) -> Self {
317 self.repo_by_host = repo_by_host;
318 self
319 }
320
321 /// Where this app is checked out on `host` (topology `AppConfig::repo_for`).
322 ///
323 /// Every git command a recipe or the engine runs on a build host goes
324 /// through this. The bare `repo` field is the daemon-local path.
325 pub fn repo_for(&self, host: &str) -> &str {
326 self.repo_by_host
327 .get(host)
328 .map_or(self.repo.as_str(), String::as_str)
329 }
330
331 /// Whether a newer build has superseded this run.
332 fn is_cancelled(&self) -> bool {
333 self.cancel.load(Ordering::SeqCst)
334 }
335
336 fn now() -> String {
337 chrono::Utc::now().to_rfc3339()
338 }
339
340 /// `<logs_root>/<app>/<version>/<target-with-slash-as-dash>/<step>.<run_id>.log`.
341 ///
342 /// The run id is in the filename because the rest of the key is not unique:
343 /// re-running an app at a version it already built (a retry, or a rebuild of
344 /// an already-published release) reopens the same path, and the old file
345 /// appended to shows two runs' output with nothing marking the boundary. The
346 /// step ledger records a run id per step, so keying the file on it makes a
347 /// ledger row resolve to exactly one file and keeps the earlier run readable.
348 fn log_path(&self, step: Step, run_id: StepRunId) -> PathBuf {
349 self.log_dir()
350 .join(format!("{}.{}.log", step.as_str(), run_id.0))
351 }
352
353 /// `<logs_root>/<app>/<version>/<target-with-slash-as-dash>/`.
354 fn log_dir(&self) -> PathBuf {
355 let target_dir = self.target.to_string().replace('/', "-");
356 self.cfg
357 .logs_root
358 .join(self.app.as_str())
359 .join(self.version.to_string())
360 .join(target_dir)
361 }
362
363 /// Close the previous step (as `Ok`), open a new one: insert its DB row,
364 /// open a live log whose chunks broadcast `StepLogChunk`, emit `StepStart`.
365 fn begin_step(self: &Arc<Self>, step: Step) -> Result<()> {
366 anyhow::ensure!(
367 !self.is_cancelled(),
368 "build superseded by a newer request; aborting before `{}`",
369 step.as_str()
370 );
371 self.finish_step(Status::Ok)?;
372 let me = self.clone();
373 let started = Self::now();
374 let started_for_header = started.clone();
375 let run_id = self.rt.block_on(async move {
376 // The step row and the target's current_step pointer are one logical
377 // state — write them atomically so a failure can't leave a `running`
378 // step row while current_step still names the previous step.
379 let mut tx = me.pool.begin().await.context("begin step tx")?;
380 // log_ref names the run id, which only exists once the row does, so
381 // the path is written back inside the same transaction rather than
382 // guessed beforehand.
383 let id: i64 = sqlx::query_scalar(
384 "INSERT INTO step_runs (target_run_id, step, status, started_at)
385 VALUES (?, ?, 'running', ?) RETURNING id",
386 )
387 .bind(me.target_run_id)
388 .bind(step.as_str())
389 .bind(&started)
390 .fetch_one(&mut *tx)
391 .await
392 .context("insert step_run")?;
393 let log_ref = me
394 .log_path(step, StepRunId(id))
395 .to_string_lossy()
396 .into_owned();
397 sqlx::query("UPDATE step_runs SET log_ref = ? WHERE id = ?")
398 .bind(&log_ref)
399 .bind(id)
400 .execute(&mut *tx)
401 .await
402 .context("set step_run log_ref")?;
403 sqlx::query("UPDATE target_runs SET current_step = ? WHERE id = ?")
404 .bind(step.as_str())
405 .bind(me.target_run_id)
406 .execute(&mut *tx)
407 .await
408 .context("update current_step")?;
409 tx.commit().await.context("commit step tx")?;
410 anyhow::Ok(StepRunId(id))
411 })?;
412
413 // Live log: each chunk fans out as a StepLogChunk event keyed by run_id.
414 let events = self.events.clone();
415 let cb_run_id = run_id;
416 let mut log = self.rt.block_on(LiveLog::open(
417 self.log_path(step, run_id),
418 Box::new(move |seq, text| {
419 events::emit(
420 &events,
421 Event::StepLogChunk {
422 run_id: cb_run_id,
423 seq,
424 text: text.to_string(),
425 },
426 );
427 }),
428 ));
429
430 events::emit(
431 &self.events,
432 Event::StepStart {
433 run_id,
434 app: self.app.clone(),
435 version: self.version.clone(),
436 target: self.target,
437 step,
438 },
439 );
440
441 // A log that names its own run: reading one tells you which ledger row
442 // it belongs to without going back to the DB, and a file that somehow
443 // does get appended to still shows where the second run began. Written
444 // after `StepStart` so its chunk event cannot precede the step it
445 // belongs to.
446 let header = format!(
447 "=== bento {app} {version} {target} step={step} run_id={run_id} started={started_for_header} ===\n",
448 app = self.app.as_str(),
449 version = self.version,
450 target = self.target,
451 step = step.as_str(),
452 );
453 self.rt.block_on(async {
454 use ops_core::remote::LogSink as _;
455 log.write_chunk(header.as_bytes()).await;
456 });
457
458 *self.current.lock().unwrap() = Some(StepState {
459 run_id,
460 step,
461 log: Arc::new(AsyncMutex::new(log)),
462 failed: false,
463 deadline: std::time::Instant::now() + self.step_budget(step),
464 });
465 Ok(())
466 }
467
468 /// This build's budget for `step`: the `Config` override if set, else the
469 /// per-kind default.
470 fn step_budget(&self, step: Step) -> std::time::Duration {
471 self.cfg
472 .step_timeout_secs
473 .map_or_else(|| default_step_budget(step), std::time::Duration::from_secs)
474 }
475
476 /// The current step's wall-clock deadline (or a default if no step is open,
477 /// which only happens before the first `step()` — commands then run under an
478 /// implicit `Build` step opened by `ensure_step`).
479 fn step_deadline(&self) -> std::time::Instant {
480 self.current.lock().unwrap().as_ref().map_or_else(
481 || std::time::Instant::now() + self.step_budget(Step::Build),
482 |s| s.deadline,
483 )
484 }
485
486 /// Drive `fut` on the runtime, but stop early on two conditions the recipe
487 /// bodies otherwise cannot observe (they run synchronously on a blocking
488 /// thread): the current step's deadline, and supersession by a newer build.
489 /// Either turns into an error that fails the step and unwinds the recipe, so
490 /// a wedged command no longer runs unbounded and a superseded build stops
491 /// mid-step instead of only at the next step boundary.
492 fn run_bounded<F, T>(&self, what: &str, fut: F) -> Result<T>
493 where
494 F: std::future::Future<Output = Result<T>>,
495 {
496 let deadline = self.step_deadline();
497 let cancel = self.cancel.clone();
498 self.rt.block_on(async move {
499 tokio::pin!(fut);
500 let watch = async {
501 // Poll the cooperative cancel flag; the finalizer and a
502 // superseding build both set it. Cheap next to a build step.
503 while !cancel.load(Ordering::SeqCst) {
504 tokio::time::sleep(std::time::Duration::from_millis(250)).await;
505 }
506 };
507 tokio::select! {
508 r = &mut fut => r,
509 () = tokio::time::sleep_until(deadline.into()) => {
510 Err(anyhow::anyhow!("`{what}` exceeded its per-step deadline"))
511 }
512 () = watch => {
513 Err(anyhow::anyhow!("build superseded by a newer request; aborting `{what}`"))
514 }
515 }
516 })
517 }
518
519 /// Flag the currently-open step as failed (no-op if none is open). Forces
520 /// its recorded status to `Failed` at `finish_step` and adds it to the
521 /// publish-barring ledger, even though the recipe kept running.
522 fn fail_current_step(&self) {
523 if let Some(st) = self.current.lock().unwrap().as_mut() {
524 st.failed = true;
525 }
526 }
527
528 /// Finalize the open step (if any): close its log, stamp the DB row, emit
529 /// `StepDone`. Idempotent when no step is open. A step flagged via
530 /// [`fail_current_step`] is recorded `Failed` regardless of the requested
531 /// status, and added to the ledger `publish` consults.
532 pub fn finish_step(self: &Arc<Self>, status: Status) -> Result<()> {
533 let st = self.current.lock().unwrap().take();
534 let Some(st) = st else { return Ok(()) };
535 let status = if st.failed { Status::Failed } else { status };
536 if status == Status::Failed {
537 self.failed_steps.lock().unwrap().push(st.step);
538 }
539 let me = self.clone();
540 self.rt.block_on(async move {
541 // Drop all log refs so the sink can be owned + flushed.
542 if let Ok(m) = Arc::try_unwrap(st.log) {
543 m.into_inner().close().await;
544 }
545 if let Err(e) = sqlx::query(
546 "UPDATE step_runs SET status = ?, finished_at = ? WHERE id = ?",
547 )
548 .bind(status.as_str())
549 .bind(Self::now())
550 .bind(st.run_id.0)
551 .execute(&me.pool)
552 .await
553 {
554 tracing::error!(step = st.step.as_str(), error = %e, "could not stamp step_run status");
555 }
556 });
557 events::emit(
558 &self.events,
559 Event::StepDone {
560 run_id: st.run_id,
561 app: self.app.clone(),
562 target: self.target,
563 step: st.step,
564 status,
565 },
566 );
567 Ok(())
568 }
569
570 /// Ensure a step is open; default to `Build` if a recipe runs a command
571 /// before declaring one.
572 fn ensure_step(self: &Arc<Self>) -> Result<Arc<AsyncMutex<LiveLog>>> {
573 if self.current.lock().unwrap().is_none() {
574 self.begin_step(Step::Build)?;
575 }
576 Ok(self.current.lock().unwrap().as_ref().unwrap().log.clone())
577 }
578
579 /// The step currently open, or `Build` as a default for failure
580 /// attribution before any step was declared.
581 pub fn current_step(&self) -> Step {
582 self.current
583 .lock()
584 .unwrap()
585 .as_ref()
586 .map_or(Step::Build, |s| s.step)
587 }
588
589 /// The capability-scoped executor for `name`, or an error if the host isn't
590 /// in the topology.
591 fn exec(&self, name: &str) -> Result<Arc<dyn ops_exec::Executor>> {
592 self.execs
593 .get(name)
594 .cloned()
595 .ok_or_else(|| anyhow::anyhow!("unknown build host `{name}` (not in topology)"))
596 }
597
598 /// The ssh string for `name` (for `collect`'s remote scp source).
599 /// The transport that moves artifacts off `name`. Distinct from
600 /// [`RecipeCtx::exec_for`]'s executor: an agent host signs over `AgentRpc`
601 /// but is collected from over ssh (`state::build_sync`).
602 fn host_sync(&self, name: &str) -> Result<Arc<dyn Executor>> {
603 self.syncs
604 .get(name)
605 .cloned()
606 .ok_or_else(|| anyhow::anyhow!("unknown build host `{name}` (not in topology)"))
607 }
608
609 /// Run `cmd` on `host` through its capability-scoped executor, streaming into
610 /// the current step's log. The command's [`Action`] is derived from the open
611 /// step (see [`action_for`]) and gated at the transport before dispatch — so a
612 /// `build` step on a host without the `build` grant is denied, and the macOS
613 /// sign steps ride the in-session `AgentRpc` transport automatically. Returns
614 /// exit code + a tail of stdout for the recipe to branch on.
615 fn run(self: &Arc<Self>, host: &str, cmd: &str) -> Result<(i32, String)> {
616 // The service host is addressed as a service host whatever step is open.
617 // Deriving the action from the step is right for a build host, where the
618 // step IS the work; on a service host it would ask for `build` during a
619 // `verify` and be denied for a reason unrelated to what was attempted.
620 let action = match &self.deploy {
621 Some(d) if d.host == host => Action::Deploy,
622 _ => action_for(self.current_step(), self.kind),
623 };
624 self.run_as(host, cmd, action)
625 }
626
627 /// `run`, with the [`Action`] stated rather than resolved. Used where the
628 /// caller already knows which plane it is on.
629 fn run_as(self: &Arc<Self>, host: &str, cmd: &str, action: Action) -> Result<(i32, String)> {
630 let sink = self.ensure_step()?;
631 let exec = self.exec(host)?;
632 let cur = self.current_step();
633 let step = OpStep::shell(action, cmd.to_string());
634 // Echo the command before running it. Without this a log says what
635 // happened but not what was asked, and a gate that prints nothing when
636 // it passes (`cargo fmt --all --check`) is indistinguishable from a gate
637 // that never ran.
638 let echo = format!("$ [{host}] {cmd}\n");
639 // Bounded by the step's deadline and interruptible on supersession, so a
640 // hung command fails its step instead of running unbounded, and a
641 // superseded build stops mid-step rather than only at the next boundary.
642 let label = format!("{cur} command on `{host}`");
643 let out = self.run_bounded(&label, async move {
644 use ops_core::remote::LogSink as _;
645 let mut guard = sink.lock().await;
646 guard.write_chunk(echo.as_bytes()).await;
647 exec.run_streaming(&step, &mut *guard).await
648 })?;
649 let code = out.status.code().unwrap_or(-1);
650 let stdout = String::from_utf8_lossy(&out.stdout);
651 let tail: String = stdout
652 .chars()
653 .rev()
654 .take(2000)
655 .collect::<Vec<_>>()
656 .into_iter()
657 .rev()
658 .collect();
659 Ok((code, tail))
660 }
661
662 /// Assert `host`'s build tree is at the release tag and return the commit,
663 /// which is what a recipe's `checkout` step logs. Fetch + checkout stream
664 /// into the current step's log; the sha comes from a separate `rev-parse` so
665 /// its stdout is only the sha.
666 ///
667 /// The preflight has already put this tree at the tag before any recipe ran —
668 /// this is the same operation again, on purpose, so that a recipe's own
669 /// `checkout` step is a real step with a real log rather than a claim about
670 /// something that happened elsewhere. Re-running it is cheap and, because the
671 /// tree is Bento's own worktree, forcing: a build that has already dirtied it
672 /// must not be able to fail its own retry.
673 fn checkout_sha(self: &Arc<Self>, host: &str) -> Result<String> {
674 // Every command below runs ON `host`, so the path is that host's, not the
675 // daemon's. Windows is why: its worktree is under `C:/Users/me/Code/...`.
676 let repo = self.repo_for(host).to_string();
677 // A failing mirror is not a failing release: fetch is advisory, and only
678 // the checkout decides. Its output still streams into the step log, so an
679 // unreachable remote stays visible without being fatal.
680 let _ = self.run(host, &git_fetch_cmd(&repo))?;
681 let (code, err) = self.run(host, &git_worktree_pin_cmd(&repo, &self.tag))?;
682 if code != 0 {
683 let (probe, _) = self.run(host, &git_tag_exists_cmd(&repo, &self.tag))?;
684 anyhow::bail!(
685 "checkout of {} failed on `{host}`: {}",
686 self.tag,
687 worktree_failure_reason(&self.tag, probe == 0, &err)
688 );
689 }
690 let (code, tail) = self.run(host, &git_rev_parse_cmd(&repo))?;
691 anyhow::ensure!(code == 0, "rev-parse failed on `{host}`");
692 Ok(tail.trim().to_string())
693 }
694
695 /// Every artifact this run collected, `file name -> sha256`.
696 ///
697 /// Already computed at `collect`, which is the only moment the bytes are
698 /// known to be the ones that landed.
699 pub fn artifact_hashes(&self) -> HashMap<String, String> {
700 self.artifact_hashes.lock().unwrap().clone()
701 }
702
703 /// Resolve `glob` on `host` to the single artifact it names. The `for` loop
704 /// lists each existing match on its own line (and prints nothing — rather
705 /// than a literal unexpanded pattern — when the glob matches no file), so
706 /// the count is unambiguous. `required` controls whether zero matches is an
707 /// error; more than one always is. See `resolve_artifact_match`.
708 fn resolve_artifact(
709 self: &Arc<Self>,
710 host: &str,
711 glob: &str,
712 required: bool,
713 ) -> Result<String> {
714 ensure_glob_safe(glob)?;
715 // `[ -e ]` guards against a non-matching glob surviving as its literal
716 // self, and lists one path per line for the count.
717 let cmd = format!("for __f in {glob}; do [ -e \"$__f\" ] && printf '%s\\n' \"$__f\"; done");
718 let (code, tail) = self.run(host, &cmd)?;
719 anyhow::ensure!(
720 code == 0,
721 "resolving artifact glob `{glob}` on `{host}` exited {code}"
722 );
723 resolve_artifact_match(&tail, glob, required)
724 }
725 }
726
727 // ----- error bridging: anyhow -> Rhai runtime error -----
728
729 // Rhai host functions return `Result<_, Box<EvalAltResult>>` by convention, so
730 // this bridge must yield the boxed form to be usable with `.map_err(rhai_err)`.
731 #[allow(
732 clippy::unnecessary_box_returns,
733 reason = "rhai's error type is used boxed throughout its host-function API"
734 )]
735 fn rhai_err(e: impl std::fmt::Display) -> Box<EvalAltResult> {
736 Box::new(EvalAltResult::ErrorRuntime(
737 e.to_string().into(),
738 rhai::Position::NONE,
739 ))
740 }
741
742 /// A crate's publish-relevant metadata, read from `cargo metadata`.
743 #[derive(Debug, Clone)]
744 pub struct CrateMeta {
745 pub name: String,
746 pub version: String,
747 pub repository: Option<String>,
748 pub description: Option<String>,
749 pub licensed: bool,
750 }
751
752 /// Parse the fields that matter for publishing out of `cargo metadata` JSON.
753 pub fn crate_meta_from_json(raw: &str) -> Result<CrateMeta> {
754 let v: serde_json::Value = serde_json::from_str(raw).context("parsing cargo metadata")?;
755 let p = v
756 .get("packages")
757 .and_then(|p| p.as_array())
758 .and_then(|a| a.first())
759 .context("cargo metadata reported no package")?;
760 let str_field = |k: &str| {
761 p.get(k)
762 .and_then(|x| x.as_str())
763 .filter(|s| !s.is_empty())
764 .map(str::to_string)
765 };
766 Ok(CrateMeta {
767 name: str_field("name").context("package has no name")?,
768 version: str_field("version").context("package has no version")?,
769 repository: str_field("repository"),
770 description: str_field("description"),
771 licensed: str_field("license").is_some() || str_field("license_file").is_some(),
772 })
773 }
774
775 /// Everything wrong with a crate's metadata, as messages. Empty means publishable.
776 ///
777 /// Checks only what crates.io records permanently. A published version cannot
778 /// be edited, only yanked, and yanking does not correct a wrong URL — so these
779 /// are the last moment any of it can be fixed.
780 pub fn crate_publish_problems(
781 meta: &CrateMeta,
782 repo_clonable: bool,
783 published: &[String],
784 credentials_present: bool,
785 ) -> Vec<String> {
786 let mut out = Vec::new();
787 if !credentials_present {
788 out.push(
789 "no crates.io credentials on the publishing host: `cargo login` there first. \
790 Checked now rather than at the upload, so this fails in seconds instead of \
791 after a full build and verify."
792 .to_string(),
793 );
794 }
795 match &meta.repository {
796 None => out.push(
797 "no `repository` field: the crates.io page will show no source link, permanently"
798 .to_string(),
799 ),
800 Some(url) if !repo_clonable => out.push(format!(
801 "`repository` is not publicly clonable: {url} \
802 (wrong URL, or the repo is private)"
803 )),
804 Some(_) => {}
805 }
806 if meta.description.is_none() {
807 out.push("no `description`: crates.io requires one".to_string());
808 }
809 if !meta.licensed {
810 out.push("no `license` or `license-file`".to_string());
811 }
812 if published.iter().any(|v| v == &meta.version) {
813 out.push(format!(
814 "version {} is already published; bump it",
815 meta.version
816 ));
817 }
818 out
819 }
820
821 /// Read the app's version from its checkout on the daemon host. With
822 /// `version_path` set (topology `version_path`), read exactly that file — a
823 /// `.json` as a Tauri config, anything else as a `Cargo.toml`. Unset (the Tauri
824 /// default), try `src-tauri/tauri.conf.json` then the root `Cargo.toml`. Used by
825 /// the runner's default-version path.
826 pub fn version_from_repo(repo: &str, version_path: Option<&str>) -> Result<Version> {
827 let root = expand_tilde(repo);
828 if let Some(vp) = version_path {
829 let path = root.join(vp);
830 let raw = std::fs::read_to_string(&path)
831 .with_context(|| format!("reading version file {}", path.display()))?;
832 let ver = if std::path::Path::new(vp)
833 .extension()
834 .is_some_and(|e| e.eq_ignore_ascii_case("json"))
835 {
836 version_from_tauri_json(&raw)?
837 } else {
838 version_from_cargo_toml(&raw)?
839 };
840 return Version::parse(&ver).map_err(|e| anyhow::anyhow!(e));
841 }
842 let tauri_conf = root.join("src-tauri").join("tauri.conf.json");
843 if tauri_conf.exists() {
844 let raw = std::fs::read_to_string(&tauri_conf)
845 .with_context(|| format!("reading {}", tauri_conf.display()))?;
846 return Version::parse(&version_from_tauri_json(&raw)?).map_err(|e| anyhow::anyhow!(e));
847 }
848 let cargo_toml = root.join("Cargo.toml");
849 let raw = std::fs::read_to_string(&cargo_toml).with_context(|| {
850 format!(
851 "reading {} (no tauri.conf.json either)",
852 cargo_toml.display()
853 )
854 })?;
855 Version::parse(&version_from_cargo_toml(&raw)?).map_err(|e| anyhow::anyhow!(e))
856 }
857
858 /// Extract `version` from raw `tauri.conf.json` text.
859 fn version_from_tauri_json(raw: &str) -> Result<String> {
860 let v: serde_json::Value = serde_json::from_str(raw).context("parsing tauri.conf.json")?;
861 v.get("version")
862 .and_then(|x| x.as_str())
863 .map(str::to_owned)
864 .context("no `version` in tauri.conf.json")
865 }
866
867 /// Extract the version from raw `Cargo.toml` text — `[package].version` (a leaf
868 /// crate) or `[workspace.package].version` (a workspace that sets it).
869 fn version_from_cargo_toml(raw: &str) -> Result<String> {
870 let doc: toml::Value = toml::from_str(raw).context("parsing Cargo.toml")?;
871 doc.get("package")
872 .and_then(|p| p.get("version"))
873 .or_else(|| {
874 doc.get("workspace")
875 .and_then(|w| w.get("package"))
876 .and_then(|p| p.get("version"))
877 })
878 .and_then(|v| v.as_str())
879 .map(str::to_owned)
880 .context("no `[package].version` or `[workspace.package].version` in Cargo.toml")
881 }
882
883 /// Cross-check every version source in a repo and confirm they all agree with
884 /// the version being built, before a single host pulls or compiles.
885 ///
886 /// `version_from_repo` reads exactly one file, so a `tauri.conf.json` at 0.5.0
887 /// and a root `Cargo.toml` still at 0.4.0 build happily and file artifacts under
888 /// whichever the runner happened to read. This reads every source present —
889 /// `version_path` (when set), `src-tauri/tauri.conf.json`, and the root
890 /// `Cargo.toml` — and fails loudly when any disagree, naming each file and its
891 /// version. A source that is absent is skipped (a library crate with only a
892 /// `Cargo.toml` has nothing to disagree with); the check never invents drift.
893 ///
894 /// Scope: the JSON/TOML sources bentod itself reads. The iOS `gen/apple/project.yml`
895 /// path (rewritten by a build-time `sed`) is out of scope here — it is asserted at
896 /// its own build step — but the same drift class motivated this guard.
897 pub fn check_version_consistency(
898 repo: &str,
899 version_path: Option<&str>,
900 expected: &Version,
901 ) -> Result<()> {
902 let root = expand_tilde(repo);
903 let mut sources: Vec<(String, String)> = Vec::new();
904 for rel in version_sources(version_path) {
905 let path = root.join(&rel);
906 // A source that is absent is skipped — a library crate with only a
907 // `Cargo.toml` has nothing to disagree with — but one the app NAMES
908 // must be readable, or the check would pass by failing to look.
909 match std::fs::read_to_string(&path) {
910 Ok(raw) => sources.push((rel, raw)),
911 Err(e) if version_path == Some(rel.as_str()) => {
912 return Err(e).with_context(|| format!("reading version file {}", path.display()));
913 }
914 Err(_) => {}
915 }
916 }
917 versions_agree(repo, &sources, version_path, expected)
918 }
919
920 /// The files a repo can state its version in, in the order they are read:
921 /// whatever the app names, then the two conventional ones.
922 ///
923 /// The app's own `version_path` is never read twice, which is why this is a
924 /// function rather than a constant.
925 pub fn version_sources(version_path: Option<&str>) -> Vec<String> {
926 let mut rels: Vec<String> = version_path.into_iter().map(str::to_string).collect();
927 for conventional in ["src-tauri/tauri.conf.json", "Cargo.toml"] {
928 if version_path != Some(conventional) {
929 rels.push(conventional.to_string());
930 }
931 }
932 rels
933 }
934
935 /// The judgement half of [`check_version_consistency`], over sources somebody
936 /// else read.
937 ///
938 /// Split out so the same rule can be applied to files read out of the release
939 /// TAG on a build host, which is where the question actually belongs: the tree
940 /// a release compiles is the tag's, so a `Cargo.toml` that disagrees with the
941 /// tag it is tagged in is the drift worth refusing. Reading the working copy
942 /// instead answered a question about a tree the release does not build.
943 ///
944 /// `where_` is only for the error message — a path, or a tag and a host.
945 pub fn versions_agree(
946 where_: &str,
947 sources: &[(String, String)],
948 version_path: Option<&str>,
949 expected: &Version,
950 ) -> Result<()> {
951 let mut found: Vec<(String, Version)> = Vec::new();
952 for (rel, raw) in sources {
953 // The app's own `version_path` can be either shape, so it is decided by
954 // extension; the two conventional sources are what they are.
955 let as_json = std::path::Path::new(rel)
956 .extension()
957 .is_some_and(|e| e.eq_ignore_ascii_case("json"));
958 let ver = if as_json {
959 version_from_tauri_json(raw)
960 } else {
961 // A Cargo.toml with neither `[package].version` nor
962 // `[workspace.package].version` (a pure virtual workspace) carries
963 // no version to check — skip it rather than fail. An app that NAMED
964 // this file is held to it.
965 match version_from_cargo_toml(raw) {
966 Ok(v) => Ok(v),
967 Err(e) if version_path == Some(rel.as_str()) => Err(e),
968 Err(_) => continue,
969 }
970 }?;
971 found.push((
972 rel.clone(),
973 Version::parse(&ver).map_err(|e| anyhow::anyhow!(e))?,
974 ));
975 }
976
977 let disagree: Vec<&(String, Version)> = found.iter().filter(|(_, v)| v != expected).collect();
978 anyhow::ensure!(
979 disagree.is_empty(),
980 "version drift in {where_}: building {expected} but {}",
981 disagree
982 .iter()
983 .map(|(src, v)| format!("{src} says {v}"))
984 .collect::<Vec<_>>()
985 .join(", ")
986 );
987 Ok(())
988 }
989
990 /// Read one file as it exists in `tag`, without checking anything out.
991 ///
992 /// `<rev>:./<path>` resolves the path relative to `-C`, so this is asked from
993 /// the app's own directory and needs no knowledge of where that sits inside the
994 /// repository. A non-zero exit means the file is not in the tag, which is the
995 /// same "absent, so nothing to disagree with" the local read treats it as.
996 pub fn git_show_file_cmd(dir: &str, tag: &str, rel: &str) -> String {
997 format!("git -C \"{dir}\" show \"{tag}:./{rel}\"")
998 }
999
1000 /// Every `X.Y.Z`-shaped version embedded in an artifact file name. Each maximal
1001 /// run of digits-and-dots contributes its first three numeric fields:
1002 /// `GoingsOn_0.5.0_aarch64.dmg` and `demo-9.9.9.bin` both yield one version (the
1003 /// trailing `.bin`/`.dmg` dot is tolerated), while `latest.json` yields `[]` and
1004 /// the `64` in `x86_64` is not three fields. Only the `major.minor.patch` core is
1005 /// taken; a prerelease/build suffix is separated by `-`/`+` and not needed here.
1006 fn versions_in_filename(name: &str) -> Vec<Version> {
1007 name.split(|c: char| !(c.is_ascii_digit() || c == '.'))
1008 .filter_map(|run| {
1009 let f: Vec<&str> = run.split('.').filter(|s| !s.is_empty()).collect();
1010 if f.len() >= 3 && f[..3].iter().all(|s| s.chars().all(|c| c.is_ascii_digit())) {
1011 Version::parse(&format!("{}.{}.{}", f[0], f[1], f[2])).ok()
1012 } else {
1013 None
1014 }
1015 })
1016 .collect()
1017 }
1018
1019 /// Fail when a collected file's name embeds a version whose `major.minor.patch`
1020 /// is not the one being built. This is the guard against a stale checked-in
1021 /// artifact winning a glob: `ls -t <glob>` once let
1022 /// `AudioFiles-0.4.0-x86_64.AppImage` ship against 0.5.0. A file whose name
1023 /// carries no version (an updater `latest.json`, a `.sig`) is not asserted —
1024 /// there is nothing to compare. Compared on the core so a prerelease build's
1025 /// plain `X.Y.Z` in the filename still matches.
1026 fn assert_artifact_version(name: &str, expected: &Version) -> Result<()> {
1027 let versions = versions_in_filename(name);
1028 anyhow::ensure!(
1029 versions.is_empty() || versions.iter().any(|v| v.core() == expected.core()),
1030 "collected artifact `{name}` carries version {} but the build is {expected}; \
1031 a stale artifact was left in the output dir — clean it so only {expected} remains",
1032 versions
1033 .iter()
1034 .map(ToString::to_string)
1035 .collect::<Vec<_>>()
1036 .join("/"),
1037 );
1038 Ok(())
1039 }
1040
1041 /// sha256 of a file, lowercase hex. Streams in 64 KiB chunks so a multi-GiB
1042 /// bundle never lands in memory whole.
1043 fn sha256_file(path: &Path) -> Result<String> {
1044 let mut file =
1045 std::fs::File::open(path).with_context(|| format!("hashing {}", path.display()))?;
1046 let mut hasher = Sha256::new();
1047 std::io::copy(&mut file, &mut hasher)
1048 .with_context(|| format!("reading {} to hash", path.display()))?;
1049 Ok(hex_lower(&hasher.finalize()))
1050 }
1051
1052 /// Every regular file under `root`, as `(path relative to root, absolute path)`,
1053 /// sorted by the relative path.
1054 ///
1055 /// **This walk has to match `bundle::digest_dir` in sando, file for file.** That
1056 /// function re-hashes an incoming bundle and refuses it when the bytes disagree
1057 /// with the manifest they arrived with, so a producer that walks differently
1058 /// produces a manifest the consumer will reject for an artifact nothing is wrong
1059 /// with. Three properties carry that agreement, and none is incidental:
1060 ///
1061 /// - **Recursive.** A bundle may carry a directory (migrations, resources), and
1062 /// a top-level-only listing would omit its contents from the manifest while
1063 /// the verifier hashed them.
1064 /// - **Symlinks are not followed, and not recorded.** Following one would let
1065 /// content from outside the bundle into its identity; recording the link
1066 /// itself would name a file the verifier does not hash.
1067 /// - **Relative paths, `/`-separated, sorted.** Readdir order is not guaranteed,
1068 /// so an unsorted manifest would differ run to run on one machine, never mind
1069 /// between two.
1070 fn collected_files(root: &Path) -> std::io::Result<Vec<(String, PathBuf)>> {
1071 fn walk(dir: &Path, root: &Path, out: &mut Vec<(String, PathBuf)>) -> std::io::Result<()> {
1072 for entry in std::fs::read_dir(dir)? {
1073 let entry = entry?;
1074 let ft = entry.file_type()?;
1075 let path = entry.path();
1076 if ft.is_dir() {
1077 walk(&path, root, out)?;
1078 } else if ft.is_file() {
1079 let rel = path
1080 .strip_prefix(root)
1081 .unwrap_or(&path)
1082 .components()
1083 .map(|c| c.as_os_str().to_string_lossy())
1084 .collect::<Vec<_>>()
1085 .join("/");
1086 out.push((rel, path));
1087 }
1088 // Symlinks and other special files are intentionally ignored,
1089 // matching the verifier.
1090 }
1091 Ok(())
1092 }
1093 let mut out = Vec::new();
1094 walk(root, root, &mut out)?;
1095 out.sort_by(|a, b| a.0.cmp(&b.0));
1096 Ok(out)
1097 }
1098
1099 /// Lowercase-hex encode without pulling in a hex crate.
1100 fn hex_lower(bytes: &[u8]) -> String {
1101 use std::fmt::Write as _;
1102 let mut s = String::with_capacity(bytes.len() * 2);
1103 for b in bytes {
1104 let _ = write!(s, "{b:02x}");
1105 }
1106 s
1107 }
1108
1109 /// Refresh every remote's refs and tags, so the tag a release names is present
1110 /// locally however it was pushed. No branch/upstream assumptions — a bare
1111 /// `git pull --ff-only` needs a tracking branch the release path shouldn't
1112 /// depend on.
1113 ///
1114 /// Best-effort on purpose. `fetch --all` exits non-zero if ANY remote fails, and
1115 /// the library repos carry three (`astra`, `mnw`, `srht`), so chaining this into
1116 /// the checkout with `&&` meant one unreachable mirror aborted the release and
1117 /// reported it as a missing tag. The checkout below is the step allowed to fail;
1118 /// this one only has to try. See [`git_worktree_pin_cmd`].
1119 ///
1120 /// `repo` is interpolated UNQUOTED so a leading `~` is expanded by the remote
1121 /// host's shell (the checkout path is trusted topology config, not user input),
1122 /// matching how the recipes `cd` into it.
1123 pub fn git_fetch_cmd(repo: &str) -> String {
1124 format!("git -C {repo} fetch --all --tags --prune")
1125 }
1126
1127 /// Does `tag` resolve to a commit in this checkout? Run only when the checkout
1128 /// has already failed, to say WHY: an absent tag is an untagged or unpushed
1129 /// release, while a tag that resolves fine means the checkout was refused for a
1130 /// local reason (a dirty tree, most often) and the operator needs to hear that
1131 /// instead.
1132 pub fn git_tag_exists_cmd(repo: &str, tag: &str) -> String {
1133 format!("git -C {repo} rev-parse -q --verify \"refs/tags/{tag}^{{commit}}\"")
1134 }
1135
1136 /// Which repository `repo` belongs to, and where `repo` sits inside it, in one
1137 /// call: `--show-toplevel` then `--show-prefix`, one per line.
1138 ///
1139 /// Both halves are needed to build in a worktree of a repo holding several
1140 /// products. The worktree is made of the repository (`~/Code/MNW`), and the
1141 /// recipe has to be pointed at the app inside it (`<worktree>/pom`).
1142 pub fn git_toplevel_and_prefix_cmd(repo: &str) -> String {
1143 format!("git -C {repo} rev-parse --show-toplevel --show-prefix")
1144 }
1145
1146 /// Read [`git_toplevel_and_prefix_cmd`]'s two lines.
1147 ///
1148 /// The prefix is empty for a repo holding one product, where `repo` IS the
1149 /// repository root — and git prints an empty second line for it, so a missing
1150 /// line is a malformed answer rather than that case.
1151 pub fn parse_toplevel_and_prefix(out: &str) -> Option<(String, String)> {
1152 let mut lines = out.split('\n');
1153 let toplevel = lines.next()?.trim().to_string();
1154 let prefix = lines.next()?.trim().to_string();
1155 (!toplevel.is_empty()).then_some((toplevel, prefix))
1156 }
1157
1158 /// The repository's own directory name, which is what names its worktrees:
1159 /// `MNW` for `/home/max/Code/MNW`.
1160 ///
1161 /// Splits on `/` only. Git reports `--show-toplevel` with forward slashes on
1162 /// every platform, Windows included, so this is the separator to read.
1163 pub fn repo_dir_name(toplevel: &str) -> &str {
1164 toplevel
1165 .trim_end_matches('/')
1166 .rsplit('/')
1167 .next()
1168 .unwrap_or(toplevel)
1169 }
1170
1171 /// Where the app being released sits inside its worktree: the worktree root for
1172 /// a repo holding one product, `<worktree>/pom` for one holding several.
1173 pub fn app_dir_in_worktree(worktree: &str, prefix: &str) -> String {
1174 let prefix = prefix.trim_matches('/');
1175 if prefix.is_empty() {
1176 worktree.to_string()
1177 } else {
1178 format!("{}/{prefix}", worktree.trim_end_matches('/'))
1179 }
1180 }
1181
1182 /// Does this worktree already exist? Run before deciding whether to create one.
1183 ///
1184 /// `rev-parse --git-dir` rather than a shell test, because the one non-unix
1185 /// build host has no `test`: every command Bento renders for a host is a git
1186 /// command or something a recipe wrote.
1187 pub fn git_worktree_probe_cmd(worktree: &str) -> String {
1188 format!("git -C \"{worktree}\" rev-parse --git-dir")
1189 }
1190
1191 /// Forget worktrees whose directories are gone. Run before creating one: a
1192 /// directory somebody deleted by hand is still registered in the repository, and
1193 /// `worktree add` refuses the path as in use rather than rebuilding it.
1194 pub fn git_worktree_prune_cmd(toplevel: &str) -> String {
1195 format!("git -C \"{toplevel}\" worktree prune")
1196 }
1197
1198 /// Create this app's build worktree, detached at the release tag. Git creates
1199 /// the leading directories, so the worktree root needs no preparation.
1200 pub fn git_worktree_add_cmd(toplevel: &str, worktree: &str, tag: &str) -> String {
1201 format!("git -C \"{toplevel}\" worktree add --detach --force \"{worktree}\" \"{tag}\"")
1202 }
1203
1204 /// Put an existing build worktree at the release tag.
1205 ///
1206 /// `--force` discards whatever the last release left in it — a rewritten
1207 /// `Cargo.lock`, most often — and that is safe here in a way it never was in the
1208 /// ordinary checkout: nothing but Bento writes in this tree, so there is no edit
1209 /// of anybody's to lose. Owning the tree is what buys the forcing.
1210 pub fn git_worktree_pin_cmd(worktree: &str, tag: &str) -> String {
1211 format!("git -C \"{worktree}\" checkout --detach --force \"{tag}\"")
1212 }
1213
1214 /// The operator-facing explanation for a worktree that could not be put at the
1215 /// tag.
1216 ///
1217 /// An absent tag is an untagged or unpushed release and is the common case, so
1218 /// it is answered plainly. Anything else is git's own stderr, which says more
1219 /// about a path that is not a worktree, or a worktree another release holds,
1220 /// than a guess would.
1221 pub fn worktree_failure_reason(tag: &str, tag_exists: bool, stderr: &str) -> String {
1222 if !tag_exists {
1223 return format!("tag {tag} does not exist there (is it created and pushed?)");
1224 }
1225 let stderr = stderr.trim();
1226 if stderr.is_empty() {
1227 format!("tag {tag} exists, and git said nothing about why")
1228 } else {
1229 stderr.to_string()
1230 }
1231 }
1232
1233 /// The command a host runs to report the commit it has checked out, for the
1234 /// release preflight barrier.
1235 pub fn git_rev_parse_cmd(repo: &str) -> String {
1236 format!("git -C {repo} rev-parse HEAD")
1237 }
1238
1239 /// Expand a leading `~/` to `$HOME`. Paths in the topology are written with `~`.
1240 pub fn expand_tilde(p: &str) -> PathBuf {
1241 if let Some(rest) = p.strip_prefix("~/")
1242 && let Ok(home) = std::env::var("HOME")
1243 {
1244 return Path::new(&home).join(rest);
1245 }
1246 PathBuf::from(p)
1247 }
1248
1249 /// Reject a glob that carries shell command metacharacters. Path and wildcard
1250 /// characters (`/ . * ? [ ] ~` etc.) are fine — the pattern reaches a login
1251 /// shell to be expanded — but a `;` or `$(...)` must not ride along and run.
1252 /// Not a privilege boundary (a recipe already runs arbitrary shell via `sh_ok`)
1253 /// but it keeps a malformed pattern from turning into a command. Shared by
1254 /// `collect` and `resolve_artifact`.
1255 fn ensure_glob_safe(glob: &str) -> Result<()> {
1256 anyhow::ensure!(
1257 !glob.chars().any(|c| matches!(
1258 c,
1259 ';' | '&' | '|' | '$' | '`' | '\'' | '"' | '\\' | ' ' | '\n' | '(' | ')' | '<' | '>'
1260 )),
1261 "glob `{glob}` contains shell metacharacters"
1262 );
1263 Ok(())
1264 }
1265
1266 /// Decide the single artifact a glob resolves to from a newline-separated
1267 /// listing of the paths that matched it.
1268 ///
1269 /// The recipes used to select an artifact with `ls -t <glob> | head -1` and
1270 /// guard only on an empty string, so a non-zero `ls` slipped past quietly and a
1271 /// stale newest-by-mtime file could win. This is the strict replacement: it
1272 /// demands exactly one match. Zero matches fail when `required` (return `""`
1273 /// when optional); more than one is always an error rather than an arbitrary
1274 /// newest-wins pick, because an ambiguous match means the build left stale
1275 /// artifacts behind and the wrong one could ship.
1276 fn resolve_artifact_match(listing: &str, glob: &str, required: bool) -> Result<String> {
1277 let matches: Vec<&str> = listing
1278 .lines()
1279 .map(str::trim)
1280 .filter(|l| !l.is_empty())
1281 .collect();
1282 match matches.as_slice() {
1283 [] if required => anyhow::bail!("no artifact matched glob `{glob}`"),
1284 [] => Ok(String::new()),
1285 [one] => Ok((*one).to_string()),
1286 many => anyhow::bail!(
1287 "glob `{glob}` is ambiguous: {} artifacts matched ({}). \
1288 The build left more than one behind; clean stale artifacts so exactly one remains.",
1289 many.len(),
1290 many.join(", ")
1291 ),
1292 }
1293 }
1294
1295 /// Build a Rhai engine with the host API bound to `ctx`. Sandboxed: recipes
1296 /// touch the outside world only through these functions.
1297 pub fn build_engine(ctx: &Arc<RecipeCtx>) -> Engine {
1298 let mut engine = Engine::new();
1299 // Defensive caps — recipes are first-party but bound the blast radius.
1300 engine.set_max_operations(5_000_000);
1301 engine.set_max_call_levels(64);
1302 engine.set_max_string_size(0);
1303
1304 // --- step(name) ---
1305 {
1306 let ctx = ctx.clone();
1307 engine.register_fn(
1308 "step",
1309 move |name: &str| -> Result<(), Box<EvalAltResult>> {
1310 let step: Step = name.parse().map_err(rhai_err)?;
1311 ctx.begin_step(step).map_err(rhai_err)
1312 },
1313 );
1314 }
1315
1316 // --- sh(host, cmd) -> #{ code, stdout_tail } ---
1317 //
1318 // The branch-on-exit-code primitive: the recipe OWNS the outcome. A non-zero
1319 // exit is returned, not raised, and does NOT fail the step or bar publish —
1320 // use this only when the recipe inspects `code` and decides. For a command
1321 // that must succeed (build/sign/etc.), use `sh_ok`, which fails the step (and
1322 // therefore bars publish via the failed-step ledger) on a non-zero exit.
1323 {
1324 let ctx = ctx.clone();
1325 engine.register_fn(
1326 "sh",
1327 move |host: &str, cmd: &str| -> Result<Map, Box<EvalAltResult>> {
1328 let (code, tail) = ctx.run(host, cmd).map_err(rhai_err)?;
1329 let mut m = Map::new();
1330 m.insert("code".into(), (code as i64).into());
1331 m.insert("stdout_tail".into(), tail.into());
1332 Ok(m)
1333 },
1334 );
1335 }
1336
1337 // --- sh_ok(host, cmd): run + assert exit 0 (the must-succeed primitive) ---
1338 //
1339 // A non-zero exit fails the current step (added to the publish-barring
1340 // ledger) and aborts the recipe, so an artifact is never shipped after a
1341 // must-succeed command failed.
1342 {
1343 let ctx = ctx.clone();
1344 engine.register_fn(
1345 "sh_ok",
1346 move |host: &str, cmd: &str| -> Result<(), Box<EvalAltResult>> {
1347 let (code, _) = ctx.run(host, cmd).map_err(rhai_err)?;
1348 if code != 0 {
1349 // Attribute the failure to the current step explicitly so the
1350 // ledger bars publish even if a future caller swallowed the error.
1351 ctx.fail_current_step();
1352 return Err(rhai_err(format!(
1353 "command on `{host}` exited {code}: {cmd}"
1354 )));
1355 }
1356 Ok(())
1357 },
1358 );
1359 }
1360
1361 // --- resolve_artifact(host, glob) -> path: the ONE artifact matching glob ---
1362 //
1363 // The artifact-selection primitive. Replaces `sh(host, "ls -t <glob> | head
1364 // -1").stdout_tail.trim()` guarded on an empty string, which let a non-zero
1365 // `ls` pass quietly and a stale newest-by-mtime file win. This resolves the
1366 // glob on the host and demands exactly one match: zero matches or more than
1367 // one both throw (an ambiguous match means the build left stale artifacts,
1368 // and silently picking the newest is how the wrong bytes ship). Use
1369 // `resolve_artifact_opt` for an artifact that may legitimately be absent.
1370 {
1371 let ctx = ctx.clone();
1372 engine.register_fn(
1373 "resolve_artifact",
1374 move |host: &str, glob: &str| -> Result<String, Box<EvalAltResult>> {
1375 ctx.resolve_artifact(host, glob, true).map_err(rhai_err)
1376 },
1377 );
1378 }
1379
1380 // --- resolve_artifact_opt(host, glob) -> path | "": zero-or-one match ---
1381 //
1382 // Same strict resolution as `resolve_artifact` but tolerates zero matches
1383 // (returns ""); more than one is still an error. For optional outputs like a
1384 // `.deb` or an updater bundle a recipe collects only when present.
1385 {
1386 let ctx = ctx.clone();
1387 engine.register_fn(
1388 "resolve_artifact_opt",
1389 move |host: &str, glob: &str| -> Result<String, Box<EvalAltResult>> {
1390 ctx.resolve_artifact(host, glob, false).map_err(rhai_err)
1391 },
1392 );
1393 }
1394
1395 // --- log(msg): operator-visible line into the current step's tail ---
1396 {
1397 let ctx = ctx.clone();
1398 engine.register_fn("log", move |msg: &str| -> Result<(), Box<EvalAltResult>> {
1399 let sink = ctx.ensure_step().map_err(rhai_err)?;
1400 let line = format!("[recipe] {msg}\n");
1401 ctx.rt.block_on(async {
1402 use ops_core::remote::LogSink;
1403 sink.lock().await.write_chunk(line.as_bytes()).await;
1404 });
1405 Ok(())
1406 });
1407 }
1408
1409 // --- version_of(app) -> string ---
1410 {
1411 let ctx = ctx.clone();
1412 engine.register_fn(
1413 "version_of",
1414 move |app: &str| -> Result<String, Box<EvalAltResult>> {
1415 // Only the current app is in scope; cross-app reads aren't needed.
1416 if app != ctx.app.as_str() {
1417 return Err(rhai_err(format!(
1418 "version_of: `{app}` is not the app being built"
1419 )));
1420 }
1421 Ok(ctx.version.to_string())
1422 },
1423 );
1424 }
1425
1426 // --- version() -> string: the version being built (no-arg form) ---
1427 {
1428 let ctx = ctx.clone();
1429 engine.register_fn("version", move || -> String { ctx.version.to_string() });
1430 }
1431
1432 // --- build_host() -> string: the host this target builds on ---
1433 {
1434 let ctx = ctx.clone();
1435 engine.register_fn("build_host", move || -> String { ctx.build_host.clone() });
1436 }
1437
1438 // --- repo() -> string: the app's checkout path on this target's build host
1439 // (`~`-prefixed on a unix host). Host-correct rather than one path per
1440 // app, so a recipe for a host whose checkout is elsewhere still calls
1441 // this instead of hard-coding the path — which is what kept the Windows
1442 // recipes off `checkout_sha`. ---
1443 {
1444 let ctx = ctx.clone();
1445 engine.register_fn("repo", move || -> String {
1446 ctx.repo_for(&ctx.build_host).to_string()
1447 });
1448 }
1449
1450 // --- checkout_sha(host) -> sha: pin this host to the release tag and report
1451 // its commit. Replaces a recipe's `git pull --ff-only`, which builds
1452 // whatever `main` is at pull time; the daemon also runs the same pin as
1453 // a cross-host preflight barrier before any target builds. ---
1454 {
1455 let ctx = ctx.clone();
1456 engine.register_fn(
1457 "checkout_sha",
1458 move |host: &str| -> Result<String, Box<EvalAltResult>> {
1459 ctx.checkout_sha(host).map_err(rhai_err)
1460 },
1461 );
1462 }
1463
1464 // --- crate_preflight() -> string: verify this crate is safe to publish,
1465 // or abort the run. Everything it checks is immutable once published:
1466 // crates.io versions can be yanked but never edited, so a wrong
1467 // repository URL is permanent. pter 0.1.0 shipped with a dead one. ---
1468 {
1469 let ctx = ctx.clone();
1470 engine.register_fn(
1471 "crate_preflight",
1472 move || -> Result<String, Box<EvalAltResult>> {
1473 // `repo`, not `repo_for(...)`: `cargo metadata` runs on the
1474 // daemon's own box, so this is the one checkout that is always
1475 // the local one. It is not a missed call site.
1476 let repo = expand_tilde(&ctx.repo);
1477
1478 let out = std::process::Command::new("cargo")
1479 .args(["metadata", "--no-deps", "--format-version", "1"])
1480 .current_dir(&repo)
1481 .output()
1482 .map_err(|e| format!("running cargo metadata in {}: {e}", repo.display()))?;
1483 if !out.status.success() {
1484 return Err(format!(
1485 "cargo metadata failed in {}: {}",
1486 repo.display(),
1487 String::from_utf8_lossy(&out.stderr).trim()
1488 )
1489 .into());
1490 }
1491 let meta = crate_meta_from_json(&String::from_utf8_lossy(&out.stdout))
1492 .map_err(|e| e.to_string())?;
1493
1494 // The real question is not whether a page renders but whether a
1495 // stranger with no credentials can fetch the source, so ask git.
1496 let clonable = meta.repository.as_ref().is_some_and(|url| {
1497 std::process::Command::new("git")
1498 .args(["ls-remote", url])
1499 .env("GIT_TERMINAL_PROMPT", "0")
1500 .output()
1501 .is_ok_and(|o| o.status.success())
1502 });
1503
1504 // Ask the publishing host whether cargo has credentials, rather
1505 // than moving the token anywhere. It stays in cargo's own 0600
1506 // store; a shell line carrying it would be visible in `ps`.
1507 // An exit code answers "are there credentials"; an Err answers
1508 // "the question could not be asked". Collapsing the second into
1509 // the first reported a capability denial as "no crates.io
1510 // credentials", which sent a real diagnosis three rounds the
1511 // wrong way. A check that cannot run is not a failed check.
1512 let creds =
1513 ctx.run(
1514 &ctx.build_host.clone(),
1515 "cargo login --help >/dev/null 2>&1 && \
1516 test -s \"${CARGO_HOME:-$HOME/.cargo}/credentials.toml\" \
1517 || test -s \"${CARGO_HOME:-$HOME/.cargo}/credentials\"",
1518 )
1519 .map_err(|e| {
1520 format!(
1521 "could not check crates.io credentials on `{}`: {e}",
1522 ctx.build_host
1523 )
1524 })?
1525 .0 == 0;
1526
1527 let published = RecipeCtx::published_versions(&meta.name);
1528 let problems = crate_publish_problems(&meta, clonable, &published, creds);
1529 if !problems.is_empty() {
1530 return Err(format!(
1531 "{} {} is not safe to publish:\n - {}",
1532 meta.name,
1533 meta.version,
1534 problems.join("\n - ")
1535 )
1536 .into());
1537 }
1538 Ok(format!("{} {} passed preflight", meta.name, meta.version))
1539 },
1540 );
1541 }
1542
1543 // --- feature_flags() -> string: `--features a,b`, or "" when the app
1544 // declares none. Returns the whole flag rather than a bare list so an
1545 // app with no features cannot produce a dangling `--features`. ---
1546 {
1547 let ctx = ctx.clone();
1548 engine.register_fn("feature_flags", move || -> String {
1549 if ctx.features.is_empty() {
1550 String::new()
1551 } else {
1552 format!("--features {}", ctx.features.join(","))
1553 }
1554 });
1555 }
1556
1557 // --- target() / platform() / arch(): the target axis, for one per-platform
1558 // recipe to branch on arch (bundle paths differ between x86_64/aarch64). ---
1559 {
1560 let ctx = ctx.clone();
1561 engine.register_fn("target", move || -> String { ctx.target.to_string() });
1562 }
1563 {
1564 let ctx = ctx.clone();
1565 engine.register_fn("platform", move || -> String {
1566 ctx.target.platform.as_str().to_string()
1567 });
1568 }
1569 {
1570 let ctx = ctx.clone();
1571 engine.register_fn("arch", move || -> String {
1572 ctx.target.arch.as_str().to_string()
1573 });
1574 }
1575
1576 // --- secret(key) -> string (file under secrets_root; never logged) ---
1577 {
1578 let ctx = ctx.clone();
1579 engine.register_fn("secret", move |key: &str| -> Result<String, Box<EvalAltResult>> {
1580 // Guard against traversal out of secrets_root. Require every path
1581 // component to be `Normal` (rejects `..`, `.`, absolute roots and
1582 // drive prefixes) and forbid backslashes (a literal filename char on
1583 // Linux, but a separator elsewhere) — the per-component strength of
1584 // Sando's `safe()`. A multi-segment key like `app/token` is still
1585 // allowed; `foo..bar` (a legit filename) is no longer falsely blocked.
1586 let safe = !key.is_empty()
1587 && !key.contains('\\')
1588 && std::path::Path::new(key)
1589 .components()
1590 .all(|c| matches!(c, std::path::Component::Normal(_)));
1591 if !safe {
1592 return Err(rhai_err(
1593 "secret key must be a relative path under secrets_root (no `..`, `.`, absolute paths, or backslashes)",
1594 ));
1595 }
1596 let path = ctx.cfg.secrets_root.join(key);
1597 std::fs::read_to_string(&path)
1598 .map(|s| s.trim_end().to_string())
1599 .map_err(|e| rhai_err(format!("secret `{key}`: {e}")))
1600 });
1601 }
1602
1603 // --- env(host, key) -> string ---
1604 {
1605 let ctx = ctx.clone();
1606 engine.register_fn(
1607 "env",
1608 move |host: &str, key: &str| -> Result<String, Box<EvalAltResult>> {
1609 // The key is interpolated into a `${...}` shell expansion, so it must
1610 // be a bare shell identifier — anything else (quotes, `}`, `$`, `;`)
1611 // could break out and run arbitrary commands on the host. Validate
1612 // before building the command; this is the one env read that can't
1613 // sh-quote its argument (a quoted var name doesn't expand).
1614 if key.is_empty()
1615 || !key
1616 .chars()
1617 .next()
1618 .is_some_and(|c| c == '_' || c.is_ascii_alphabetic())
1619 || !key.chars().all(|c| c == '_' || c.is_ascii_alphanumeric())
1620 {
1621 return Err(rhai_err(format!(
1622 "env name `{key}` must be a shell identifier ([A-Za-z_][A-Za-z0-9_]*)"
1623 )));
1624 }
1625 // Read via the shell so it works on remote hosts too.
1626 let (code, tail) = ctx
1627 .run(host, &format!("printf '%s' \"${{{key}}}\""))
1628 .map_err(rhai_err)?;
1629 if code != 0 {
1630 return Err(rhai_err(format!("env `{key}` on `{host}` failed")));
1631 }
1632 Ok(tail.trim().to_string())
1633 },
1634 );
1635 }
1636
1637 // --- collect(host, glob, app, version): pull artifacts to dist_root ---
1638 {
1639 let ctx = ctx.clone();
1640 engine.register_fn(
1641 "collect",
1642 move |host: &str,
1643 glob: &str,
1644 app: &str,
1645 version: &str|
1646 -> Result<(), Box<EvalAltResult>> {
1647 ctx.collect(host, glob, app, version).map_err(rhai_err)
1648 },
1649 );
1650 }
1651
1652 // --- publish(channel, app, target, version, artifact, meta) ---
1653 {
1654 let ctx = ctx.clone();
1655 engine.register_fn(
1656 "publish",
1657 move |channel: &str,
1658 app: &str,
1659 target: &str,
1660 version: &str,
1661 artifact: &str,
1662 meta: Map|
1663 -> Result<String, Box<EvalAltResult>> {
1664 ctx.publish(channel, app, target, version, artifact, &meta)
1665 .map_err(rhai_err)
1666 },
1667 );
1668 }
1669
1670 // --- deploy(binary) -> summary: install a service binary and restart its
1671 // unit. The terminal step for `kind = "service"`, the counterpart of
1672 // `publish` for something that is run rather than distributed.
1673 //
1674 // Takes only the binary's path on the build host: where it lands, on
1675 // which machine, and which unit restarts all come from the `[[deploy]]`
1676 // entry for the target already being built. A recipe cannot deploy the
1677 // aarch64 binary to the x86_64 box by naming the wrong host, because it
1678 // never names a host at all.
1679 {
1680 let ctx = ctx.clone();
1681 engine.register_fn(
1682 "deploy",
1683 move |binary: &str| -> Result<String, Box<EvalAltResult>> {
1684 ctx.deploy(binary).map_err(rhai_err)
1685 },
1686 );
1687 }
1688
1689 // --- deploy_host() -> string: the service host's ssh destination, so a
1690 // recipe can run its own assertions there (`sh_ok(deploy_host(), ...)`).
1691 // Commands run through it while the `deploy` step is open, so they are
1692 // gated on the deploy grant like the install itself. ---
1693 {
1694 let ctx = ctx.clone();
1695 engine.register_fn(
1696 "deploy_host",
1697 move || -> Result<String, Box<EvalAltResult>> {
1698 ctx.deploy_target()
1699 .map(|d| d.host.clone())
1700 .map_err(rhai_err)
1701 },
1702 );
1703 }
1704
1705 // --- service_name() / install_path() / health_url(): the rest of the
1706 // `[[deploy]]` entry, so a recipe asserts against the configured values
1707 // rather than repeating them as literals that can drift. `health_url`
1708 // is "" when unset. ---
1709 {
1710 let ctx = ctx.clone();
1711 engine.register_fn(
1712 "service_name",
1713 move || -> Result<String, Box<EvalAltResult>> {
1714 ctx.deploy_target()
1715 .map(|d| d.service.clone())
1716 .map_err(rhai_err)
1717 },
1718 );
1719 }
1720 {
1721 let ctx = ctx.clone();
1722 engine.register_fn(
1723 "install_path",
1724 move || -> Result<String, Box<EvalAltResult>> {
1725 ctx.deploy_target()
1726 .map(|d| d.install_path.clone())
1727 .map_err(rhai_err)
1728 },
1729 );
1730 }
1731 {
1732 let ctx = ctx.clone();
1733 engine.register_fn(
1734 "health_url",
1735 move || -> Result<String, Box<EvalAltResult>> {
1736 ctx.deploy_target()
1737 .map(|d| d.health_url.clone().unwrap_or_default())
1738 .map_err(rhai_err)
1739 },
1740 );
1741 }
1742
1743 // --- glibc_check(binary) -> string: assert the build host did not produce
1744 // a binary the service host's glibc is too old to exec. Aborts the run
1745 // if it did; returns "needs X, host has Y" for the log if it did not.
1746 //
1747 // WHICH RECIPES CALL THIS, AND WHY THE OTHERS MUST NOT. The rule is not
1748 // a style preference and it is not optional: this reads the recipe's
1749 // `[[deploy]]` entry to learn which machine runs the bytes, so a recipe
1750 // with no `[[deploy]]` cannot call it at all.
1751 //
1752 // - A service that installs ITSELF (`[[deploy]]` present: magicmirror,
1753 // wam, mnw-cli) SHOULD call it. Bento is both builder and installer
1754 // there, so it knows the service host, and nothing downstream will
1755 // check on its behalf.
1756 // - A service HANDED OFF to Sando (`[[deploy]]` absent: pom) MUST NOT,
1757 // and the absence is the Sando/Bento boundary rather than an omission.
1758 // Which machine runs the bytes is environment knowledge, which is
1759 // Sando's half. Sando covers it on the far side, more strongly: it runs
1760 // the node's own loader against the rsynced bytes before the symlink
1761 // swap (`sando_daemon::deploy::ldd_guard_script`), and since 0.2.12
1762 // also compares the bundle's glibc floor against the node's declared
1763 // `libc` before the rsync (`check_bundle_fits_node`).
1764 //
1765 // So a new service recipe takes its answer from whether it carries a
1766 // `[[deploy]]` table, not from whichever sibling recipe it was copied
1767 // from. Wiki `sando-bento-boundary`, `host-base-images`. ---
1768 {
1769 let ctx = ctx.clone();
1770 engine.register_fn(
1771 "glibc_check",
1772 move |binary: &str| -> Result<String, Box<EvalAltResult>> {
1773 let (needs, has) = ctx.glibc_check(binary).map_err(rhai_err)?;
1774 Ok(format!(
1775 "glibc: binary needs {needs}, service host has {has}"
1776 ))
1777 },
1778 );
1779 }
1780
1781 // --- macOS signing helpers. They dispatch through the named host's
1782 // executor like any other step; when that host is the mac (transport =
1783 // "agent"), codesign/notarize/staple ride the in-session `AgentRpc`
1784 // transport — the only security session where the Developer ID key is
1785 // usable (design §7 "THE WALL"). Capability-gated by the host's `sign`
1786 // grant. ---
1787 register_macos_fns(&mut engine, ctx);
1788
1789 engine
1790 }
1791
1792 /// Highest `GLIBC_x.y` version referenced by a built binary, and the glibc a
1793 /// host actually has, both parsed from the text the commands print.
1794 ///
1795 /// Native-per-architecture builds remove the cross-compile hazard `deploy.sh`
1796 /// was written against, but not this one: fw13 tracks a newer glibc than the
1797 /// Ubuntu 24.04 box in Hetzner, so a binary built here can reference a symbol
1798 /// version that box does not have and fail at exec — after the unit has already
1799 /// been restarted onto it. Comparing the two before the install is what makes
1800 /// that a failed step instead of a downed service.
1801 fn max_glibc_symbol(objdump_out: &str) -> Option<(u64, u64)> {
1802 objdump_out
1803 .split(|c: char| !(c.is_ascii_digit() || c == '.' || c == '_' || c.is_ascii_alphabetic()))
1804 .filter_map(|tok| tok.strip_prefix("GLIBC_"))
1805 .filter_map(parse_glibc_version)
1806 .max()
1807 }
1808
1809 /// Parse `2.39` (or `2.39.1`, keeping major/minor) into a comparable pair.
1810 fn parse_glibc_version(s: &str) -> Option<(u64, u64)> {
1811 let mut parts = s.split('.');
1812 let major = parts.next()?.parse().ok()?;
1813 let minor = parts.next()?.parse().ok()?;
1814 Some((major, minor))
1815 }
1816
1817 /// The glibc version out of `ldd --version`'s first line, whose tail is the
1818 /// version however the distro decorates the rest (`ldd (Ubuntu GLIBC
1819 /// 2.39-0ubuntu8.8) 2.39`).
1820 fn glibc_from_ldd(ldd_out: &str) -> Option<(u64, u64)> {
1821 let first = ldd_out.lines().find(|l| !l.trim().is_empty())?;
1822 parse_glibc_version(first.split_whitespace().last()?)
1823 }
1824
1825 impl RecipeCtx {
1826 /// This target's install destination, or an error naming why there is none.
1827 fn deploy_target(&self) -> Result<&DeployTarget> {
1828 self.deploy.as_ref().ok_or_else(|| {
1829 anyhow::anyhow!(
1830 "no deploy destination for {} {}: the app is `kind = \"{}\"`, and only a \
1831 service declares [[deploy]] entries",
1832 self.app,
1833 self.target,
1834 match self.kind {
1835 Kind::App => "app",
1836 Kind::Library => "library",
1837 Kind::Service => "service",
1838 }
1839 )
1840 })
1841 }
1842
1843 /// Compare the built binary's glibc requirement against the service host's.
1844 /// Returns the two versions for the recipe to log.
1845 fn glibc_check(self: &Arc<Self>, binary: &str) -> Result<(String, String)> {
1846 let d = self.deploy_target()?.clone();
1847 // `objdump -T` on the build host; no symbols at all (a static binary)
1848 // means nothing to check, which is a pass rather than a failure.
1849 let (code, out) = self.run(
1850 &self.build_host.clone(),
1851 &format!(
1852 "objdump -T {binary} 2>/dev/null | grep -o 'GLIBC_[0-9.]*' | sort -uV || true"
1853 ),
1854 )?;
1855 anyhow::ensure!(code == 0, "reading glibc symbols from {binary} failed");
1856 let Some(needs) = max_glibc_symbol(&out) else {
1857 return Ok(("none".into(), "n/a".into()));
1858 };
1859 let (code, ldd) = self.run(&d.host, "ldd --version")?;
1860 anyhow::ensure!(
1861 code == 0,
1862 "could not read glibc version on service host `{}`",
1863 d.host
1864 );
1865 let has = glibc_from_ldd(&ldd).ok_or_else(|| {
1866 anyhow::anyhow!(
1867 "could not parse glibc version from `ldd --version` on `{}`",
1868 d.host
1869 )
1870 })?;
1871 anyhow::ensure!(
1872 needs <= has,
1873 "binary needs glibc {}.{} but `{}` has {}.{} — it would fail to exec after the \
1874 unit restarted onto it. Build on a host no newer than the service host.",
1875 needs.0,
1876 needs.1,
1877 d.host,
1878 has.0,
1879 has.1,
1880 );
1881 Ok((
1882 format!("{}.{}", needs.0, needs.1),
1883 format!("{}.{}", has.0, has.1),
1884 ))
1885 }
1886
1887 /// Install `binary` (a path on the BUILD host) onto the service host and
1888 /// restart its unit, via the privileged installer the host holds a scoped
1889 /// sudo grant for.
1890 ///
1891 /// Bento never runs the install itself. It stages the bytes and calls a
1892 /// root script whose arguments are re-checked on the far side — the same
1893 /// shape as Sando's `install-companion.sh`, and for the same reason: the
1894 /// sudoers grant is then ONE auditable script rather than a broad
1895 /// `install`+`systemctl` grant on a production box.
1896 ///
1897 /// Only the binary moves. Config is deliberately untouched: pom's
1898 /// `pom-astra.toml` / `pom-hetzner.toml` differ per instance, and prod's
1899 /// carried a `[targets.mnw.tests]` block the repo did not have. A deploy
1900 /// that copies config over is how that block gets silently deleted.
1901 fn deploy(self: &Arc<Self>, binary: &str) -> Result<String> {
1902 anyhow::ensure!(
1903 !self.is_cancelled(),
1904 "build superseded by a newer request; refusing to deploy"
1905 );
1906 // A failed earlier step bars a deploy exactly as it bars a publish. An
1907 // artifact that failed its gates must not reach a production host just
1908 // because the recipe kept running.
1909 let failed = self.failed_steps.lock().unwrap().clone();
1910 anyhow::ensure!(
1911 failed.is_empty(),
1912 "refusing to deploy {} {}: {} failed earlier in this run",
1913 self.app,
1914 self.version,
1915 failed
1916 .iter()
1917 .map(ToString::to_string)
1918 .collect::<Vec<_>>()
1919 .join(", "),
1920 );
1921 let d = self.deploy_target()?.clone();
1922 ensure_glob_safe(binary)?;
1923
1924 // Stage under a fixed root the installer also insists on, so "what was
1925 // checked" and "what is installed" cannot drift apart.
1926 let staged = format!("{DEPLOY_STAGING_ROOT}/{}", self.app);
1927 let staged_bin = format!("{staged}/{}", self.app);
1928 let deploy_exec = self.exec(&d.host)?;
1929 anyhow::ensure!(
1930 deploy_exec.capabilities().permits(&Action::Deploy),
1931 "service host `{}` is not granted the `deploy` capability",
1932 d.host
1933 );
1934
1935 self.run_ok(&d.host, &format!("mkdir -p {staged}"))?;
1936 if self.build_host_ssh == d.host {
1937 // Same box: the binary is already there. Routing it through the
1938 // daemon would be two transfers to end up where it started. This is
1939 // pom's aarch64 leg — astra builds it and astra runs it.
1940 self.run_ok(&d.host, &format!("cp -f {binary} {staged_bin}"))?;
1941 } else {
1942 // Build host -> daemon -> service host. Two hops because an executor
1943 // reaches one host; a direct host-to-host transport would mean the
1944 // build host holding a credential for the production box.
1945 let tmp = tempfile::tempdir().context("staging dir for deploy")?;
1946 let local = tmp.path().join(self.app.as_str());
1947 self.pull_for_deploy(binary, &local)?;
1948 let (dest, opts) = (PathBuf::from(&staged), SyncOpts::default());
1949 let dir = tmp.path().to_path_buf();
1950 self.run_bounded(&format!("stage {} on `{}`", self.app, d.host), async move {
1951 deploy_exec.push_dir(&dir, &dest, &opts).await
1952 })
1953 .with_context(|| format!("staging {} onto `{}`", self.app, d.host))?;
1954 }
1955
1956 // The privileged half. Every argument is re-validated by the script,
1957 // which is the thing actually holding the sudo grant.
1958 self.run_ok(
1959 &d.host,
1960 &format!(
1961 "{} {staged_bin} {} {}",
1962 self.cfg.deploy_installer, d.install_path, d.service
1963 ),
1964 )?;
1965 Ok(format!(
1966 "{} {} installed at {} on `{}`; {} restarted",
1967 self.app, self.version, d.install_path, d.host, d.service
1968 ))
1969 }
1970
1971 /// Fetch one file off a host into a daemon-local path for re-pushing.
1972 ///
1973 /// A local build host is read directly: `fw13` is the daemon's own box, so
1974 /// the file is already on this filesystem. Routing it through the
1975 /// artifact-pull gate instead would demand a `pull_root` covering every repo
1976 /// a service could be built in — today that is `~/Code/Apps`, and pom lives
1977 /// in `~/Code/MNW`. Widening it to `~/Code` would put `_private`, the
1978 /// secrets root, inside the collectable tree. This is pom's x86_64 leg.
1979 fn pull_for_deploy(self: &Arc<Self>, remote: &str, local: &Path) -> Result<()> {
1980 let host = self.build_host.clone();
1981 let remote_path = expand_tilde(remote);
1982 if self.build_host_ssh == "local" || self.build_host_ssh.is_empty() {
1983 std::fs::copy(&remote_path, local).with_context(|| {
1984 format!("staging {} from the daemon host", remote_path.display())
1985 })?;
1986 return Ok(());
1987 }
1988 let sync = self.host_sync(&host)?;
1989 let (src, dst, opts) = (remote_path, local.to_path_buf(), SyncOpts::default());
1990 self.run_bounded(&format!("fetch {remote} from `{host}`"), async move {
1991 sync.pull_file(&src, &dst, &opts).await
1992 })
1993 .with_context(|| format!("fetching {remote} from `{host}` to deploy"))
1994 }
1995
1996 /// `run`, failing the step on a non-zero exit. The Rust-side twin of the
1997 /// recipe's `sh_ok`, for commands the deploy machinery issues itself.
1998 fn run_ok(self: &Arc<Self>, host: &str, cmd: &str) -> Result<String> {
1999 let (code, tail) = self.run(host, cmd)?;
2000 if code != 0 {
2001 self.fail_current_step();
2002 anyhow::bail!("command on `{host}` exited {code}: {cmd}\n{tail}");
2003 }
2004 Ok(tail)
2005 }
2006
2007 /// Where this run's collected files land locally.
2008 ///
2009 /// Per target, not per version. Every target used to share one
2010 /// `dist_root/<app>/<version>/`, so the hash loop below (which lists the
2011 /// directory) attributed a sibling's AppImage to the mac build's artifact
2012 /// record. It is also the layout the archive uses, and the two have to agree
2013 /// or the local copy and the deposited one are different shapes.
2014 fn collect_dest(&self, app: &str, version: &str) -> PathBuf {
2015 self.cfg
2016 .dist_root
2017 .join(app)
2018 .join(version)
2019 .join(crate::archive::target_slug(self.target))
2020 }
2021
2022 fn collect(self: &Arc<Self>, host: &str, glob: &str, app: &str, version: &str) -> Result<()> {
2023 let dest = self.collect_dest(app, version);
2024 let dest_s = dest.to_string_lossy().into_owned();
2025 // The glob reaches a remote login shell intact (that's what expands it),
2026 // so command metacharacters stay barred. Path/wildcard chars are fine.
2027 ensure_glob_safe(glob)?;
2028 std::fs::create_dir_all(&dest)
2029 .with_context(|| format!("creating collect dest {dest_s}"))?;
2030 // The SYNC transport, not the host's exec executor: artifacts move over
2031 // ssh/rsync even from an agent host, whose `/pull` is confined to a
2032 // narrow `pull_root` that deliberately excludes the repo checkout these
2033 // artifacts are built in (see `state::build_sync`). The daemon still
2034 // runs the transfer itself, as it always has.
2035 let sync = self.host_sync(host)?;
2036 let opts = SyncOpts::precompressed();
2037 // Bounded by the collect step's deadline (rsync of a multi-GiB artifact
2038 // can wedge on a stalled transport) and interruptible on supersession.
2039 let dest_pull = dest.clone();
2040 self.run_bounded(&format!("collect {glob} from `{host}`"), async move {
2041 sync.pull_glob(glob, &dest_pull, &opts).await
2042 })
2043 .with_context(|| format!("collect {glob} from `{host}`"))?;
2044 // Assert the version and hash every collected file. This is where a
2045 // stale artifact is caught: a file whose name embeds a different version
2046 // fails the collect (rather than silently winning a later glob), and the
2047 // sha256 recorded here is what `publish` writes into the release ledger
2048 // and what the artifact record's manifest is built from.
2049 //
2050 // Recursive, and keyed by path relative to the collect dir. That is not
2051 // a preference: Sando's intake re-hashes the bundle with its own walker,
2052 // which recurses and keys the same way, and refuses a bundle whose bytes
2053 // do not match the manifest it was handed. A top-level `read_dir` keyed
2054 // by file name agrees with that walker for a flat directory and diverges
2055 // the moment a bundle carries a subdirectory — the honest artifact would
2056 // be refused for a manifest that omitted everything nested. The two
2057 // walkers have to be the same walk. See `bundle::digest_dir` in sando.
2058 for (rel, path) in
2059 collected_files(&dest).with_context(|| format!("listing collect dest {dest_s}"))?
2060 {
2061 // The version check stays on the file NAME rather than the relative
2062 // path: it is looking for a stale `app_1.2.3.AppImage` beside the
2063 // one this release built, and a directory component is not that.
2064 let name = path
2065 .file_name()
2066 .map_or_else(|| rel.clone(), |n| n.to_string_lossy().into_owned());
2067 assert_artifact_version(&name, &self.version)?;
2068 let digest = sha256_file(&path)?;
2069 self.artifact_hashes.lock().unwrap().insert(rel, digest);
2070 }
2071 // Deposit at the archive path, so this target's bytes have one address
2072 // whichever host produced them. A no-op when no archive is configured.
2073 //
2074 // Inside `collect`, not after the recipe: a failure here fails the
2075 // collect step, before sign and publish, rather than putting a red mark
2076 // on a release that has already shipped. And it is a failure, not a
2077 // warning — a deposit that is quietly skipped leaves the archive path
2078 // wrong for exactly the release nobody was watching, which is the thing
2079 // having one address is for.
2080 let (cfg, app_id, version, target) = (
2081 self.cfg.clone(),
2082 self.app.clone(),
2083 self.version.clone(),
2084 self.target,
2085 );
2086 let dest_archive = dest.clone();
2087 self.run_bounded("deposit in the archive", async move {
2088 crate::archive::deposit(&cfg, &dest_archive, &app_id, &version, target).await
2089 })?;
2090 // Best-effort size accounting for the event.
2091 events::emit(
2092 &self.events,
2093 Event::ArtifactCollected {
2094 app: self.app.clone(),
2095 target: self.target,
2096 path: dest_s,
2097 bytes: dir_size(&dest).unwrap_or(0),
2098 },
2099 );
2100 Ok(())
2101 }
2102
2103 /// The all-targets-green gate: err unless every declared target OTHER than
2104 /// the one publishing has a latest `target_runs` row of `ok` for this
2105 /// `(app, version)`. A sibling with no run, a running run, or a failed
2106 /// latest run all block the publish, naming what is not green.
2107 fn assert_siblings_green(self: &Arc<Self>, declared: &[Target]) -> Result<()> {
2108 let me = self.clone();
2109 let (app_s, ver_s) = (self.app.to_string(), self.version.to_string());
2110 let rows: Vec<(String, String)> = self.rt.block_on(async move {
2111 sqlx::query_as(
2112 "SELECT target, status FROM target_runs tr
2113 WHERE app = ?1 AND version = ?2
2114 AND id = (SELECT MAX(id) FROM target_runs
2115 WHERE app = ?1 AND version = ?2 AND target = tr.target)",
2116 )
2117 .bind(app_s)
2118 .bind(ver_s)
2119 .fetch_all(&me.pool)
2120 .await
2121 .unwrap_or_default()
2122 });
2123 let status_of = |t: &Target| -> Option<String> {
2124 let key = t.to_string();
2125 rows.iter()
2126 .find(|(name, _)| name == &key)
2127 .map(|(_, s)| s.clone())
2128 };
2129 let not_green: Vec<String> = declared
2130 .iter()
2131 .filter(|t| **t != self.target) // the publishing target is the last mile
2132 .filter(|t| status_of(t).as_deref() != Some("ok"))
2133 .map(|t| format!("{t} ({})", status_of(t).unwrap_or_else(|| "no run".into())))
2134 .collect();
2135 anyhow::ensure!(
2136 not_green.is_empty(),
2137 "all-targets-green gate: refusing to publish {} {} — not green: {}",
2138 self.app,
2139 self.version,
2140 not_green.join(", "),
2141 );
2142 Ok(())
2143 }
2144
2145 fn publish(
2146 self: &Arc<Self>,
2147 channel: &str,
2148 app: &str,
2149 target: &str,
2150 version: &str,
2151 artifact: &str,
2152 meta: &Map,
2153 ) -> Result<String> {
2154 // Never let a superseded build ship. This is the last and most important
2155 // cooperative-cancel checkpoint: even if a long-running step finished
2156 // after supersession, the artifact must not reach the backend.
2157 anyhow::ensure!(
2158 !self.is_cancelled(),
2159 "build superseded by a newer request; refusing to publish"
2160 );
2161 // Opt-in all-targets-green gate: refuse a partial release. Every OTHER
2162 // declared target of this (app, version) must have a successful latest
2163 // run before this one ships, so macOS can't publish while windows is red
2164 // or still building. The publishing target itself is the last mile (it
2165 // reached publish, so its steps passed) and is not required to be green
2166 // in the ledger yet.
2167 if let Some(declared) = self.all_green_required.clone() {
2168 self.assert_siblings_green(&declared)?;
2169 }
2170 let backend = self
2171 .ota
2172 .get(channel)
2173 .ok_or_else(|| anyhow::anyhow!("unknown publish channel `{channel}`"))?;
2174 let target: Target = target.parse().map_err(|e: String| anyhow::anyhow!(e))?;
2175 let version = Version::parse(version).map_err(|e| anyhow::anyhow!(e))?;
2176 let app = AppId::new(app);
2177
2178 // The backend must actually handle this target (e.g. the desktop updater
2179 // disclaims iOS) — otherwise publish would push an artifact through a
2180 // backend that does not support it.
2181 anyhow::ensure!(
2182 backend.supports(target),
2183 "publish channel `{channel}` does not support target {target}",
2184 );
2185
2186 // Monotonicity: never publish a version that is not strictly newer than
2187 // the latest already published for this (app, target, channel). Without
2188 // this an older build could republish over a live newer release. The
2189 // `releases` column is TEXT, so compare by parsed semver precedence
2190 // (Version: Ord), not lexically.
2191 {
2192 let (app_s, target_s, chan_s) =
2193 (app.to_string(), target.to_string(), channel.to_string());
2194 let me = self.clone();
2195 let latest: Option<Version> = self.rt.block_on(async move {
2196 let rows: Vec<(String,)> = sqlx::query_as(
2197 "SELECT version FROM releases WHERE app = ? AND target = ? AND channel = ?",
2198 )
2199 .bind(app_s)
2200 .bind(target_s)
2201 .bind(chan_s)
2202 .fetch_all(&me.pool)
2203 .await
2204 .unwrap_or_default();
2205 rows.into_iter()
2206 .filter_map(|(v,)| Version::parse(&v).ok())
2207 .max()
2208 });
2209 if let Some(latest) = latest {
2210 anyhow::ensure!(
2211 version > latest,
2212 "refusing to publish {app} {version} to `{channel}` ({target}): \
2213 not newer than the last published {latest}",
2214 );
2215 }
2216 }
2217
2218 // Step-success ledger (the Bento analogue of Sando's gate fail-closed),
2219 // minted as an unforgeable PublishAuthority. `backend.publish` cannot be
2220 // called without one, so the unverified/post-failure ship path is sealed
2221 // at the type level rather than guarded by a separate runtime check.
2222 let authority = {
2223 let failed = self.failed_steps.lock().unwrap();
2224 let gatekeeper = *self.gatekeeper_ok.lock().unwrap();
2225 PublishAuthority::prove(target, failed.as_slice(), gatekeeper)?
2226 };
2227 let notes = meta
2228 .get("notes")
2229 .and_then(|v| v.clone().into_string().ok())
2230 .unwrap_or_default();
2231 // Resolve the artifact relative to the collected dist dir if not absolute.
2232 let artifact_path = {
2233 let p = PathBuf::from(artifact);
2234 if p.is_absolute() {
2235 p
2236 } else {
2237 self.collect_dest(app.as_str(), &version.to_string())
2238 .join(artifact)
2239 }
2240 };
2241 let rel = Release {
2242 app: &app,
2243 target,
2244 version: &version,
2245 notes,
2246 };
2247 let receipt = backend
2248 .publish(&rel, &artifact_path, &authority)
2249 .with_context(|| format!("publish to `{channel}`"))?;
2250 // Record for idempotency / monotonicity. This write is CHECKED, not
2251 // fire-and-forget: a swallowed failure here would silently re-arm the
2252 // monotonicity guard (which reads this same table), letting an older
2253 // version republish over a live release. Concurrent same-(app,target)
2254 // publishers can't race the read-then-insert because the latest-wins slot
2255 // (state::ActiveSlot) serializes them and a superseded run is cancelled
2256 // before it reaches publish.
2257 // The artifact's hash, recorded so the release ledger says exactly which
2258 // bytes shipped. Prefer the digest computed at `collect`; fall back to
2259 // hashing the file now (an absolute-path artifact never routed through
2260 // `collect`). A hash failure must not fail an already-published release,
2261 // so degrade to NULL rather than erroring.
2262 let artifact_hash: Option<String> = artifact_path
2263 .file_name()
2264 .and_then(|n| n.to_str())
2265 .and_then(|n| self.artifact_hashes.lock().unwrap().get(n).cloned())
2266 .or_else(|| sha256_file(&artifact_path).ok());
2267 let me = self.clone();
2268 let (app_s, target_s, ver_s, chan_s) = (
2269 app.to_string(),
2270 target.to_string(),
2271 version.to_string(),
2272 channel.to_string(),
2273 );
2274 self.rt
2275 .block_on(async move {
2276 sqlx::query(
2277 "INSERT OR IGNORE INTO releases (app, target, version, channel, artifact_hash, published_at)
2278 VALUES (?, ?, ?, ?, ?, ?)",
2279 )
2280 .bind(app_s)
2281 .bind(target_s)
2282 .bind(ver_s)
2283 .bind(chan_s)
2284 .bind(artifact_hash)
2285 .bind(Self::now())
2286 .execute(&me.pool)
2287 .await
2288 })
2289 .context("recording release in the idempotency ledger (artifact published but ledger write failed)")?;
2290 events::emit(
2291 &self.events,
2292 Event::PublishOk {
2293 app: self.app.clone(),
2294 target: self.target,
2295 channel: channel.to_string(),
2296 },
2297 );
2298 Ok(receipt)
2299 }
2300 }
2301
2302 fn dir_size(p: &Path) -> Option<i64> {
2303 let mut total = 0i64;
2304 for entry in std::fs::read_dir(p).ok()? {
2305 let entry = entry.ok()?;
2306 let md = entry.metadata().ok()?;
2307 if md.is_file() {
2308 total += md.len() as i64;
2309 } else if md.is_dir() {
2310 // Recurse so a bundle dir (a `.app`) reports its real size, not ~0.
2311 total += dir_size(&entry.path()).unwrap_or(0);
2312 }
2313 }
2314 Some(total)
2315 }
2316
2317 /// macOS signing/notarization host functions. Thin wrappers over the right
2318 /// shell incantations, dispatched through the named host's executor. On the mac
2319 /// host (`transport = "agent"`) they run via the in-session `ops-agent`, the only
2320 /// context where codesign can use the Developer ID key (design §7 "THE WALL"); a
2321 /// plain SSH session cannot. Each is gated by the host's `sign` capability.
2322 fn register_macos_fns(engine: &mut Engine, ctx: &Arc<RecipeCtx>) {
2323 {
2324 let ctx = ctx.clone();
2325 engine.register_fn(
2326 "verify_gatekeeper",
2327 move |host: &str, path: &str| -> Result<bool, Box<EvalAltResult>> {
2328 // spctl has no JSON mode, so assess on-host and decide there,
2329 // emitting an unambiguous sentinel as the final line. We match the
2330 // sentinel rather than substring-hunting `source=Notarized...` in a
2331 // 2000-char tail: truncation only drops the front, so the sentinel
2332 // is always present, and it can't be spoofed by spctl's own prose.
2333 // The full assess output is still streamed to the step log.
2334 let q = ops_core::remote::sh_quote(path);
2335 let cmd = format!(
2336 "out=$(spctl --assess -vv --type install {q} 2>&1); printf '%s\\n' \"$out\"; \
2337 printf '%s' \"$out\" | grep -q 'source=Notarized Developer ID' \
2338 && echo BENTO_GATEKEEPER_OK || echo BENTO_GATEKEEPER_FAIL",
2339 );
2340 let (_, tail) = ctx.run(host, &cmd).map_err(rhai_err)?;
2341 let accepted = tail.contains("BENTO_GATEKEEPER_OK");
2342 // Record the verdict for the publish gate. A rejection also
2343 // fails the step, so the matrix shows red and `publish` is barred
2344 // even if the recipe ignores the returned bool.
2345 *ctx.gatekeeper_ok.lock().unwrap() = Some(accepted);
2346 if !accepted {
2347 ctx.fail_current_step();
2348 }
2349 Ok(accepted)
2350 },
2351 );
2352 }
2353 {
2354 let ctx = ctx.clone();
2355 engine.register_fn(
2356 "codesign",
2357 move |host: &str, identity: &str, path: &str| -> Result<(), Box<EvalAltResult>> {
2358 let cmd = format!(
2359 "codesign --force --options runtime --timestamp --sign {} {}",
2360 ops_core::remote::sh_quote(identity),
2361 ops_core::remote::sh_quote(path),
2362 );
2363 let (code, _) = ctx.run(host, &cmd).map_err(rhai_err)?;
2364 if code != 0 {
2365 return Err(rhai_err("codesign failed"));
2366 }
2367 Ok(())
2368 },
2369 );
2370 }
2371 {
2372 let ctx = ctx.clone();
2373 engine.register_fn(
2374 "staple",
2375 move |host: &str, path: &str| -> Result<(), Box<EvalAltResult>> {
2376 let (code, _) = ctx
2377 .run(
2378 host,
2379 &format!("xcrun stapler staple {}", ops_core::remote::sh_quote(path)),
2380 )
2381 .map_err(rhai_err)?;
2382 if code != 0 {
2383 return Err(rhai_err("stapler failed"));
2384 }
2385 Ok(())
2386 },
2387 );
2388 }
2389 {
2390 let ctx = ctx.clone();
2391 engine.register_fn(
2392 "notarize",
2393 move |host: &str, path: &str| -> Result<String, Box<EvalAltResult>> {
2394 ctx.notarize(host, path).map_err(rhai_err)
2395 },
2396 );
2397 }
2398 {
2399 let ctx = ctx.clone();
2400 engine.register_fn(
2401 "keychain_open",
2402 move |host: &str, name: &str| -> Result<(), Box<EvalAltResult>> {
2403 // The full build-keychain lifecycle lives in dist/build-keychain.sh
2404 // (design §7); this drives it by name so the recipe stays short.
2405 let (code, _) = ctx
2406 .run(
2407 host,
2408 &format!(
2409 ". ~/.tauri/passwords.env && ./dist/build-keychain.sh open {}",
2410 ops_core::remote::sh_quote(name)
2411 ),
2412 )
2413 .map_err(rhai_err)?;
2414 if code != 0 {
2415 return Err(rhai_err("keychain_open failed"));
2416 }
2417 Ok(())
2418 },
2419 );
2420 }
2421 {
2422 let ctx = ctx.clone();
2423 engine.register_fn(
2424 "keychain_close",
2425 move |host: &str, name: &str| -> Result<(), Box<EvalAltResult>> {
2426 let _ = ctx.run(
2427 host,
2428 &format!(
2429 "./dist/build-keychain.sh close {}",
2430 ops_core::remote::sh_quote(name)
2431 ),
2432 );
2433 Ok(())
2434 },
2435 );
2436 }
2437 }
2438
2439 impl RecipeCtx {
2440 /// `xcrun notarytool submit --wait` with bounded retry (the one flaky,
2441 /// network-bound step). Emits `NotarizeRetry` per attempt.
2442 fn notarize(self: &Arc<Self>, host: &str, path: &str) -> Result<String> {
2443 const MAX_ATTEMPTS: u32 = 3;
2444 let backoff = self
2445 .cfg
2446 .notarize_backoff_secs
2447 .map_or(std::time::Duration::from_secs(15), |s| {
2448 std::time::Duration::from_secs(s)
2449 });
2450 let cmd = format!(
2451 ". ~/.tauri/passwords.env && xcrun notarytool submit {} \
2452 --key \"$NOTARY_KEY\" --key-id \"$NOTARY_KEY_ID\" --issuer \"$NOTARY_ISSUER\" \
2453 --wait --output-format json",
2454 ops_core::remote::sh_quote(path),
2455 );
2456 let mut last = String::new();
2457 for attempt in 1..=MAX_ATTEMPTS {
2458 let (code, tail) = self.run(host, &cmd)?;
2459 if code == 0 && notary_accepted(&tail) {
2460 return Ok(tail);
2461 }
2462 last = tail;
2463 if attempt < MAX_ATTEMPTS {
2464 events::emit(
2465 &self.events,
2466 Event::NotarizeRetry {
2467 app: self.app.clone(),
2468 target: self.target,
2469 attempt,
2470 reason: format!("exit {code}"),
2471 },
2472 );
2473 self.rt.block_on(tokio::time::sleep(backoff));
2474 }
2475 }
2476 anyhow::bail!("notarization failed after {MAX_ATTEMPTS} attempts: {last}")
2477 }
2478 }
2479
2480 /// True iff `notarytool --output-format json` output reports `status: Accepted`.
2481 /// Isolates the JSON object (`{`..`}`) from any shell-sourcing noise and reads
2482 /// the typed `status` field, rather than substring-matching `"status":"Accepted"`
2483 /// in a possibly-truncated tail — which could match the literal inside an error
2484 /// message or miss it across a whitespace variant. Fails closed: any parse or
2485 /// field miss returns false.
2486 fn notary_accepted(output: &str) -> bool {
2487 let (Some(start), Some(end)) = (output.find('{'), output.rfind('}')) else {
2488 return false;
2489 };
2490 if start > end {
2491 return false;
2492 }
2493 serde_json::from_str::<serde_json::Value>(&output[start..=end])
2494 .ok()
2495 .and_then(|v| {
2496 v.get("status")
2497 .and_then(|s| s.as_str())
2498 .map(|s| s.eq_ignore_ascii_case("accepted"))
2499 })
2500 .unwrap_or(false)
2501 }
2502
2503 #[cfg(test)]
2504 mod tests {
2505 use super::*;
2506
2507 /// Build the shared cross-crate bundle fixture under `root`.
2508 ///
2509 /// A binary at the top and two files in a subdirectory — the shape a service
2510 /// that ships its migrations has, which is the case the flat walk used to
2511 /// get wrong.
2512 pub(crate) fn write_bundle_fixture(root: &Path) {
2513 std::fs::create_dir_all(root.join("migrations")).unwrap();
2514 std::fs::write(root.join("pom"), b"binary-bytes").unwrap();
2515 std::fs::write(root.join("migrations/001_init.sql"), b"create table a;").unwrap();
2516 std::fs::write(root.join("migrations/002_next.sql"), b"alter table a;").unwrap();
2517 }
2518
2519 /// The manifest text the fixture must produce, in BOTH crates.
2520 ///
2521 /// Sando's `bundle::digest_dir` has the identical constant and the identical
2522 /// fixture. That is the whole point: bento writes this text into the artifact
2523 /// record, sando recomputes it from the bytes that arrive, and an artifact is
2524 /// refused when they differ. Two walks, one answer, pinned from both ends —
2525 /// if either crate's walk drifts, its own test fails and names the drift
2526 /// rather than a release failing intake for a bundle nothing is wrong with.
2527 pub(crate) const BUNDLE_FIXTURE_MANIFEST: &str = concat!(
2528 "e4c908e219c533fa7ad7ea1634398f9bf51637ba20717769ada545bab26d7368 migrations/001_init.sql\n",
2529 "b026fd51bae096b34672cefdb781b6585b13efb53bc301d50c305f422552a380 migrations/002_next.sql\n",
2530 "71227a7f160afca3fb3c39f448735886dda7bd366252580c2222fb87d4bb4d85 pom\n",
2531 );
2532
2533 /// The producer half of the contract above: what `collect` hashes, turned
2534 /// into a manifest, is exactly the text the verifier will recompute.
2535 ///
2536 /// Nested files are included and addressed by relative path. Before this,
2537 /// `collect` listed only the top level, so `migrations/` contributed nothing
2538 /// to the manifest while sando's walker hashed both files in it — and the
2539 /// honest bundle was refused for a manifest that had omitted them.
2540 #[test]
2541 fn a_collected_bundle_manifests_exactly_as_the_verifier_will_read_it() {
2542 let dir = tempfile::tempdir().unwrap();
2543 write_bundle_fixture(dir.path());
2544
2545 let files = collected_files(dir.path()).unwrap();
2546 assert_eq!(
2547 files.iter().map(|(r, _)| r.as_str()).collect::<Vec<_>>(),
2548 vec!["migrations/001_init.sql", "migrations/002_next.sql", "pom"],
2549 "recursive, relative, sorted"
2550 );
2551
2552 let hashes: Vec<(String, String)> = files
2553 .into_iter()
2554 .map(|(rel, path)| (rel, sha256_file(&path).unwrap()))
2555 .collect();
2556 let manifest = ops_artifact::Manifest::new(hashes).unwrap();
2557 assert_eq!(manifest.to_text(), BUNDLE_FIXTURE_MANIFEST);
2558 }
2559
2560 /// A symlink is neither followed nor named. Following one would let bytes
2561 /// from outside the bundle into its identity; naming it would put a path in
2562 /// the manifest the verifier does not hash, which reads as a corrupt bundle.
2563 #[test]
2564 #[cfg(unix)]
2565 fn a_symlink_in_the_collect_dir_is_not_part_of_the_bundle() {
2566 let dir = tempfile::tempdir().unwrap();
2567 write_bundle_fixture(dir.path());
2568 let outside = dir.path().join("..").join("secret.env");
2569 std::fs::write(&outside, b"TOKEN=1").ok();
2570 std::os::unix::fs::symlink(&outside, dir.path().join("link.env")).unwrap();
2571
2572 let files = collected_files(dir.path()).unwrap();
2573 assert!(
2574 !files.iter().any(|(rel, _)| rel.contains("link.env")),
2575 "{files:?}"
2576 );
2577 }
2578
2579 /// Run 3 S1: once the cooperative cancel flag is set (a newer build
2580 /// superseded this run), a step boundary refuses to proceed — the blocking
2581 /// recipe stops at the next `step()` instead of running on and publishing.
2582 #[tokio::test]
2583 async fn begin_step_bails_when_cancelled() {
2584 let dir = tempfile::tempdir().unwrap();
2585 let cfg = Arc::new(Config::for_tests(dir.path()));
2586 let pool = crate::db::open(&cfg.db_path).await.unwrap();
2587 let cancel = Arc::new(AtomicBool::new(true));
2588 let ctx = Arc::new(RecipeCtx::new(
2589 AppId::new("demo"),
2590 Version::parse("0.1.0").unwrap(),
2591 "linux/x86_64".parse().unwrap(),
2592 "fw13".into(),
2593 "local".into(),
2594 "v0.1.0".into(),
2595 "/tmp".into(),
2596 vec![],
2597 Kind::App,
2598 1,
2599 Arc::new(std::collections::HashMap::new()),
2600 Arc::new(std::collections::HashMap::new()),
2601 None,
2602 pool,
2603 crate::events::channel(),
2604 cfg,
2605 Arc::new(OtaRegistry::standard("https://makenot.work")),
2606 tokio::runtime::Handle::current(),
2607 cancel.clone(),
2608 None,
2609 ));
2610 // Cancelled: begin_step refuses before touching the DB (the ensure! is
2611 // ahead of any block_on, so this is safe to call from the async test).
2612 let err = ctx.begin_step(Step::Build).unwrap_err();
2613 assert!(err.to_string().contains("supersede"), "got: {err}");
2614 assert!(ctx.is_cancelled());
2615 }
2616
2617 /// `feature_flags()` returns a whole flag or nothing at all. An app with
2618 /// no declared features must not yield a bare `--features`, which would
2619 /// swallow the next word of the build command as its argument.
2620 #[tokio::test]
2621 async fn feature_flags_renders_whole_flag_or_empty() {
2622 async fn flags_for(features: Vec<String>) -> String {
2623 let dir = tempfile::tempdir().unwrap();
2624 let cfg = Arc::new(Config::for_tests(dir.path()));
2625 let pool = crate::db::open(&cfg.db_path).await.unwrap();
2626 let ctx = Arc::new(RecipeCtx::new(
2627 AppId::new("demo"),
2628 Version::parse("0.1.0").unwrap(),
2629 "linux/x86_64".parse().unwrap(),
2630 "fw13".into(),
2631 "local".into(),
2632 "v0.1.0".into(),
2633 "/tmp".into(),
2634 features,
2635 Kind::App,
2636 1,
2637 Arc::new(std::collections::HashMap::new()),
2638 Arc::new(std::collections::HashMap::new()),
2639 None,
2640 pool,
2641 crate::events::channel(),
2642 cfg,
2643 Arc::new(OtaRegistry::standard("https://makenot.work")),
2644 tokio::runtime::Handle::current(),
2645 Arc::new(AtomicBool::new(false)),
2646 None,
2647 ));
2648 let engine = build_engine(&ctx);
2649 engine.eval::<String>("feature_flags()").unwrap()
2650 }
2651
2652 assert_eq!(flags_for(vec![]).await, "");
2653 assert_eq!(
2654 flags_for(vec!["supernote".into()]).await,
2655 "--features supernote"
2656 );
2657 assert_eq!(
2658 flags_for(vec!["supernote".into(), "extra".into()]).await,
2659 "--features supernote,extra"
2660 );
2661 }
2662
2663 /// `repo()` answers for the host this target builds on, not for the daemon.
2664 ///
2665 /// This is what lets a Windows recipe call `repo()` and `checkout_sha(h)`
2666 /// instead of hard-coding `C:/Users/me/...` — and hard-coding it is what
2667 /// kept those recipes off the release-tag pin, since `checkout_sha` builds
2668 /// its git commands from the app's path and takes no override.
2669 #[tokio::test]
2670 async fn repo_resolves_per_build_host() {
2671 async fn repo_on(build_host: &str) -> String {
2672 let dir = tempfile::tempdir().unwrap();
2673 let cfg = Arc::new(Config::for_tests(dir.path()));
2674 let pool = crate::db::open(&cfg.db_path).await.unwrap();
2675 let ctx = Arc::new(
2676 RecipeCtx::new(
2677 AppId::new("demo"),
2678 Version::parse("0.1.0").unwrap(),
2679 "linux/x86_64".parse().unwrap(),
2680 build_host.into(),
2681 "local".into(),
2682 "v0.1.0".into(),
2683 "~/Code/Apps/demo".into(),
2684 vec![],
2685 Kind::App,
2686 1,
2687 Arc::new(std::collections::HashMap::new()),
2688 Arc::new(std::collections::HashMap::new()),
2689 None,
2690 pool,
2691 crate::events::channel(),
2692 cfg,
2693 Arc::new(OtaRegistry::standard("https://makenot.work")),
2694 tokio::runtime::Handle::current(),
2695 Arc::new(AtomicBool::new(false)),
2696 None,
2697 )
2698 .with_repo_by_host(HashMap::from([(
2699 "windows-x86".to_string(),
2700 "C:/Users/me/Code/Apps/demo".to_string(),
2701 )])),
2702 );
2703 build_engine(&ctx).eval::<String>("repo()").unwrap()
2704 }
2705
2706 assert_eq!(repo_on("windows-x86").await, "C:/Users/me/Code/Apps/demo");
2707 assert_eq!(repo_on("fw13").await, "~/Code/Apps/demo");
2708 }
2709
2710 /// `secret(key)` reads a file under `secrets_root`, trims its trailing
2711 /// newline (the shape of a here-doc'd token file), and refuses any key that
2712 /// could escape the root. Covers the host-fn registered in `build_engine`.
2713 #[tokio::test]
2714 async fn secret_reads_under_root_and_blocks_traversal() {
2715 let dir = tempfile::tempdir().unwrap();
2716 let cfg = Config::for_tests(dir.path());
2717 // Seed a secret and one in a nested subdir; a trailing newline that the
2718 // read must strip.
2719 std::fs::create_dir_all(&cfg.secrets_root).unwrap();
2720 std::fs::write(cfg.secrets_root.join("token"), "s3cr3t\n").unwrap();
2721 std::fs::create_dir_all(cfg.secrets_root.join("app")).unwrap();
2722 std::fs::write(cfg.secrets_root.join("app").join("key"), "nested").unwrap();
2723 // Plant a file OUTSIDE the root that a traversal key would reach.
2724 std::fs::write(dir.path().join("outside"), "leak").unwrap();
2725
2726 let cfg = Arc::new(cfg);
2727 let pool = crate::db::open(&cfg.db_path).await.unwrap();
2728 let ctx = Arc::new(RecipeCtx::new(
2729 AppId::new("demo"),
2730 Version::parse("0.1.0").unwrap(),
2731 "linux/x86_64".parse().unwrap(),
2732 "fw13".into(),
2733 "local".into(),
2734 "v0.1.0".into(),
2735 "/tmp".into(),
2736 vec![],
2737 Kind::App,
2738 1,
2739 Arc::new(std::collections::HashMap::new()),
2740 Arc::new(std::collections::HashMap::new()),
2741 None,
2742 pool,
2743 crate::events::channel(),
2744 cfg,
2745 Arc::new(OtaRegistry::standard("https://makenot.work")),
2746 tokio::runtime::Handle::current(),
2747 Arc::new(AtomicBool::new(false)),
2748 None,
2749 ));
2750 let engine = build_engine(&ctx);
2751
2752 // Happy path: read + trim.
2753 assert_eq!(
2754 engine.eval::<String>(r#"secret("token")"#).unwrap(),
2755 "s3cr3t"
2756 );
2757 // A multi-segment relative key is allowed.
2758 assert_eq!(
2759 engine.eval::<String>(r#"secret("app/key")"#).unwrap(),
2760 "nested"
2761 );
2762
2763 // Traversal, absolute paths, and empty keys are refused BEFORE any read,
2764 // so the file one `..` above the root is never disclosed.
2765 for bad in [
2766 r#"secret("../outside")"#,
2767 r#"secret("/etc/passwd")"#,
2768 r#"secret("")"#,
2769 ] {
2770 let err = engine.eval::<String>(bad).unwrap_err().to_string();
2771 assert!(
2772 err.contains("relative path under secrets_root"),
2773 "`{bad}` should hit the traversal guard, got: {err}"
2774 );
2775 }
2776 // A missing key surfaces the filesystem error, not a panic, and does not
2777 // trip the traversal guard (it is a legitimate relative path).
2778 let err = engine
2779 .eval::<String>(r#"secret("nope")"#)
2780 .unwrap_err()
2781 .to_string();
2782 assert!(err.contains("secret `nope`"), "got: {err}");
2783 }
2784
2785 /// The two failures that actually shipped, as regression cases.
2786 #[test]
2787 fn preflight_catches_a_dead_repository_url() {
2788 // pter 0.1.0: repository pointed at a URL that does not exist. It
2789 // published clean and the link is now permanent for that version.
2790 let meta = CrateMeta {
2791 name: "pter".into(),
2792 version: "0.1.0".into(),
2793 repository: Some("https://github.com/maxjacobson/pter".into()),
2794 description: Some("d".into()),
2795 licensed: true,
2796 };
2797 let problems = crate_publish_problems(&meta, false, &[], true);
2798 assert_eq!(problems.len(), 1, "{problems:?}");
2799 assert!(
2800 problems[0].contains("not publicly clonable"),
2801 "{problems:?}"
2802 );
2803
2804 // Same metadata, reachable URL: nothing to report.
2805 assert!(crate_publish_problems(&meta, true, &[], true).is_empty());
2806 }
2807
2808 #[test]
2809 fn preflight_requires_the_fields_crates_io_bakes_in() {
2810 let bare = CrateMeta {
2811 name: "x".into(),
2812 version: "0.1.0".into(),
2813 repository: None,
2814 description: None,
2815 licensed: false,
2816 };
2817 let problems = crate_publish_problems(&bare, false, &[], true);
2818 assert_eq!(problems.len(), 3, "{problems:?}");
2819 assert!(problems.iter().any(|p| p.contains("repository")));
2820 assert!(problems.iter().any(|p| p.contains("description")));
2821 assert!(problems.iter().any(|p| p.contains("license")));
2822 }
2823
2824 // A library's verify is a crate preflight, not a Gatekeeper check on a
2825 // signed bundle. Gating it on `gatekeeper` asked a Linux host for a macOS
2826 // code-signing capability it can never hold, so the step was denied before
2827 // it ran a command; the denial then surfaced as "no crates.io credentials",
2828 // which is not what went wrong. The only way to satisfy the old gate was to
2829 // declare the capability falsely in the topology.
2830 #[test]
2831 fn a_library_verify_is_not_gated_on_gatekeeper() {
2832 assert_eq!(
2833 action_for(Step::Verify, Kind::Library),
2834 Action::Build,
2835 "a crate preflight runs the build toolchain; that is what it needs",
2836 );
2837 assert_eq!(
2838 action_for(Step::Verify, Kind::App),
2839 Action::Observe(ObserveKind::Custom("gatekeeper".into())),
2840 "an app's verify still proves the bundle is signed and notarized",
2841 );
2842 }
2843
2844 // The capability the default host grant actually carries. Without this the
2845 // fix above is only true by inspection.
2846 #[test]
2847 fn a_default_host_can_run_a_library_verify_and_not_an_app_one() {
2848 let caps =
2849 ops_exec::CapabilitySet::from_tokens(["build", "package"], ["build-log", "artifact"]);
2850 assert!(caps.permits(&action_for(Step::Verify, Kind::Library)));
2851 assert!(!caps.permits(&action_for(Step::Verify, Kind::App)));
2852 }
2853
2854 // Every other step is a property of the step alone; verify is the one that
2855 // depends on what is being released.
2856 #[test]
2857 fn no_other_step_changes_with_the_kind() {
2858 for step in [
2859 Step::Checkout,
2860 Step::Prebuild,
2861 Step::Build,
2862 Step::Sign,
2863 Step::Notarize,
2864 Step::Staple,
2865 Step::Package,
2866 Step::Publish,
2867 Step::Collect,
2868 ] {
2869 assert_eq!(
2870 action_for(step, Kind::App),
2871 action_for(step, Kind::Library),
2872 "{step:?} should not depend on the kind",
2873 );
2874 }
2875 }
2876
2877 #[test]
2878 fn preflight_rejects_republishing_the_same_version() {
2879 let meta = CrateMeta {
2880 name: "makeover".into(),
2881 version: "0.10.0".into(),
2882 repository: Some("https://git.sr.ht/~maxmj/makeover".into()),
2883 description: Some("d".into()),
2884 licensed: true,
2885 };
2886 let problems =
2887 crate_publish_problems(&meta, true, &["0.9.0".into(), "0.10.0".into()], true);
2888 assert_eq!(problems.len(), 1, "{problems:?}");
2889 assert!(problems[0].contains("already published"), "{problems:?}");
2890
2891 // An unreleased version against the same history is fine.
2892 let mut next = meta.clone();
2893 next.version = "0.11.0".into();
2894 assert!(crate_publish_problems(&next, true, &["0.10.0".into()], true).is_empty());
2895 }
2896
2897 /// Missing credentials must surface at preflight, not at the upload. The
2898 /// publish step is the irreversible one and runs last, after a full build
2899 /// and verify; discovering there that cargo cannot authenticate wastes the
2900 /// whole run.
2901 #[test]
2902 fn preflight_reports_missing_credentials_up_front() {
2903 let meta = CrateMeta {
2904 name: "makeover".into(),
2905 version: "0.11.0".into(),
2906 repository: Some("https://git.sr.ht/~maxmj/makeover".into()),
2907 description: Some("d".into()),
2908 licensed: true,
2909 };
2910 // Metadata is perfect; only the token is absent.
2911 let problems = crate_publish_problems(&meta, true, &[], false);
2912 assert_eq!(problems.len(), 1, "{problems:?}");
2913 assert!(problems[0].contains("credentials"), "{problems:?}");
2914 assert!(
2915 problems[0].contains("cargo login"),
2916 "should say how to fix it"
2917 );
2918
2919 // Present: nothing to report.
2920 assert!(crate_publish_problems(&meta, true, &[], true).is_empty());
2921 }
2922
2923 #[test]
2924 fn crate_meta_reads_cargo_metadata_json() {
2925 let raw = r#"{"packages":[{"name":"makeover","version":"0.10.0",
2926 "repository":"https://git.sr.ht/~maxmj/makeover","description":"themes",
2927 "license":"MIT"}]}"#;
2928 let m = crate_meta_from_json(raw).unwrap();
2929 assert_eq!(m.name, "makeover");
2930 assert_eq!(m.version, "0.10.0");
2931 assert!(m.licensed);
2932 assert_eq!(
2933 m.repository.as_deref(),
2934 Some("https://git.sr.ht/~maxmj/makeover")
2935 );
2936
2937 // license_file alone also counts as licensed; empty strings do not
2938 // count as present.
2939 let lf = r#"{"packages":[{"name":"x","version":"0.1.0","license":"",
2940 "license_file":"LICENSE","description":""}]}"#;
2941 let m = crate_meta_from_json(lf).unwrap();
2942 assert!(m.licensed);
2943 assert!(m.description.is_none());
2944 }
2945
2946 /// Reads the ambient `HOME` rather than setting one. `set_var` is
2947 /// process-global and unsynchronized, so a test that overwrote HOME changed
2948 /// it for every other test in the binary — which is what silently disabled
2949 /// `topology::live_config_smoke` (it skips when `$HOME/.config/bento` is
2950 /// absent, and `/home/test` always is).
2951 #[test]
2952 fn expand_tilde_handles_home() {
2953 let home = PathBuf::from(std::env::var("HOME").expect("HOME is set"));
2954 assert_eq!(expand_tilde("~/Code/x"), home.join("Code/x"));
2955 assert_eq!(expand_tilde("/abs/path"), PathBuf::from("/abs/path"));
2956 }
2957
2958 // ---- artifact resolution (the M3 silent-`sh` fix) ----
2959
2960 #[test]
2961 fn resolve_artifact_match_wants_exactly_one() {
2962 // Exactly one match: the path, trimmed of the listing's line noise.
2963 assert_eq!(
2964 resolve_artifact_match(" /d/App.AppImage \n", "*.AppImage", true).unwrap(),
2965 "/d/App.AppImage"
2966 );
2967 }
2968
2969 #[test]
2970 fn resolve_artifact_match_zero_depends_on_required() {
2971 // Required + zero matches is the case the old empty-string guard caught;
2972 // keep failing it.
2973 let err = resolve_artifact_match("", "*.dmg", true).unwrap_err();
2974 assert!(err.to_string().contains("no artifact matched"), "{err}");
2975 // Optional + zero matches resolves to empty (recipe skips the collect).
2976 assert_eq!(
2977 resolve_artifact_match("\n \n", "*.deb", false).unwrap(),
2978 ""
2979 );
2980 }
2981
2982 #[test]
2983 fn resolve_artifact_match_rejects_ambiguous() {
2984 // Two matches must throw rather than silently pick one — this is the
2985 // stale-newest-mtime hole the audit flagged. Applies even when optional.
2986 for required in [true, false] {
2987 let err =
2988 resolve_artifact_match("/d/old.deb\n/d/new.deb\n", "*.deb", required).unwrap_err();
2989 let msg = err.to_string();
2990 assert!(msg.contains("ambiguous"), "{msg}");
2991 assert!(msg.contains("old.deb") && msg.contains("new.deb"), "{msg}");
2992 }
2993 }
2994
2995 #[test]
2996 fn ensure_glob_safe_allows_paths_bars_commands() {
2997 // Path and wildcard characters pass.
2998 assert!(ensure_glob_safe("~/Code/app/dist/*.AppImage").is_ok());
2999 assert!(ensure_glob_safe("/t/App_1.2.3-x86_64.dmg").is_ok());
3000 // A command substitution or separator does not.
3001 for bad in ["*.dmg; rm -rf /", "$(evil)", "a|b", "a b"] {
3002 assert!(ensure_glob_safe(bad).is_err(), "should reject {bad:?}");
3003 }
3004 }
3005
3006 // ---- version resolution ----
3007
3008 #[test]
3009 fn version_from_tauri_json_reads_version() {
3010 assert_eq!(
3011 version_from_tauri_json(r#"{"version":"0.4.2"}"#).unwrap(),
3012 "0.4.2"
3013 );
3014 assert!(version_from_tauri_json(r#"{"productName":"X"}"#).is_err());
3015 }
3016
3017 #[test]
3018 fn version_from_cargo_toml_prefers_package_then_workspace() {
3019 // A leaf crate's [package].version.
3020 assert_eq!(
3021 version_from_cargo_toml("[package]\nname = \"x\"\nversion = \"0.5.0\"\n").unwrap(),
3022 "0.5.0"
3023 );
3024 // A workspace that sets [workspace.package].version.
3025 assert_eq!(
3026 version_from_cargo_toml("[workspace.package]\nversion = \"1.2.3\"\n").unwrap(),
3027 "1.2.3"
3028 );
3029 // No version anywhere -> error, not a panic.
3030 assert!(version_from_cargo_toml("[workspace]\nmembers = []\n").is_err());
3031 }
3032
3033 #[test]
3034 fn version_from_repo_default_and_explicit_paths() {
3035 let tmp = tempfile::tempdir().unwrap();
3036 let root = tmp.path();
3037
3038 // Tauri app: default path reads src-tauri/tauri.conf.json.
3039 let tauri = root.join("tauri");
3040 std::fs::create_dir_all(tauri.join("src-tauri")).unwrap();
3041 std::fs::write(
3042 tauri.join("src-tauri/tauri.conf.json"),
3043 r#"{"version":"0.4.2"}"#,
3044 )
3045 .unwrap();
3046 assert_eq!(
3047 version_from_repo(tauri.to_str().unwrap(), None)
3048 .unwrap()
3049 .to_string(),
3050 "0.4.2"
3051 );
3052
3053 // Workspace egui app: no tauri.conf.json, explicit version_path at a member crate.
3054 let ws = root.join("ws");
3055 std::fs::create_dir_all(ws.join("crates/app")).unwrap();
3056 std::fs::write(
3057 ws.join("Cargo.toml"),
3058 "[workspace]\nmembers = [\"crates/app\"]\n",
3059 )
3060 .unwrap();
3061 std::fs::write(
3062 ws.join("crates/app/Cargo.toml"),
3063 "[package]\nname = \"app\"\nversion = \"0.5.0\"\n",
3064 )
3065 .unwrap();
3066 assert_eq!(
3067 version_from_repo(ws.to_str().unwrap(), Some("crates/app/Cargo.toml"))
3068 .unwrap()
3069 .to_string(),
3070 "0.5.0"
3071 );
3072 }
3073
3074 // ---- version-source cross-check (drift preflight) ----
3075
3076 fn ver(s: &str) -> Version {
3077 Version::parse(s).unwrap()
3078 }
3079
3080 #[test]
3081 fn version_consistency_passes_when_all_sources_agree() {
3082 let tmp = tempfile::tempdir().unwrap();
3083 let repo = tmp.path();
3084 std::fs::create_dir_all(repo.join("src-tauri")).unwrap();
3085 std::fs::write(
3086 repo.join("src-tauri/tauri.conf.json"),
3087 r#"{"version":"0.5.0"}"#,
3088 )
3089 .unwrap();
3090 std::fs::write(
3091 repo.join("Cargo.toml"),
3092 "[package]\nname = \"app\"\nversion = \"0.5.0\"\n",
3093 )
3094 .unwrap();
3095 check_version_consistency(repo.to_str().unwrap(), None, &ver("0.5.0")).unwrap();
3096 }
3097
3098 #[test]
3099 fn version_consistency_flags_tauri_vs_cargo_drift() {
3100 // The concrete finding: tauri.conf.json bumped to 0.5.0 but the root
3101 // Cargo.toml left at 0.4.0. version_from_repo (one file) would miss it.
3102 let tmp = tempfile::tempdir().unwrap();
3103 let repo = tmp.path();
3104 std::fs::create_dir_all(repo.join("src-tauri")).unwrap();
3105 std::fs::write(
3106 repo.join("src-tauri/tauri.conf.json"),
3107 r#"{"version":"0.5.0"}"#,
3108 )
3109 .unwrap();
3110 std::fs::write(
3111 repo.join("Cargo.toml"),
3112 "[package]\nname = \"app\"\nversion = \"0.4.0\"\n",
3113 )
3114 .unwrap();
3115 let err =
3116 check_version_consistency(repo.to_str().unwrap(), None, &ver("0.5.0")).unwrap_err();
3117 let msg = format!("{err:#}");
3118 assert!(msg.contains("Cargo.toml says 0.4.0"), "{msg}");
3119 }
3120
3121 #[test]
3122 fn version_consistency_flags_explicit_version_the_repo_does_not_reflect() {
3123 let tmp = tempfile::tempdir().unwrap();
3124 let repo = tmp.path();
3125 std::fs::create_dir_all(repo.join("src-tauri")).unwrap();
3126 std::fs::write(
3127 repo.join("src-tauri/tauri.conf.json"),
3128 r#"{"version":"0.5.0"}"#,
3129 )
3130 .unwrap();
3131 let err =
3132 check_version_consistency(repo.to_str().unwrap(), None, &ver("9.9.9")).unwrap_err();
3133 assert!(format!("{err:#}").contains("building 9.9.9"));
3134 }
3135
3136 #[test]
3137 fn version_consistency_single_source_never_invents_drift() {
3138 // A virtual-workspace root Cargo.toml (no version) alongside the member
3139 // crate the version_path points at: only one real source, so no drift.
3140 let tmp = tempfile::tempdir().unwrap();
3141 let repo = tmp.path();
3142 std::fs::create_dir_all(repo.join("crates/app")).unwrap();
3143 std::fs::write(
3144 repo.join("Cargo.toml"),
3145 "[workspace]\nmembers = [\"crates/app\"]\n",
3146 )
3147 .unwrap();
3148 std::fs::write(
3149 repo.join("crates/app/Cargo.toml"),
3150 "[package]\nname = \"app\"\nversion = \"0.5.0\"\n",
3151 )
3152 .unwrap();
3153 check_version_consistency(
3154 repo.to_str().unwrap(),
3155 Some("crates/app/Cargo.toml"),
3156 &ver("0.5.0"),
3157 )
3158 .unwrap();
3159 }
3160
3161 // ---- artifact filename version assertion + hashing ----
3162
3163 #[test]
3164 fn versions_in_filename_extracts_only_real_semvers() {
3165 assert_eq!(
3166 versions_in_filename("GoingsOn_0.5.0_aarch64.dmg"),
3167 vec![ver("0.5.0")]
3168 );
3169 assert_eq!(
3170 versions_in_filename("AudioFiles-0.4.0-x86_64.AppImage"),
3171 vec![ver("0.4.0")]
3172 );
3173 // No three-part token ⇒ nothing (an updater manifest, a bare signature).
3174 assert!(versions_in_filename("latest.json").is_empty());
3175 assert!(versions_in_filename("app.sig").is_empty());
3176 }
3177
3178 #[test]
3179 fn assert_artifact_version_rejects_a_stale_artifact() {
3180 // The 0.4.0 file sitting in the output dir against a 0.5.0 build.
3181 let err =
3182 assert_artifact_version("AudioFiles-0.4.0-x86_64.AppImage", &ver("0.5.0")).unwrap_err();
3183 assert!(format!("{err:#}").contains("stale artifact"), "{err:#}");
3184 // The matching version passes, and a versionless file is not asserted.
3185 assert_artifact_version("GoingsOn_0.5.0_aarch64.dmg", &ver("0.5.0")).unwrap();
3186 assert_artifact_version("latest.json", &ver("0.5.0")).unwrap();
3187 }
3188
3189 /// The comparison that decides whether a binary can exec on the box that is
3190 /// about to be restarted onto it. Both sides are parsed out of text a tool
3191 /// printed, so both parsers are worth pinning: fw13 tracks a newer glibc
3192 /// than the Ubuntu 24.04 host in Hetzner, and getting this backwards means a
3193 /// dead unit rather than a failed step.
3194 #[test]
3195 fn glibc_versions_parse_from_what_the_tools_actually_print() {
3196 // `objdump -T | grep -o 'GLIBC_[0-9.]*'` output: highest wins, and the
3197 // comparison is numeric (2.9 must not beat 2.34 lexically).
3198 let objdump = "GLIBC_2.2.5\nGLIBC_2.34\nGLIBC_2.9\nGLIBC_2.17\n";
3199 assert_eq!(max_glibc_symbol(objdump), Some((2, 34)));
3200 // A static binary references none: nothing to check.
3201 assert_eq!(max_glibc_symbol(""), None);
3202
3203 // `ldd --version` first line, however the distro decorates it.
3204 assert_eq!(
3205 glibc_from_ldd("ldd (Ubuntu GLIBC 2.39-0ubuntu8.8) 2.39\nCopyright...\n"),
3206 Some((2, 39))
3207 );
3208 assert_eq!(
3209 glibc_from_ldd("ldd (GNU libc) 2.41\nCopyright (C) 2025\n"),
3210 Some((2, 41))
3211 );
3212 assert_eq!(glibc_from_ldd(""), None);
3213 }
3214
3215 /// A binary needing MORE than the host has is the failure this check exists
3216 /// for; equal and less are both fine (glibc symbol versioning is backward
3217 /// compatible, so an older requirement runs on a newer host).
3218 #[test]
3219 fn glibc_requirement_is_satisfied_by_equal_or_newer_only() {
3220 let needs = max_glibc_symbol("GLIBC_2.41").unwrap();
3221 assert!(needs > glibc_from_ldd("ldd (Ubuntu GLIBC 2.39) 2.39").unwrap());
3222 assert!(needs <= glibc_from_ldd("ldd (GNU libc) 2.41").unwrap());
3223 assert!(needs <= glibc_from_ldd("ldd (GNU libc) 2.42").unwrap());
3224 assert!(needs <= glibc_from_ldd("ldd (GNU libc) 3.0").unwrap());
3225 }
3226
3227 /// Every deploy host function fails with the app's KIND as the reason when
3228 /// there is no destination, rather than with a missing-host error from
3229 /// somewhere deeper. A recipe calling `deploy()` on a library is a recipe
3230 /// written against the wrong kind, and the message should say so.
3231 #[tokio::test]
3232 async fn deploy_host_fns_explain_a_missing_destination_by_kind() {
3233 let dir = tempfile::tempdir().unwrap();
3234 let cfg = Arc::new(Config::for_tests(dir.path()));
3235 let pool = crate::db::open(&cfg.db_path).await.unwrap();
3236 let ctx = Arc::new(RecipeCtx::new(
3237 AppId::new("demo"),
3238 Version::parse("0.1.0").unwrap(),
3239 "linux/x86_64".parse().unwrap(),
3240 "fw13".into(),
3241 "local".into(),
3242 "v0.1.0".into(),
3243 "/tmp".into(),
3244 vec![],
3245 Kind::Library,
3246 1,
3247 Arc::new(std::collections::HashMap::new()),
3248 Arc::new(std::collections::HashMap::new()),
3249 None,
3250 pool,
3251 crate::events::channel(),
3252 cfg,
3253 Arc::new(OtaRegistry::standard("https://makenot.work")),
3254 tokio::runtime::Handle::current(),
3255 Arc::new(AtomicBool::new(false)),
3256 None,
3257 ));
3258 let engine = build_engine(&ctx);
3259 for call in [
3260 "deploy_host()",
3261 "service_name()",
3262 "install_path()",
3263 "health_url()",
3264 r#"deploy("/tmp/x")"#,
3265 ] {
3266 let err = engine.eval::<String>(call).unwrap_err().to_string();
3267 assert!(
3268 err.contains("library") && err.contains("no deploy destination"),
3269 "`{call}` must fail on the kind, got: {err}"
3270 );
3271 }
3272 }
3273
3274 /// A service host is addressed on the DEPLOY plane whatever step is open.
3275 ///
3276 /// The subtle one. Actions are normally derived from the step, which is
3277 /// right for a build host — the step is what that host is being asked to do.
3278 /// A service host is granted `deploy`/`restart` and must never be granted
3279 /// `build`, so the same rule would have `glibc_check` ask it for `build`
3280 /// during a `verify` step and get denied for a reason unrelated to what was
3281 /// attempted. `verify` is the step that check belongs in, so without this
3282 /// routing the glibc gate cannot run at all.
3283 #[tokio::test]
3284 async fn a_service_host_is_addressed_on_the_deploy_plane_in_any_step() {
3285 let dir = tempfile::tempdir().unwrap();
3286 let cfg = Arc::new(Config::for_tests(dir.path()));
3287 let pool = crate::db::open(&cfg.db_path).await.unwrap();
3288 sqlx::query(
3289 "INSERT INTO builds (id, app, version, status, created_at) \
3290 VALUES (1, 'demo', '0.1.0', 'running', '2026-07-30T00:00:00Z')",
3291 )
3292 .execute(&pool)
3293 .await
3294 .unwrap();
3295 sqlx::query(
3296 "INSERT INTO target_runs (id, build_id, app, version, target, status, started_at) \
3297 VALUES (1, 1, 'demo', '0.1.0', 'linux/x86_64', 'running', '2026-07-30T00:00:00Z')",
3298 )
3299 .execute(&pool)
3300 .await
3301 .unwrap();
3302
3303 let deploy = crate::topology::DeployTarget {
3304 target: "linux/x86_64".parse().unwrap(),
3305 host: "local".into(),
3306 port: None,
3307 install_path: "/usr/local/bin/demo".into(),
3308 service: "demo.service".into(),
3309 health_url: None,
3310 };
3311 let mut execs: crate::state::ExecutorMap = std::collections::HashMap::new();
3312 execs.insert("local".into(), crate::state::build_deploy_executor(&deploy));
3313 // The service host's grant is exactly deploy + restart. If this ever
3314 // widens to include `build`, the test below stops proving anything.
3315 assert!(!execs["local"].capabilities().permits(&Action::Build));
3316 assert!(execs["local"].capabilities().permits(&Action::Deploy));
3317
3318 let ctx = Arc::new(RecipeCtx::new(
3319 AppId::new("demo"),
3320 Version::parse("0.1.0").unwrap(),
3321 "linux/x86_64".parse().unwrap(),
3322 "fw13".into(),
3323 "local".into(),
3324 "v0.1.0".into(),
3325 "/tmp".into(),
3326 vec![],
3327 Kind::Service,
3328 1,
3329 Arc::new(execs),
3330 Arc::new(std::collections::HashMap::new()),
3331 Some(deploy),
3332 pool,
3333 crate::events::channel(),
3334 cfg,
3335 Arc::new(OtaRegistry::standard("https://makenot.work")),
3336 tokio::runtime::Handle::current(),
3337 Arc::new(AtomicBool::new(false)),
3338 None,
3339 ));
3340
3341 let ctx_blocking = ctx.clone();
3342 tokio::task::spawn_blocking(move || {
3343 // `verify` on a service derives Action::Build — which the service
3344 // host does not grant. The command must still run.
3345 ctx_blocking.begin_step(Step::Verify).unwrap();
3346 assert_eq!(
3347 action_for(Step::Verify, Kind::Service),
3348 Action::Build,
3349 "the step's own action is the one that would be denied",
3350 );
3351 let (code, out) = ctx_blocking
3352 .run("local", "echo reached-the-service-host")
3353 .expect("a service host must be reachable during a verify step");
3354 assert_eq!(code, 0, "{out}");
3355 assert!(out.contains("reached-the-service-host"), "{out}");
3356 })
3357 .await
3358 .unwrap();
3359 }
3360
3361 /// A step that finalized `Failed` bars the deploy, exactly as it bars a
3362 /// publish. Without this, a recipe that inspects `sh(...).code` and carries
3363 /// on regardless still lands a binary on a production host — the precise
3364 /// hazard a pipeline exists to remove. The check is the ledger, not the
3365 /// control flow, so it holds whether or not the recipe noticed.
3366 #[tokio::test]
3367 async fn a_failed_step_bars_the_deploy() {
3368 let dir = tempfile::tempdir().unwrap();
3369 let cfg = Arc::new(Config::for_tests(dir.path()));
3370 let pool = crate::db::open(&cfg.db_path).await.unwrap();
3371 let deploy = crate::topology::DeployTarget {
3372 target: "linux/x86_64".parse().unwrap(),
3373 host: "local".into(),
3374 port: None,
3375 install_path: "/usr/local/bin/demo".into(),
3376 service: "demo.service".into(),
3377 health_url: None,
3378 };
3379 // A real build + target run, so the step rows this test finalizes have
3380 // the parents the schema requires.
3381 sqlx::query(
3382 "INSERT INTO builds (id, app, version, status, created_at) \
3383 VALUES (1, 'demo', '0.1.0', 'running', '2026-07-30T00:00:00Z')",
3384 )
3385 .execute(&pool)
3386 .await
3387 .unwrap();
3388 sqlx::query(
3389 "INSERT INTO target_runs (id, build_id, app, version, target, status, started_at) \
3390 VALUES (1, 1, 'demo', '0.1.0', 'linux/x86_64', 'running', '2026-07-30T00:00:00Z')",
3391 )
3392 .execute(&pool)
3393 .await
3394 .unwrap();
3395
3396 let mut execs: crate::state::ExecutorMap = std::collections::HashMap::new();
3397 execs.insert("local".into(), crate::state::build_deploy_executor(&deploy));
3398 let ctx = Arc::new(RecipeCtx::new(
3399 AppId::new("demo"),
3400 Version::parse("0.1.0").unwrap(),
3401 "linux/x86_64".parse().unwrap(),
3402 "fw13".into(),
3403 "local".into(),
3404 "v0.1.0".into(),
3405 "/tmp".into(),
3406 vec![],
3407 Kind::Service,
3408 1,
3409 Arc::new(execs),
3410 Arc::new(std::collections::HashMap::new()),
3411 Some(deploy),
3412 pool,
3413 crate::events::channel(),
3414 cfg,
3415 Arc::new(OtaRegistry::standard("https://makenot.work")),
3416 tokio::runtime::Handle::current(),
3417 Arc::new(AtomicBool::new(false)),
3418 None,
3419 ));
3420
3421 // A gate ran, failed, and the recipe did not abort — the swallowed
3422 // failure. Finalizing it is what puts it in the ledger.
3423 let ctx_blocking = ctx.clone();
3424 tokio::task::spawn_blocking(move || {
3425 ctx_blocking.begin_step(Step::Prebuild).unwrap();
3426 ctx_blocking.fail_current_step();
3427 ctx_blocking.finish_step(Status::Ok).unwrap();
3428
3429 let err = ctx_blocking.deploy("/tmp/demo").unwrap_err().to_string();
3430 assert!(
3431 err.contains("refusing to deploy") && err.contains("prebuild"),
3432 "must refuse and name the failed step, got: {err}"
3433 );
3434 })
3435 .await
3436 .unwrap();
3437 }
3438
3439 #[test]
3440 fn every_step_has_a_nonzero_default_budget() {
3441 // A zero/missing budget would deadline-fail a step instantly. Cover the
3442 // whole matrix so a new Step variant can't silently get a 0 budget.
3443 for step in Step::ALL {
3444 assert!(
3445 default_step_budget(step) >= std::time::Duration::from_mins(1),
3446 "{step} budget must be a sane ceiling",
3447 );
3448 }
3449 }
3450
3451 #[test]
3452 fn sha256_file_is_lowercase_hex_of_contents() {
3453 let tmp = tempfile::tempdir().unwrap();
3454 let f = tmp.path().join("a.bin");
3455 std::fs::write(&f, b"abc").unwrap();
3456 // Known SHA-256 of "abc".
3457 assert_eq!(
3458 sha256_file(&f).unwrap(),
3459 "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
3460 );
3461 }
3462
3463 // ---- publish step-success gate ----
3464
3465 fn target(s: &str) -> Target {
3466 s.parse().unwrap()
3467 }
3468
3469 #[test]
3470 fn publish_gate_blocks_macos_without_verification() {
3471 // Never verified -> blocked, with a message pointing at verify_gatekeeper.
3472 let err = PublishAuthority::prove(target("macos/aarch64"), &[], None).unwrap_err();
3473 assert!(format!("{err:#}").contains("never verified"), "{err:#}");
3474 }
3475
3476 #[test]
3477 fn publish_gate_blocks_macos_when_gatekeeper_rejected() {
3478 let err = PublishAuthority::prove(target("macos/aarch64"), &[], Some(false)).unwrap_err();
3479 assert!(
3480 format!("{err:#}").contains("Gatekeeper rejected"),
3481 "{err:#}"
3482 );
3483 }
3484
3485 #[test]
3486 fn publish_gate_allows_macos_when_gatekeeper_accepted() {
3487 PublishAuthority::prove(target("macos/aarch64"), &[], Some(true)).unwrap();
3488 // iOS is gated the same way.
3489 PublishAuthority::prove(target("ios/universal"), &[], Some(true)).unwrap();
3490 assert!(PublishAuthority::prove(target("ios/universal"), &[], None).is_err());
3491 }
3492
3493 #[test]
3494 fn publish_gate_does_not_require_gatekeeper_for_non_apple_targets() {
3495 // Linux/Windows aren't notarized; no gatekeeper proof needed.
3496 PublishAuthority::prove(target("linux/x86_64"), &[], None).unwrap();
3497 PublishAuthority::prove(target("windows/x86_64"), &[], None).unwrap();
3498 }
3499
3500 #[test]
3501 fn publish_gate_blocks_when_any_prior_step_failed() {
3502 // A failed step bars publish on every target, even a verified macOS one.
3503 let err =
3504 PublishAuthority::prove(target("linux/x86_64"), &[Step::Build], None).unwrap_err();
3505 assert!(
3506 format!("{err:#}").contains("prior step(s) failed"),
3507 "{err:#}"
3508 );
3509 assert!(
3510 format!("{err:#}").contains("build"),
3511 "names the failed step: {err:#}"
3512 );
3513
3514 let err = PublishAuthority::prove(target("macos/aarch64"), &[Step::Sign], Some(true))
3515 .unwrap_err();
3516 assert!(
3517 format!("{err:#}").contains("prior step(s) failed"),
3518 "{err:#}"
3519 );
3520 }
3521
3522 #[test]
3523 fn notary_accepted_parses_status_field() {
3524 assert!(notary_accepted(
3525 r#"{"id":"abc","status":"Accepted","message":"ok"}"#
3526 ));
3527 // Embedded in shell-sourcing noise: the object is isolated and parsed.
3528 assert!(notary_accepted(
3529 "sourcing env...\n{\n \"status\": \"Accepted\"\n}\nbye"
3530 ));
3531 // Whitespace variant that a tight substring `"status":"Accepted"` misses.
3532 assert!(notary_accepted(r#"{ "status" : "Accepted" }"#));
3533 }
3534
3535 #[test]
3536 fn notary_accepted_rejects_non_accepted_and_garbage() {
3537 assert!(!notary_accepted(r#"{"status":"Invalid"}"#));
3538 assert!(!notary_accepted(r#"{"status":"In Progress"}"#));
3539 assert!(!notary_accepted("no json here"));
3540 assert!(!notary_accepted("")); // empty / truncated -> fail closed
3541 // A truncated tail whose opening brace was cut off cannot parse -> closed.
3542 assert!(!notary_accepted(r#""status":"Accepted"}"#));
3543 // The literal appearing inside an error string must NOT pass as success.
3544 assert!(!notary_accepted(
3545 r#"{"status":"Invalid","message":"expected status:Accepted"}"#
3546 ));
3547 }
3548
3549 /// Both shapes of repo: one holding several products, and one holding a
3550 /// single crate, where git prints an empty prefix line.
3551 #[test]
3552 fn toplevel_and_prefix_read_both_shapes_of_repo() {
3553 let (top, prefix) =
3554 parse_toplevel_and_prefix("/home/max/Code/MNW\npom/\n").expect("two lines");
3555 assert_eq!(top, "/home/max/Code/MNW");
3556 assert_eq!(prefix, "pom/");
3557 // A repo holding one product: git prints an empty second line.
3558 let (top, prefix) =
3559 parse_toplevel_and_prefix("/home/max/Code/Libraries/pter\n\n").expect("two lines");
3560 assert_eq!(top, "/home/max/Code/Libraries/pter");
3561 assert_eq!(prefix, "");
3562 assert!(
3563 parse_toplevel_and_prefix("").is_none(),
3564 "no answer is not an answer"
3565 );
3566 }
3567
3568 #[test]
3569 fn repo_dir_name_is_the_last_segment_on_every_platform() {
3570 assert_eq!(repo_dir_name("/home/max/Code/MNW"), "MNW");
3571 assert_eq!(repo_dir_name("/home/max/Code/MNW/"), "MNW");
3572 // Git reports forward slashes on Windows too.
3573 assert_eq!(repo_dir_name("C:/Users/me/Code/Apps/goingson"), "goingson");
3574 }
3575
3576 /// The app's directory inside its worktree, for both repo shapes.
3577 #[test]
3578 fn app_dir_in_worktree_follows_the_prefix() {
3579 assert_eq!(
3580 app_dir_in_worktree("/home/max/Code/.bento/MNW/pom", "pom/"),
3581 "/home/max/Code/.bento/MNW/pom/pom"
3582 );
3583 assert_eq!(
3584 app_dir_in_worktree("/home/max/Code/.bento/pter/pter", ""),
3585 "/home/max/Code/.bento/pter/pter"
3586 );
3587 }
3588
3589 /// A missing tag is the common failure and gets a plain answer; anything
3590 /// else is git's own stderr, which says more than a guess.
3591 #[test]
3592 fn worktree_failure_reason_names_the_tag_or_repeats_git() {
3593 let missing = worktree_failure_reason("pom-v0.4.5", false, "irrelevant");
3594 assert!(missing.contains("does not exist"), "{missing}");
3595 let held = worktree_failure_reason(
3596 "pom-v0.4.5",
3597 true,
3598 "fatal: '/home/max/Code/.bento/MNW/pom' already exists",
3599 );
3600 assert!(held.contains("already exists"), "{held}");
3601 let silent = worktree_failure_reason("pom-v0.4.5", true, " ");
3602 assert!(silent.contains("said nothing"), "{silent}");
3603 }
3604 }
3605