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