Verify.Diagnostics

Extends Verify to allow verification of System.Diagnostics.Activity

See Milestones for release notes.

Sponsors

Entity Framework Extensions

Entity Framework Extensions is a major sponsor and is proud to contribute to the development this project.

NuGet

• https://nuget.org/packages/Verify.Diagnostics

Usage

[ModuleInitializer]
public static void Initialize() =>
    VerifyDiagnostics.Initialize();

^{snippet source | anchor}

RecordingActivityListener allows, when a method is being tested, for any Activity created as part of that method call to be recorded and verified.

Call RecordingActivityListener.Start() to begin listening. All activities from any ActivitySource will be captured by default.

[Fact]
public Task Usage()
{
    Recording.Start();
    using var source = new ActivitySource("TestSource");

    using (var activity = source.StartActivity("MyOperation"))
    {
        activity!.SetTag("key1", "value1");
        activity.SetTag("key2", 42);
    }

    return Verify("result");
}

^{snippet source | anchor}

Results in:

{
  target: result,
  activity: {
    MyOperation: {
      Tags: {
        key1: value1,
        key2: 42
      }
    }
  }
}

^{snippet source | anchor}

Serialization

Activities are serialized with the following conventions:

• OperationName is used as the JSON property key
• DisplayName only included if different from OperationName
• Kind only included if not Internal
• Status and StatusDescription only included if not Unset
• Tags, Events, Links, and Baggage included when present
• Non-deterministic values (Id, TraceId, SpanId, ParentSpanId, Duration, StartTimeUtc, Source) are omitted

Icon

Diagnostic from The Noun Project.