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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
|
#![allow(missing_docs, dead_code)]
pub use tracing_mock::{event, field, span, subscriber};
use tracing_core::{
span::{Attributes, Id, Record},
Event, Subscriber,
};
use tracing_mock::{
event::MockEvent,
span::{MockSpan, NewSpan},
subscriber::{Expect, MockHandle},
};
use tracing_subscriber::{
layer::{Context, Layer},
registry::{LookupSpan, SpanRef},
};
use std::{
collections::VecDeque,
fmt,
sync::{Arc, Mutex},
};
pub mod layer {
use super::ExpectLayerBuilder;
pub fn mock() -> ExpectLayerBuilder {
ExpectLayerBuilder {
expected: Default::default(),
name: std::thread::current()
.name()
.map(String::from)
.unwrap_or_default(),
}
}
pub fn named(name: impl std::fmt::Display) -> ExpectLayerBuilder {
mock().named(name)
}
}
pub struct ExpectLayerBuilder {
expected: VecDeque<Expect>,
name: String,
}
pub struct ExpectLayer {
expected: Arc<Mutex<VecDeque<Expect>>>,
current: Mutex<Vec<Id>>,
name: String,
}
impl ExpectLayerBuilder {
/// Overrides the name printed by the mock subscriber's debugging output.
///
/// The debugging output is displayed if the test panics, or if the test is
/// run with `--nocapture`.
///
/// By default, the mock subscriber's name is the name of the test
/// (*technically*, the name of the thread where it was created, which is
/// the name of the test unless tests are run with `--test-threads=1`).
/// When a test has only one mock subscriber, this is sufficient. However,
/// some tests may include multiple subscribers, in order to test
/// interactions between multiple subscribers. In that case, it can be
/// helpful to give each subscriber a separate name to distinguish where the
/// debugging output comes from.
pub fn named(mut self, name: impl fmt::Display) -> Self {
use std::fmt::Write;
if !self.name.is_empty() {
write!(&mut self.name, "::{}", name).unwrap();
} else {
self.name = name.to_string();
}
self
}
pub fn enter(mut self, span: MockSpan) -> Self {
self.expected.push_back(Expect::Enter(span));
self
}
pub fn event(mut self, event: MockEvent) -> Self {
self.expected.push_back(Expect::Event(event));
self
}
pub fn exit(mut self, span: MockSpan) -> Self {
self.expected.push_back(Expect::Exit(span));
self
}
pub fn done(mut self) -> Self {
self.expected.push_back(Expect::Nothing);
self
}
pub fn record<I>(mut self, span: MockSpan, fields: I) -> Self
where
I: Into<field::Expect>,
{
self.expected.push_back(Expect::Visit(span, fields.into()));
self
}
pub fn new_span<I>(mut self, new_span: I) -> Self
where
I: Into<NewSpan>,
{
self.expected.push_back(Expect::NewSpan(new_span.into()));
self
}
pub fn run(self) -> ExpectLayer {
ExpectLayer {
expected: Arc::new(Mutex::new(self.expected)),
name: self.name,
current: Mutex::new(Vec::new()),
}
}
pub fn run_with_handle(self) -> (ExpectLayer, MockHandle) {
let expected = Arc::new(Mutex::new(self.expected));
let handle = MockHandle::new(expected.clone(), self.name.clone());
let layer = ExpectLayer {
expected,
name: self.name,
current: Mutex::new(Vec::new()),
};
(layer, handle)
}
}
impl ExpectLayer {
fn check_span_ref<'spans, S>(
&self,
expected: &MockSpan,
actual: &SpanRef<'spans, S>,
what_happened: impl fmt::Display,
) where
S: LookupSpan<'spans>,
{
if let Some(exp_name) = expected.name() {
assert_eq!(
actual.name(),
exp_name,
"\n[{}] expected {} a span named {:?}\n\
[{}] but it was named {:?} instead (span {} {:?})",
self.name,
what_happened,
exp_name,
self.name,
actual.name(),
actual.name(),
actual.id()
);
}
if let Some(exp_level) = expected.level() {
let actual_level = actual.metadata().level();
assert_eq!(
actual_level,
&exp_level,
"\n[{}] expected {} a span at {:?}\n\
[{}] but it was at {:?} instead (span {} {:?})",
self.name,
what_happened,
exp_level,
self.name,
actual_level,
actual.name(),
actual.id(),
);
}
if let Some(exp_target) = expected.target() {
let actual_target = actual.metadata().target();
assert_eq!(
actual_target,
exp_target,
"\n[{}] expected {} a span with target {:?}\n\
[{}] but it had the target {:?} instead (span {} {:?})",
self.name,
what_happened,
exp_target,
self.name,
actual_target,
actual.name(),
actual.id(),
);
}
}
}
impl<S> Layer<S> for ExpectLayer
where
S: Subscriber + for<'a> LookupSpan<'a>,
{
fn register_callsite(
&self,
metadata: &'static tracing::Metadata<'static>,
) -> tracing_core::Interest {
println!("[{}] register_callsite {:#?}", self.name, metadata);
tracing_core::Interest::always()
}
fn on_record(&self, _: &Id, _: &Record<'_>, _: Context<'_, S>) {
unimplemented!(
"so far, we don't have any tests that need an `on_record` \
implementation.\nif you just wrote one that does, feel free to \
implement it!"
);
}
fn on_event(&self, event: &Event<'_>, cx: Context<'_, S>) {
let name = event.metadata().name();
println!(
"[{}] event: {}; level: {}; target: {}",
self.name,
name,
event.metadata().level(),
event.metadata().target(),
);
match self.expected.lock().unwrap().pop_front() {
None => {}
Some(Expect::Event(mut expected)) => {
let get_parent_name = || cx.event_span(event).map(|span| span.name().to_string());
expected.check(event, get_parent_name, &self.name);
let mut current_scope = cx.event_scope(event).into_iter().flatten();
let expected_scope = expected.scope_mut();
let mut i = 0;
for (expected, actual) in expected_scope.iter_mut().zip(&mut current_scope) {
println!(
"[{}] event_scope[{}] actual={} ({:?}); expected={}",
self.name,
i,
actual.name(),
actual.id(),
expected
);
self.check_span_ref(
expected,
&actual,
format_args!("the {}th span in the event's scope to be", i),
);
i += 1;
}
let remaining_expected = &expected_scope[i..];
assert!(
remaining_expected.is_empty(),
"\n[{}] did not observe all expected spans in event scope!\n[{}] missing: {:#?}",
self.name,
self.name,
remaining_expected,
);
assert!(
current_scope.next().is_none(),
"\n[{}] did not expect all spans in the actual event scope!",
self.name,
);
}
Some(ex) => ex.bad(&self.name, format_args!("observed event {:#?}", event)),
}
}
fn on_follows_from(&self, _span: &Id, _follows: &Id, _: Context<'_, S>) {
// TODO: it should be possible to expect spans to follow from other spans
}
fn on_new_span(&self, span: &Attributes<'_>, id: &Id, cx: Context<'_, S>) {
let meta = span.metadata();
println!(
"[{}] new_span: name={:?}; target={:?}; id={:?};",
self.name,
meta.name(),
meta.target(),
id
);
let mut expected = self.expected.lock().unwrap();
let was_expected = matches!(expected.front(), Some(Expect::NewSpan(_)));
if was_expected {
if let Expect::NewSpan(mut expected) = expected.pop_front().unwrap() {
let get_parent_name = || {
span.parent()
.and_then(|id| cx.span(id))
.or_else(|| cx.lookup_current())
.map(|span| span.name().to_string())
};
expected.check(span, get_parent_name, &self.name);
}
}
}
fn on_enter(&self, id: &Id, cx: Context<'_, S>) {
let span = cx
.span(id)
.unwrap_or_else(|| panic!("[{}] no span for ID {:?}", self.name, id));
println!("[{}] enter: {}; id={:?};", self.name, span.name(), id);
match self.expected.lock().unwrap().pop_front() {
None => {}
Some(Expect::Enter(ref expected_span)) => {
self.check_span_ref(expected_span, &span, "to enter");
}
Some(ex) => ex.bad(&self.name, format_args!("entered span {:?}", span.name())),
}
self.current.lock().unwrap().push(id.clone());
}
fn on_exit(&self, id: &Id, cx: Context<'_, S>) {
if std::thread::panicking() {
// `exit()` can be called in `drop` impls, so we must guard against
// double panics.
println!("[{}] exit {:?} while panicking", self.name, id);
return;
}
let span = cx
.span(id)
.unwrap_or_else(|| panic!("[{}] no span for ID {:?}", self.name, id));
println!("[{}] exit: {}; id={:?};", self.name, span.name(), id);
match self.expected.lock().unwrap().pop_front() {
None => {}
Some(Expect::Exit(ref expected_span)) => {
self.check_span_ref(expected_span, &span, "to exit");
let curr = self.current.lock().unwrap().pop();
assert_eq!(
Some(id),
curr.as_ref(),
"[{}] exited span {:?}, but the current span was {:?}",
self.name,
span.name(),
curr.as_ref().and_then(|id| cx.span(id)).map(|s| s.name())
);
}
Some(ex) => ex.bad(&self.name, format_args!("exited span {:?}", span.name())),
};
}
fn on_close(&self, id: Id, cx: Context<'_, S>) {
if std::thread::panicking() {
// `try_close` can be called in `drop` impls, so we must guard against
// double panics.
println!("[{}] close {:?} while panicking", self.name, id);
return;
}
let span = cx.span(&id);
let name = span.as_ref().map(|span| {
println!("[{}] close_span: {}; id={:?};", self.name, span.name(), id,);
span.name()
});
if name.is_none() {
println!("[{}] drop_span: id={:?}", self.name, id);
}
if let Ok(mut expected) = self.expected.try_lock() {
let was_expected = match expected.front() {
Some(Expect::DropSpan(ref expected_span)) => {
// Don't assert if this function was called while panicking,
// as failing the assertion can cause a double panic.
if !::std::thread::panicking() {
if let Some(ref span) = span {
self.check_span_ref(expected_span, span, "to close");
}
}
true
}
Some(Expect::Event(_)) => {
if !::std::thread::panicking() {
panic!(
"[{}] expected an event, but dropped span {} (id={:?}) instead",
self.name,
name.unwrap_or("<unknown name>"),
id
);
}
true
}
_ => false,
};
if was_expected {
expected.pop_front();
}
}
}
fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>) {
panic!("well-behaved subscribers should never do this to us, lol");
}
}
impl fmt::Debug for ExpectLayer {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut s = f.debug_struct("ExpectLayer");
s.field("name", &self.name);
if let Ok(expected) = self.expected.try_lock() {
s.field("expected", &expected);
} else {
s.field("expected", &format_args!("<locked>"));
}
if let Ok(current) = self.current.try_lock() {
s.field("current", &format_args!("{:?}", ¤t));
} else {
s.field("current", &format_args!("<locked>"));
}
s.finish()
}
}
|