Skip to content

Commit e2cc9b2

Browse files
committed
tracing: generate macros tests
There are a large number of combinations of field types which currently are not matched by the level event macros (e.g. `info!`). Some recent examples from #3407 is the following that doesn't work: ```rust info!(name: "order.received.ok", order.id = 123, "order received"); ``` However, the corresponding `event!` macro does work: ```rust event!(name: "order.received.ok", Level::INFO, order.id = 123, "order received"); ``` And other variants also work: ```rust // Without `name:` directive info!(order.id = 123, "order received"); // With another field before the dotted one info!(name: "order.received.ok", foo = true, order.id = 123, "order received"); ``` Many such cases have been fixed in the past (#2983, #2883, #2879). However, this has been a bit like wack-a-mole, where we keep finding issues and then fixing those issues, adding extra tests for them and then going on our way. Since the complexity is often in combinations (as above, only when using the `name:` directive together with a dotted field name on the first field), it would be useful to have some extensive tests that attempt to cover all possible combinations. It turns out that there are **a lot** of combiantions. This change adds an `xtask` that generates tests for event macros (span macros are out of scope for this change) similar to the ones found in `tracing/tests/macros.rs`. Which is to say, tests containing macros which should compile, but don't need to run. Owing to the large number of combinations, the tests are split into test files by macro (e.g. `event!`, `info!`) and directive combination (e.g. no directives, just `name:`, `name:` and `target:`). The tests are kept in a separate crate outside the main workspace to avoid rust-analyzer trying to parse the files - as they are quite large. Specifically, there are 1220 macro invocations per test file. The test files are generated (no need to check them in) and then validated by `cargo check` on CI. When run against the unmodified macros in `tracing`, there were 504 `info!` macro invocations which failed to compile, out of a total of 9760 (including all combinations of directives).
1 parent cc44064 commit e2cc9b2

File tree

8 files changed

+988
-280
lines changed

8 files changed

+988
-280
lines changed

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ members = [
1616
"tracing-test",
1717
"tracing-appender",
1818
"tracing-journald",
19-
"examples"
20-
]
19+
"examples",
20+
"xtask"]
2121

2222
# This will be ignored with Rust older than 1.74, but for now that's okay;
2323
# we're only using it to fix check-cfg issues that first appeared in Rust 1.80.

tracing/src/macros.rs

Lines changed: 279 additions & 255 deletions
Large diffs are not rendered by default.

tracing/test-macros/Cargo.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[workspace]
2+
3+
[package]
4+
name = "test-macros"
5+
version = "0.1.0"
6+
publish = false
7+
edition = "2018"
8+
9+
[dependencies]
10+
tracing = { path = ".." }
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*

tracing/tests/macro_imports.rs

Lines changed: 0 additions & 23 deletions
This file was deleted.

xtask/Cargo.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[package]
2+
name = "xtask"
3+
version = "0.1.0"
4+
edition = "2024"
5+
6+
[dependencies]
7+
8+
[lints]
9+
workspace = true

0 commit comments

Comments
 (0)