tracing/tracing-attributes/tests/follows_from.rs
Hayden Stainsby 91ca0e03d8
test: add tracing-test crate for non-publishable test utils (#2466)
## Motivation

There has been interest around publishing tracing-mock to crates.io
for some time. In order to make this possible, it needs to be cleaned up.

## Solution

There are some test utils in the `tracing-mock` crate which wouldn't
make sense to publish. They provide test futures that are needed in
multiple `tracing-*` crates, but would likely not be needed outside that
context.

This change moves that functionality into a separate `tracing-test`
crate, which should never be published to crates.io.

Refs: #539

Co-authored-by: David Barsky <me@davidbarsky.com>
2023-11-07 11:36:18 +01:00

102 lines
3.3 KiB
Rust

use tracing::{collect::with_default, Id, Level, Span};
use tracing_attributes::instrument;
use tracing_mock::{collector, expect};
use tracing_test::block_on_future;
#[instrument(follows_from = causes, skip(causes))]
fn with_follows_from_sync(causes: impl IntoIterator<Item = impl Into<Option<Id>>>) {}
#[instrument(follows_from = causes, skip(causes))]
async fn with_follows_from_async(causes: impl IntoIterator<Item = impl Into<Option<Id>>>) {}
#[instrument(follows_from = [&Span::current()])]
fn follows_from_current() {}
#[test]
fn follows_from_sync_test() {
let cause_a = expect::span().named("cause_a");
let cause_b = expect::span().named("cause_b");
let cause_c = expect::span().named("cause_c");
let consequence = expect::span().named("with_follows_from_sync");
let (collector, handle) = collector::mock()
.new_span(cause_a.clone())
.new_span(cause_b.clone())
.new_span(cause_c.clone())
.new_span(consequence.clone())
.follows_from(consequence.clone(), cause_a)
.follows_from(consequence.clone(), cause_b)
.follows_from(consequence.clone(), cause_c)
.enter(consequence.clone())
.exit(consequence)
.only()
.run_with_handle();
with_default(collector, || {
let cause_a = tracing::span!(Level::TRACE, "cause_a");
let cause_b = tracing::span!(Level::TRACE, "cause_b");
let cause_c = tracing::span!(Level::TRACE, "cause_c");
with_follows_from_sync(&[cause_a, cause_b, cause_c])
});
handle.assert_finished();
}
#[test]
fn follows_from_async_test() {
let cause_a = expect::span().named("cause_a");
let cause_b = expect::span().named("cause_b");
let cause_c = expect::span().named("cause_c");
let consequence = expect::span().named("with_follows_from_async");
let (collector, handle) = collector::mock()
.new_span(cause_a.clone())
.new_span(cause_b.clone())
.new_span(cause_c.clone())
.new_span(consequence.clone())
.follows_from(consequence.clone(), cause_a)
.follows_from(consequence.clone(), cause_b)
.follows_from(consequence.clone(), cause_c)
.enter(consequence.clone())
.exit(consequence.clone())
.enter(consequence.clone())
.exit(consequence)
.only()
.run_with_handle();
with_default(collector, || {
block_on_future(async {
let cause_a = tracing::span!(Level::TRACE, "cause_a");
let cause_b = tracing::span!(Level::TRACE, "cause_b");
let cause_c = tracing::span!(Level::TRACE, "cause_c");
with_follows_from_async(&[cause_a, cause_b, cause_c]).await
})
});
handle.assert_finished();
}
#[test]
fn follows_from_current_test() {
let cause = expect::span().named("cause");
let consequence = expect::span().named("follows_from_current");
let (collector, handle) = collector::mock()
.new_span(cause.clone())
.enter(cause.clone())
.new_span(consequence.clone())
.follows_from(consequence.clone(), cause.clone())
.enter(consequence.clone())
.exit(consequence)
.exit(cause)
.only()
.run_with_handle();
with_default(collector, || {
tracing::span!(Level::TRACE, "cause").in_scope(follows_from_current)
});
handle.assert_finished();
}