Add a logger to unit tests #6125
Comments
|
We have tons of tests with logging. However, I don't see the reason for this issue. If someone is debugging a test, they can just add a logger. There is no need to have a logger in every test, because not every test will always fail. Also not sure how many people are "debugging these tests" constantly that we need an issue for this. |
|
And also don't use |
|
I agree that using cargo test -p xcm-simulator-example reserve_asset_transfer_nft -- --nocaptureExample output: To further improve XCM debugging, I’ve proposed enhancing debugging with log capture in unit tests in PR #7594. This provides a structured way to capture logs in unit tests. |
# Description This PR introduces a lightweight log-capturing mechanism for XCM unit tests, simplifying debugging by enabling structured log assertions. It partially addresses #6119 and #6125, offering an optional way to verify logs in tests while remaining unobtrusive in normal execution. # Key Changes * [x] Introduces a log capture utility in `sp_tracing`. * [x] Adds XCM test examples demonstrating how and when to use log capturing. # Review Notes: * The log capture mechanism is opt-in and does not affect existing tests unless explicitly used. * The implementation is minimal and does not add complexity to existing test setups. * It provides a structured alternative to [`sp_tracing::init_for_tests()`](https://paritytech.github.io/polkadot-sdk/master/sp_tracing/fn.init_for_tests.html) for log verification in automated tests. --------- Co-authored-by: cmd[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
Here's a video clip explaining how to use |
This PR enhances **`test_log_capture`**, ensuring logs are **captured for assertions** and **printed to the console** during test execution. ## **Motivation** - Partially addresses #6119 and #6125, to improves developer **tracing and debugging** in XCM-related tests. - Builds on #7594, improving **log visibility** while maintaining test **log capture capabilities**. - While writing tests for #7234, I noticed this function was missing. This PR adds it to streamline log handling in unit tests. ## **Changes** - Ensures logs up to `TRACE` level are **captured** (for assertions) and **printed** (for visibility). - Refines documentation to clearly specify **when to use** each function. - **Removes ANSI escape codes** from captured logs to ensure clean, readable assertions. ## **When to Use?** | Usage | Captures Logs? | Prints Logs? | Example | |----------------------------------------------|-----------------|--------------|-----------------------------------------------| | `init_log_capture(LevelFilter::INFO, false)` | ✅ Yes | ❌ No | Capture logs for assertions without printing. | | `init_log_capture(LevelFilter::TRACE, true)` | ✅ Yes | ✅ Yes | Capture logs and print them in test output. | | `sp_tracing::init_for_tests()` | ❌ No | ✅ Yes | Print logs to the console without capturing. | --------- Co-authored-by: cmd[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
The improvements to log capture in testing, along with updated documentation, have been addressed in PR #7769. To clarify the usage of the related functions, here's a breakdown:
This ensures that each function’s behavior is clearly defined. Let me know if any adjustments are needed! If there are no objections, I'll close this issue next Monday. |
Logs are very helpful for xcm debugging in particular, where we mark them all with
target: xcmand get them by specifyingRUST_LOG=xcm.However, this doesn't work out-of-the-box with unit tests, since we need a logger.
We can use
env_loggerbut then each test needs this line in the start:let _ = env_logger::init();.The other option is to add
test-logas a dependency and import thetestmacro from it.This was already done in
polkadot/xcm/docs/src/cookbook/relay_token_transactor/tests.rs.We could either adopt this everywhere or create a README of how to enable logs to make people's lives easier when debugging.
The text was updated successfully, but these errors were encountered: