Skip to main content

anodizer_core/
log.rs

1//! Thin structured logging helper for anodizer stages.
2//!
3//! Provides level-gated output to stderr in a single unified style ("format
4//! B"). Keeps stdout clean for machine-parseable output (e.g. `anodizer tag`).
5//!
6//! # Output style
7//!
8//! Two visual registers, one source of truth — never hand-format a stage line:
9//!
10//! ```text
11//!  Checking determinism          ← SECTION HEADER (group / step)
12//!    • targets  aarch64-…         ← META key/value row     (kv)
13//!    • stages   build, sign       ← META key/value row     (kv)
14//!    • runs     2                 ← META key/value row     (kv)
15//!  Building binaries              ← SECTION HEADER
16//!    • compiling x86_64-…         ← DETAIL / info line     (detail / status)
17//!    ✓ x86_64-…    1.2 MiB         ← SUCCESS line           (success)
18//!    ✗ aarch64-…   build failed    ← FAILURE line           (failure)
19//! ```
20//!
21//! Body lines belonging to a [`StageLogger::group`] section additionally
22//! carry the section's 2-space nesting indent, so a header's own detail
23//! rows sit one level beneath it (the indents in the sketch above are
24//! relative, not absolute columns).
25//!
26//! - **Section headers** ([`StageLogger::step`] / [`StageLogger::group`]) put a
27//!   bold-green present-participle verb (the leading word of the stage's
28//!   [`stage_header`] phrase) right-aligned in a fixed 12-column gutter, then
29//!   one space, then the message. ONLY verbs live in this gutter — never a
30//!   lowercase key.
31//! - **Body lines** ([`StageLogger::detail`] / [`success`] / [`failure`], plus
32//!   the retargeted [`StageLogger::status`]) sit at a 3-space body indent under
33//!   their header, prefixed by a marker — `•` info (cyan), `✓` success (green),
34//!   `✗` failure (red) — one space, then the text.
35//! - **Key/value rows** ([`StageLogger::kv`]) are `•` detail lines whose
36//!   lowercase dimmed key is padded so the values align within a group.
37//! - **Status labels** (`Warning` / `Error` / `Note`, via
38//!   [`render_warning`] / [`render_error`] / [`render_note`]) render the label
39//!   right-aligned in the same verb gutter as a section header (no colon), so
40//!   their messages align with the header messages above them.
41//!
42//! [`success`]: StageLogger::success
43//! [`failure`]: StageLogger::failure
44//!
45//! # Verbosity levels
46//!
47//! - **quiet**: errors only (for CI where only failures matter)
48//! - **default**: status messages (stage start/complete, key actions)
49//! - **verbose**: detail (command output, env vars, file paths)
50//! - **debug**: everything (HTTP request/response, template contexts, resolved config)
51//!
52//! # Secret redaction
53//!
54//! Every `StageLogger` carries an optional env-pairs list that drives the
55//! redaction policy applied inside [`StageLogger::check_output`]. Callers
56//! that go through [`crate::context::Context::logger`] inherit the merged
57//! `{process env, config env}` pairs automatically; manual constructors
58//! (`StageLogger::new`) start with no env and can be enriched via
59//! [`StageLogger::with_env`]. Stderr / stdout interpolated into log lines
60//! or `bail!` messages is therefore redacted without callers having to
61//! remember to scrub at every site.
62
63use std::sync::Arc;
64use std::sync::Mutex;
65use std::sync::OnceLock;
66use std::sync::atomic::{AtomicUsize, Ordering};
67
68use colored::Colorize;
69
70/// Process-global section nesting depth. Drives the 2-space-per-level
71/// indentation applied to every stderr log line so output produced
72/// inside a [`StageLogger::group`] sits visually beneath its header.
73///
74/// A single atomic (rather than per-logger state) is correct because the
75/// release pipeline drives one stderr stream and no `group()` is ever
76/// opened from a worker thread — sections bracket whole stages on the
77/// main thread, while a stage's interior parallelism (e.g. `build`
78/// spawning per-target threads) emits *inside* an already-open section.
79/// The depth is therefore a property of "where the main thread is in the
80/// run", not of any individual logger clone or worker.
81static SECTION_DEPTH: AtomicUsize = AtomicUsize::new(0);
82
83/// Env var carrying a parent `anodizer` process's visual nesting depth.
84///
85/// The determinism harness spawns child `anodizer release` subprocesses
86/// whose stderr is inherited, so the child's lines interleave directly
87/// into the parent's stream. Without an inherited base depth the child's
88/// section headers would render flush-left, visually escaping the
89/// parent's open section. The parent exports its depth here; the child
90/// reads it once (see [`base_depth`]) and offsets every indent by it.
91pub const LOG_DEPTH_ENV: &str = "ANODIZER_LOG_DEPTH";
92
93/// Base nesting depth inherited from a parent process via
94/// [`LOG_DEPTH_ENV`], parsed once on first use. Zero when the var is
95/// absent or unparseable (a standalone process indents from column 0).
96static BASE_DEPTH: OnceLock<usize> = OnceLock::new();
97
98/// Parse the inherited base depth from a raw [`LOG_DEPTH_ENV`] value.
99/// Lenient by design: a missing or malformed value degrades to 0 (the
100/// standalone-process default) rather than failing — indentation is
101/// presentation, never worth aborting a release over.
102fn parse_base_depth(raw: Option<&str>) -> usize {
103    raw.and_then(|v| v.trim().parse().ok()).unwrap_or(0)
104}
105
106/// The process's inherited base depth (see [`LOG_DEPTH_ENV`]).
107fn base_depth() -> usize {
108    *BASE_DEPTH.get_or_init(|| parse_base_depth(std::env::var(LOG_DEPTH_ENV).ok().as_deref()))
109}
110
111/// Current absolute nesting depth: the inherited base plus every open
112/// section. This is the value [`indent`] renders and the value a parent
113/// exports (offset for the child's nesting) when spawning a subprocess
114/// whose stderr joins this process's stream.
115pub fn current_depth() -> usize {
116    base_depth() + SECTION_DEPTH.load(Ordering::Relaxed)
117}
118
119/// A section header that has been opened ([`StageLogger::group`]) but not yet
120/// printed. The header line is deferred until the section actually emits a
121/// body line, so a stage that does nothing prints nothing at all (matching
122/// GoReleaser, which only prints a section header once the section has output).
123struct PendingHeader {
124    /// Section depth captured at open time. The header renders at *this* depth,
125    /// not the current global depth, so a nested section's deferred header is
126    /// still indented to its own level when flushed alongside its ancestors.
127    depth: usize,
128    /// Right-aligned bold-green verb (the leading word of the stage's
129    /// [`stage_header`] phrase).
130    verb: String,
131    /// The remaining words of the phrase, printed after the verb (empty for a
132    /// single-word phrase, which renders a bare gutter verb).
133    msg: String,
134    /// Whether this header has already been printed. A flushed entry stays on
135    /// the stack (so the LIFO pop in [`SectionGuard::drop`] removes the right
136    /// one) but is never reprinted.
137    flushed: bool,
138}
139
140/// Stack of section headers awaiting their first body line. Pushed by
141/// [`StageLogger::group`], drained by [`flush_pending`] when a real line is
142/// about to print, and popped (LIFO) by [`SectionGuard::drop`].
143///
144/// A `Mutex` (not a thread-local) because sections are opened on the main
145/// thread like [`SECTION_DEPTH`], but body lines may flush from a stage's
146/// worker threads (e.g. `build` spawning per-target threads). The lock
147/// serializes the flush state transition: each header's `flushed` flag flips
148/// under the lock, so a header prints exactly once — never lost, never
149/// duplicated. Header-before-body ordering holds because every emit method
150/// calls [`flush_pending`] then writes its body line with no early return
151/// between. It does not serialize body-line-vs-body-line ordering across
152/// workers — two `build` threads may print their body lines in either order
153/// under a just-flushed header, matching build's existing unordered parallel
154/// output.
155static PENDING: Mutex<Vec<PendingHeader>> = Mutex::new(Vec::new());
156
157/// Print every still-unflushed pending section header, in ancestor-first
158/// (bottom-to-top) order, then mark each flushed.
159///
160/// Called immediately before any method actually writes a visible body line,
161/// so the deferred headers appear above their first line in correct nesting
162/// order. A header renders at its own stored [`PendingHeader::depth`] — the
163/// 2-space-per-level indent, the right-aligned bold-green verb in the
164/// [`VERB_COLUMN`] gutter, then (if non-empty) one space and the message.
165///
166/// No-op when nothing is pending (the common case once a section has already
167/// emitted its first line), so the per-body-line cost is one uncontended lock.
168fn flush_pending() {
169    // Recover a poisoned guard rather than bailing: pending headers are pure
170    // presentation state, and silently muting every section header for the
171    // rest of the run on one panic-mid-format is worse than reusing it.
172    let mut pending = PENDING.lock().unwrap_or_else(|e| e.into_inner());
173    for entry in pending.iter_mut() {
174        if entry.flushed {
175            continue;
176        }
177        eprintln!("{}", render_header(entry.depth, &entry.verb, &entry.msg));
178        entry.flushed = true;
179    }
180}
181
182/// Render a section/stage header line at `depth`: the 2-space-per-level
183/// nesting indent, a bold-green verb right-aligned in the [`VERB_COLUMN`]
184/// gutter, then (only for a non-empty `msg`) a single space and the message.
185///
186/// The single source of truth shared by both header-emitting paths — the
187/// deferred section header in [`flush_pending`] and the direct
188/// [`StageLogger::step`] — so interleaved headers and steps land in
189/// byte-identical columns for the same depth. A single-word phrase (empty
190/// `msg`) renders the bare gutter verb with no trailing space, so headers
191/// never carry stray whitespace.
192fn render_header(depth: usize, verb: &str, msg: &str) -> String {
193    render_gutter(&"  ".repeat(depth), verb, |s| s.green().bold(), msg)
194}
195
196/// Render one gutter line: `label` right-aligned in the [`VERB_COLUMN`] gutter
197/// (painted by `paint`) after `prefix`, then a space and `msg` — or, when `msg`
198/// is empty, the bare painted label with no trailing space. The single column
199/// system shared by section headers and the Warning/Error/Note status labels,
200/// so a status label's message lands in the same column as a header's.
201fn render_gutter(
202    prefix: &str,
203    label: &str,
204    paint: impl Fn(String) -> colored::ColoredString,
205    msg: &str,
206) -> String {
207    let label = paint(format!("{label:>VERB_COLUMN$}"));
208    if msg.is_empty() {
209        format!("{prefix}{label}")
210    } else {
211        format!("{prefix}{label} {msg}")
212    }
213}
214
215/// Width of the right-aligned verb column in [`StageLogger::step`],
216/// matching Cargo's `   Compiling foo` look (3 leading spaces + 9-char
217/// verb = a 12-column gutter before the message).
218const VERB_COLUMN: usize = 12;
219
220/// Indent (after any section nesting) of a body line — a [`StageLogger::detail`]
221/// / [`success`] / [`failure`] / [`kv`] row, or a status label. Three spaces
222/// place the marker column one stop in from the section header's text, so body
223/// lines read as subordinate to the header above them.
224///
225/// [`success`]: StageLogger::success
226/// [`failure`]: StageLogger::failure
227/// [`kv`]: StageLogger::kv
228const BODY_INDENT: &str = "   ";
229
230/// Marker for an info / detail body line (`•`). Rendered cyan.
231const MARKER_DETAIL: &str = "•";
232
233/// Marker for a success body line (`✓`). Rendered green.
234const MARKER_SUCCESS: &str = "✓";
235
236/// Marker for a failure body line (`✗`). Rendered red.
237const MARKER_FAILURE: &str = "✗";
238
239/// Map a pipeline stage name to its full Cargo-style header phrase
240/// (`"Building binaries"`, `"Signing artifacts"`, `"Publishing"`). Drives
241/// [`StageLogger::group`]'s deferred header: the leading verb is right-aligned
242/// into the [`VERB_COLUMN`] gutter (bold-green, matching `cargo`'s
243/// `   Compiling foo` look), and the remaining words form the message that
244/// follows. A single-word phrase (`"Publishing"`) renders just the gutter
245/// verb with no trailing message.
246///
247/// The phrase is a *readable description* of the work, not an echo of the
248/// stage name — `group("build")` reads `   Building binaries`, not
249/// `   Building build`. This keeps the continuous log scannable: a reader
250/// sees what each section does, not the internal stage identifier.
251///
252/// Falls back to `"Running <stage>"` for any stage without a bespoke
253/// phrase, so a newly-added stage still renders in the system vocabulary
254/// (`   Running myfancystage`) without a code change here.
255pub fn stage_header(stage: &str) -> &'static str {
256    match stage {
257        "setup" => "Preparing release",
258        "build" => "Building binaries",
259        "archive" => "Creating archives",
260        "checksum" => "Computing checksums",
261        "sbom" => "Cataloging dependencies",
262        "templatefiles" => "Rendering templates",
263        "changelog" => "Generating changelog",
264        "attest" => "Generating attestations",
265        "binary-sign" => "Signing binaries",
266        "sign" => "Signing artifacts",
267        "docker" => "Building images",
268        "docker-sign" => "Signing images",
269        "upx" => "Compressing binaries",
270        "nfpm" => "Building packages",
271        "snapcraft" => "Building snap",
272        "flatpak" => "Building Flatpak",
273        "msi" => "Building MSI",
274        "nsis" => "Building installer",
275        "dmg" => "Building DMG",
276        "pkg" => "Building pkg",
277        "notarize" => "Notarizing app",
278        "makeself" => "Building installer",
279        "srpm" => "Building source RPM",
280        "appbundle" => "Building app bundle",
281        "appimage" => "Building AppImage",
282        "universal" => "Merging binaries",
283        "source" => "Archiving source",
284        "release" => "Creating release",
285        "before-publish" => "Preparing publishers",
286        "emission-validate" => "Validating output",
287        "publish" => "Publishing",
288        "blob" => "Uploading blobs",
289        "snapcraft-publish" => "Publishing snap",
290        "announce" => "Announcing release",
291        "verify-release" => "Verifying release",
292        "publisher-summary" => "Summary",
293        "check-determinism" => "Checking determinism",
294        "finalize" => "Finalizing",
295        "prepare" => "Preparing",
296        _ => "Running",
297    }
298}
299
300/// Render the themed `Warning` line for `msg`: the label right-aligned in the
301/// gutter (bold-yellow, no colon) at the enclosing section's header indent
302/// ([`label_indent`]), so it reads as a peer of the section verbs and its
303/// message aligns with theirs. The single source of truth for the warning
304/// palette and label, shared by [`StageLogger::warn`] and the CLI's tracing
305/// formatter so a library-side `warn!` looks identical to a logger warn (one
306/// output authority).
307pub fn render_warning(msg: &str) -> String {
308    render_gutter(&label_indent(), "Warning", |s| s.yellow().bold(), msg)
309}
310
311/// Render the themed `Error` line for `msg` — gutter-aligned bold-red label,
312/// companion to [`render_warning`]; shared so the error palette/label lives in
313/// exactly one place.
314pub fn render_error(msg: &str) -> String {
315    render_gutter(&label_indent(), "Error", |s| s.red().bold(), msg)
316}
317
318/// Render the themed `Note` line for `msg`: gutter-aligned bold-green label.
319/// The third status label — informational lines that are neither warnings nor
320/// errors (host-target selection, auto-snapshot activation). The bold-green
321/// deliberately matches the section-verb palette (not yellow/red): a note is a
322/// neutral peer of the section headers, not an alert. Shared so the `Note`
323/// palette/label lives in exactly one place rather than being open-coded per
324/// call site.
325pub fn render_note(msg: &str) -> String {
326    render_gutter(&label_indent(), "Note", |s| s.green().bold(), msg)
327}
328
329/// Current indentation prefix (2 spaces per open section). Empty at the
330/// top level. Applied identically everywhere — including under GitHub
331/// Actions, where the indentation (not a collapsible `::group::` block) is
332/// what conveys section nesting, matching the continuous single-stream log
333/// GoReleaser emits.
334///
335/// This is the body-line depth (`•` detail / `success` / `failure` / `kv`
336/// rows). Status labels do NOT use it — they sit one level shallower at the
337/// enclosing header's depth via [`label_indent`].
338pub fn indent() -> String {
339    "  ".repeat(current_depth())
340}
341
342/// Indentation prefix for a status label (`Warning` / `Error` / `Note`).
343///
344/// A label is a body-level event, but unlike a `•` detail line it renders
345/// through the right-aligned [`render_gutter`] system (like a section header),
346/// so to land its label in the verb column and its message in the header's
347/// message column it must sit at the ENCLOSING header's depth — one level
348/// shallower than [`indent`] (which tracks the deeper body depth). Using the
349/// body indent here would push the gutter-aligned label two columns past both
350/// the sibling headers and the body bullets, leaving it floating on its own.
351///
352/// Floored at the inherited [`base_depth`] so a label emitted with no open
353/// section never dedents below the ambient (e.g. GitHub Actions) indent.
354fn label_indent() -> String {
355    "  ".repeat(current_depth().saturating_sub(1).max(base_depth()))
356}
357
358/// RAII guard returned by [`indent_one_level`]. Removes the extra indent
359/// level when dropped.
360#[must_use = "dropping the guard immediately removes the extra indent"]
361pub struct IndentGuard {
362    _private: (),
363}
364
365impl Drop for IndentGuard {
366    fn drop(&mut self) {
367        SECTION_DEPTH.fetch_sub(1, Ordering::Relaxed);
368    }
369}
370
371/// Deepen the body indent by one level WITHOUT opening a section header.
372///
373/// For rows that must align with the body bullets of sibling sections
374/// while no section is open — e.g. the pipeline's consolidated
375/// `skipped  a, b, c` row, which prints between stage sections (the
376/// previous stage's guard has already dropped) but should sit at the
377/// same column as those sections' own `•` lines instead of two columns
378/// to their left. Unlike [`StageLogger::group`] this pushes no pending
379/// header, so nothing extra ever prints.
380pub fn indent_one_level() -> IndentGuard {
381    SECTION_DEPTH.fetch_add(1, Ordering::Relaxed);
382    IndentGuard { _private: () }
383}
384
385/// RAII guard returned by [`StageLogger::group`]. Closes the section
386/// (decrements the indent depth) when dropped, so a stage's body
387/// indentation is always balanced even if the stage bails early with `?`.
388#[must_use = "dropping the guard immediately ends the section"]
389pub struct SectionGuard {
390    _private: (),
391}
392
393impl Drop for SectionGuard {
394    fn drop(&mut self) {
395        // Take the PENDING lock BEFORE decrementing the depth: a
396        // flush_pending observer on another thread serializes on this
397        // lock, so it sees the depth decrement and the pop as one
398        // transition instead of a window where the depth is already
399        // lowered but the section's pending header is still queued.
400        let mut pending = PENDING.lock().unwrap_or_else(|e| e.into_inner());
401        SECTION_DEPTH.fetch_sub(1, Ordering::Relaxed);
402        // Remove this section's pending entry (LIFO matches nesting). An
403        // unflushed entry means the section emitted no body line — a no-op
404        // stage — so dropping it without printing is exactly the desired
405        // "no-op stages print nothing" behavior.
406        pending.pop();
407    }
408}
409
410/// Level of a log line captured by a [`LogCapture`]. Mirrors the
411/// [`StageLogger`] methods that produce each level.
412///
413/// Gated behind the `test-helpers` Cargo feature — production binaries
414/// do not link the capture infrastructure.
415#[cfg(feature = "test-helpers")]
416#[derive(Debug, Clone, Copy, PartialEq, Eq)]
417pub enum LogLevel {
418    Error,
419    Warn,
420    Status,
421    /// Liveness / progress line from [`StageLogger::heartbeat`], surfaced
422    /// during a slow subprocess or upload. A level of its own so a heartbeat is
423    /// never counted as a status result line.
424    Heartbeat,
425    Verbose,
426    Debug,
427}
428
429/// In-memory sink that records every log line a [`StageLogger`] emits.
430///
431/// Cheap clone (`Arc<Mutex<Vec<…>>>` underneath) — pass the same handle to
432/// every logger derived from a [`crate::context::Context`] and read aggregated
433/// counts back via the accessor methods. Intended for tests that need to
434/// assert "publisher emitted ≥N status lines" — calls still write to stderr
435/// so test output stays debuggable.
436///
437/// Gated behind the `test-helpers` Cargo feature.
438#[cfg(feature = "test-helpers")]
439#[derive(Clone, Default)]
440pub struct LogCapture {
441    inner: Arc<Mutex<Vec<(LogLevel, String)>>>,
442}
443
444#[cfg(feature = "test-helpers")]
445impl LogCapture {
446    /// Construct a fresh empty capture sink.
447    pub fn new() -> Self {
448        Self::default()
449    }
450
451    /// Append a log line to the capture vec. Called from the
452    /// [`StageLogger`] methods when a capture is attached.
453    pub(crate) fn record(&self, level: LogLevel, msg: impl Into<String>) {
454        if let Ok(mut guard) = self.inner.lock() {
455            guard.push((level, msg.into()));
456        }
457    }
458
459    /// Number of [`LogLevel::Status`] lines recorded.
460    pub fn status_count(&self) -> usize {
461        self.count(LogLevel::Status)
462    }
463
464    /// Number of [`LogLevel::Debug`] lines recorded.
465    pub fn debug_count(&self) -> usize {
466        self.count(LogLevel::Debug)
467    }
468
469    /// Number of [`LogLevel::Verbose`] lines recorded.
470    pub fn verbose_count(&self) -> usize {
471        self.count(LogLevel::Verbose)
472    }
473
474    /// Number of [`LogLevel::Warn`] lines recorded.
475    pub fn warn_count(&self) -> usize {
476        self.count(LogLevel::Warn)
477    }
478
479    /// Number of [`LogLevel::Heartbeat`] lines recorded.
480    pub fn heartbeat_count(&self) -> usize {
481        self.count(LogLevel::Heartbeat)
482    }
483
484    /// Number of [`LogLevel::Error`] lines recorded.
485    pub fn error_count(&self) -> usize {
486        self.count(LogLevel::Error)
487    }
488
489    /// Total count across all levels (useful sanity check).
490    pub fn total_count(&self) -> usize {
491        self.inner.lock().map(|g| g.len()).unwrap_or(0)
492    }
493
494    fn count(&self, level: LogLevel) -> usize {
495        self.inner
496            .lock()
497            .map(|g| g.iter().filter(|(l, _)| *l == level).count())
498            .unwrap_or(0)
499    }
500
501    /// Snapshot of every recorded line in insertion order.
502    pub fn all_messages(&self) -> Vec<(LogLevel, String)> {
503        self.inner.lock().map(|g| g.clone()).unwrap_or_default()
504    }
505
506    /// Snapshot of every [`LogLevel::Warn`] message in insertion order.
507    ///
508    /// Convenience accessor for tests that care only about warns — strips
509    /// the level tuple [`all_messages`] returns so callers can write
510    /// `cap.warn_messages().iter().any(|m| m.contains("..."))` without
511    /// the per-call filter+map boilerplate.
512    ///
513    /// [`all_messages`]: Self::all_messages
514    pub fn warn_messages(&self) -> Vec<String> {
515        self.inner
516            .lock()
517            .map(|g| {
518                g.iter()
519                    .filter(|(lvl, _)| *lvl == LogLevel::Warn)
520                    .map(|(_, m)| m.clone())
521                    .collect()
522            })
523            .unwrap_or_default()
524    }
525}
526
527/// Verbosity level, derived from CLI flags.
528#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Default)]
529pub enum Verbosity {
530    Quiet,
531    #[default]
532    Normal,
533    Verbose,
534    Debug,
535}
536
537impl Verbosity {
538    /// Derive verbosity from CLI flag combination.
539    /// `--quiet` overrides `--verbose`; `--debug` overrides everything.
540    pub fn from_flags(quiet: bool, verbose: bool, debug: bool) -> Self {
541        if debug {
542            Verbosity::Debug
543        } else if quiet {
544            Verbosity::Quiet
545        } else if verbose {
546            Verbosity::Verbose
547        } else {
548            Verbosity::Normal
549        }
550    }
551}
552
553/// Stage logger: wraps a stage name, verbosity level, and an optional
554/// env-pairs list used for secret redaction.
555///
556/// All output goes to stderr. Create one per stage via [`StageLogger::new`].
557/// Prefer `Context::logger("name")` over `StageLogger::new` when a
558/// `Context` is in scope, because it carries the env automatically.
559///
560/// ```rust,ignore
561/// let log = ctx.logger("build");                  // env pre-populated
562/// let log = StageLogger::new("build", verbosity)  // no env yet
563///     .with_env(env_pairs);                       // attach env for redact
564/// log.status("compiling for x86_64-unknown-linux-gnu");
565/// log.verbose(&format!("RUSTFLAGS={}", flags));
566/// log.debug(&format!("full env = {:?}", env));
567/// ```
568#[derive(Clone)]
569pub struct StageLogger {
570    /// The logger's stage identity. No longer printed (the per-line
571    /// `[stage]` tag was dropped for the unified body style — section
572    /// headers name the stage instead), but retained as the constructor
573    /// contract: callers build a logger per stage via [`Self::new`] /
574    /// [`crate::context::Context::logger`] and retag sub-sections via
575    /// [`Self::with_stage`]. Kept so those entry points keep a stable
576    /// signature.
577    #[allow(dead_code)]
578    stage: &'static str,
579    verbosity: Verbosity,
580    /// Env-pairs used to redact subprocess output and bail messages. The
581    /// inner vec is shared via `Arc` so cloning a logger does not copy the
582    /// env every time. `None` means redaction is a no-op (matches the
583    /// behaviour before this field existed).
584    env: Option<Arc<Vec<(String, String)>>>,
585    /// Optional in-memory capture sink. When present, every log method also
586    /// appends to the capture vec (after the stderr write). `None` means
587    /// the logger only writes to stderr (production default).
588    ///
589    /// Gated behind the `test-helpers` Cargo feature — production binaries
590    /// do not carry the field, so no per-log-call `is_none()` check fires.
591    #[cfg(feature = "test-helpers")]
592    capture: Option<LogCapture>,
593}
594
595impl StageLogger {
596    pub fn new(stage: &'static str, verbosity: Verbosity) -> Self {
597        Self {
598            stage,
599            verbosity,
600            env: None,
601            #[cfg(feature = "test-helpers")]
602            capture: None,
603        }
604    }
605
606    /// Construct a logger backed by an in-memory [`LogCapture`] alongside the
607    /// usual stderr writes. Returns the logger plus a clone of the capture
608    /// handle so the test can read counts back after the SUT runs.
609    ///
610    /// Intended exclusively for tests — production code uses
611    /// [`StageLogger::new`] or [`crate::context::Context::logger`].
612    ///
613    /// Gated behind the `test-helpers` Cargo feature.
614    #[cfg(feature = "test-helpers")]
615    pub fn with_capture(stage: &'static str, verbosity: Verbosity) -> (Self, LogCapture) {
616        let capture = LogCapture::new();
617        let logger = Self {
618            stage,
619            verbosity,
620            env: None,
621            capture: Some(capture.clone()),
622        };
623        (logger, capture)
624    }
625
626    /// Attach an existing [`LogCapture`] to this logger. Useful when the
627    /// capture is owned by a [`crate::context::Context`] and every derived
628    /// logger should append to the same vec.
629    ///
630    /// Gated behind the `test-helpers` Cargo feature.
631    #[cfg(feature = "test-helpers")]
632    pub fn with_capture_handle(mut self, capture: LogCapture) -> Self {
633        self.capture = Some(capture);
634        self
635    }
636
637    /// Attach an env-pairs list to drive secret redaction inside
638    /// [`StageLogger::check_output`] and [`StageLogger::redact`]. The list
639    /// is shared via `Arc`, so passing the same vec to many loggers does
640    /// not duplicate the underlying storage.
641    pub fn with_env(mut self, env: Vec<(String, String)>) -> Self {
642        self.env = Some(Arc::new(env));
643        self
644    }
645
646    /// Derive a clone of this logger tagged for a different `stage`, keeping
647    /// verbosity, the (Arc-shared) redaction env, and any capture sink.
648    ///
649    /// The pipeline driver owns one `[release]`-tagged logger but brackets
650    /// sub-sections (`setup`, `finalize`, `publisher-summary`) with their own
651    /// `group()`. Body lines emitted inside such a section must carry the
652    /// *section's* tag, not `[release]`, or the output reads
653    /// `[release] wrote …` underneath `::group::finalize`. Retagging once at
654    /// the section boundary lets every helper called within the section emit
655    /// under the correct tag without threading an explicit `stage` argument
656    /// through each call.
657    pub fn with_stage(&self, stage: &'static str) -> Self {
658        Self {
659            stage,
660            verbosity: self.verbosity,
661            env: self.env.clone(),
662            #[cfg(feature = "test-helpers")]
663            capture: self.capture.clone(),
664        }
665    }
666
667    /// Redact secret values from `s` using this logger's attached env.
668    ///
669    /// When no env has been attached (the default for `StageLogger::new`),
670    /// returns the input unchanged. Combines `redact::string` (for
671    /// known-secret env values) with `redact::redact_url_credentials`
672    /// (for inline `https://<user>:<pass>@host` URL credentials that may
673    /// not match any exported env-var value).
674    pub fn redact(&self, s: &str) -> String {
675        match self.env.as_deref() {
676            Some(env) => crate::redact::with_env(s, env),
677            None => crate::redact::redact_url_credentials(s),
678        }
679    }
680
681    /// Render a body line: the current section indent, the 3-space body
682    /// indent, a colored `marker`, one space, then `text`. The single source
683    /// of truth for the `•` / `✓` / `✗` body register so every marker line
684    /// aligns byte-identically under its section header.
685    fn render_body(marker: &str, text: &str) -> String {
686        format!("{}{}{} {}", indent(), BODY_INDENT, marker, text)
687    }
688
689    /// Error message — always shown (even in quiet mode). Renders the
690    /// `Error` status label gutter-aligned beneath the current section.
691    pub fn error(&self, msg: &str) {
692        flush_pending();
693        eprintln!("{}", render_error(msg));
694        #[cfg(feature = "test-helpers")]
695        if let Some(cap) = &self.capture {
696            cap.record(LogLevel::Error, msg);
697        }
698    }
699
700    /// Warning message — shown at Normal and above. Renders the `Warning`
701    /// status label gutter-aligned beneath the current section.
702    pub fn warn(&self, msg: &str) {
703        if self.verbosity >= Verbosity::Normal {
704            flush_pending();
705            eprintln!("{}", render_warning(msg));
706        }
707        #[cfg(feature = "test-helpers")]
708        if let Some(cap) = &self.capture {
709            cap.record(LogLevel::Warn, msg);
710        }
711    }
712
713    /// Status message — shown at Normal and above. This is the default level
714    /// for key actions (stage start, completion, skips, dry-run notes).
715    ///
716    /// Renders as a `•` detail body line beneath the current section. An
717    /// empty `msg` is preserved as a bare blank spacer line (no marker, no
718    /// indent) so callers using `status("")` for vertical rhythm keep a
719    /// clean blank even inside a group. For an explicit register, prefer
720    /// [`Self::detail`] / [`Self::success`] / [`Self::failure`].
721    pub fn status(&self, msg: &str) {
722        if self.verbosity >= Verbosity::Normal {
723            if msg.is_empty() {
724                // A marker on a "blank" line would render as a stray bullet;
725                // emit a truly empty line to preserve the caller's rhythm.
726                // A blank spacer is NOT a real body line, so it does not flush
727                // pending headers (a no-op section must stay invisible).
728                eprintln!();
729            } else {
730                flush_pending();
731                eprintln!(
732                    "{}",
733                    Self::render_body(&MARKER_DETAIL.cyan().to_string(), msg)
734                );
735            }
736        }
737        #[cfg(feature = "test-helpers")]
738        if let Some(cap) = &self.capture {
739            cap.record(LogLevel::Status, msg);
740        }
741    }
742
743    /// Info / detail body line — a cyan `•` marker, then `msg`, at the body
744    /// indent beneath the current section. Shown at Normal and above. The
745    /// explicit-register sibling of [`Self::status`] for callers that want to
746    /// name the `•` style directly.
747    pub fn detail(&self, msg: &str) {
748        if self.verbosity >= Verbosity::Normal {
749            flush_pending();
750            eprintln!(
751                "{}",
752                Self::render_body(&MARKER_DETAIL.cyan().to_string(), msg)
753            );
754        }
755        #[cfg(feature = "test-helpers")]
756        if let Some(cap) = &self.capture {
757            cap.record(LogLevel::Status, msg);
758        }
759    }
760
761    /// Success body line — a green `✓` marker, then `msg`, at the body indent
762    /// beneath the current section. Shown at Normal and above. Use for a
763    /// completed unit of work (`✓ x86_64-… 1.2 MiB`, `✓ signed 6 artifacts`).
764    pub fn success(&self, msg: &str) {
765        if self.verbosity >= Verbosity::Normal {
766            flush_pending();
767            eprintln!(
768                "{}",
769                Self::render_body(&MARKER_SUCCESS.green().to_string(), msg)
770            );
771        }
772        #[cfg(feature = "test-helpers")]
773        if let Some(cap) = &self.capture {
774            cap.record(LogLevel::Status, msg);
775        }
776    }
777
778    /// Failure body line — a red `✗` marker, then `msg`, at the body indent
779    /// beneath the current section. Shown at Normal and above. Use for a
780    /// failed unit of work that is reported inline (the run continues or the
781    /// error is surfaced separately via [`Self::error`]).
782    pub fn failure(&self, msg: &str) {
783        if self.verbosity >= Verbosity::Normal {
784            flush_pending();
785            eprintln!(
786                "{}",
787                Self::render_body(&MARKER_FAILURE.red().to_string(), msg)
788            );
789        }
790        #[cfg(feature = "test-helpers")]
791        if let Some(cap) = &self.capture {
792            cap.record(LogLevel::Status, msg);
793        }
794    }
795
796    /// Whether liveness heartbeats should surface: only at exactly Normal
797    /// verbosity. Quiet shows errors only, and at Verbose/Debug the live
798    /// subprocess tee already conveys progress, so a heartbeat there would
799    /// double the signal. The single authority for the suppression policy:
800    /// the drivers consult it via `progress::heartbeat_period` before spawning
801    /// any ticker, and [`Self::heartbeat`] re-checks it as defense-in-depth for
802    /// a direct caller — both gates read this one predicate, never a second
803    /// copy of the rule.
804    pub fn heartbeats_enabled(&self) -> bool {
805        self.verbosity == Verbosity::Normal
806    }
807
808    /// Heartbeat / liveness body line — a cyan `•` marker, then `msg`. Renders a
809    /// slow operation (`still running cargo publish (2m15s)`) so it is not
810    /// mistaken for a hang. Shown only when [`Self::heartbeats_enabled`], and
811    /// recorded at its own [`LogLevel::Heartbeat`] level.
812    pub fn heartbeat(&self, msg: &str) {
813        if !self.heartbeats_enabled() {
814            return;
815        }
816        flush_pending();
817        eprintln!(
818            "{}",
819            Self::render_body(&MARKER_DETAIL.cyan().to_string(), msg)
820        );
821        #[cfg(feature = "test-helpers")]
822        if let Some(cap) = &self.capture {
823            cap.record(LogLevel::Heartbeat, msg);
824        }
825    }
826
827    /// Key/value meta row — a `•` detail line whose lowercase dimmed `key` is
828    /// left-padded to `key_width` so the values line up within a group, then
829    /// the `value`. Shown at Normal and above.
830    ///
831    /// Lowercase keys must never sit in the verb gutter (that column is for
832    /// bold capitalized verbs only), so meta rows render in the body
833    /// register. Callers that emit several rows pass the width of their
834    /// widest key as `key_width` so the values share a column:
835    ///
836    /// ```rust,ignore
837    /// let w = ["targets", "stages", "runs"].iter().map(|k| k.len()).max().unwrap();
838    /// log.kv("targets", "aarch64-pc-windows-msvc", w);
839    /// log.kv("stages", "build, source, sign", w);
840    /// log.kv("runs", "2", w);
841    /// //   • targets  aarch64-pc-windows-msvc
842    /// //   • stages   build, source, sign
843    /// //   • runs     2
844    /// ```
845    pub fn kv(&self, key: &str, value: &str, key_width: usize) {
846        if self.verbosity >= Verbosity::Normal {
847            // Pad the PLAIN key to width before coloring — padding the
848            // already-dimmed string would count the ANSI escape bytes toward
849            // the field width and misalign the value column. Two spaces after
850            // the padded key give a readable gutter without a separator glyph.
851            let padded = format!("{key:<key_width$}");
852            let row = format!("{}  {}", padded.dimmed(), value);
853            flush_pending();
854            eprintln!(
855                "{}",
856                Self::render_body(&MARKER_DETAIL.cyan().to_string(), &row)
857            );
858        }
859        #[cfg(feature = "test-helpers")]
860        if let Some(cap) = &self.capture {
861            cap.record(LogLevel::Status, format!("{key} = {value}"));
862        }
863    }
864
865    /// Cargo-style status line: a capitalized, right-aligned, bold-green
866    /// `verb` in a fixed-width gutter followed by `msg`
867    /// (`   Building binaries`, `   Signing artifacts`). Shown at Normal and
868    /// above. Use for section/stage headers where there is a natural
869    /// verb; plain key-action lines stay on [`StageLogger::status`].
870    pub fn step(&self, verb: &str, msg: &str) {
871        if self.verbosity >= Verbosity::Normal {
872            eprintln!("{}", render_header(current_depth(), verb, msg));
873        }
874        #[cfg(feature = "test-helpers")]
875        if let Some(cap) = &self.capture {
876            cap.record(LogLevel::Status, msg);
877        }
878    }
879
880    /// Open a log section for stage `title`.
881    ///
882    /// The Cargo-style header (derived from [`stage_header`]: the phrase's
883    /// leading verb bold-green and right-aligned in the [`VERB_COLUMN`]
884    /// gutter, then one space and the remaining words — `   Building binaries`,
885    /// ` Publishing` for a single-word phrase) is *deferred*: it prints only
886    /// when this section emits its first real body line, matching GoReleaser
887    /// (a section header appears only once the section has output). A stage
888    /// that does nothing therefore prints no header at all — no bare
889    /// `Verifying release` over an empty body. The header renders identically
890    /// everywhere — locally and under GitHub Actions — because anodizer streams
891    /// one continuous log; the body indentation (not a collapsible `::group::`
892    /// block) conveys nesting. Every subsequent log line is indented two spaces
893    /// until the guard drops. Sections nest.
894    ///
895    /// ```rust,ignore
896    /// let _section = log.group("build");                 // header pending…
897    /// log.status("compiling x86_64-unknown-linux-gnu");  //    Building binaries
898    ///                                                     //    • compiling …
899    /// // section closes here as `_section` drops
900    /// ```
901    #[must_use = "the section stays open only while the guard is alive"]
902    pub fn group(&self, title: &str) -> SectionGuard {
903        // Defer the header: push it onto the pending stack at the CURRENT depth
904        // (before incrementing) and print it only when this section actually
905        // emits a body line via `flush_pending`. A stage that does nothing
906        // therefore prints no header at all.
907        let (verb, msg) = self.split_header(title);
908        let mut pending = PENDING.lock().unwrap_or_else(|e| e.into_inner());
909        pending.push(PendingHeader {
910            depth: current_depth(),
911            verb: verb.to_string(),
912            msg: msg.to_string(),
913            flushed: false,
914        });
915        // Track depth even at Quiet verbosity so any line that DOES print
916        // (errors) indents correctly and the guard's decrement is balanced.
917        SECTION_DEPTH.fetch_add(1, Ordering::Relaxed);
918        SectionGuard { _private: () }
919    }
920
921    /// Split a stage's [`stage_header`] phrase into the `(verb, message)`
922    /// pair [`Self::group`] feeds to [`Self::step`]. The verb is everything
923    /// up to the first space; the message is the remainder (empty for a
924    /// single-word phrase, which renders as a bare gutter verb). An unknown
925    /// stage (default `"Running"`) takes the stage name itself as the
926    /// message, so it reads `   Running myfancystage`.
927    fn split_header<'a>(&self, title: &'a str) -> (&'a str, &'a str) {
928        let phrase = stage_header(title);
929        match phrase.split_once(' ') {
930            Some((verb, rest)) => (verb, rest),
931            // Single-word phrase: the default "Running" echoes the stage name
932            // as its object; any other single word renders verb-only.
933            None if phrase == "Running" => (phrase, title),
934            None => (phrase, ""),
935        }
936    }
937
938    /// Detail message — shown only at Verbose and above. Renders as a `•`
939    /// detail body line beneath the current section.
940    /// Use for: command output on success, env vars, file paths, template vars.
941    pub fn verbose(&self, msg: &str) {
942        if self.verbosity >= Verbosity::Verbose {
943            flush_pending();
944            eprintln!(
945                "{}",
946                Self::render_body(&MARKER_DETAIL.cyan().to_string(), msg)
947            );
948        }
949        #[cfg(feature = "test-helpers")]
950        if let Some(cap) = &self.capture {
951            cap.record(LogLevel::Verbose, msg);
952        }
953    }
954
955    /// Debug message — shown only at Debug level. Renders as a dimmed `•`
956    /// detail body line beneath the current section.
957    /// Use for: HTTP request/response details, full template contexts, resolved config.
958    pub fn debug(&self, msg: &str) {
959        if self.verbosity >= Verbosity::Debug {
960            flush_pending();
961            eprintln!(
962                "{}",
963                Self::render_body(
964                    &MARKER_DETAIL.dimmed().to_string(),
965                    &msg.dimmed().to_string()
966                )
967            );
968        }
969        #[cfg(feature = "test-helpers")]
970        if let Some(cap) = &self.capture {
971            cap.record(LogLevel::Debug, msg);
972        }
973    }
974
975    /// Emit a per-crate "no `<publisher>` config block" skip line at the
976    /// verbosity the operator asked for.
977    ///
978    /// These lines fire once per non-applicable crate in workspace mode (every
979    /// PR-based publisher visits every selected crate and skips the ones whose
980    /// config lacks its block), so at default verbosity they would bury the
981    /// real output under hundreds of lines of pure no-op noise. They are routed
982    /// to [`Self::debug`] (invisible at default and `--verbose`, visible at
983    /// `--debug`) unless `show` is set — `--show-skipped`, the diagnostic
984    /// escape hatch for "why didn't publisher X run for crate Y?" — in which
985    /// case they surface at [`Self::status`] like any other key action.
986    pub fn skip_line(&self, show: bool, msg: &str) {
987        if show {
988            self.status(msg);
989        } else {
990            self.debug(msg);
991        }
992    }
993
994    /// Return the current verbosity level.
995    pub fn verbosity(&self) -> Verbosity {
996        self.verbosity
997    }
998
999    /// Snapshot this logger's redaction env-pairs (empty when none is
1000    /// attached). Lets a caller construct a sibling logger at a different
1001    /// verbosity while preserving the same secret-redaction policy — e.g. the
1002    /// blob KMS path, which runs its encrypt subprocesses through a
1003    /// Normal-verbosity clone so ciphertext is never teed live, yet must keep
1004    /// the original logger's redaction coverage.
1005    pub fn redaction_env(&self) -> Vec<(String, String)> {
1006        self.env.as_deref().cloned().unwrap_or_default()
1007    }
1008
1009    /// Check if verbose output is enabled.
1010    pub fn is_verbose(&self) -> bool {
1011        self.verbosity >= Verbosity::Verbose
1012    }
1013
1014    /// Check if debug output is enabled.
1015    pub fn is_debug(&self) -> bool {
1016        self.verbosity >= Verbosity::Debug
1017    }
1018
1019    /// Tee a single line of a child process's standard output to this
1020    /// process's STDERR, unmodified except for secret redaction.
1021    ///
1022    /// Used by the verbose live-stream in [`crate::run::run_checked`]: long
1023    /// tools (cargo, snapcraft, nix-build) show progress as they run. Unlike
1024    /// the marker-prefixed body register ([`Self::verbose`]), the line is
1025    /// written *raw* — no `•` marker, no section indent — so the streamed
1026    /// output looks exactly as the tool produced it, matching a tee.
1027    ///
1028    /// The tee goes to **stderr**, not stdout: anodizer's stdout is a
1029    /// machine-readable data channel (GHA step outputs like `new_tag=…`, plus
1030    /// json/changelog/metadata payloads), and a hook's child stdout teed onto
1031    /// stdout would corrupt it. Progress UX belongs on stderr with every other
1032    /// human/log line. Recorded into any attached [`LogCapture`] at
1033    /// [`LogLevel::Verbose`] so tests can assert the stream surfaced.
1034    ///
1035    /// `line` must be a single line with its trailing newline already
1036    /// stripped (the caller's line reader does this); the newline is added
1037    /// here by `eprintln!`.
1038    pub fn stream_child_stdout(&self, line: &str) {
1039        self.stream_child_line(line, false);
1040    }
1041
1042    /// Tee a single line of a child process's standard error to this
1043    /// process's stderr, unmodified except for secret redaction. The stderr
1044    /// companion to [`Self::stream_child_stdout`]; recorded at
1045    /// [`LogLevel::Error`] so the verbose-failure double-emit guard is
1046    /// observable in tests.
1047    pub fn stream_child_stderr(&self, line: &str) {
1048        self.stream_child_line(line, true);
1049    }
1050
1051    /// Shared body of [`stream_child_stdout`](Self::stream_child_stdout) and
1052    /// [`stream_child_stderr`](Self::stream_child_stderr): flush any deferred
1053    /// section header, write the redacted line to stderr, and record it.
1054    /// Both child streams tee to stderr (see
1055    /// [`stream_child_stdout`](Self::stream_child_stdout)); the methods differ
1056    /// only in which capture level the line is recorded under
1057    /// (`from_stderr` selects [`LogLevel::Error`] vs [`LogLevel::Verbose`]),
1058    /// so the write lives here once.
1059    ///
1060    /// `flush_pending()` runs first so a streamed line never prints *above* its
1061    /// deferred section header — the same header-before-body ordering every
1062    /// other body-line emitter (`verbose` / `status` / `error` / `debug`)
1063    /// upholds.
1064    fn stream_child_line(&self, line: &str, from_stderr: bool) {
1065        let redacted = self.redact(line);
1066        flush_pending();
1067        eprintln!("{redacted}");
1068        #[cfg(feature = "test-helpers")]
1069        if let Some(cap) = &self.capture {
1070            let level = if from_stderr {
1071                LogLevel::Error
1072            } else {
1073                LogLevel::Verbose
1074            };
1075            cap.record(level, redacted);
1076        }
1077        #[cfg(not(feature = "test-helpers"))]
1078        let _ = from_stderr;
1079    }
1080
1081    /// Check command output, log stderr/stdout on failure, and bail with context.
1082    /// On success, log stdout at verbose level. Returns `Ok(output)` on success.
1083    ///
1084    /// Stderr and stdout are passed through [`StageLogger::redact`] before
1085    /// they reach the log sink, so any secret env-var values present in the
1086    /// subprocess output are replaced with `$KEY_NAME` (and inline
1087    /// `https://<user>:<pass>@host` URL credentials are scrubbed) without
1088    /// callers having to remember to redact at each call site. Mirrors
1089    /// a safe-stderr pattern at every subprocess
1090    /// boundary.
1091    pub fn check_output(
1092        &self,
1093        output: std::process::Output,
1094        label: &str,
1095    ) -> anyhow::Result<std::process::Output> {
1096        self.check_output_inner(output, label, false)
1097    }
1098
1099    /// Like [`StageLogger::check_output`], but for callers that already
1100    /// streamed the child's stdout/stderr live (the verbose tee in
1101    /// [`crate::run::run_checked`]). Suppresses the stderr/stdout re-emit
1102    /// — both on the success-verbose path and the failure path — so output
1103    /// that was teed line-by-line is not printed a second time. The
1104    /// `bail!` embed (tail-truncated, redacted stderr in the error chain)
1105    /// is preserved unchanged, so error-chain consumers still see context.
1106    pub fn check_output_streamed(
1107        &self,
1108        output: std::process::Output,
1109        label: &str,
1110    ) -> anyhow::Result<std::process::Output> {
1111        self.check_output_inner(output, label, true)
1112    }
1113
1114    /// Shared body of [`check_output`](Self::check_output) and
1115    /// [`check_output_streamed`](Self::check_output_streamed).
1116    ///
1117    /// `already_streamed` suppresses the stderr/stdout log re-emit (the
1118    /// caller's live tee already wrote those lines), but never the `bail!`
1119    /// embed: an error chain propagated past the logger still carries the
1120    /// redacted, truncated stderr tail regardless of streaming.
1121    fn check_output_inner(
1122        &self,
1123        output: std::process::Output,
1124        label: &str,
1125        already_streamed: bool,
1126    ) -> anyhow::Result<std::process::Output> {
1127        let (stderr_line, stdout_line) = self.format_output_lines(&output, label);
1128        if !output.status.success() {
1129            if !already_streamed {
1130                if let Some(line) = stderr_line {
1131                    self.error(&line);
1132                }
1133                if let Some(line) = stdout_line {
1134                    self.error(&line);
1135                }
1136            }
1137            // Embed a (truncated, redacted) stderr tail in the bubbled
1138            // error so operators reading the final anyhow chain see
1139            // something more actionable than just an exit code. The
1140            // separately-emitted `log.error` lines above remain the
1141            // primary surface; this is defense in depth for callers
1142            // that propagate the error past the StageLogger context.
1143            let stderr_raw = String::from_utf8_lossy(&output.stderr);
1144            let stderr_tail = if stderr_raw.is_empty() {
1145                String::from("<no stderr>")
1146            } else {
1147                // Strip the child's terminal color codes BEFORE redaction and
1148                // truncation: this tail is bubbled up the anyhow chain and ends
1149                // up in non-terminal sinks (failure-notification emails, the
1150                // on_error hook's $ANODIZER_ERROR, JSON run summaries) where raw
1151                // ANSI renders as garbage around every styled token. Color is
1152                // forced on for child processes so the live CI log stays
1153                // colorized; the persisted error must not inherit it. Stripping
1154                // first also makes the byte cap below count visible content, not
1155                // escape bytes.
1156                let stripped = strip_ansi(&stderr_raw);
1157                let redacted = self.redact(&stripped);
1158                let trimmed = redacted.trim();
1159                // Cap at 2 KiB to keep error chains scannable.
1160                const MAX: usize = 2048;
1161                if trimmed.len() > MAX {
1162                    let cut = trimmed
1163                        .char_indices()
1164                        .nth(MAX)
1165                        .map(|(i, _)| i)
1166                        .unwrap_or(MAX);
1167                    format!("{}…", &trimmed[..cut])
1168                } else {
1169                    trimmed.to_string()
1170                }
1171            };
1172            anyhow::bail!(
1173                "{} failed with exit code: {}; stderr: {}",
1174                label,
1175                output.status.code().unwrap_or(-1),
1176                stderr_tail
1177            );
1178        }
1179        if !already_streamed
1180            && self.is_verbose()
1181            && let Some(line) = stdout_line
1182        {
1183            self.verbose(&line);
1184        }
1185        Ok(output)
1186    }
1187
1188    /// Compose the redacted stderr / stdout log lines that
1189    /// [`StageLogger::check_output`] would emit for `output`. Returned as
1190    /// `(stderr_line, stdout_line)` where each `Option` is `Some` only when
1191    /// the corresponding stream had any content. Exposed via
1192    /// `pub(crate)` so the redaction logic can be unit-tested without
1193    /// having to capture stderr (`eprintln!` cannot be intercepted from
1194    /// the same process portably).
1195    pub(crate) fn format_output_lines(
1196        &self,
1197        output: &std::process::Output,
1198        label: &str,
1199    ) -> (Option<String>, Option<String>) {
1200        let stderr_raw = String::from_utf8_lossy(&output.stderr);
1201        let stderr_line = if stderr_raw.is_empty() {
1202            None
1203        } else {
1204            let stderr = self.redact(&stderr_raw);
1205            let prefix = if output.status.success() {
1206                "output"
1207            } else {
1208                "stderr"
1209            };
1210            // Failure messages format stderr separately from stdout (under
1211            // the "stderr" label); success uses one "output" label for
1212            // stdout only.
1213            if output.status.success() {
1214                // success path: stderr is never surfaced through check_output
1215                None
1216            } else {
1217                Some(format!("{label} {prefix}:\n{stderr}"))
1218            }
1219        };
1220        let stdout_raw = String::from_utf8_lossy(&output.stdout);
1221        let stdout_line = if stdout_raw.is_empty() {
1222            None
1223        } else {
1224            let stdout = self.redact(&stdout_raw);
1225            let prefix = if output.status.success() {
1226                "output"
1227            } else {
1228                "stdout"
1229            };
1230            Some(format!("{label} {prefix}:\n{stdout}"))
1231        };
1232        (stderr_line, stdout_line)
1233    }
1234}
1235
1236/// Strip ANSI CSI escape sequences (SGR color codes, cursor moves) from `s`.
1237///
1238/// Captured subprocess output (cargo, gpg, …) carries terminal color codes
1239/// when color is forced for the live CI log. Those bytes must never leak into
1240/// a propagated error message that reaches a non-terminal sink — a failure
1241/// email, the `on_error` hook's `$ANODIZER_ERROR`, a JSON run summary — where
1242/// they render as garbage around every styled token.
1243pub(crate) fn strip_ansi(s: &str) -> String {
1244    let mut out = String::with_capacity(s.len());
1245    let mut chars = s.chars();
1246    while let Some(c) = chars.next() {
1247        if c == '\u{1b}' {
1248            // Only a CSI introducer (`ESC [`) starts a parameterized sequence
1249            // we must consume to its final byte (0x40–0x7E); any other escape
1250            // form (a lone ESC, a two-char sequence) drops just the introducer.
1251            if chars.next() == Some('[') {
1252                for ec in chars.by_ref() {
1253                    if ('\u{40}'..='\u{7e}').contains(&ec) {
1254                        break;
1255                    }
1256                }
1257            }
1258        } else {
1259            out.push(c);
1260        }
1261    }
1262    out
1263}
1264
1265#[cfg(test)]
1266mod tests {
1267    use super::*;
1268
1269    /// Serializes the section-depth tests: `SECTION_DEPTH` is a
1270    /// process-global atomic, so two grouping tests running on parallel
1271    /// threads would observe each other's increments.
1272    static SECTION_TEST_LOCK: Mutex<()> = Mutex::new(());
1273
1274    #[test]
1275    fn test_group_guard_balances_depth_locally() {
1276        // `group()` increments depth on open and the guard decrements on
1277        // drop, so nested sections always balance back to the start depth.
1278        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1279        let log = StageLogger::new("build", Verbosity::Normal);
1280        let start = SECTION_DEPTH.load(Ordering::Relaxed);
1281        {
1282            let _outer = log.group("build");
1283            assert_eq!(SECTION_DEPTH.load(Ordering::Relaxed), start + 1);
1284            {
1285                let _inner = log.group("sign");
1286                assert_eq!(SECTION_DEPTH.load(Ordering::Relaxed), start + 2);
1287            }
1288            assert_eq!(SECTION_DEPTH.load(Ordering::Relaxed), start + 1);
1289        }
1290        assert_eq!(SECTION_DEPTH.load(Ordering::Relaxed), start);
1291    }
1292
1293    #[test]
1294    fn test_group_quiet_still_tracks_local_depth() {
1295        // Even at Quiet verbosity the indent depth must stay balanced so
1296        // any status lines that DO print (errors) indent correctly and the
1297        // guard's decrement has a matching increment.
1298        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1299        let log = StageLogger::new("build", Verbosity::Quiet);
1300        let start = SECTION_DEPTH.load(Ordering::Relaxed);
1301        {
1302            let _s = log.group("build");
1303            assert_eq!(SECTION_DEPTH.load(Ordering::Relaxed), start + 1);
1304        }
1305        assert_eq!(SECTION_DEPTH.load(Ordering::Relaxed), start);
1306    }
1307
1308    #[test]
1309    fn test_group_with_body_flushes_header_once() {
1310        // A section that emits a real body line flushes its deferred header:
1311        // the pending entry is marked `flushed` exactly once and stays at its
1312        // own depth. (`flush_pending` writes the header to stderr; we assert
1313        // the state transition rather than capture the uncapturable eprintln.)
1314        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1315        let log = StageLogger::new("build", Verbosity::Normal);
1316        {
1317            let _section = log.group("build");
1318            // Header is pending, not yet printed.
1319            assert!(!PENDING.lock().unwrap().last().unwrap().flushed);
1320            log.status("compiling x86_64-unknown-linux-gnu");
1321            // The body line flushed the header.
1322            let pending = PENDING.lock().unwrap();
1323            let entry = pending.last().unwrap();
1324            assert!(entry.flushed, "body line must flush the header");
1325            assert_eq!(entry.verb, "Building");
1326            assert_eq!(entry.msg, "binaries");
1327        }
1328        // Guard drop popped the (flushed) entry.
1329        assert!(PENDING.lock().unwrap().is_empty());
1330    }
1331
1332    #[test]
1333    fn test_noop_group_prints_no_header() {
1334        // A section that emits NOTHING leaves its pending entry unflushed, and
1335        // the guard drop pops it without ever printing — a no-op stage shows
1336        // no bare header (the GoReleaser behavior). A blank `status("")` spacer
1337        // is NOT a real body line, so it does not flush either.
1338        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1339        let log = StageLogger::new("verify-release", Verbosity::Normal);
1340        {
1341            let _section = log.group("verify-release");
1342            log.status(""); // blank spacer — must not flush
1343            assert!(
1344                !PENDING.lock().unwrap().last().unwrap().flushed,
1345                "a no-op section's header must stay unflushed"
1346            );
1347        }
1348        assert!(PENDING.lock().unwrap().is_empty());
1349    }
1350
1351    #[test]
1352    fn test_nested_groups_flush_in_ancestor_order() {
1353        // A body line in a nested section flushes BOTH the ancestor and the
1354        // nested header (each at its own stored depth), so the deferred
1355        // headers appear in correct order above the first line.
1356        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1357        let log = StageLogger::new("publish", Verbosity::Normal);
1358        let start = SECTION_DEPTH.load(Ordering::Relaxed);
1359        {
1360            let _outer = log.group("publish");
1361            {
1362                let _inner = log.group("blob");
1363                log.status("uploading blob");
1364                let pending = PENDING.lock().unwrap();
1365                assert_eq!(pending.len(), 2);
1366                assert!(pending[0].flushed, "ancestor header must flush");
1367                assert!(pending[1].flushed, "nested header must flush");
1368                assert_eq!(pending[0].depth, start);
1369                assert_eq!(pending[1].depth, start + 1);
1370            }
1371        }
1372        assert!(PENDING.lock().unwrap().is_empty());
1373    }
1374
1375    /// Run `f` with the process stderr fd (2) redirected to a temp file, then
1376    /// restore it and return everything that reached fd 2 as a string, or
1377    /// `None` if `eprintln!` output is being intercepted before fd 2.
1378    ///
1379    /// `eprintln!` writes through libtest's macro path, which — under a plain
1380    /// in-process `cargo test` — diverts output to a thread-local capture sink
1381    /// BEFORE it reaches fd 2, so an fd swap observes nothing. Under
1382    /// `cargo nextest` (the CI test runner) each test is its own process with a
1383    /// real stderr pipe, so the swap captures the true bytes. A sentinel probe
1384    /// distinguishes the two: if the sentinel does not survive the round-trip,
1385    /// fd 2 is not the real emit target and the caller must fall back.
1386    ///
1387    /// `f` must emit its header as the FIRST line it writes — callers slice the
1388    /// header off with `.lines().next()`, which is only correct because the
1389    /// caller's `group()` defers the header and `flush_pending` writes it ahead
1390    /// of any body line. A change that made `f` emit anything before its header
1391    /// would silently grab the wrong line.
1392    ///
1393    /// Unix-only. The fd-2 swap is process-global across the WHOLE
1394    /// `anodizer-core` test binary, so callers carry the crate-wide unnamed
1395    /// `#[serial_test::serial]` key (the convention in
1396    /// [`crate::test_helpers`]) to mutually exclude against every other
1397    /// env/cwd/fd-mutating test; `SECTION_TEST_LOCK` only orders the in-file
1398    /// `PENDING`/`SECTION_DEPTH` state these callers also touch.
1399    #[cfg(unix)]
1400    fn capture_stderr(f: impl FnOnce()) -> Option<String> {
1401        use std::io::{Read, Seek, SeekFrom, Write};
1402        use std::os::unix::io::AsRawFd;
1403
1404        /// Restores fd 2 from the saved dup on EVERY exit path, including a
1405        /// panic in `f` or the probe between the swap and the read. Without
1406        /// this, an unwind would leave fd 2 pointed at the dropped tempfile, so
1407        /// every later test's panic/`eprintln!` diagnostics in this shared
1408        /// process would write to a dangling fd and vanish.
1409        struct StderrRestore(libc::c_int);
1410        impl Drop for StderrRestore {
1411            fn drop(&mut self) {
1412                // SAFETY: self.0 is the dup of the original stderr taken before
1413                // the swap; restoring it on every exit path (including unwind)
1414                // guarantees fd 2 is never left dangling at the tempfile.
1415                unsafe {
1416                    libc::dup2(self.0, libc::STDERR_FILENO);
1417                    libc::close(self.0);
1418                }
1419            }
1420        }
1421
1422        let mut file = tempfile::tempfile().expect("tempfile for stderr capture");
1423        std::io::stderr().flush().ok();
1424        // SAFETY: dup/dup2 on the live stderr fd; the saved fd is owned by the
1425        // StderrRestore guard below, which restores fd 2 and closes the dup on
1426        // every exit path (panic-safe). The whole swap is serialized by the
1427        // caller's crate-wide `#[serial]` key.
1428        let saved = unsafe { libc::dup(libc::STDERR_FILENO) };
1429        assert!(saved >= 0, "dup(stderr) failed");
1430        unsafe {
1431            assert!(
1432                libc::dup2(file.as_raw_fd(), libc::STDERR_FILENO) >= 0,
1433                "dup2(tempfile, stderr) failed"
1434            );
1435        }
1436        // Owns `saved` from here on; its Drop restores fd 2 even if `f` panics.
1437        let _restore = StderrRestore(saved);
1438
1439        const SENTINEL: &str = "__anodizer_capture_probe__";
1440        eprintln!("{SENTINEL}");
1441        f();
1442        std::io::stderr().flush().ok();
1443
1444        file.seek(SeekFrom::Start(0)).expect("rewind capture file");
1445        let mut out = String::new();
1446        file.read_to_string(&mut out).expect("read capture file");
1447        // The sentinel survives only when fd 2 is the real emit target (nextest
1448        // / `--nocapture`); under in-process `cargo test` libtest swallowed it
1449        // (and `f`'s output), so the fd capture cannot prove anything.
1450        let body = out.strip_prefix(SENTINEL)?.trim_start_matches('\n');
1451        Some(body.to_string())
1452    }
1453
1454    #[test]
1455    #[cfg(unix)]
1456    #[serial_test::serial]
1457    fn test_header_paths_emit_identical_bytes() {
1458        // Regression guard for the v0.9.1 drift where stage headers rendered
1459        // with 2/3/4/5 leading spaces depending on which path printed them.
1460        //
1461        // This drives the TWO REAL emitting paths — the deferred-section header
1462        // in `flush_pending` and the direct `step` — and asserts they write
1463        // byte-identical headers at the same depth. It compares ACTUAL stderr
1464        // bytes (not `render_header`'s return value), so it FAILS the moment
1465        // either path open-codes its own indent/spacing instead of delegating
1466        // to `render_header`. Under `cargo nextest` (the CI gate) the fd capture
1467        // sees real output; under a bare in-process `cargo test` libtest
1468        // intercepts `eprintln!` and `capture_stderr` returns None, so the body
1469        // falls back to re-checking the shared helper rather than failing
1470        // spuriously. The crate-wide `#[serial]` key keeps every other
1471        // env/fd-mutating test out of the fd-swapped capture; SECTION_TEST_LOCK
1472        // only orders the in-file PENDING/SECTION_DEPTH state.
1473        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1474        let log = StageLogger::new("sign", Verbosity::Normal);
1475        // Absolute depth both paths must render at (includes any inherited base
1476        // from ANODIZER_LOG_DEPTH, so the anchor below shifts with it).
1477        let depth = current_depth();
1478
1479        // flush_pending path: open a section (pending header pushed at `depth`),
1480        // then a body line triggers `flush_pending`, which prints the header.
1481        // The header is the FIRST captured line; the body line follows it.
1482        let flushed = capture_stderr(|| {
1483            let _section = log.group("sign");
1484            assert_eq!(
1485                PENDING.lock().unwrap().last().unwrap().depth,
1486                depth,
1487                "pending header must sit at the pre-increment depth"
1488            );
1489            log.status("byte-equality probe"); // forces flush_pending
1490        });
1491        assert!(
1492            PENDING.lock().unwrap().is_empty(),
1493            "guard must pop the entry"
1494        );
1495
1496        // step path: the section is closed, so `current_depth()` is back to
1497        // `depth` — the same depth the pending header rendered at. `step` emits
1498        // exactly the header line, nothing else.
1499        assert_eq!(current_depth(), depth, "depth must return to start");
1500        let stepped = capture_stderr(|| log.step("Signing", "artifacts"));
1501
1502        let prefix = "  ".repeat(depth);
1503        let expected = format!("{prefix}{:>VERB_COLUMN$} artifacts", "Signing");
1504
1505        match (flushed, stepped) {
1506            (Some(flushed), Some(stepped)) => {
1507                let flush_header = strip_ansi(
1508                    flushed
1509                        .lines()
1510                        .next()
1511                        .expect("flush_pending must emit a header line"),
1512                );
1513                let step_header = strip_ansi(stepped.trim_end_matches('\n'));
1514                // The whole point: both REAL paths produce the same header
1515                // bytes. If a future edit makes one open-code a different
1516                // indent, these diverge and the test fails.
1517                assert_eq!(
1518                    flush_header, step_header,
1519                    "flush_pending and step must emit byte-identical headers \
1520                     (flush={flush_header:?} step={step_header:?})"
1521                );
1522                // Anchor the shared bytes so a regression that drifts BOTH paths
1523                // in lockstep (still equal to each other) is also caught.
1524                assert_eq!(
1525                    step_header, expected,
1526                    "header must be indent + gutter verb + space + message"
1527                );
1528            }
1529            // In-process `cargo test`: BOTH swaps were intercepted, so the real
1530            // paths are unobservable here. Re-assert the shared helper so the
1531            // test is not a silent no-op; nextest exercises the real bytes.
1532            (None, None) => {
1533                assert_eq!(
1534                    strip_ansi(&render_header(depth, "Signing", "artifacts")),
1535                    expected
1536                );
1537            }
1538            // The sentinel survived one swap but not the other — a real capture
1539            // anomaly (a flaky/half-redirected environment), not the documented
1540            // all-or-nothing fallback. Surface it loudly instead of silently
1541            // running the weaker check.
1542            (flushed, stepped) => panic!(
1543                "inconsistent stderr capture: flush={} step={}",
1544                flushed.is_some(),
1545                stepped.is_some()
1546            ),
1547        }
1548    }
1549
1550    #[test]
1551    #[cfg(unix)]
1552    #[serial_test::serial]
1553    fn test_single_word_header_emits_no_trailing_space() {
1554        // A single-word phrase (empty message) renders the bare gutter verb
1555        // with NO trailing space on the REAL `step` path — a stray space here
1556        // would leave invisible whitespace at the end of every `Publishing`
1557        // header line. Drives `step` directly and inspects the emitted bytes.
1558        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1559        let log = StageLogger::new("publish", Verbosity::Normal);
1560        let depth = current_depth();
1561        let prefix = "  ".repeat(depth);
1562
1563        match capture_stderr(|| log.step("Publishing", "")) {
1564            Some(stepped) => {
1565                let header = strip_ansi(stepped.trim_end_matches('\n'));
1566                assert_eq!(header, format!("{prefix}{:>VERB_COLUMN$}", "Publishing"));
1567                assert!(
1568                    !header.ends_with(' '),
1569                    "single-word header must not carry a trailing space: {header:?}"
1570                );
1571            }
1572            // In-process `cargo test` intercepts `eprintln!`; re-assert the
1573            // shared helper so the invariant still has a floor under nextest.
1574            None => {
1575                let header = strip_ansi(&render_header(depth, "Publishing", ""));
1576                assert_eq!(header, format!("{prefix}{:>VERB_COLUMN$}", "Publishing"));
1577                assert!(!header.ends_with(' '));
1578            }
1579        }
1580    }
1581
1582    #[test]
1583    fn test_status_labels_gutter_aligned_without_colon() {
1584        // Regression guard: Warning/Error/Note must render as right-aligned
1585        // gutter labels with NO trailing colon, and their message must land in
1586        // the same column as a section header's message (both follow the
1587        // VERB_COLUMN gutter + one space). The old format open-coded
1588        // "Warning:" at BODY_INDENT, which faked Cargo alignment with an
1589        // anti-Cargo colon.
1590        let header = strip_ansi(&render_header(0, "Building", "binaries"));
1591        let header_msg_col = header.find("binaries");
1592        for (rendered, label, msg) in [
1593            (render_warning("oops"), "Warning", "oops"),
1594            (render_error("boom"), "Error", "boom"),
1595            (render_note("fyi"), "Note", "fyi"),
1596        ] {
1597            let line = strip_ansi(&rendered);
1598            assert!(
1599                !line.contains(':'),
1600                "status label must not carry a colon: {line:?}"
1601            );
1602            // Label lines go through the SAME gutter renderer as section
1603            // headers: stripped of color, a Warning/Error/Note line is
1604            // byte-identical to a header whose verb is that label. Deriving the
1605            // expectation from `render_header` (not a hand-written format)
1606            // proves the shared renderer rather than re-stating its shape.
1607            assert_eq!(line, strip_ansi(&render_header(0, label, msg)));
1608            // Column-invariance across differing label widths: every label's
1609            // message lands in the same column as the "Building" header's,
1610            // regardless of how long the verb is.
1611            assert_eq!(
1612                line.find(msg),
1613                header_msg_col,
1614                "status-label message must align with the header message column"
1615            );
1616        }
1617    }
1618
1619    #[test]
1620    #[serial_test::serial]
1621    fn test_status_label_aligns_with_enclosing_header_not_body_depth() {
1622        // Regression: a Warning/Error/Note fired INSIDE a section must align
1623        // with that section's HEADER (label in the verb column, message in the
1624        // header message column), NOT one level deeper at the body-bullet
1625        // depth. The body-depth variant pushed the gutter-aligned label two
1626        // columns past both the sibling headers and the `•` bullets, leaving it
1627        // floating on its own.
1628        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1629        let log = StageLogger::new("build", Verbosity::Normal);
1630        let base = base_depth();
1631        // Open one section: its header renders at depth `base`; body lines
1632        // (and the bullets) render one level deeper at `base + 1`.
1633        let _outer = log.group("preparing release");
1634        let warn = strip_ansi(&render_warning("preflight skipped"));
1635        // Aligns with the enclosing header (depth `base`) ...
1636        assert_eq!(
1637            warn,
1638            strip_ansi(&render_header(base, "Warning", "preflight skipped")),
1639            "in-section label must align with its enclosing header"
1640        );
1641        // ... and NOT with the deeper body depth (`base + 1`) it used before.
1642        assert_ne!(
1643            warn,
1644            strip_ansi(&render_header(base + 1, "Warning", "preflight skipped")),
1645            "in-section label must not float at the deeper body indent"
1646        );
1647    }
1648
1649    #[test]
1650    #[cfg(unix)]
1651    #[serial_test::serial]
1652    fn test_capture_stderr_restores_fd_on_panic() {
1653        // The fd-restore must run on the unwind path: a panic inside `f`
1654        // (the asserts in the real callers are a reachable panic path) must
1655        // not leave fd 2 dangling at the dropped tempfile, which would make
1656        // every later test's stderr vanish in the shared process.
1657        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1658        let panicked = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
1659            capture_stderr(|| panic!("boom inside capture"));
1660        }));
1661        assert!(panicked.is_err(), "the injected panic must propagate");
1662
1663        // fd 2 is usable again: a fresh capture round-trips its sentinel. (Under
1664        // in-process `cargo test` the sentinel is swallowed and the result is
1665        // None — still a successful, non-dangling write; only a leaked fd 2
1666        // would corrupt this follow-up capture.)
1667        let after = capture_stderr(|| eprintln!("after panic"));
1668        if let Some(body) = after {
1669            assert!(
1670                body.contains("after panic"),
1671                "stderr must work after a mid-capture panic: {body:?}"
1672            );
1673        }
1674    }
1675
1676    #[test]
1677    fn test_indent_reflects_section_depth() {
1678        // Indentation tracks the open-section depth (2 spaces per level)
1679        // identically everywhere — anodizer streams one continuous log, so
1680        // indentation (not a collapsible `::group::` block) conveys nesting.
1681        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1682        let log = StageLogger::new("build", Verbosity::Normal);
1683        // Relative to the inherited base so an exported ANODIZER_LOG_DEPTH
1684        // in the test environment shifts every expectation uniformly.
1685        let base = "  ".repeat(base_depth());
1686        assert_eq!(indent(), base);
1687        {
1688            let _outer = log.group("build");
1689            assert_eq!(indent(), format!("{base}  "));
1690            {
1691                let _inner = log.group("sign");
1692                assert_eq!(indent(), format!("{base}    "));
1693            }
1694            assert_eq!(indent(), format!("{base}  "));
1695        }
1696        assert_eq!(indent(), base);
1697    }
1698
1699    #[test]
1700    fn test_indent_one_level_adds_depth_without_pending_header() {
1701        // The header-less guard must deepen the indent (so the row aligns
1702        // with sibling sections' body bullets) without registering a
1703        // pending header that a later body line could spuriously flush.
1704        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1705        let start = SECTION_DEPTH.load(Ordering::Relaxed);
1706        let pending_before = PENDING.lock().unwrap().len();
1707        {
1708            let _indent = indent_one_level();
1709            assert_eq!(SECTION_DEPTH.load(Ordering::Relaxed), start + 1);
1710            assert_eq!(
1711                PENDING.lock().unwrap().len(),
1712                pending_before,
1713                "indent_one_level must not push a pending header"
1714            );
1715            assert_eq!(indent(), "  ".repeat(current_depth()));
1716        }
1717        assert_eq!(SECTION_DEPTH.load(Ordering::Relaxed), start);
1718    }
1719
1720    #[test]
1721    fn test_parse_base_depth_accepts_valid_and_degrades_invalid() {
1722        // A subprocess child inherits a numeric depth; anything else
1723        // (absent, junk, negative) degrades to the standalone default 0 —
1724        // indentation must never abort a run.
1725        assert_eq!(parse_base_depth(Some("3")), 3);
1726        assert_eq!(parse_base_depth(Some(" 2 ")), 2);
1727        assert_eq!(parse_base_depth(Some("0")), 0);
1728        assert_eq!(parse_base_depth(Some("-1")), 0);
1729        assert_eq!(parse_base_depth(Some("abc")), 0);
1730        assert_eq!(parse_base_depth(Some("")), 0);
1731        assert_eq!(parse_base_depth(None), 0);
1732    }
1733
1734    #[test]
1735    fn test_current_depth_tracks_sections() {
1736        // `current_depth` = inherited base (0 in tests — the env var is
1737        // not set under cargo test) + open sections; it is the value a
1738        // parent exports to children via LOG_DEPTH_ENV.
1739        let _guard = SECTION_TEST_LOCK.lock().unwrap();
1740        let log = StageLogger::new("build", Verbosity::Normal);
1741        let start = current_depth();
1742        {
1743            let _outer = log.group("build");
1744            assert_eq!(current_depth(), start + 1);
1745        }
1746        assert_eq!(current_depth(), start);
1747    }
1748
1749    #[test]
1750    fn test_stage_header_splits_into_verb_and_message() {
1751        // A multi-word phrase splits on the FIRST space: the verb feeds the
1752        // right-aligned gutter, the remainder is the section message.
1753        let log = StageLogger::new("build", Verbosity::Normal);
1754        assert_eq!(log.split_header("build"), ("Building", "binaries"));
1755        assert_eq!(log.split_header("sign"), ("Signing", "artifacts"));
1756        assert_eq!(log.split_header("source"), ("Archiving", "source"));
1757    }
1758
1759    #[test]
1760    fn test_stage_header_single_word_renders_verb_only() {
1761        // A known single-word phrase ("Publishing") renders just the gutter
1762        // verb with an empty message — no stage-name echo.
1763        let log = StageLogger::new("publish", Verbosity::Normal);
1764        assert_eq!(log.split_header("publish"), ("Publishing", ""));
1765    }
1766
1767    #[test]
1768    fn test_stage_header_unknown_stage_uses_running_plus_name() {
1769        // An unknown stage falls back to "Running" + the stage name, so it
1770        // still renders in the system vocabulary (`   Running myfancystage`).
1771        let log = StageLogger::new("x", Verbosity::Normal);
1772        assert_eq!(
1773            log.split_header("myfancystage"),
1774            ("Running", "myfancystage")
1775        );
1776    }
1777
1778    #[test]
1779    fn test_verbosity_from_flags_default() {
1780        assert_eq!(
1781            Verbosity::from_flags(false, false, false),
1782            Verbosity::Normal
1783        );
1784    }
1785
1786    #[test]
1787    fn test_verbosity_from_flags_quiet() {
1788        assert_eq!(Verbosity::from_flags(true, false, false), Verbosity::Quiet);
1789    }
1790
1791    #[test]
1792    fn test_verbosity_from_flags_verbose() {
1793        assert_eq!(
1794            Verbosity::from_flags(false, true, false),
1795            Verbosity::Verbose
1796        );
1797    }
1798
1799    #[test]
1800    fn test_verbosity_from_flags_debug() {
1801        assert_eq!(Verbosity::from_flags(false, false, true), Verbosity::Debug);
1802    }
1803
1804    #[test]
1805    fn test_verbosity_from_flags_debug_wins_over_verbose() {
1806        assert_eq!(Verbosity::from_flags(false, true, true), Verbosity::Debug);
1807    }
1808
1809    #[test]
1810    fn test_verbosity_from_flags_debug_wins_over_quiet() {
1811        assert_eq!(Verbosity::from_flags(true, false, true), Verbosity::Debug);
1812    }
1813
1814    #[test]
1815    fn test_verbosity_from_flags_quiet_overrides_verbose() {
1816        assert_eq!(Verbosity::from_flags(true, true, false), Verbosity::Quiet);
1817    }
1818
1819    #[test]
1820    fn test_verbosity_ordering() {
1821        assert!(Verbosity::Quiet < Verbosity::Normal);
1822        assert!(Verbosity::Normal < Verbosity::Verbose);
1823        assert!(Verbosity::Verbose < Verbosity::Debug);
1824    }
1825
1826    #[test]
1827    fn test_stage_logger_is_verbose() {
1828        let log = StageLogger::new("test", Verbosity::Verbose);
1829        assert!(log.is_verbose());
1830        assert!(!log.is_debug());
1831    }
1832
1833    #[test]
1834    fn test_stage_logger_is_debug() {
1835        let log = StageLogger::new("test", Verbosity::Debug);
1836        assert!(log.is_verbose());
1837        assert!(log.is_debug());
1838    }
1839
1840    #[test]
1841    fn test_stage_logger_normal_not_verbose() {
1842        let log = StageLogger::new("test", Verbosity::Normal);
1843        assert!(!log.is_verbose());
1844        assert!(!log.is_debug());
1845    }
1846
1847    #[test]
1848    fn test_default_verbosity_is_normal() {
1849        assert_eq!(Verbosity::default(), Verbosity::Normal);
1850    }
1851
1852    // -----------------------------------------------------------------
1853    // Redaction inside check_output
1854    // -----------------------------------------------------------------
1855
1856    #[cfg(unix)]
1857    fn fake_output(stdout: &[u8], stderr: &[u8], code: i32) -> std::process::Output {
1858        use std::os::unix::process::ExitStatusExt;
1859        std::process::Output {
1860            status: std::process::ExitStatus::from_raw(code << 8),
1861            stdout: stdout.to_vec(),
1862            stderr: stderr.to_vec(),
1863        }
1864    }
1865
1866    #[test]
1867    fn test_redact_uses_attached_env() {
1868        // A logger built via `with_env` must scrub configured secrets.
1869        let log = StageLogger::new("test", Verbosity::Normal).with_env(vec![(
1870            "GITHUB_TOKEN".to_string(),
1871            "ghp_real_secret_token".to_string(),
1872        )]);
1873        let out = log.redact("auth header: ghp_real_secret_token");
1874        assert_eq!(out, "auth header: $GITHUB_TOKEN");
1875        assert!(!out.contains("ghp_real_secret_token"));
1876    }
1877
1878    #[test]
1879    fn test_redact_without_env_only_scrubs_inline_urls() {
1880        // A logger constructed without `with_env` still scrubs inline URL
1881        // credentials, even if the bare token is not in env (the env-pair
1882        // list is empty).
1883        let log = StageLogger::new("test", Verbosity::Normal);
1884        let out = log.redact("fetched from https://user:tok@example.com/path");
1885        assert_eq!(out, "fetched from https://<redacted>@example.com/path");
1886    }
1887
1888    #[test]
1889    fn test_redact_combines_env_and_url_credentials() {
1890        let log = StageLogger::new("test", Verbosity::Normal)
1891            .with_env(vec![("API_TOKEN".to_string(), "ghp_tok123".to_string())]);
1892        // Both the env-value token AND the inline URL credential should be
1893        // scrubbed in a single call.
1894        let out = log.redact("remote: https://ghp_tok123@github.com/x/y");
1895        // URL credential strip runs first, so the `ghp_tok123` between
1896        // `://` and `@` becomes `<redacted>`. The path / host text never
1897        // contains `ghp_tok123`, so the env-value pass is a no-op here.
1898        assert_eq!(out, "remote: https://<redacted>@github.com/x/y");
1899        assert!(!out.contains("ghp_tok123"));
1900    }
1901
1902    #[cfg(unix)]
1903    #[test]
1904    fn test_check_output_redacts_stderr_on_failure() {
1905        // Stderr from a failing subprocess must be redacted before
1906        // the logger surfaces it, so secrets present in `output.stderr`
1907        // never reach the eprintln sink (or any future log appender).
1908        let log = StageLogger::new("test", Verbosity::Normal).with_env(vec![(
1909            "REGISTRY_PASSWORD".to_string(),
1910            "supersecret_pw_123".to_string(),
1911        )]);
1912        let output = fake_output(
1913            b"",
1914            b"docker login failed: invalid password 'supersecret_pw_123'",
1915            1,
1916        );
1917        let (stderr_line, _) = log.format_output_lines(&output, "docker login");
1918        let line = stderr_line.expect("stderr should be present on failure");
1919        assert!(
1920            !line.contains("supersecret_pw_123"),
1921            "stderr must be redacted: {line}"
1922        );
1923        assert!(line.contains("$REGISTRY_PASSWORD"));
1924    }
1925
1926    #[cfg(unix)]
1927    #[test]
1928    fn test_check_output_redacts_stdout_on_failure() {
1929        // Stdout on the failure path must be redacted alongside
1930        // stderr. Some tools dump credentials onto stdout (e.g. helm
1931        // login prints a warning to stdout, not stderr).
1932        let log = StageLogger::new("test", Verbosity::Normal).with_env(vec![(
1933            "DOCKER_PASSWORD".to_string(),
1934            "tok_dckr_abc".to_string(),
1935        )]);
1936        let output = fake_output(b"echoed config: DOCKER_PASSWORD=tok_dckr_abc\n", b"", 2);
1937        let (_, stdout_line) = log.format_output_lines(&output, "docker");
1938        let line = stdout_line.expect("stdout should be present on failure");
1939        assert!(!line.contains("tok_dckr_abc"));
1940        assert!(line.contains("$DOCKER_PASSWORD"));
1941    }
1942
1943    #[cfg(unix)]
1944    #[test]
1945    fn test_check_output_redacts_stdout_on_verbose_success() {
1946        // At verbose level, successful subprocess stdout is logged
1947        // too; it must also be redacted.
1948        let log = StageLogger::new("test", Verbosity::Verbose).with_env(vec![(
1949            "MY_API_KEY".to_string(),
1950            "key-abcdef-123".to_string(),
1951        )]);
1952        let output = fake_output(b"echo: key-abcdef-123 OK\n", b"", 0);
1953        let (_, stdout_line) = log.format_output_lines(&output, "echo");
1954        let line = stdout_line.expect("stdout should be present on success");
1955        assert!(!line.contains("key-abcdef-123"));
1956        assert!(line.contains("$MY_API_KEY"));
1957    }
1958
1959    #[cfg(unix)]
1960    #[test]
1961    fn test_check_output_strips_inline_url_credentials_without_env() {
1962        // A logger built without env still strips URL credentials,
1963        // so even when the user did not export a matching env var, an
1964        // inline `https://<user>:<pw>@host` in stderr is scrubbed.
1965        let log = StageLogger::new("test", Verbosity::Normal);
1966        let output = fake_output(
1967            b"",
1968            b"fatal: cannot read https://user:p4ssw0rd@example.com/repo.git\n",
1969            128,
1970        );
1971        let (stderr_line, _) = log.format_output_lines(&output, "git fetch");
1972        let line = stderr_line.expect("stderr should be present on failure");
1973        assert!(
1974            !line.contains("p4ssw0rd"),
1975            "userinfo must be redacted: {line}"
1976        );
1977        assert!(line.contains("<redacted>@example.com"));
1978    }
1979
1980    #[cfg(unix)]
1981    #[test]
1982    fn test_check_output_bail_message_excludes_raw_secret() {
1983        // The bail message embeds the (truncated, redacted) stderr tail
1984        // so an operator reading the bubbled anyhow chain sees something
1985        // more actionable than the bare exit code. That redaction must
1986        // still strip env-resolved secrets — otherwise the new tail
1987        // would leak whatever stderr the subprocess emitted.
1988        let log = StageLogger::new("test", Verbosity::Normal).with_env(vec![(
1989            "AUTH_TOKEN".to_string(),
1990            "secret_zzz_yyy".to_string(),
1991        )]);
1992        let output = fake_output(b"", b"401 Unauthorized: secret_zzz_yyy\n", 1);
1993        let err = log
1994            .check_output(output, "curl")
1995            .expect_err("non-zero exit should bail");
1996        let msg = format!("{err:#}");
1997        assert!(
1998            !msg.contains("secret_zzz_yyy"),
1999            "bail message leaks secret: {msg}"
2000        );
2001        assert!(
2002            msg.contains("stderr:") && msg.contains("401 Unauthorized"),
2003            "bail message should embed redacted stderr tail: {msg}"
2004        );
2005    }
2006
2007    #[cfg(unix)]
2008    #[test]
2009    fn test_check_output_bail_message_strips_ansi_color_codes() {
2010        // Color is forced on for child processes so the live CI log stays
2011        // colorized; cargo (and friends) then emit SGR escapes around versions,
2012        // paths, and numbers. The bubbled tail flows into failure-notification
2013        // emails and the on_error hook's $ANODIZER_ERROR, which render raw ANSI
2014        // as garbage — so the persisted error must carry plain text only.
2015        let log = StageLogger::new("test", Verbosity::Normal);
2016        // cargo-shaped colorized stderr: bold version, dimmed path, red error.
2017        let colorized =
2018            b"\x1b[1mPackaging\x1b[0m foo \x1b[2mv\x1b[1m0.11.3\x1b[0m\n\x1b[31merror\x1b[0m: exit \x1b[33m101\x1b[0m\n";
2019        let output = fake_output(b"", colorized, 101);
2020        let err = log
2021            .check_output(output, "cargo publish")
2022            .expect_err("non-zero exit should bail");
2023        let msg = format!("{err:#}");
2024        assert!(
2025            !msg.contains('\u{1b}'),
2026            "bail message must contain no ANSI escape bytes: {msg:?}"
2027        );
2028        assert!(
2029            msg.contains("Packaging") && msg.contains("0.11.3") && msg.contains("101"),
2030            "plain-text content must survive ANSI stripping: {msg}"
2031        );
2032    }
2033
2034    #[cfg(unix)]
2035    #[test]
2036    fn test_check_output_bail_includes_no_stderr_marker_when_empty() {
2037        // Subprocess failed with empty stderr — the bail still wants
2038        // SOMETHING after `stderr:` so a grep on operator logs sees a
2039        // deterministic marker rather than blank text.
2040        let log = StageLogger::new("test", Verbosity::Normal);
2041        let output = fake_output(b"", b"", 7);
2042        let err = log
2043            .check_output(output, "tool")
2044            .expect_err("non-zero exit should bail");
2045        let msg = format!("{err:#}");
2046        assert!(
2047            msg.contains("stderr: <no stderr>"),
2048            "expected explicit <no stderr> marker: {msg}"
2049        );
2050    }
2051
2052    #[cfg(unix)]
2053    #[test]
2054    fn test_check_output_bail_truncates_long_stderr() {
2055        // Stderr larger than the 2 KiB cap is truncated with an ellipsis
2056        // so the operator's error chain remains scannable.
2057        let log = StageLogger::new("test", Verbosity::Normal);
2058        // 3 KiB of stderr.
2059        let big = vec![b'x'; 3072];
2060        let output = fake_output(b"", &big, 1);
2061        let err = log
2062            .check_output(output, "tool")
2063            .expect_err("non-zero exit should bail");
2064        let msg = format!("{err:#}");
2065        assert!(
2066            msg.ends_with('…'),
2067            "expected ellipsis on truncated stderr: {msg}"
2068        );
2069        // Truncation must keep the surface manageable — well under
2070        // 3 KiB of raw stderr should make it into the bail.
2071        assert!(
2072            msg.len() < 2500,
2073            "bail message too long: {} bytes",
2074            msg.len()
2075        );
2076    }
2077
2078    #[test]
2079    fn test_with_env_is_arc_shared() {
2080        // Cloning a logger should share the env vec via Arc, not deep-copy.
2081        // Verified by pointer equality on the inner Vec backing the Arc.
2082        let env = vec![("K".to_string(), "v_long_enough_to_be_a_token".to_string())];
2083        let a = StageLogger::new("a", Verbosity::Normal).with_env(env);
2084        let b = a.clone();
2085        let pa: *const Vec<(String, String)> = a.env.as_ref().unwrap().as_ref();
2086        let pb: *const Vec<(String, String)> = b.env.as_ref().unwrap().as_ref();
2087        assert_eq!(pa, pb);
2088    }
2089
2090    #[test]
2091    fn test_with_stage_rebinds_stage_field() {
2092        // The per-line `[stage]` tag is gone from rendered output, but
2093        // `with_stage` still rebinds the `stage` field a logger carries (it
2094        // drives redaction env inheritance, not line formatting now).
2095        let log = StageLogger::new("release", Verbosity::Normal);
2096        assert_eq!(log.stage, "release");
2097        assert_eq!(log.with_stage("finalize").stage, "finalize");
2098    }
2099
2100    #[test]
2101    fn test_body_markers_render_at_body_indent() {
2102        // Body lines sit at the 3-space body indent (top level: no section
2103        // nesting) behind a colored marker glyph. ANSI codes are stripped
2104        // for the assertion so the test pins the visible shape, not palette.
2105        let _guard = SECTION_TEST_LOCK.lock().unwrap();
2106        let strip = |s: String| {
2107            // Drop CSI sequences so the assertion is palette-independent.
2108            let mut out = String::new();
2109            let mut chars = s.chars().peekable();
2110            while let Some(c) = chars.next() {
2111                if c == '\u{1b}' {
2112                    for n in chars.by_ref() {
2113                        if n == 'm' {
2114                            break;
2115                        }
2116                    }
2117                } else {
2118                    out.push(c);
2119                }
2120            }
2121            out
2122        };
2123        // Relative to the live indent so an exported ANODIZER_LOG_DEPTH
2124        // (or a section left open by a parallel test) cannot skew the
2125        // absolute column.
2126        let prefix = indent();
2127        assert_eq!(
2128            strip(StageLogger::render_body(MARKER_DETAIL, "x")),
2129            format!("{prefix}   • x")
2130        );
2131        assert_eq!(
2132            strip(StageLogger::render_body(MARKER_SUCCESS, "ok")),
2133            format!("{prefix}   ✓ ok")
2134        );
2135        assert_eq!(
2136            strip(StageLogger::render_body(MARKER_FAILURE, "bad")),
2137            format!("{prefix}   ✗ bad")
2138        );
2139    }
2140
2141    #[test]
2142    fn test_kv_pads_plain_key_so_values_align() {
2143        // The padded key width counts the PLAIN key, not the ANSI-dimmed
2144        // bytes, so a short key and a long key share the same value column.
2145        // Emitting a body line drains the process-global PENDING stack via
2146        // `flush_pending`, so serialize against the section-depth tests that
2147        // assert on that stack.
2148        let _guard = SECTION_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
2149        let (log, cap) = StageLogger::with_capture("check", Verbosity::Normal);
2150        let w = ["targets", "runs"].iter().map(|k| k.len()).max().unwrap();
2151        log.kv("targets", "aarch64", w);
2152        log.kv("runs", "2", w);
2153        // The capture stores a normalized `key = value` form regardless of
2154        // the rendered padding/palette.
2155        assert_eq!(
2156            cap.all_messages(),
2157            vec![
2158                (LogLevel::Status, "targets = aarch64".to_string()),
2159                (LogLevel::Status, "runs = 2".to_string()),
2160            ]
2161        );
2162    }
2163
2164    #[test]
2165    fn test_retag_helpers_record_under_shared_capture() {
2166        // The retagged clone shares the capture sink, and the plain
2167        // delegations still record at the right level — locking the plumbing
2168        // independent of the rendered tag (which the capture does not store).
2169        // Emitting body lines drains the global PENDING stack via
2170        // `flush_pending`; serialize against the section-depth tests.
2171        let _guard = SECTION_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
2172        let (log, cap) = StageLogger::with_capture("release", Verbosity::Normal);
2173
2174        log.with_stage("finalize").status("x");
2175        log.error("y");
2176        log.status("own-status");
2177        log.error("own-error");
2178
2179        assert_eq!(
2180            cap.all_messages(),
2181            vec![
2182                (LogLevel::Status, "x".to_string()),
2183                (LogLevel::Error, "y".to_string()),
2184                (LogLevel::Status, "own-status".to_string()),
2185                (LogLevel::Error, "own-error".to_string()),
2186            ]
2187        );
2188    }
2189
2190    #[test]
2191    fn skip_line_records_debug_when_not_shown() {
2192        // The default (show=false) routes a per-crate "no config block" skip to
2193        // debug() so it stays invisible at Normal/Verbose and only surfaces at
2194        // --debug — the fix for the 300+-line workspace skip-noise problem.
2195        // skip_line emits a body line that drains the global PENDING stack;
2196        // serialize against the section-depth tests.
2197        let _guard = SECTION_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
2198        let (log, cap) = StageLogger::with_capture("homebrew", Verbosity::Normal);
2199        log.skip_line(
2200            false,
2201            "skipped homebrew for crate 'demo' — no homebrew config block",
2202        );
2203        assert_eq!(cap.debug_count(), 1);
2204        assert_eq!(cap.status_count(), 0);
2205        assert_eq!(
2206            cap.all_messages(),
2207            vec![(
2208                LogLevel::Debug,
2209                "skipped homebrew for crate 'demo' — no homebrew config block".to_string()
2210            )]
2211        );
2212    }
2213
2214    #[test]
2215    fn skip_line_records_status_when_shown() {
2216        // --show-skipped (show=true) forces the skip line back to status so the
2217        // operator can diagnose why a publisher didn't run for a given crate.
2218        // skip_line emits a body line that drains the global PENDING stack;
2219        // serialize against the section-depth tests.
2220        let _guard = SECTION_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
2221        let (log, cap) = StageLogger::with_capture("homebrew", Verbosity::Normal);
2222        log.skip_line(
2223            true,
2224            "skipped homebrew for crate 'demo' — no homebrew config block",
2225        );
2226        assert_eq!(cap.status_count(), 1);
2227        assert_eq!(cap.debug_count(), 0);
2228    }
2229}