This repository has been archived on 2026-03-27. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
tracing/tracing-attributes/tests/names.rs
Hayden Stainsby 22c1ed9657
mock: change helper functions to expect::<thing> (#2377)
* mock: change helper functions to `expect::<thing>`

The current format of test expectations in `tracing-mock` isn't ideal.
The format `span::expect` requires importing `tracing_mock::<thing>` which
may conflict with imports from other tracing crates, especially
`tracing-core`.

So we change the order and move the functions into a module called
`expect` so that:
* `event::expect` becomes `expect::event`
* `span::expect` becomes `expect::span`
* `field::expect` becomes `expect::field`

This format has two advantages.
1. It reads as natural English, e.g "expect span"
2. It is no longer common to import the modules directly.

Regarding point (2), the following format was previously common:

```rust
use tracing_mock::field;

field::expect();
```

This import of the `field` module may then conflict with importing the
same from `tracing_core`, making it necessary to rename one of the
imports.

The same code would now be written:

```rust
use tracing_mock::expect;

expect::field();
```

Which is less likely to conflict.

This change also fixes an unused warning on `MockHandle::new` when the
`tracing-subscriber` feature is not enabled.

Refs: #539
2022-11-11 09:53:06 -08:00

63 lines
1.5 KiB
Rust

use tracing::collect::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 (collector, handle) = collector::mock()
.new_span(expect::span().named("default_name"))
.enter(expect::span().named("default_name"))
.exit(expect::span().named("default_name"))
.only()
.run_with_handle();
with_default(collector, || {
default_name();
});
handle.assert_finished();
}
#[test]
fn custom_name_test() {
let (collector, handle) = collector::mock()
.new_span(expect::span().named("my_name"))
.enter(expect::span().named("my_name"))
.exit(expect::span().named("my_name"))
.only()
.run_with_handle();
with_default(collector, || {
custom_name();
});
handle.assert_finished();
}
#[test]
fn custom_name_no_equals_test() {
let (collector, handle) = collector::mock()
.new_span(expect::span().named("my_other_name"))
.enter(expect::span().named("my_other_name"))
.exit(expect::span().named("my_other_name"))
.only()
.run_with_handle();
with_default(collector, || {
custom_name_no_equals();
});
handle.assert_finished();
}