Azure Split - Use MDS Common Project

eng/pipelines/jobs/pack-abstractions-package-ci-job.yml

@@ -81,7 +81,6 @@ jobs:
         value: >-
           $(commonArguments)
           --configuration ${{ parameters.buildConfiguration }}
-          -p:ForceMdsAssemblyNameSuffix=true
           -p:AbstractionsPackageVersion=${{ parameters.abstractionsPackageVersion }}
 
       # Explicitly unset the $PLATFORM environment variable that is set by the

eng/pipelines/jobs/pack-azure-package-ci-job.yml

@@ -100,7 +100,6 @@ jobs:
         value: >-
           --verbosity ${{ parameters.dotnetVerbosity }}
           -p:ReferenceType=${{ parameters.referenceType }}
-          -p:ForceMdsAssemblyNameSuffix=true
           -p:AbstractionsPackageVersion=${{ parameters.abstractionsPackageVersion }}
 
       # dotnet CLI arguments for build/test/pack commands

eng/pipelines/jobs/test-abstractions-package-ci-job.yml

@@ -98,7 +98,6 @@ jobs:
         value: >-
           $(commonArguments)
           --configuration ${{ parameters.buildConfiguration }}
-          -p:ForceMdsAssemblyNameSuffix=true
 
       # Explicitly unset the $PLATFORM environment variable that is set by the
       # 'ADO Build properties' Library in the ADO SqlClientDrivers public project.

eng/pipelines/jobs/test-azure-package-ci-job.yml

@@ -97,6 +97,18 @@ parameters:
     - Package
     - Project
 
+  # Steps to run, if any, to configure a local SQL Server instance on the agent
+  # VM.
+  - name: sqlServerSetupSteps
+    type: stepList
+    default: []
+
+  # True if the VM image includes a local SQL Server that supports connections
+  # via integrated security.
+  - name: supportsIntegratedSecurity
+    type: boolean
+    default: false
+
   # The pool VM image to use.
   - name: vmImage
     type: string
@@ -129,16 +141,24 @@ jobs:
         value: >-
           --verbosity ${{ parameters.dotnetVerbosity }}
           -p:ReferenceType=${{ parameters.referenceType }}
-          -p:ForceMdsAssemblyNameSuffix=true
           -p:AbstractionsPackageVersion=${{ parameters.abstractionsPackageVersion }}
           -p:MdsPackageVersion=${{ parameters.mdsPackageVersion }}
 
-      # dotnet CLI arguments for build/test/pack commands
+      # dotnet CLI arguments for build/test/pack commands.
       - name: buildArguments
         value: >-
           $(commonArguments)
           --configuration ${{ parameters.buildConfiguration }}
 
+      # dotnet CLI arguments for test commands.
+      #
+      # Filter out tests annotated with the ActiveIssue attribute, which for
+      # some reason uses the category 'failing' rather than 'ActiveIssue'.
+      #
+      - name: testArguments
+        value: >-
+          --filter "category != failing"
+
       # Explicitly unset the $PLATFORM environment variable that is set by the
       # 'ADO Build properties' Library in the ADO SqlClientDrivers public
       # project.  This is defined with a non-standard Platform of 'AnyCPU', and
@@ -232,19 +252,25 @@ jobs:
           AzureKeyVaultTenantId: $(AzureKeyVaultTenantId)
           # macOS doesn't support managed identities.
           ManagedIdentitySupported: ${{ not(eq(parameters.vmImage, 'macos-latest')) }}
-          SupportsIntegratedSecurity: ${{ eq(variables['SupportsIntegratedSecurity'], 'true') }}
+          SupportsIntegratedSecurity: ${{ parameters.supportsIntegratedSecurity }}
           TCPConnectionString: $(AZURE_DB_TCP_CONN_STRING)
           UserManagedIdentityClientId: $(UserManagedIdentityClientId)
           WorkloadIdentityFederationServiceConnectionId: $(WorkloadIdentityFederationServiceConnectionId)
-          # Note: Using the isFork variable to determine if secrets are
-          # available is not ideal since it's an indirect association. But
-          # everything else (referencing secret variables various ways to detect
-          # if they were present) won't run consistently across forks and
-          # non-forks.
+          # Avoid exposing secrets to pipeline jobs triggered via forks.  This
+          # prevents external contributors from creating PRs and running
+          # pipelines that could expose these secrets.
+          #
+          # Note that this isn't a perfect restriction since internal
+          # contributors may want to use forks, but this would prevent them from
+          # running the full test suite.  We don't have a better way to detect
+          # external parties though.
           ${{ if eq(variables['system.pullRequest.isFork'], 'False') }}:
             AADPasswordConnectionString: $(AAD_PASSWORD_CONN_STR)
             AADServicePrincipalSecret: $(AADServicePrincipalSecret)
 
