Christopher Durham c1c75c9196 tests: put mocking functionality into a crate (#2009)
... instead of `#[path = ""]` importing it everywhere.

Make sure to use a diff review tool that understands file renaming 😅
(GitHub's diff view does.)

## Motivation

Transparency: I want to use the mocking functionality in the development
of a tracing component out-of-tree.

Additionally, this reduces the use of `#[path] mod` and file
multiple-inclusion, which aren't that great of a practice.

## Solution

The tracing test support module was already well self-contained, due to
being `#[path] mod` used in multiple places. As such, extracting it to
its own crate is rather mechanical, with no surprising blockers.

We additionally move the tracing-futures support module contents into
tracing_mock, for convenience. The one function which relies on
tokio-test is made optional.

It's a reasonable result for this functionality to stay unpublished, and
only used inside the repo, but pulling it out into a directly reusable
chunk instead of abusing the module system to reuse it via
multiple-inclusion is an improvement to code structure and
modularization.
2022-03-29 16:20:56 -07:00

64 lines
1.5 KiB
Rust

use tracing::subscriber::with_default;
use tracing_attributes::instrument;
use tracing_mock::*;
#[instrument]
fn default_name() {}
#[instrument(name = "my_name")]
fn custom_name() {}
// XXX: it's weird that we support both of these forms, but apparently we
// managed to release a version that accepts both syntax, so now we have to
// support it! yay!
#[instrument("my_other_name")]
fn custom_name_no_equals() {}
#[test]
fn default_name_test() {
let (subscriber, handle) = subscriber::mock()
.new_span(span::mock().named("default_name"))
.enter(span::mock().named("default_name"))
.exit(span::mock().named("default_name"))
.done()
.run_with_handle();
with_default(subscriber, || {
default_name();
});
handle.assert_finished();
}
#[test]
fn custom_name_test() {
let (subscriber, handle) = subscriber::mock()
.new_span(span::mock().named("my_name"))
.enter(span::mock().named("my_name"))
.exit(span::mock().named("my_name"))
.done()
.run_with_handle();
with_default(subscriber, || {
custom_name();
});
handle.assert_finished();
}
#[test]
fn custom_name_no_equals_test() {
let (subscriber, handle) = subscriber::mock()
.new_span(span::mock().named("my_other_name"))
.enter(span::mock().named("my_other_name"))
.exit(span::mock().named("my_other_name"))
.done()
.run_with_handle();
with_default(subscriber, || {
custom_name_no_equals();
});
handle.assert_finished();
}