mirror of
https://github.com/tokio-rs/tracing.git
synced 2025-09-29 22:10:38 +00:00
c1c75c9196
... 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.
98 lines
2.4 KiB
Rust
98 lines
2.4 KiB
Rust
use tracing::subscriber::with_default;
|
|
use tracing_attributes::instrument;
|
|
use tracing_mock::*;
|
|
|
|
#[instrument]
|
|
fn default_target() {}
|
|
|
|
#[instrument(target = "my_target")]
|
|
fn custom_target() {}
|
|
|
|
mod my_mod {
|
|
use tracing_attributes::instrument;
|
|
|
|
pub const MODULE_PATH: &str = module_path!();
|
|
|
|
#[instrument]
|
|
pub fn default_target() {}
|
|
|
|
#[instrument(target = "my_other_target")]
|
|
pub fn custom_target() {}
|
|
}
|
|
|
|
#[test]
|
|
fn default_targets() {
|
|
let (subscriber, handle) = subscriber::mock()
|
|
.new_span(
|
|
span::mock()
|
|
.named("default_target")
|
|
.with_target(module_path!()),
|
|
)
|
|
.enter(
|
|
span::mock()
|
|
.named("default_target")
|
|
.with_target(module_path!()),
|
|
)
|
|
.exit(
|
|
span::mock()
|
|
.named("default_target")
|
|
.with_target(module_path!()),
|
|
)
|
|
.new_span(
|
|
span::mock()
|
|
.named("default_target")
|
|
.with_target(my_mod::MODULE_PATH),
|
|
)
|
|
.enter(
|
|
span::mock()
|
|
.named("default_target")
|
|
.with_target(my_mod::MODULE_PATH),
|
|
)
|
|
.exit(
|
|
span::mock()
|
|
.named("default_target")
|
|
.with_target(my_mod::MODULE_PATH),
|
|
)
|
|
.done()
|
|
.run_with_handle();
|
|
|
|
with_default(subscriber, || {
|
|
default_target();
|
|
my_mod::default_target();
|
|
});
|
|
|
|
handle.assert_finished();
|
|
}
|
|
|
|
#[test]
|
|
fn custom_targets() {
|
|
let (subscriber, handle) = subscriber::mock()
|
|
.new_span(span::mock().named("custom_target").with_target("my_target"))
|
|
.enter(span::mock().named("custom_target").with_target("my_target"))
|
|
.exit(span::mock().named("custom_target").with_target("my_target"))
|
|
.new_span(
|
|
span::mock()
|
|
.named("custom_target")
|
|
.with_target("my_other_target"),
|
|
)
|
|
.enter(
|
|
span::mock()
|
|
.named("custom_target")
|
|
.with_target("my_other_target"),
|
|
)
|
|
.exit(
|
|
span::mock()
|
|
.named("custom_target")
|
|
.with_target("my_other_target"),
|
|
)
|
|
.done()
|
|
.run_with_handle();
|
|
|
|
with_default(subscriber, || {
|
|
custom_target();
|
|
my_mod::custom_target();
|
|
});
|
|
|
|
handle.assert_finished();
|
|
}
|