eventheader 0.5.0

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

#![allow(clippy::needless_return)]

use eventheader as eh;
use eventheader::_internal as ehi;

#[test]
fn time_from_systemtime() {
    let epoch = std::time::SystemTime::UNIX_EPOCH;
    let d100 = std::time::Duration::from_secs(100);
    assert_eq!(
        eh::time_from_systemtime!(epoch + d100),
        ehi::time_from_duration_after_1970(d100)
    );
    assert_eq!(
        eh::time_from_systemtime!(epoch - d100),
        ehi::time_from_duration_before_1970(d100)
    );
}

#[test]
fn time_from_duration() {
    use std::time::Duration;

    // Values should round down.
    assert_eq!(
        0,
        ehi::time_from_duration_after_1970(Duration::from_millis(0))
    );
    assert_eq!(
        0,
        ehi::time_from_duration_after_1970(Duration::from_millis(1))
    );
    assert_eq!(
        0,
        ehi::time_from_duration_after_1970(Duration::from_millis(999))
    );
    assert_eq!(
        1,
        ehi::time_from_duration_after_1970(Duration::from_millis(1000))
    );
    assert_eq!(
        1,
        ehi::time_from_duration_after_1970(Duration::from_millis(1001))
    );
    assert_eq!(
        1,
        ehi::time_from_duration_after_1970(Duration::from_millis(1999))
    );

    // Overflow should saturate.
    assert_eq!(
        i64::MAX,
        ehi::time_from_duration_after_1970(Duration::from_secs(i64::MAX as u64))
    );
    assert_eq!(
        i64::MAX,
        ehi::time_from_duration_after_1970(Duration::from_secs(1 + i64::MAX as u64))
    );
    assert_eq!(
        i64::MAX,
        ehi::time_from_duration_after_1970(Duration::from_secs(2 + i64::MAX as u64))
    );

    // Values should round down.
    assert_eq!(
        0,
        ehi::time_from_duration_before_1970(Duration::from_millis(0))
    );
    assert_eq!(
        -1,
        ehi::time_from_duration_before_1970(Duration::from_millis(1))
    );
    assert_eq!(
        -1,
        ehi::time_from_duration_before_1970(Duration::from_millis(999))
    );
    assert_eq!(
        -1,
        ehi::time_from_duration_before_1970(Duration::from_millis(1000))
    );
    assert_eq!(
        -2,
        ehi::time_from_duration_before_1970(Duration::from_millis(1001))
    );
    assert_eq!(
        -2,
        ehi::time_from_duration_before_1970(Duration::from_millis(1999))
    );

    // Overflow should saturate.
    assert_eq!(
        i64::MIN + 1,
        ehi::time_from_duration_before_1970(Duration::from_secs(i64::MAX as u64))
    );
    assert_eq!(
        i64::MIN,
        ehi::time_from_duration_before_1970(Duration::from_secs(1 + i64::MAX as u64))
    );
    assert_eq!(
        i64::MIN,
        ehi::time_from_duration_before_1970(Duration::from_secs(2 + i64::MAX as u64))
    );
}

struct Unregister(&'static eh::Provider<'static>);

impl Drop for Unregister {
    fn drop(&mut self) {
        self.0.unregister();
    }
}

#[test]
fn define_provider() {
    eh::define_provider!(PROV1, "TraceLoggingDynamicTest");
    eh::write_event!(PROV1, "Default");

    fn prov1_enabled() -> bool {
        eh::provider_enabled!(PROV1, eh::Level::Verbose, 1)
    }

    let _u1 = Unregister(&PROV1);
    assert!(!prov1_enabled());
    PROV1.unregister();
    assert!(!prov1_enabled());
    unsafe { PROV1.register() };
    PROV1.unregister();
    assert!(!prov1_enabled());
    PROV1.unregister();
    assert!(!prov1_enabled());
    assert!(!prov1_enabled());
    PROV1.unregister();
    assert!(!prov1_enabled());
    PROV1.name();
    PROV1.options();

    eh::define_provider!(PROV2, "TestProvider2", group_name("mygroup"));
    assert_eq!("TestProvider2", PROV2.name());
    assert_eq!("Gmygroup", PROV2.options());
}

#[cfg(all(target_os = "linux", feature = "user_events"))]
#[test]
#[should_panic]
fn provider_panic() {
    eh::define_provider!(PROV3, "TraceLoggingDynamicTest");
    eh::write_event!(PROV3, "Default");
    let _u = Unregister(&PROV3);

    if 0 != unsafe { PROV3.register() } {
        // If register fails (e.g. if running on downlevel kernel) then make test pass.
        panic!("register not successful");
    }

    // Registering an already-registered provider should panic.
    unsafe { PROV3.register() };
}