+      # Perform any local SQL Server setup.
+      - ${{ parameters.sqlServerSetupSteps }}
+
       # We use the 'custom' command because the DotNetCoreCLI@2 task doesn't
       # support all of our argument combinations for the different build steps.
 
@@ -282,7 +308,7 @@ jobs:
             # Many of our tests require access to Azure resources that are
             # currently only granted by agents running our custom ADO 1ES
             # images in our ADO pools.
-            ${{ if startsWith(parameters.poolName, 'ADO-') }}:
+            ${{ if ne(parameters.poolName, 'Azure Pipelines') }}:
               ADO_POOL: 1
             # When using connectedServiceName below, the DotNetCoreCLI task
             # needs the system access token to be injected as this environment
@@ -299,14 +325,14 @@ jobs:
             command: custom
             custom: test
             projects: $(project)
-            arguments: $(buildArguments) --no-build -f ${{ runtime }}
+            arguments: $(buildArguments) $(testArguments) --no-build -f ${{ runtime }}
 
       # Run the tests for each .NET Framework runtime.
       - ${{ each runtime in parameters.netFrameworkRuntimes }}:
         - task: DotNetCoreCLI@2
           displayName: Test [${{ runtime }}]
           env:
-            ${{ if startsWith(parameters.poolName, 'ADO-CI') }}:
+            ${{ if ne(parameters.poolName, 'Azure Pipelines') }}:
               ADO_POOL: 1
             SYSTEM_ACCESSTOKEN: $(System.AccessToken)
             ${{ if eq(parameters.debug, true) }}:
@@ -316,4 +342,4 @@ jobs:
             command: custom
             custom: test
             projects: $(project)
-            arguments: $(buildArguments) --no-build -f ${{ runtime }}
+            arguments: $(buildArguments) $(testArguments) --no-build -f ${{ runtime }}

eng/pipelines/stages/build-azure-package-ci-stage.yml

@@ -46,8 +46,8 @@ parameters:
     #
     # Any pool specified here must contain images with the following names:
     #
+    #   - ADO-MMS22-SQL22
     #   - ADO-UB22-SQL22
-    #   - ADO-CI-Win11
     #
     default: $(ci_var_defaultPoolName)
 
@@ -139,7 +139,7 @@ stages:
           debug: ${{ parameters.debug }}
           displayNamePrefix: Linux
           dotnetVerbosity: ${{ parameters.dotnetVerbosity }}
-          jobNameSuffix: linux_basic
+          jobNameSuffix: linux
           mdsArtifactName: MDS.Artifact
           mdsPackageVersion: ${{ parameters.mdsPackageVersion }}
           netFrameworkRuntimes: []
@@ -155,15 +155,25 @@ stages:
           abstractionsPackageVersion: ${{ parameters.abstractionsPackageVersion }}
           buildConfiguration: ${{ parameters.buildConfiguration }}
           debug: ${{ parameters.debug }}
-          displayNamePrefix: Linux
+          displayNamePrefix: Linux Integration
           dotnetVerbosity: ${{ parameters.dotnetVerbosity }}
-          jobNameSuffix: linux_comprehensive
+          jobNameSuffix: linux_integration
           mdsArtifactName: MDS.Artifact
           mdsPackageVersion: ${{ parameters.mdsPackageVersion }}
           netFrameworkRuntimes: []
           netRuntimes: [net8.0, net9.0, net10.0]
           poolName: ${{ parameters.adoPoolName }}
           referenceType: ${{ parameters.referenceType }}
+          # The image includes a SQL Server instance that we must configure.
+          sqlServerSetupSteps:
+            - template: /eng/pipelines/common/templates/steps/configure-sql-server-linux-step.yml@self
+              parameters:
+                # Override the template's default step condition.  We always
+                # want this step to run.
+                condition: true
+                # Use the Azure DevOps Library variable "password" for the SA
+                # password.
+                password: $(password)
           vmImage: ADO-UB22-SQL22
 
       # ------------------------------------------------------------------------
@@ -178,7 +188,7 @@ stages:
           debug: ${{ parameters.debug }}
           displayNamePrefix: Win
           dotnetVerbosity: ${{ parameters.dotnetVerbosity }}
-          jobNameSuffix: windows_basic
+          jobNameSuffix: windows
           mdsArtifactName: MDS.Artifact
           mdsPackageVersion: ${{ parameters.mdsPackageVersion }}
           netFrameworkRuntimes: [net462]
