Add tests

Author: zacharycmontoya

tracer/test/Datadog.Trace.ClrProfiler.IntegrationTests/AspNet/OpenTelemetryAspNetMvc5Tests.cs

@@ -0,0 +1,118 @@
+// <copyright file="OpenTelemetryAspNetMvc5Tests.cs" company="Datadog">
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
+// </copyright>
+
+#if NETFRAMEWORK
+#pragma warning disable SA1402 // File may only contain a single class
+#pragma warning disable SA1649 // File name must match first type name
+
+using System.Threading.Tasks;
+using Datadog.Trace.ClrProfiler.IntegrationTests.Helpers;
+using Datadog.Trace.TestHelpers;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Datadog.Trace.ClrProfiler.IntegrationTests
+{
+    [Collection(nameof(TestAgentOtlpCollection))]
+    public class OpenTelemetryAspNetMvc5TestsDatadogSemantics : OpenTelemetryAspNetMvc5Tests
+    {
+        public OpenTelemetryAspNetMvc5TestsDatadogSemantics(IisFixture iisFixture, ITestOutputHelper output)
+            : base(iisFixture, output, openTelemetrySemanticsEnabled: false)
+        {
+        }
+    }
+
+    [Collection(nameof(TestAgentOtlpCollection))]
+    public class OpenTelemetryAspNetMvc5TestsOtelSemantics : OpenTelemetryAspNetMvc5Tests
+    {
+        public OpenTelemetryAspNetMvc5TestsOtelSemantics(IisFixture iisFixture, ITestOutputHelper output)
+            : base(iisFixture, output, openTelemetrySemanticsEnabled: true)
+        {
+        }
+    }
+
+    /// <summary>
+    /// Covers the HTTP server coverage for the OpenTelemetry HTTP Semantic Conventions
+    /// implementation, using the ASP.NET MVC 5 sample hosted in IIS Express. One test case per
+    /// endpoint, each exercising a different requirement from
+    /// <see href="https://opentelemetry.io/docs/specs/semconv/http/http-spans/#http-server">the HTTP
+    /// server conventions</see>: standard vs. unknown request methods, route templates as
+    /// <c>http.route</c>, status-to-error mapping (which for server spans differs from client spans
+    /// in the 4xx range), and <c>url.query</c> obfuscation.
+    /// </summary>
+    public abstract class OpenTelemetryAspNetMvc5Tests : OpenTelemetryAspNetTestBase
+    {
+        protected OpenTelemetryAspNetMvc5Tests(IisFixture iisFixture, ITestOutputHelper output, bool openTelemetrySemanticsEnabled)
+            : base(iisFixture, output, nameof(OpenTelemetryAspNetMvc5Tests), openTelemetrySemanticsEnabled)
+        {
+        }
+
+        /// <summary>
+        /// One endpoint per OpenTelemetry HTTP server requirement, as (method, path, status code,
+        /// Datadog-semantics span count, OpenTelemetry-semantics span count). With Datadog semantics
+        /// the count is 2 for a request that reaches an MVC action (the <c>aspnet.request</c> span
+        /// plus the <c>aspnet-mvc.request</c> span nested inside it) and 1 when no action runs,
+        /// because the MVC span is created by the action invoker. With OpenTelemetry semantics the
+        /// <c>aspnet-mvc.request</c> span is not created, because the conventions describe a single
+        /// HTTP server span per request.
+        /// </summary>
+        public static TheoryData<string, string, int, int, int> Data => new()
+        {
+            // Baseline: a conventionally-routed request that exercises every required and recommended
+            // server attribute (http.request.method, url.path, url.scheme, http.route,
+            // http.response.status_code, server.address, server.port, user_agent.original) and the
+            // "{method} {http.route}" span name.
+            { "GET", "/home/index", 200, 2, 1 },
+
+            // A route with a parameter: http.route must stay low-cardinality, so it carries the
+            // template ("delay/{seconds}") rather than the substituted value.
+            { "GET", "/delay/0", 200, 2, 1 },
+
+            // A standard method other than GET, to show http.request.method follows the request.
+            { "POST", "/home/index", 200, 2, 1 },
+
+            // Unknown/non-standard method: http.request.method must be _OTHER, the raw verb must move
+            // to http.request.method_original, and the span name must fall back to "HTTP" for the
+            // method part instead of the raw verb.
+            { "FOO", "/home/index", 200, 2, 1 },
+
+            // Sensitive query string: url.query must be captured and obfuscated with the same
+            // DD_TRACE_OBFUSCATION_QUERY_STRING_REGEXP that http.url uses. Note that the two keys here
+            // are treated differently, which the paired snapshots pin: "token" is matched by the
+            // default pattern, but the bare key "sig" is not, even though the OpenTelemetry
+            // conventions name it as one of the values to redact in a URL.
+            { "GET", "/statuscode/201?token=SUPER-SECRET-TOKEN-VALUE&sig=SUPER-SECRET-SIGNATURE", 201, 2, 1 },
+
+            // 2xx and 3xx responses: not an error under either Datadog or OpenTelemetry semantics.
+            { "GET", "/statuscode/302", 302, 2, 1 },
+
+            // 4xx response: for *server* spans the status stays unset, which is the opposite of the
+            // client-span rule where 4xx is an error.
+            { "GET", "/statuscode/404", 404, 2, 1 },
+
+            // 5xx response: an error under both Datadog and OpenTelemetry semantics.
+            { "GET", "/statuscode/503", 503, 2, 1 },
+
+            // An unhandled exception rather than a status code: the exception is recorded on the span
+            // and error.type carries the status code.
+            { "GET", "/badrequest", 500, 2, 1 },
+
+            // No controller for the matched route, so no MVC span is created and the server span is
+            // the only record of the request. With OpenTelemetry semantics there is also no
+            // http.route, so the span name must be just the method rather than the URI path.
+            { "GET", "/not-a-registered-route/1", 404, 1, 1 },
+        };
+
+        [SkippableTheory]
+        [Trait("Category", "EndToEnd")]
+        [Trait("RunOnWindows", "True")]
+        [Trait("LoadFromGAC", "True")]
+        [Trait("RequiresDockerDependency", "true")]
+        [MemberData(nameof(Data))]
+        public Task SubmitsOtlpTraces(string httpMethod, string path, int statusCode, int datadogSpanCount, int otelSpanCount)
+            => RunTestCaseAsync(httpMethod, path, statusCode, OpenTelemetrySemanticsEnabled ? otelSpanCount : datadogSpanCount);
+    }
+}
+#endif