Sql Server Runtime Compatibility Check (#3314)

Refactor from compile time check to runtime check
open-telemetry · Mar 11, 2024 · a085f91 · a085f91
1 parent 8310a7d
commit a085f91
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 32 deletions.
diff --git a/build/Build.Steps.cs b/build/Build.Steps.cs
@@ -211,7 +211,7 @@ DotNetBuildSettings BuildTestApplication(DotNetBuildSettings x) =>
                 }
             }
 
-            foreach (var project in Solution.GetManagedUnitTestProjects())
+            foreach (var project in Solution.GetManagedTestProjects())
             {
                 if (TestTargetFramework != TargetFramework.NOT_SPECIFIED &&
                     !project.GetTargetFrameworks().Contains(TestTargetFramework))
@@ -228,14 +228,6 @@ DotNetBuildSettings BuildTestApplication(DotNetBuildSettings x) =>
                     .When(TestTargetFramework != TargetFramework.NOT_SPECIFIED,
                         s => s.SetFramework(TestTargetFramework)));
             }
-
-            DotNetBuild(x => x
-                .SetProjectFile(Solution.GetManagedIntegrationTestProject())
-                .SetConfiguration(BuildConfiguration)
-                .SetNoRestore(NoRestore)
-                .SetPlatform(Platform)
-                .When(TestTargetFramework != TargetFramework.NOT_SPECIFIED,
-                    s => s.SetFramework(TestTargetFramework)));
         });
 
     Target CompileNativeDependenciesForManagedTests => _ => _
@@ -528,7 +520,6 @@ void RemoveFilesInNetFolderAvailableInAdditionalStore()
             {
                 DotNetMSBuild(config => config
                     .SetConfiguration(BuildConfiguration)
-                    .SetPlatform(Platform)
                     .SetFilter(AndFilter(TestNameFilter(), ContainersFilter()))
                     .SetBlameHangTimeout("5m")
                     .EnableTrxLogOutput(GetResultsDirectory(project))

diff --git a/test/IntegrationTests/Helpers/EnvironmentTools.cs b/test/IntegrationTests/Helpers/EnvironmentTools.cs
@@ -92,6 +92,11 @@ public static string GetPlatform()
         return RuntimeInformation.ProcessArchitecture.ToString();
     }
 
+    public static bool IsX64()
+    {
+        return RuntimeInformation.ProcessArchitecture == Architecture.X64;
+    }
+
     public static string GetPlatformDir()
     {
         return RuntimeInformation.ProcessArchitecture switch

diff --git a/test/IntegrationTests/IntegrationTests.csproj b/test/IntegrationTests/IntegrationTests.csproj
@@ -4,21 +4,12 @@
     <AddTestStrongNameAssemblyKeyOnNetFramework>true</AddTestStrongNameAssemblyKeyOnNetFramework>
     <!-- No warn is needed for autogenerated code by protobuf: CS8981 - The type name only contains lower-cased ascii characters. -->
     <NoWarn Condition="'$(TargetFramework)' == 'net8.0' OR '$(TargetFramework)' == 'net7.0'">CS8981</NoWarn>
-    <Platforms>x64;ARM64</Platforms>
   </PropertyGroup>
 
   <PropertyGroup Condition=" '$(OS)' == 'Windows_NT' ">
     <DefineConstants>$(DefineConstants);_WINDOWS</DefineConstants>
   </PropertyGroup>
 
-  <PropertyGroup Condition=" '$(Platform)' == 'ARM64' ">
-    <DefineConstants>$(DefineConstants);_ARM64</DefineConstants>
-  </PropertyGroup>
-
-  <PropertyGroup Condition=" '$(Platform)' == 'x64' ">
-    <DefineConstants>$(DefineConstants);_X64</DefineConstants>
-  </PropertyGroup>
-
   <ItemGroup>
     <Reference Include="System.EnterpriseServices" Condition="$(TargetFramework.StartsWith('net4'))" />
   </ItemGroup>

diff --git a/test/IntegrationTests/SqlClientMicrosoftTests.cs b/test/IntegrationTests/SqlClientMicrosoftTests.cs
@@ -1,9 +1,6 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-// SQL Server is supported on only AMD64
-#if _X64
-
 using IntegrationTests.Helpers;
 using Xunit.Abstractions;
 
@@ -30,12 +27,15 @@ public static IEnumerable<object[]> GetData()
 #endif
     }
 
-    [Theory]
+    [SkippableTheory]
     [Trait("Category", "EndToEnd")]
     [Trait("Containers", "Linux")]
     [MemberData(nameof(GetData))]
     public void SubmitTraces(string packageVersion)
     {
+        // Skip the test if fixture does not support current platform
+        _sqlServerFixture.SkipIfUnsupportedPlatform();
+
         using var collector = new MockSpansCollector(Output);
         SetExporter(collector);
         collector.Expect("OpenTelemetry.Instrumentation.SqlClient");
@@ -49,5 +49,3 @@ public void SubmitTraces(string packageVersion)
         collector.AssertExpectations();
     }
 }
-
-#endif
diff --git a/test/IntegrationTests/SqlClientSystemTests.cs b/test/IntegrationTests/SqlClientSystemTests.cs
@@ -1,9 +1,6 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-// SQL Server is supported on only AMD64
-#if _X64
-
 using IntegrationTests.Helpers;
 using Xunit.Abstractions;
 
@@ -31,12 +28,15 @@ public static IEnumerable<object[]> GetData()
         }
     }
 
-    [Theory]
+    [SkippableTheory]
     [Trait("Category", "EndToEnd")]
     [Trait("Containers", "Linux")]
     [MemberData(nameof(GetData))]
     public void SubmitTraces(string packageVersion, bool dbStatementForText)
     {
+        // Skip the test if fixture does not support current platform
+        _sqlServerFixture.SkipIfUnsupportedPlatform();
+
         SetEnvironmentVariable("OTEL_DOTNET_AUTO_SQLCLIENT_SET_DBSTATEMENT_FOR_TEXT", dbStatementForText.ToString());
         using var collector = new MockSpansCollector(Output);
         SetExporter(collector);
@@ -59,5 +59,3 @@ public void SubmitTraces(string packageVersion, bool dbStatementForText)
         collector.AssertExpectations();
     }
 }
-
-#endif
diff --git a/test/IntegrationTests/SqlServerCollection.cs b/test/IntegrationTests/SqlServerCollection.cs
@@ -25,15 +25,25 @@ public class SqlServerFixture : IAsyncLifetime
 
     public SqlServerFixture()
     {
-        Port = TcpPortProvider.GetOpenPort();
+        if (IsCurrentArchitectureSupported)
+        {
+            Port = TcpPortProvider.GetOpenPort();
+        }
     }
 
     public string Password { get; } = $"@{Guid.NewGuid().ToString("N")}";
 
     public int Port { get; }
 
+    public bool IsCurrentArchitectureSupported { get; } = EnvironmentTools.IsX64();
+
     public async Task InitializeAsync()
     {
+        if (!IsCurrentArchitectureSupported)
+        {
+            return;
+        }
+
         _container = await LaunchSqlServerContainerAsync();
     }
 
@@ -45,6 +55,14 @@ public async Task DisposeAsync()
         }
     }
 
+    public void SkipIfUnsupportedPlatform()
+    {
+        if (!IsCurrentArchitectureSupported)
+        {
+            throw new SkipException("SQL Server is supported only on AMD64.");
+        }
+    }
+
     private static async Task ShutdownSqlServerContainerAsync(IContainer container)
     {
         await container.DisposeAsync();