Giter Club home page Giter Club logo

test-span's Introduction

test-span

A macro and utilities to do snapshot tests on tracing spans.

docs Build status Apache 2.0 License MIT License

How to use

Refer to the tests for a more exhaustive list of features and behaviors:

use test_span::prelude::*;

#[test_span]
fn a_test() {
    do_something();

    // test_span provides your with three functions:
    let spans = get_spans();
    let logs = get_logs();
    // you can get both in one call
    let (spans, logs) = get_telemetry();

    // This plays well with insta snapshots:
    insta::assert_json_snapshot!(logs);
    insta::assert_json_snapshot!(spans);
}

// Test span plays well with async
#[test_span(tokio::test)]
// you can specify the span / log level
// you would like to track like this:
#[level(tracing::Level::INFO)]
async fn an_sync_test() {
    do_something_async().await;
    // You still get access to each function
    let spans = get_spans();
    let logs = get_logs();
    let (spans, logs) = get_telemetry();
}

Limitations

Spans and logs are hard to track across thread spawns. However we're providing you with a log dump you can check:

#[test_span]
fn track_across_threads() {
    std::thread::spawn(|| {
        tracing::info!("only in get_all_logs!");
    })
    .join()
    .unwrap();

    let logs = get_logs();
    // not in get_logs()
    assert!(!logs.contains_message("only in get_all_logs!");

    // get_all_logs takes a filter Level
    let all_logs = test_span::get_all_logs(&tracing::Level::INFO);
    assert!(all_logs.contains_message("only in get_all_logs!"));
}

Contributing

More information can be found in the contribution docs

License

Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT license](LICENSE-MIT) at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

test-span's People

Contributors

bnjjj avatar o0ignition0o avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.