Refactor tests validating configuration for capture of db.query.text (#2718)

Author: alanwest

test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientTests.cs

@@ -71,8 +71,6 @@ public void SqlClient_NamedOptions()
     public void SqlClientCallsAreCollectedSuccessfully(
         string beforeCommand,
         CommandType commandType,
-        string commandText,
-        bool captureTextCommandContent,
         bool emitOldAttributes = true,
         bool emitNewAttributes = false)
     {
@@ -82,7 +80,7 @@ public void SqlClientCallsAreCollectedSuccessfully(
         using var traceProvider = Sdk.CreateTracerProviderBuilder()
             .AddSqlClientInstrumentation(options =>
             {
-                options.SetDbStatementForText = captureTextCommandContent;
+                options.SetDbStatementForText = true;
                 options.EmitOldAttributes = emitOldAttributes;
                 options.EmitNewAttributes = emitNewAttributes;
             })
@@ -94,6 +92,10 @@ public void SqlClientCallsAreCollectedSuccessfully(
             .AddInMemoryExporter(metrics)
             .Build();
 
+        var commandText = commandType == CommandType.Text
+            ? "select * from sys.databases"
+            : "SP_GetOrders";
+
         this.ExecuteCommand(commandType, commandText, false, beforeCommand);
 
         traceProvider.ForceFlush();
@@ -105,7 +107,7 @@ public void SqlClientCallsAreCollectedSuccessfully(
         VerifyActivityData(
             commandType,
             commandText,
-            captureTextCommandContent,
+            true,
             false,
             false,
             false,
@@ -230,6 +232,46 @@ public void MicrosoftDataStartsActivityWithExpectedAttributes(SqlClientTestCase
         this.RunSqlClientTestCase(testCase, SqlClientDiagnosticListener.SqlMicrosoftBeforeExecuteCommand, SqlClientDiagnosticListener.SqlMicrosoftAfterExecuteCommand);
     }
 
+    [Theory]
+    [InlineData(true)]
+    [InlineData(false)]
+    public void DbQueryTextCollectedWhenEnabled(bool captureTextCommandContent)
+    {
+        var activities = new List<Activity>();
+
+        using var tracerProvider = Sdk.CreateTracerProviderBuilder()
+            .AddSqlClientInstrumentation(options =>
+            {
+                options.SetDbStatementForText = captureTextCommandContent;
+                options.EmitOldAttributes = true;
+                options.EmitNewAttributes = true;
+            })
+            .AddInMemoryExporter(activities)
+            .Build();
+
+        var commandText = "select * from sys.databases";
+        this.ExecuteCommand(CommandType.Text, commandText, false, SqlClientDiagnosticListener.SqlDataBeforeExecuteCommand);
+        this.ExecuteCommand(CommandType.Text, commandText, false, SqlClientDiagnosticListener.SqlMicrosoftBeforeExecuteCommand);
+
+        tracerProvider.ForceFlush();
+        Assert.Equal(2, activities.Count);
+
+        if (captureTextCommandContent)
+        {
+            Assert.Equal(commandText, activities[0].GetTagValue(SemanticConventions.AttributeDbStatement));
+            Assert.Equal(commandText, activities[0].GetTagValue(SemanticConventions.AttributeDbQueryText));
+            Assert.Equal(commandText, activities[1].GetTagValue(SemanticConventions.AttributeDbStatement));
+            Assert.Equal(commandText, activities[1].GetTagValue(SemanticConventions.AttributeDbQueryText));
+        }
+        else
+        {
+            Assert.Null(activities[0].GetTagValue(SemanticConventions.AttributeDbStatement));
+            Assert.Null(activities[0].GetTagValue(SemanticConventions.AttributeDbQueryText));
+            Assert.Null(activities[1].GetTagValue(SemanticConventions.AttributeDbStatement));
+            Assert.Null(activities[1].GetTagValue(SemanticConventions.AttributeDbQueryText));
+        }
+    }
+
     [Theory]
     [InlineData(true, false)]
     [InlineData(false, false)]

test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlTestData.cs

@@ -16,19 +16,13 @@ public static IEnumerable<object[]> SqlClientCallsAreCollectedSuccessfullyCases(
         var bools = new[] { true, false };
         return from beforeCommand in new[] { SqlClientDiagnosticListener.SqlDataBeforeExecuteCommand, SqlClientDiagnosticListener.SqlMicrosoftBeforeExecuteCommand }
                from commandType in new[] { CommandType.StoredProcedure, CommandType.Text }
-               from captureTextCommandContent in bools
                from emitOldAttributes in bools
                from emitNewAttributes in bools
                where emitOldAttributes && emitNewAttributes
-               let commandText = commandType == CommandType.Text
-                   ? "select * from sys.databases"
-                   : "SP_GetOrders"
                select new object[]
                {
                     beforeCommand,
                     commandType,
-                    commandText,
-                    captureTextCommandContent,
                     emitOldAttributes,
                     emitNewAttributes,
                };