#[test]
fn write_event() {
    eh::define_provider!(PROV, "TraceLoggingDynamicTest");

    let _u = Unregister(&PROV);
    unsafe { PROV.register() };

    let sample_guid = eh::Guid::from_name("sample");
    let sample_rusttime =
        std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs(1671930123);
    let sample_ipv4 = [127, 0, 0, 1];
    let sample_ipv6 = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];

    eh::write_event!(PROV, "Default");

    eh::write_event!(
        PROV,
        "4v2o6t123c0l3k11",
        id_version(4, 2),
        opcode(6),
        task(123),  // Task is ignored by eventheader.
        channel(0), // Channel is ignored by eventheader.
        level(3),
        keyword(0x11),
    );

    eh::write_event!(PROV, "tag0xFEDC", tag(0xFEDC));

    eh::write_event!(PROV, "fieldtag", u8("0xFEDC", &0, tag(0xFEDC)),);

    eh::write_event!(
        PROV,
        "outtypes",
        u8("0xFEDC", &0, tag(0xFEDC)),
        u8("default100", &100),
        u8("string65", &65, format(String8)),
        u8("bool1", &1, format(Boolean)),
        u8("hex100", &100, format(HexInt)),
    );

    eh::write_event!(PROV, "structs",
        u8("start", &0),
        struct("struct1", tag(0xFEDC), {
            u8("nested1", &1),
            struct("struct2", {
                u8("nested2", &2),
            }),
        }),
    );

    eh::write_event!(
        PROV,
        "cstrs-L4-kFF",
        level(eh::Level::Informational),
        keyword(0xFF),
        char8_cp1252("A", &b'A'),
        cstr16("cstr16-", &[]),
        cstr16("cstr16-a", &[97]),
        cstr16("cstr16-0", &[0]),
        cstr16("cstr16-a0", &[97, 0]),
        cstr16("cstr16-0a", &[0, 97]),
        cstr16("cstr16-a0a", &[97, 0, 97]),
        cstr8("cstr8-", ""),
        cstr8("cstr8-a", "a"),
        cstr8("cstr8-0", "\0"),
        cstr8("cstr8-a0", "a\0"),
        cstr8("cstr8-0a", "\0a"),
        cstr8("cstr8-a0a", "a\0a"),
        cstr8_cp1252("cstr8e-", ""),
        cstr8_cp1252("cstr8e-a", "a"),
        cstr8_cp1252("cstr8e-0", "\0"),
        cstr8_cp1252("cstr8e-a0", "a\0"),
        cstr8_cp1252("cstr8e-0a", "\0a"),
        cstr8_cp1252("cstr8e-a0a", "a\0a"),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "UnicodeString",
        char8_cp1252("A", &b'A'),
        cstr16("scalar", &Vec::from_iter("cstr-utf16".encode_utf16())),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "AnsiString",
        char8_cp1252("A", &b'A'),
        cstr8("scalar", "cstr-utf8"),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Int8",
        char8_cp1252("A", &b'A'),
        i8("scalar", &-8),
        i8_slice("a0", &[]),
        i8_slice("a1", &[-8]),
        i8_slice("a2", &[-8, -8]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "UInt8",
        char8_cp1252("A", &b'A'),
        u8("scalar", &8),
        u8_slice("a0", &[]),
        u8_slice("a1", &[8]),
        u8_slice("a2", &[8, 8]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Int16",
        char8_cp1252("A", &b'A'),
        i16("scalar", &-16),
        i16_slice("a0", &[]),
        i16_slice("a1", &[-16]),
        i16_slice("a2", &[-16, -16]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "UInt16",
        char8_cp1252("A", &b'A'),
        u16("scalar", &16),
        u16_slice("a0", &[]),
        u16_slice("a1", &[16]),
        u16_slice("a2", &[16, 16]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Int32",
        char8_cp1252("A", &b'A'),
        i32("scalar", &-32),
        i32_slice("a0", &[]),
        i32_slice("a1", &[-32]),
        i32_slice("a2", &[-32, -32]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "UInt32",
        char8_cp1252("A", &b'A'),
        u32("scalar", &32),
        u32_slice("a0", &[]),
        u32_slice("a1", &[32]),
        u32_slice("a2", &[32, 32]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Int64",
        char8_cp1252("A", &b'A'),
        i64("scalar", &-64),
        i64_slice("a0", &[]),
        i64_slice("a1", &[-64]),
        i64_slice("a2", &[-64, -64]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "UInt64",
        char8_cp1252("A", &b'A'),
        u64("scalar", &64),
        u64_slice("a0", &[]),
        u64_slice("a1", &[64]),
        u64_slice("a2", &[64, 64]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "IntPtr",
        char8_cp1252("A", &b'A'),
        isize("scalar", &-3264),
        isize_slice("a0", &[]),
        isize_slice("a1", &[-3264]),
        isize_slice("a2", &[-3264, -3264]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "UIntPtr",
        char8_cp1252("A", &b'A'),
        usize("scalar", &3264),
        usize_slice("a0", &[]),
        usize_slice("a1", &[3264]),
        usize_slice("a2", &[3264, 3264]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Float32",
        char8_cp1252("A", &b'A'),
        f32("scalar", &3.2),
        f32_slice("a0", &[]),
        f32_slice("a1", &[3.2]),
        f32_slice("a2", &[3.2, 3.2]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Float64",
        char8_cp1252("A", &b'A'),
        f64("scalar", &6.4),
        f64_slice("a0", &[]),
        f64_slice("a1", &[6.4]),
        f64_slice("a2", &[6.4, 6.4]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Bool8",
        char8_cp1252("A", &b'A'),
        bool8("scalar", &false),
        bool8_slice("a0", &[]),
        bool8_slice("a1", &[false]),
        bool8_slice("a2", &[false, false]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Bool8",
        char8_cp1252("A", &b'A'),
        bool8("scalar", &true),
        bool8_slice("a0", &[]),
        bool8_slice("a1", &[true]),
        bool8_slice("a2", &[true, true]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Bool32",
        char8_cp1252("A", &b'A'),
        bool32("scalar", &0),
        bool32_slice("a0", &[]),
        bool32_slice("a1", &[0]),
        bool32_slice("a2", &[0, 0]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Bool32",
        char8_cp1252("A", &b'A'),
        bool32("scalar", &1),
        bool32_slice("a0", &[]),
        bool32_slice("a1", &[1]),
        bool32_slice("a2", &[1, 1]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Binary",
        char8_cp1252("A", &b'A'),
        binary("scalar", "0123"),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "Guid",
        char8_cp1252("A", &b'A'),
        guid("scalar", &sample_guid),
        guid_slice("a0", &[]),
        guid_slice("a1", &[sample_guid]),
        guid_slice("a2", &[sample_guid, sample_guid]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "FileTime",
        char8_cp1252("A", &b'A'),
        systemtime("scalar", &sample_rusttime),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "HexInt32",
        char8_cp1252("A", &b'A'),
        i32_hex("scalar", &-559038737),
        i32_hex_slice("a0", &[]),
        i32_hex_slice("a1", &[-559038737]),
        i32_hex_slice("a2", &[-559038737, -559038737]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "HexInt32",
        char8_cp1252("A", &b'A'),
        u32_hex("scalar", &0xdeadbeef),
        u32_hex_slice("a0", &[]),
        u32_hex_slice("a1", &[0xdeadbeef]),
        u32_hex_slice("a2", &[0xdeadbeef, 0xdeadbeef]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "HexInt64",
        char8_cp1252("A", &b'A'),
        i64_hex("scalar", &-2401053088335073280),
        i64_hex_slice("a0", &[]),
        i64_hex_slice("a1", &[-2401053088335073280]),
        i64_hex_slice("a2", &[-2401053088335073280, -2401053088335073280]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "HexInt64",
        char8_cp1252("A", &b'A'),
        u64_hex("scalar", &0xdeadbeeffeeef000),
        u64_hex_slice("a0", &[]),
        u64_hex_slice("a1", &[0xdeadbeeffeeef000]),
        u64_hex_slice("a2", &[0xdeadbeeffeeef000, 0xdeadbeeffeeef000]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "HexIntPtr",
        char8_cp1252("A", &b'A'),
        isize_hex("scalar", &0x1234),
        isize_hex_slice("a0", &[]),
        isize_hex_slice("a1", &[0x1234]),
        isize_hex_slice("a2", &[0x1234, 0x1234]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "HexIntPtr",
        char8_cp1252("A", &b'A'),
        usize_hex("scalar", &0x1234),
        usize_hex_slice("a0", &[]),
        usize_hex_slice("a1", &[0x1234]),
        usize_hex_slice("a2", &[0x1234, 0x1234]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "CountedString",
        char8_cp1252("A", &b'A'),
        str16("scalar", &Vec::from_iter("utf16".encode_utf16())),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "CountedAnsiString",
        char8_cp1252("A", &b'A'),
        str8("scalar", "utf8"),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "BinaryC",
        char8_cp1252("A", &b'A'),
        binaryc("scalar", "0123"),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "IPv4",
        char8_cp1252("A", &b'A'),
        ipv4("scalar", &sample_ipv4),
        ipv4_slice("a0", &[]),
        ipv4_slice("a1", &[sample_ipv4]),
        ipv4_slice("a2", &[sample_ipv4, sample_ipv4]),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "IPv6",
        char8_cp1252("A", &b'A'),
        ipv6("scalar", &sample_ipv6),
        char8_cp1252("A", &b'A'),
    );

    eh::write_event!(
        PROV,
        "IPv6c",
        char8_cp1252("A", &b'A'),
        ipv6c("scalar", &sample_ipv6),
        char8_cp1252("A", &b'A'),
    );
}

eventheader::define_provider!(TEST, "Testing_TestComponent");

macro_rules! log {
    ($name:literal) => {
        eventheader::write_event!(TEST, $name );
    };
    ($name:literal, $($field:tt)*) => {
        eventheader::write_event!(TEST, $name, $($field)*);
    };
}

#[test]
fn nested_macro_usage() {
    // testing that these statements expand and compile
    log!("hello");
    log!("hello", u32("world", &1u32));
    log!("hello", u32("key1", &1u32), str8("key2", "value"));
}