[Infra] Refactor EventSource tests (#6896)

Co-authored-by: Rajkumar Rangaraj <rajrang@microsoft.com>

Author: martincostello

test/OpenTelemetry.Api.Tests/EventSourceTests.cs

@@ -10,8 +10,6 @@ namespace OpenTelemetry.Api.Tests;
 public class EventSourceTests
 {
     [Fact]
-    public void EventSourceTest_OpenTelemetryApiEventSource()
-    {
-        EventSourceTestHelper.MethodsAreImplementedConsistentlyWithTheirAttributes(OpenTelemetryApiEventSource.Log);
-    }
+    public void EventSourceTests_OpenTelemetryApiEventSource() =>
+        EventSourceTestHelper.ValidateEventSourceIds<OpenTelemetryApiEventSource>();
 }

test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/EventSourceTests.cs

@@ -11,20 +11,14 @@ namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests;
 public class EventSourceTests
 {
     [Fact]
-    public void EventSourceTest_OpenTelemetryProtocolExporterEventSource()
-    {
-        EventSourceTestHelper.MethodsAreImplementedConsistentlyWithTheirAttributes(OpenTelemetryProtocolExporterEventSource.Log);
-    }
+    public void EventSourceTests_OpenTelemetryProtocolExporterEventSource() =>
+        EventSourceTestHelper.ValidateEventSourceIds<OpenTelemetryProtocolExporterEventSource>();
 
     [Fact]
-    public void EventSourceTest_PersistentStorageAbstractionsEventSource()
-    {
-        EventSourceTestHelper.MethodsAreImplementedConsistentlyWithTheirAttributes(PersistentStorageAbstractionsEventSource.Log);
-    }
+    public void EventSourceTests_PersistentStorageAbstractionsEventSource() =>
+        EventSourceTestHelper.ValidateEventSourceIds<PersistentStorageAbstractionsEventSource>();
 
     [Fact]
-    public void EventSourceTest_PersistentStorageEventSource()
-    {
-        EventSourceTestHelper.MethodsAreImplementedConsistentlyWithTheirAttributes(PersistentStorageEventSource.Log);
-    }
+    public void EventSourceTests_PersistentStorageEventSource() =>
+        EventSourceTestHelper.ValidateEventSourceIds<PersistentStorageEventSource>();
 }

test/OpenTelemetry.Exporter.Prometheus.HttpListener.Tests/EventSourceTests.cs

@@ -9,8 +9,6 @@ namespace OpenTelemetry.Exporter.Prometheus.Tests;
 public class EventSourceTests
 {
     [Fact]
-    public void EventSourceTest_PrometheusExporterEventSource()
-    {
-        EventSourceTestHelper.MethodsAreImplementedConsistentlyWithTheirAttributes(PrometheusExporterEventSource.Log);
-    }
+    public void EventSourceTests_PrometheusExporterEventSource() =>
+        EventSourceTestHelper.ValidateEventSourceIds<PrometheusExporterEventSource>();
 }

test/OpenTelemetry.Exporter.Zipkin.Tests/EventSourceTests.cs

@@ -10,8 +10,6 @@ namespace OpenTelemetry.Exporter.Zipkin.Tests;
 public class EventSourceTests
 {
     [Fact]
-    public void EventSourceTest_ZipkinExporterEventSource()
-    {
-        EventSourceTestHelper.MethodsAreImplementedConsistentlyWithTheirAttributes(ZipkinExporterEventSource.Log);
-    }
+    public void EventSourceTests_ZipkinExporterEventSource() =>
+        EventSourceTestHelper.ValidateEventSourceIds<ZipkinExporterEventSource>();
 }

test/OpenTelemetry.Extensions.Hosting.Tests/EventSourceTests.cs

@@ -10,8 +10,6 @@ namespace OpenTelemetry.Extensions.Hosting.Tests;
 public class EventSourceTests
 {
     [Fact]
-    public void EventSourceTest_HostingExtensionsEventSource()
-    {
-        EventSourceTestHelper.MethodsAreImplementedConsistentlyWithTheirAttributes(HostingExtensionsEventSource.Log);
-    }
+    public void EventSourceTests_HostingExtensionsEventSource() =>
+        EventSourceTestHelper.ValidateEventSourceIds<HostingExtensionsEventSource>();
 }

test/OpenTelemetry.Extensions.Propagators.Tests/EventSourceTests.cs

@@ -10,8 +10,6 @@ namespace OpenTelemetry.Extensions.Propagators.Tests;
 public class EventSourceTests
 {
     [Fact]
-    public void EventSourceTest_PropagatorsEventSource()
-    {
-        EventSourceTestHelper.MethodsAreImplementedConsistentlyWithTheirAttributes(OpenTelemetryPropagatorsEventSource.Log);
-    }
+    public void EventSourceTests_OpenTelemetryPropagatorsEventSource() =>
+        EventSourceTestHelper.ValidateEventSourceIds<OpenTelemetryPropagatorsEventSource>();
 }

test/OpenTelemetry.Tests/EventSourceTestHelperTests.cs

@@ -0,0 +1,124 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+// Adapted from https://github.com/dotnet/aspnetcore/blob/3a973a5f4d28242262f27c86eb3f14299fe712ba/src/Testing/test/EventSourceValidatorTests.cs
+
+using System.Diagnostics.Tracing;
+using Xunit;
+
+namespace OpenTelemetry.Tests;
+
+public static class EventSourceTestHelperTests
+{
+    [Fact]
+    public static void ValidateEventSourceIds_PassesForCorrectEventSource()
+        => EventSourceTestHelper.ValidateEventSourceIds<CorrectEventSource>();
+
+    // GenerateManifest(Strict) detects the mismatch via IL inspection
+    // and our validator surfaces it through Assert.Fail.
+    // The exact runtime error message varies by .NET version, so we
+    // only verify the validator rejects the bad source.
+
+    [Fact]
+    public static void ValidateEventSourceIds_FailsForMismatchedWriteEventId()
+    {
+#if !NETFRAMEWORK
+        if (!OperatingSystem.IsWindows())
+        {
+            // Only supported on Windows
+            return;
+        }
+#endif
+
+        Assert.ThrowsAny<Exception>(
+            EventSourceTestHelper.ValidateEventSourceIds<MismatchedIdEventSource>);
+    }
+
+    [Fact]
+    public static void ValidateEventSourceIds_FailsForDuplicateEventIds()
+    {
+        // The duplicate ID message is produced by our validator code.
+        var ex = Assert.ThrowsAny<Exception>(
+            EventSourceTestHelper.ValidateEventSourceIds<DuplicateIdEventSource>);
+
+        Assert.Contains("Duplicate EventId 1", ex.Message, StringComparison.Ordinal);
+        Assert.Contains("EventAlpha", ex.Message, StringComparison.Ordinal);
+        Assert.Contains("EventBeta", ex.Message, StringComparison.Ordinal);
+    }
+
+    [Fact]
+    public static void ValidateEventSourceIds_FailsForNonEventSourceType()
+    {
+        // The guard clause message is produced by our validator code.
+        var ex = Assert.ThrowsAny<Exception>(
+            () => EventSourceTestHelper.ValidateEventSourceIds(typeof(string)));
+
+        Assert.Contains("does not derive from EventSource", ex.Message, StringComparison.Ordinal);
+    }
+
+    [Fact]
+    public static void ValidateEventSourceIds_PassesForEventSourceWithNoEvents() =>
+        EventSourceTestHelper.ValidateEventSourceIds<EmptyEventSource>();
+
+    [Fact]
+    public static void ValidateEventSourceIds_PassesForEventSourceWithMultipleParameterTypes() =>
+        EventSourceTestHelper.ValidateEventSourceIds<MultiParamEventSource>();
+
+#pragma warning disable CA1812
+
+    // -- Test-only EventSource implementations --
+
+    [EventSource(Name = "Test-Correct")]
+    private sealed class CorrectEventSource : EventSource
+    {
+        [Event(1, Level = EventLevel.Informational)]
+        public void EventOne(string message) => this.WriteEvent(1, message);
+
+        [Event(2, Level = EventLevel.Verbose)]
+        public void EventTwo(int count) => this.WriteEvent(2, count);
+
+        [Event(3, Level = EventLevel.Warning)]
+        public void EventThree() => this.WriteEvent(3);
+    }
+
+    [EventSource(Name = "Test-MismatchedId")]
+    private sealed class MismatchedIdEventSource : EventSource
+    {
+        [Event(1, Level = EventLevel.Informational)]
+        public void EventOne(int value) => this.WriteEvent(99, value);
+    }
+
+    [EventSource(Name = "Test-DuplicateId")]
+    private sealed class DuplicateIdEventSource : EventSource
+    {
+        [Event(1, Level = EventLevel.Informational)]
+        public void EventAlpha(string message) => this.WriteEvent(1, message);
+
+        [Event(1, Level = EventLevel.Informational)]
+        public void EventBeta(int count) => this.WriteEvent(1, count);
+    }
+
+    [EventSource(Name = "Test-Empty")]
+    private sealed class EmptyEventSource : EventSource;
+
+    [EventSource(Name = "Test-MultiParam")]
+    private sealed class MultiParamEventSource : EventSource
+    {
+        [Event(1, Level = EventLevel.Informational)]
+        public void EventWithString(string value) => this.WriteEvent(1, value);
+
+        [Event(2, Level = EventLevel.Informational)]
+        public void EventWithInt(int value) => this.WriteEvent(2, value);
+
+        [Event(3, Level = EventLevel.Informational)]
+        public void EventWithLong(long value) => this.WriteEvent(3, value);
+
+        [Event(4, Level = EventLevel.Informational)]
+        public void EventWithMultiple(string name, int count) => this.WriteEvent(4, name, count);
+
+        [Event(5, Level = EventLevel.Informational)]
+        public void EventWithNoArgs() => this.WriteEvent(5);
+    }
+
+#pragma warning restore CA1812
+}

test/OpenTelemetry.Tests/EventSourceTests.cs

@@ -9,8 +9,6 @@ namespace OpenTelemetry.Tests;
 public class EventSourceTests
 {
     [Fact]
-    public void EventSourceTest_OpenTelemetrySdkEventSource()
-    {
-        EventSourceTestHelper.MethodsAreImplementedConsistentlyWithTheirAttributes(OpenTelemetrySdkEventSource.Log);
-    }
+    public void EventSourceTests_OpenTelemetrySdkEventSource() =>
+        EventSourceTestHelper.ValidateEventSourceIds<OpenTelemetrySdkEventSource>();
 }