@@ -194,16 +204,33 @@ stages:
           abstractionsPackageVersion: ${{ parameters.abstractionsPackageVersion }}
           buildConfiguration: ${{ parameters.buildConfiguration }}
           debug: ${{ parameters.debug }}
-          displayNamePrefix: Win
+          displayNamePrefix: Win Integration
           dotnetVerbosity: ${{ parameters.dotnetVerbosity }}
-          jobNameSuffix: windows_comprehensive
+          jobNameSuffix: windows_integration
           mdsArtifactName: MDS.Artifact
           mdsPackageVersion: ${{ parameters.mdsPackageVersion }}
           netFrameworkRuntimes: [net462]
           netRuntimes: [net8.0, net9.0, net10.0]
           poolName: ${{ parameters.adoPoolName }}
           referenceType: ${{ parameters.referenceType }}
-          vmImage: ADO-CI-Win11
+          # The image includes a SQL Server instance that we must configure.
+          sqlServerSetupSteps:
+            - template: /eng/pipelines/common/templates/steps/configure-sql-server-win-step.yml@self
+              # Use defaults for most parameters.
+              parameters:
+                # Override the template's default step condition.  We always
+                # want this step to run.
+                condition: true
+                enableLocalDB: true
+                # These variables are from an Azure DevOps Library variable
+                # group.
+                fileStreamDirectory: $(FileStreamDirectory)
+                password: $(password)
+                sqlRootPath: $(SQL22RootPath)
+          # The ADO-MMS22-SQL22 image includes a local SQL Server that supports
+          # integrated security.
+          supportsIntegratedSecurity: true
+          vmImage: ADO-MMS22-SQL22
 
       # ------------------------------------------------------------------------
       # Build and test on macOS.
@@ -242,10 +269,10 @@ stages:
           dependsOn:
             # We depend on all of the test jobs to ensure the tests pass before
             # producing the NuGet package.
-            - test_azure_package_job_linux_basic
-            - test_azure_package_job_linux_comprehensive
-            - test_azure_package_job_windows_basic
-            - test_azure_package_job_windows_comprehensive
+            - test_azure_package_job_linux
+            - test_azure_package_job_linux_integration
+            - test_azure_package_job_windows
+            - test_azure_package_job_windows_integration
             - test_azure_package_job_macos
           dotnetVerbosity: ${{ parameters.dotnetVerbosity }}
           referenceType: ${{ parameters.referenceType }}

src/Directory.Build.props

@@ -153,43 +153,4 @@
     <!-- The newest .NET SDK we support is .NET 10.0, which uses C# 14 -->
     <LangVersion>14</LangVersion>
   </PropertyGroup>
-
-  <PropertyGroup>
-    <!--
-      We currently define 2 separate projects for MDS that both produce an
-      assembly named 'Microsoft.Data.SqlClient'.  This confuses MSBuild during
-      project-reference based builds of downstream projects (like AKV, Azure, or
-      tests) - it can't resolve the correct assembly based on the downstream
-      project's target framework.  To avoid such conflicts, we append a suffix
-      to the MDS AssemblyName property:  '.NetCore' for .NET targets, and
-      '.NetFx' for .NET Framwork targets.
-
-      These suffices are only applied during project-reference based builds,
-      and only for non-pipeline builds (i.e. developer builds).  This ensures
-      that pipeline builds and package-reference based builds use the normal
-      MDS assembly name.  These builds already include safeguards to build
-      downstream projects for specific target frameworks individually, and thus
-      don't encounter the same assembly name conflicts.
-
-      For developer builds, we don't care that the MDS assembly name isn't
-      truthful.  MSBuild finds the correct artifacts based on target framework
-      and all downstream projects build without needing a target framework
-      specified.
-
-      For package reference or pipeline builds, the assembly name remains
-      truthful and downstream projects don't encounter MSBuild restore problems
-      since the MDS artifacts are pulled from the NuGet package directly.
-
-      There are some downstream projects that still expect different assembly
-      names, even during pipeline builds.  For those, we define the
-      ForceMdsAssemblyNameSuffix property, which overrides the default pipeline
-      behaviour for project-based builds.
-
-      The boolean property ApplyMdsAssemblyNameSuffix can be used by any
-      project to determine whether or not to apply the MDS assembly name suffix.
-    -->
-    <ApplyMdsAssemblyNameSuffix>false</ApplyMdsAssemblyNameSuffix>
-    <ApplyMdsAssemblyNameSuffix
-      Condition="'$(ReferenceType)' == 'Project' AND ('$(ForceMdsAssemblyNameSuffix)' == 'true' OR '$(TF_BUILD)' != 'true')">true</ApplyMdsAssemblyNameSuffix>
-  </PropertyGroup>
 </Project>

