Sql Server Runtime Compatibility Check (open-telemetry#3314)

RassK · web-flow · commit a085f916a637 · 2024-03-11T18:03:40.000+01:00
Refactor from compile time check to runtime check
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();

Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@ DotNetBuildSettings BuildTestApplication(DotNetBuildSettings x) =>`
`211`	`211`	`}`
`212`	`212`	`}`
`213`	`213`
`214`		`- foreach (var project in Solution.GetManagedUnitTestProjects())`
	`214`	`+ foreach (var project in Solution.GetManagedTestProjects())`
`215`	`215`	`{`
`216`	`216`	`if (TestTargetFramework != TargetFramework.NOT_SPECIFIED &&`
`217`	`217`	`!project.GetTargetFrameworks().Contains(TestTargetFramework))`
`@@ -228,14 +228,6 @@ DotNetBuildSettings BuildTestApplication(DotNetBuildSettings x) =>`
`228`	`228`	`.When(TestTargetFramework != TargetFramework.NOT_SPECIFIED,`
`229`	`229`	`s => s.SetFramework(TestTargetFramework)));`
`230`	`230`	`}`
`231`		`-`
`232`		`- DotNetBuild(x => x`
`233`		`- .SetProjectFile(Solution.GetManagedIntegrationTestProject())`
`234`		`- .SetConfiguration(BuildConfiguration)`
`235`		`- .SetNoRestore(NoRestore)`
`236`		`- .SetPlatform(Platform)`
`237`		`- .When(TestTargetFramework != TargetFramework.NOT_SPECIFIED,`
`238`		`- s => s.SetFramework(TestTargetFramework)));`
`239`	`231`	`});`
`240`	`232`
`241`	`233`	`Target CompileNativeDependenciesForManagedTests => _ => _`
`@@ -528,7 +520,6 @@ void RemoveFilesInNetFolderAvailableInAdditionalStore()`
`528`	`520`	`{`
`529`	`521`	`DotNetMSBuild(config => config`
`530`	`522`	`.SetConfiguration(BuildConfiguration)`
`531`		`- .SetPlatform(Platform)`
`532`	`523`	`.SetFilter(AndFilter(TestNameFilter(), ContainersFilter()))`
`533`	`524`	`.SetBlameHangTimeout("5m")`
`534`	`525`	`.EnableTrxLogOutput(GetResultsDirectory(project))`
Original file line number	Diff line number	Diff line change
`@@ -92,6 +92,11 @@ public static string GetPlatform()`
`92`	`92`	`return RuntimeInformation.ProcessArchitecture.ToString();`
`93`	`93`	`}`
`94`	`94`
	`95`	`+ public static bool IsX64()`
	`96`	`+ {`
	`97`	`+ return RuntimeInformation.ProcessArchitecture == Architecture.X64;`
	`98`	`+ }`
	`99`	`+`
`95`	`100`	`public static string GetPlatformDir()`
`96`	`101`	`{`
`97`	`102`	`return RuntimeInformation.ProcessArchitecture switch`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,6 @@`
`1`	`1`	`// Copyright The OpenTelemetry Authors`
`2`	`2`	`// SPDX-License-Identifier: Apache-2.0`
`3`	`3`
`4`		`-// SQL Server is supported on only AMD64`
`5`		`-#if _X64`
`6`		`-`
`7`	`4`	`using IntegrationTests.Helpers;`
`8`	`5`	`using Xunit.Abstractions;`
`9`	`6`
`@@ -31,12 +28,15 @@ public static IEnumerable<object[]> GetData()`
`31`	`28`	`}`
`32`	`29`	`}`
`33`	`30`
`34`		`- [Theory]`
	`31`	`+ [SkippableTheory]`
`35`	`32`	`[Trait("Category", "EndToEnd")]`
`36`	`33`	`[Trait("Containers", "Linux")]`
`37`	`34`	`[MemberData(nameof(GetData))]`
`38`	`35`	`public void SubmitTraces(string packageVersion, bool dbStatementForText)`
`39`	`36`	`{`
	`37`	`+ // Skip the test if fixture does not support current platform`
	`38`	`+ _sqlServerFixture.SkipIfUnsupportedPlatform();`
	`39`	`+`
`40`	`40`	`SetEnvironmentVariable("OTEL_DOTNET_AUTO_SQLCLIENT_SET_DBSTATEMENT_FOR_TEXT", dbStatementForText.ToString());`
`41`	`41`	`using var collector = new MockSpansCollector(Output);`
`42`	`42`	`SetExporter(collector);`
`@@ -59,5 +59,3 @@ public void SubmitTraces(string packageVersion, bool dbStatementForText)`
`59`	`59`	`collector.AssertExpectations();`
`60`	`60`	`}`
`61`	`61`	`}`
`62`		`-`
`63`		`-#endif`
Original file line number	Diff line number	Diff line change
`@@ -25,15 +25,25 @@ public class SqlServerFixture : IAsyncLifetime`
`25`	`25`
`26`	`26`	`public SqlServerFixture()`
`27`	`27`	`{`
`28`		`- Port = TcpPortProvider.GetOpenPort();`
	`28`	`+ if (IsCurrentArchitectureSupported)`
	`29`	`+ {`
	`30`	`+ Port = TcpPortProvider.GetOpenPort();`
	`31`	`+ }`
`29`	`32`	`}`
`30`	`33`
`31`	`34`	`public string Password { get; } = $"@{Guid.NewGuid().ToString("N")}";`
`32`	`35`
`33`	`36`	`public int Port { get; }`
`34`	`37`
	`38`	`+ public bool IsCurrentArchitectureSupported { get; } = EnvironmentTools.IsX64();`
	`39`	`+`
`35`	`40`	`public async Task InitializeAsync()`
`36`	`41`	`{`
	`42`	`+ if (!IsCurrentArchitectureSupported)`
	`43`	`+ {`
	`44`	`+ return;`
	`45`	`+ }`
	`46`	`+`
`37`	`47`	`_container = await LaunchSqlServerContainerAsync();`
`38`	`48`	`}`
`39`	`49`
`@@ -45,6 +55,14 @@ public async Task DisposeAsync()`
`45`	`55`	`}`
`46`	`56`	`}`
`47`	`57`
	`58`	`+ public void SkipIfUnsupportedPlatform()`
	`59`	`+ {`
	`60`	`+ if (!IsCurrentArchitectureSupported)`
	`61`	`+ {`
	`62`	`+ throw new SkipException("SQL Server is supported only on AMD64.");`
	`63`	`+ }`
	`64`	`+ }`
	`65`	`+`
`48`	`66`	`private static async Task ShutdownSqlServerContainerAsync(IContainer container)`
`49`	`67`	`{`
`50`	`68`	`await container.DisposeAsync();`