-
Notifications
You must be signed in to change notification settings - Fork 777
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Enable SuccessfulCommandTest by leveraging Testcontainers (#4198)
Co-authored-by: Alan West <[email protected]>
- Loading branch information
1 parent
63de729
commit 533513f
Showing
8 changed files
with
224 additions
and
146 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 0 additions & 22 deletions
22
test/OpenTelemetry.Instrumentation.SqlClient.Tests/Dockerfile
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
131 changes: 131 additions & 0 deletions
131
test/OpenTelemetry.Instrumentation.SqlClient.Tests/SqlClientIntegrationTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| // <copyright file="SqlClientIntegrationTests.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using System.Data; | ||
| using System.Diagnostics; | ||
| using System.Runtime.InteropServices; | ||
| using DotNet.Testcontainers.Containers; | ||
| using Microsoft.Data.SqlClient; | ||
| using OpenTelemetry.Tests; | ||
| using OpenTelemetry.Trace; | ||
| using Testcontainers.MsSql; | ||
| using Testcontainers.SqlEdge; | ||
| using Xunit; | ||
|
|
||
| namespace OpenTelemetry.Instrumentation.SqlClient.Tests | ||
| { | ||
| public sealed class SqlClientIntegrationTests : IAsyncLifetime | ||
| { | ||
| // The Microsoft SQL Server Docker image is not compatible with ARM devices, such as Macs with Apple Silicon. | ||
| private readonly IContainer databaseContainer = Architecture.Arm64.Equals(RuntimeInformation.ProcessArchitecture) ? new SqlEdgeBuilder().Build() : new MsSqlBuilder().Build(); | ||
|
|
||
| public Task InitializeAsync() | ||
| { | ||
| return this.databaseContainer.StartAsync(); | ||
| } | ||
|
|
||
| public Task DisposeAsync() | ||
| { | ||
| return this.databaseContainer.DisposeAsync().AsTask(); | ||
| } | ||
|
|
||
| [Trait("CategoryName", "SqlIntegrationTests")] | ||
| [EnabledOnDockerPlatformTheory(EnabledOnDockerPlatformTheoryAttribute.DockerPlatform.Linux)] | ||
| [InlineData(CommandType.Text, "select 1/1", false)] | ||
| [InlineData(CommandType.Text, "select 1/1", false, true)] | ||
| [InlineData(CommandType.Text, "select 1/0", false, false, true)] | ||
| [InlineData(CommandType.Text, "select 1/0", false, false, true, false, false)] | ||
| [InlineData(CommandType.Text, "select 1/0", false, false, true, true, false)] | ||
| [InlineData(CommandType.StoredProcedure, "sp_who", false)] | ||
| [InlineData(CommandType.StoredProcedure, "sp_who", true)] | ||
| public void SuccessfulCommandTest( | ||
| CommandType commandType, | ||
| string commandText, | ||
| bool captureStoredProcedureCommandName, | ||
| bool captureTextCommandContent = false, | ||
| bool isFailure = false, | ||
| bool recordException = false, | ||
| bool shouldEnrich = true) | ||
| { | ||
| #if NETFRAMEWORK | ||
| // Disable things not available on netfx | ||
| recordException = false; | ||
| shouldEnrich = false; | ||
| #endif | ||
|
|
||
| var sampler = new TestSampler(); | ||
| var activities = new List<Activity>(); | ||
| using var tracerProvider = Sdk.CreateTracerProviderBuilder() | ||
| .SetSampler(sampler) | ||
| .AddInMemoryExporter(activities) | ||
| .AddSqlClientInstrumentation(options => | ||
| { | ||
| #if !NETFRAMEWORK | ||
| options.SetDbStatementForStoredProcedure = captureStoredProcedureCommandName; | ||
| options.SetDbStatementForText = captureTextCommandContent; | ||
| #else | ||
| options.SetDbStatementForText = captureStoredProcedureCommandName || captureTextCommandContent; | ||
| #endif | ||
| options.RecordException = recordException; | ||
| if (shouldEnrich) | ||
| { | ||
| options.Enrich = SqlClientTests.ActivityEnrichment; | ||
| } | ||
| }) | ||
| .Build(); | ||
|
|
||
| using SqlConnection sqlConnection = new SqlConnection(this.GetConnectionString()); | ||
|
|
||
| sqlConnection.Open(); | ||
|
|
||
| string dataSource = sqlConnection.DataSource; | ||
|
|
||
| sqlConnection.ChangeDatabase("master"); | ||
|
|
||
| using SqlCommand sqlCommand = new SqlCommand(commandText, sqlConnection) | ||
| { | ||
| CommandType = commandType, | ||
| }; | ||
|
|
||
| try | ||
| { | ||
| sqlCommand.ExecuteNonQuery(); | ||
| } | ||
| catch | ||
| { | ||
| } | ||
|
|
||
| Assert.Single(activities); | ||
| var activity = activities[0]; | ||
|
|
||
| SqlClientTests.VerifyActivityData(commandType, commandText, captureStoredProcedureCommandName, captureTextCommandContent, isFailure, recordException, shouldEnrich, dataSource, activity); | ||
| SqlClientTests.VerifySamplingParameters(sampler.LatestSamplingParameters); | ||
| } | ||
|
|
||
| private string GetConnectionString() | ||
| { | ||
| switch (this.databaseContainer) | ||
| { | ||
| case SqlEdgeContainer container: | ||
| return container.GetConnectionString(); | ||
| case MsSqlContainer container: | ||
| return container.GetConnectionString(); | ||
| default: | ||
| throw new InvalidOperationException($"Container type ${this.databaseContainer.GetType().Name} not supported."); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 0 additions & 25 deletions
25
test/OpenTelemetry.Instrumentation.SqlClient.Tests/docker-compose.yml
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.