src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/Abstractions.csproj

@@ -42,12 +42,6 @@
     <Version>$(AbstractionsPackageVersion)</Version>
 
     <DocumentationFile>$(Artifacts)/doc/$(TargetFramework)/$(AssemblyName).xml</DocumentationFile>
-
-    <!--
-      Apply an MDS assembly name suffix, if necessary.  See the top-level
-      Directory.Build.props for more information.
-    -->
-    <DefineConstants Condition="'$(ApplyMdsAssemblyNameSuffix)' == 'true'">$(DefineConstants);APPLY_MDS_ASSEMBLY_NAME_SUFFIX</DefineConstants>
   </PropertyGroup>
   <ItemGroup>
     <!-- Our API is CLS Compliant. -->
@@ -86,7 +80,7 @@
     <PackageIcon>dotnet.png</PackageIcon>
   </PropertyGroup>
   <ItemGroup>
-    <None Include="../../../../tools/icons/dotnet.png" Pack="true" PackagePath="/" />
+    <None Include="$(RepoRoot)/tools/icons/dotnet.png" Pack="true" PackagePath="/" />
   </ItemGroup>
 
 </Project>

src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/SqlAuthenticationProviderInternal.cs

@@ -32,20 +32,7 @@ private static class Internal
         /// </summary>
         static Internal()
         {
-            // Choose the MDS assembly name based on compilation flags and the
-            // runtime environment.  See the top-level Directory.Build.props for
-            // more information.
-            string assemblyName = "Microsoft.Data.SqlClient";
-            #if (APPLY_MDS_ASSEMBLY_NAME_SUFFIX)
-            if (RuntimeInformation.FrameworkDescription.StartsWith(".NET Framework"))
-            {
-                assemblyName += ".NetFx";
-            }
-            else
-            {
-                assemblyName += ".NetCore";
-            }
-            #endif
+            const string assemblyName = "Microsoft.Data.SqlClient";
 
             // If the MDS package is present, load its
             // SqlAuthenticationProviderManager class and get/set methods.

src/Microsoft.Data.SqlClient.Extensions/Abstractions/test/Abstractions.Test.csproj

@@ -9,14 +9,6 @@
     <AssemblyName>Microsoft.Data.SqlClient.Extensions.Abstractions.Test</AssemblyName>
   </PropertyGroup>
 
-  <PropertyGroup>
-    <!--
-      Apply an MDS assembly name suffix, if necessary.  See the top-level
-      Directory.Build.props for more information.
-    -->
-    <DefineConstants Condition="'$(ApplyMdsAssemblyNameSuffix)' == 'true'">$(DefineConstants);APPLY_MDS_ASSEMBLY_NAME_SUFFIX</DefineConstants>
-  </PropertyGroup>
-
   <ItemGroup>
     <ProjectReference Include="../src/Abstractions.csproj" />
   </ItemGroup>
@@ -33,7 +25,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Content Include="../../../Microsoft.Data.SqlClient/tests/tools/Microsoft.Data.SqlClient.TestUtilities/xunit.runner.json">
+    <Content Include="$(RepoRoot)/src/Microsoft.Data.SqlClient/tests/tools/Microsoft.Data.SqlClient.TestUtilities/xunit.runner.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
       <TargetPath>xunit.runner.json</TargetPath>
     </Content>

src/Microsoft.Data.SqlClient.Extensions/Abstractions/test/SqlAuthenticationProviderTest.cs

@@ -8,23 +8,14 @@ namespace Microsoft.Data.SqlClient.Extensions.Abstractions.Test;
 
 public class SqlAuthenticationProviderTest
 {
-    // Choose the MDS assembly name based on compilation flags.  See the
-    // top-level Directory.Build.props for more information.
-    #if (APPLY_MDS_ASSEMBLY_NAME_SUFFIX && NET)
-    const string assemblyName = "Microsoft.Data.SqlClient.NetCore";
-    #elif (APPLY_MDS_ASSEMBLY_NAME_SUFFIX && NETFRAMEWORK)
-    const string assemblyName = "Microsoft.Data.SqlClient.NetFx";
-    #else
-    const string assemblyName = "Microsoft.Data.SqlClient";
-    #endif
-
     /// <summary>
     /// Construct to confirm preconditions.
     /// </summary>
     public SqlAuthenticationProviderTest()
     {
         // Confirm that the MDS assembly is indeed not present.
-        Assert.Throws<FileNotFoundException>(() => Assembly.Load(assemblyName));
+        Assert.Throws<FileNotFoundException>(
+            () => Assembly.Load("Microsoft.Data.SqlClient"));
     }
 
     #region Tests