ferridriver-test 0.4.0

E2E test runner for ferridriver. Playwright-compatible API, parallel workers, auto-retrying expect, fixtures, snapshots.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

//! Centralized tracing/logging initialization.
//!
//! Call `ferridriver_test::logging::init()` once at startup. It's safe to call
//! multiple times — subsequent calls are no-ops.
//!
//! Respects (in priority order):
//! 1. `RUST_LOG` — standard tracing env filter
//! 2. `FERRIDRIVER_DEBUG` — category-based filter
//! 3. `verbose` parameter — 0=warn, 1=debug, 2+=trace
//!
//! ## `FERRIDRIVER_DEBUG` categories
//!
//! | Value | Tracing target |
//! |-------|---------------|
//! | `*` / `all` | `ferridriver=trace` |
//! | `cdp` | `ferridriver::cdp=trace` |
//! | `step` / `steps` | `ferridriver::bdd::step=trace` |
//! | `hook` / `hooks` | `ferridriver::bdd::hook=trace` |
//! | `worker` | `ferridriver::worker=trace` |
//! | `fixture` | `ferridriver::fixture=trace` |
//! | `reporter` | `ferridriver::reporter=trace` |
//! | `action` | `ferridriver::action=trace` |
//! | `runner` | `ferridriver::runner=trace` |
//!
//! ## Profiling modes (`FERRIDRIVER_PROFILE` env var)
//!
//! | Value | Feature flag | Output |
//! |-------|-------------|--------|
//! | `chrome` | `--features profiling` | `trace-{pid}.json` (Chrome DevTools / Perfetto) |
//! | `console` | `--features tokio-console` | Live tokio-console dashboard |

use std::sync::Once;
use tracing_subscriber::EnvFilter;

static INIT: Once = Once::new();

/// Initialize the tracing subscriber. Safe to call multiple times.
///
/// `verbose`: 0 = warn (default), 1 = debug, 2+ = trace.
/// Overridden by `RUST_LOG` or `FERRIDRIVER_DEBUG` env vars.
pub fn init(verbose: u8) {
  INIT.call_once(|| {
    // tokio-console mode: sole subscriber, mutually exclusive with everything else.
    #[cfg(feature = "tokio-console")]
    if std::env::var("FERRIDRIVER_PROFILE").as_deref() == Ok("console") {
      console_subscriber::init();
      return;
    }

    let filter = build_filter(verbose);
    let use_ansi = std::io::IsTerminal::is_terminal(&std::io::stderr());

    // Chrome trace mode: layer on top of the fmt subscriber.
    #[cfg(feature = "profiling")]
    if std::env::var("FERRIDRIVER_PROFILE").as_deref() == Ok("chrome") {
      use tracing_subscriber::prelude::*;

      let trace_file =
        std::env::var("FERRIDRIVER_TRACE_FILE").unwrap_or_else(|_| format!("trace-{}.json", std::process::id()));
      let (chrome_layer, guard) = tracing_chrome::ChromeLayerBuilder::new()
        .file(trace_file)
        .include_args(true)
        .build();

      // Leak the guard so it flushes on process exit.
      std::mem::forget(guard);

      let fmt_layer = tracing_subscriber::fmt::layer()
        .with_writer(std::io::stderr)
        .with_ansi(use_ansi);

      let _ = tracing_subscriber::registry()
        .with(filter)
        .with(fmt_layer)
        .with(chrome_layer)
        .try_init();
      return;
    }

    // Default: fmt subscriber only.
    let _ = tracing_subscriber::fmt()
      .with_env_filter(filter)
      .with_writer(std::io::stderr)
      .with_ansi(use_ansi)
      .try_init();
  });
}

/// Initialize with env-var-only detection (no verbose flag).
/// Used by standalone harnesses and NAPI where there's no CLI verbose flag.
pub fn init_from_env() {
  if std::env::var("FERRIDRIVER_DEBUG").is_ok()
    || std::env::var("RUST_LOG").is_ok()
    || std::env::var("FERRIDRIVER_PROFILE").is_ok()
  {
    init(0);
  }
}

/// Build a tracing `EnvFilter` from verbose level and env vars.
fn build_filter(verbose: u8) -> EnvFilter {
  // RUST_LOG takes top priority.
  if std::env::var("RUST_LOG").is_ok() {
    return EnvFilter::from_default_env();
  }

  // FERRIDRIVER_DEBUG category-based filter.
  if let Ok(debug_val) = std::env::var("FERRIDRIVER_DEBUG") {
    return parse_debug_categories(&debug_val);
  }

  // --verbose flag.
  match verbose {
    0 => EnvFilter::new("warn"),
    1 => EnvFilter::new("warn,ferridriver=debug"),
    _ => EnvFilter::new("warn,ferridriver=trace"),
  }
}

/// Parse `FERRIDRIVER_DEBUG` value into an `EnvFilter`.
fn parse_debug_categories(debug_val: &str) -> EnvFilter {
  let mut filter = EnvFilter::new("warn");
  for category in debug_val.split(',').map(str::trim) {
    let directive = match category {
      "*" | "all" => "ferridriver=trace",
      "cdp" => "ferridriver::cdp=trace",
      "step" | "steps" => "ferridriver::bdd::step=trace",
      "hook" | "hooks" => "ferridriver::bdd::hook=trace",
      "worker" => "ferridriver::worker=trace",
      "fixture" => "ferridriver::fixture=trace",
      "reporter" => "ferridriver::reporter=trace",
      "action" => "ferridriver::action=trace",
      "runner" => "ferridriver::runner=trace",
      "napi" => "napi=trace",
      other => {
        // Allow arbitrary target names.
        let owned = format!("{other}=trace");
        filter = filter.add_directive(
          owned
            .parse()
            .unwrap_or_else(|_| "warn".parse().expect("'warn' is a valid directive")),
        );
        continue;
      },
    };
    filter = filter.add_directive(
      directive
        .parse()
        .unwrap_or_else(|_| "warn".parse().expect("'warn' is a valid directive")),
    );
  }
  filter
}