Azure Split - Step 2 - New Files

.github/workflows/codeql.yml

@@ -13,9 +13,9 @@ name: "CodeQL Advanced"
 
 on:
   push:
-    branches: [ "main", "feat/*" ]
+    branches: [ "main", "feat/*", "dev/**/*" ]
   pull_request:
-    branches: [ "main", "feat/*" ]
+    branches: [ "main", "feat/*", "dev/**/*" ]
   schedule:
     - cron: '33 23 * * 6'
 

BUILDGUIDE.md

@@ -29,7 +29,9 @@ The following build targets are defined in `build.proj`:
 
 |Target|Description|
 |-|-|
+|`BuildAbstractions`|Restore, build, and pack the Abstractions package, publishing the resulting NuGet into `packages/`.|
 |`BuildAllConfigurations`|Default target. Builds the .NET Framework and .NET drivers for all target frameworks and operating systems.|
+|`BuildAzure`|Restore, build, and pack the Azure package, publishing the resulting NuGet into `packages/`.|
 |`BuildNetCore`|Builds the .NET driver for all target frameworks.|
 |`BuildNetCoreAllOS`|Builds the .NET driver for all target frameworks and operating systems.|
 |`BuildNetFx`|Builds the .NET Framework driver for all target frameworks.|
@@ -230,6 +232,8 @@ Then, you can specify `Package` references be used, for example:
 
 ```bash
 cp NuGet.config.local NuGet.config
+dotnet build -t:BuildAbstractions
+dotnet build -t:BuildAzure -p:ReferenceType=Package
 dotnet build -t:BuildAll -p:ReferenceType=Package
 dotnet build -t:BuildAKVNetCore -p:ReferenceType=Package
 dotnet build -t:GenerateMdsPackage

Directory.Packages.props

@@ -7,10 +7,28 @@
   <!-- ===================================================================== -->
   <!-- Driver Packages -->
 
+  <ItemGroup>
+    <!--
+      We never reference this package via its project, so we always need a
+      version specified.
+    -->
+    <PackageVersion Include="Microsoft.SqlServer.Server" Version="1.0.0" />
+  </ItemGroup>
+
+  <!--
+    We only need other driver package versions specified when building via
+    package references.
+  -->
   <ItemGroup Condition="'$(ReferenceType)' == 'Package'">
     <PackageVersion
       Include="Microsoft.Data.SqlClient"
       Version="$(MdsPackageVersion)" />
+    <PackageVersion
+      Include="Microsoft.Data.SqlClient.Extensions.Abstractions"
+      Version="$(AbstractionsPackageVersion)" />
+    <PackageVersion
+      Include="Microsoft.Data.SqlClient.Extensions.Azure"
+      Version="$(AzurePackageVersion)" />
     <PackageVersion
       Include="Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider"
       Version="$(AkvPackageVersion)" />
@@ -56,15 +74,24 @@
   </ItemGroup>
 
   <!-- ===================================================================== -->
-  <!-- MDS project dependencies -->
+  <!-- MSS Dependencies -->
+
+  <!-- None -->
+
+  <!-- ===================================================================== -->
+  <!-- Abstractions Dependencies -->
+
+  <!-- None -->
+
+  <!-- ===================================================================== -->
+  <!-- MDS Dependencies -->
 
   <ItemGroup>
     <PackageVersion Include="Azure.Identity" Version="1.17.0" />
     <PackageVersion Include="Microsoft.Data.SqlClient.SNI" Version="6.0.2" />
     <PackageVersion Include="Microsoft.Data.SqlClient.SNI.runtime" Version="6.0.2" />
     <PackageVersion Include="Microsoft.IdentityModel.JsonWebTokens" Version="8.14.0" />
     <PackageVersion Include="Microsoft.IdentityModel.Protocols.OpenIdConnect" Version="8.14.0" />
-    <PackageVersion Include="Microsoft.SqlServer.Server" Version="1.0.0" />
     <PackageVersion Include="System.Buffers" Version="4.6.1" />
     <PackageVersion Include="System.Diagnostics.DiagnosticSource" Version="8.0.1" />
     <PackageVersion Include="System.Memory" Version="4.6.3" />
@@ -87,15 +114,14 @@
   </ItemGroup>
 
   <!-- ===================================================================== -->
-  <!-- AKV project dependencies -->
+  <!-- Azure Dependencies -->
 
-  <ItemGroup>
-    <PackageVersion Include="Azure.Security.KeyVault.Keys" Version="4.8.0" />
-  </ItemGroup>
+  <!-- None -->
 
   <!-- ===================================================================== -->
-  <!-- MSS project dependencies -->
-
-  <!-- None -->
+  <!-- AKV Dependencies -->
 
+  <ItemGroup>
+    <PackageVersion Include="Azure.Security.KeyVault.Keys" Version="4.8.0" />
+  </ItemGroup>
 </Project>

build.proj

@@ -66,6 +66,8 @@
   <ItemGroup>
     <Tools Include="tools/GenAPI/Microsoft.DotNet.GenAPI/Microsoft.DotNet.GenAPI.csproj" />
     <SqlServerLib Include="**/Microsoft.SqlServer.Server.csproj" />
+    <Abstractions Include="src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/Abstractions.csproj" />
+    <Azure Include="src/Microsoft.Data.SqlClient.Extensions/Azure/src/Azure.csproj" />
     <NetFxDriver Include="**/netfx/**/Microsoft.Data.SqlClient*.csproj" Condition="'$(IsEnabledWindows)' == 'true'" />
     <NetCoreDriver Include="**/netcore/**/Microsoft.Data.SqlClient*.csproj" />
     <!-- Used to build .NET Standard DLL for lib folder from this project. -->
@@ -103,20 +105,105 @@
   <Target Name="BuildTestsNetCore" DependsOnTargets="RestoreTestsNetCore;BuildAKVNetCore;BuildManualTestsNetCore"/>
   <Target Name="BuildTestsNetFx" DependsOnTargets="RestoreTestsNetFx;BuildAKVNetFx;BuildManualTestsNetFx" Condition="$(IsEnabledWindows) == 'true'"/>
 
+  <!-- Abstractions Targets -->
+  <PropertyGroup>
+    <AbstractionsProperties>$(CommonProperties)</AbstractionsProperties>
+
+    <!--
+      If the AbstractionsPackageVersion property was supplied on the
+      command-line, then pass it along to the Abstractions build.  Otherwise,
+      omit it entirely to avoid it expanding as empty here and thus overriding
+      the default behaviour in the Abstractions project.  Command-line
+      properties take precedence over project defaults, even if their value is
+      empty.  For example:
+
+        dotnet build -p:AbstractionsPackageVersion=
+
+      That results in $(AbstractionsPackageVersion) being defined as empty,
+      and cannot be overridden by the project.
+    -->
+    <AbstractionsProperties
+      Condition="'$(AbstractionsPackageVersion)' != ''">
+      $(AbstractionsProperties);AbstractionsPackageVersion=$(AbstractionsPackageVersion)
+    </AbstractionsProperties>
+
+    <!-- Do the same for the AbstractionsAssemblyFileVersion property. -->
+    <AbstractionsProperties
+      Condition="'$(AbstractionsAssemblyFileVersion)' != ''">
+      $(AbstractionsProperties);AbstractionsAssemblyFileVersion=$(AbstractionsAssemblyFileVersion)
+    </AbstractionsProperties>
+  </PropertyGroup>
+
+  <Target Name="RestoreAbstractions">
+    <MSBuild
+      Projects="@(Abstractions)"
+      Targets="Restore"
+      Properties="$(AbstractionsProperties)" />
+  </Target>
+
+  <Target Name="BuildAbstractions" DependsOnTargets="RestoreAbstractions">
+    <MSBuild
+      Projects="@(Abstractions)"
+      Targets="Build;Pack"
+      Properties="$(AbstractionsProperties)" />
+  </Target>
+
+  <!-- Azure Targets -->
+  <PropertyGroup>
+    <AzureProperties>$(CommonProperties)</AzureProperties>
+
+    <!--
+      If the AzurePackageVersion property was supplied on the command-line, then
+      pass it along to the Azure build.  Otherwise, omit it entirely to avoid it
+      expanding as empty here and thus overriding the default behaviour in the
+      Azure project.  Command-line properties take precedence over project
+      defaults, even if their value is empty.  For example:
+
+        dotnet build -p:AzurePackageVersion=
+
+      That results in $(AzurePackageVersion) being defined as empty, and cannot
+      be overridden by the project.
+    -->
+    <AzureProperties
+      Condition="'$(AzurePackageVersion)' != ''">
+      $(AzureProperties);AzurePackageVersion=$(AzurePackageVersion)
+    </AzureProperties>
+
+    <!-- Do the same for the AzureAssemblyFileVersion property. -->
+    <AzureProperties
+      Condition="'$(AzureAssemblyFileVersion)' != ''">
+      $(AzureProperties);AzureAssemblyFileVersion=$(AzureAssemblyFileVersion)
+    </AzureProperties>
+  </PropertyGroup>
+
+  <Target Name="RestoreAzure">
+    <MSBuild
+      Projects="@(Azure)"
+      Targets="Restore"
+      Properties="$(AzureProperties)" />
+  </Target>
+
+  <Target Name="BuildAzure" DependsOnTargets="RestoreAzure">
+    <MSBuild
+      Projects="@(Azure)"
+      Targets="Build;Pack"
+      Properties="$(AzureProperties)" />
+  </Target>
+
   <!-- Other Targets -->
   <Target Name="RestoreSqlServerLib">
     <MSBuild Projects="@(SqlServerLib)" Targets="restore" Properties="$(SqlServerLibProperties)" />
   </Target>
 
-  <Target Name="RestoreNetCore" DependsOnTargets="RestoreSqlServerLib">
+  <Target Name="RestoreNetCore" DependsOnTargets="RestoreSqlServerLib;RestoreAbstractions">
     <MSBuild Projects="@(NetCoreDriver)" Targets="restore" Properties="$(ProjectProperties)" />
   </Target>
 
   <Target Name="RestoreTestsNetCore" DependsOnTargets="RestoreNetCore">
     <MSBuild Projects="@(ManualTests)" Targets="restore" Properties="$(TestProjectProperties)" />
   </Target>
 
-  <Target Name="RestoreNetFx" DependsOnTargets="RestoreSqlServerLib" Condition="'$(IsEnabledWindows)' == 'true'">
+  <Target Name="RestoreNetFx" DependsOnTargets="RestoreSqlServerLib;RestoreAbstractions" Condition="'$(IsEnabledWindows)' == 'true'">
     <MSBuild Projects="@(NetFxDriver)" Targets="restore" Properties="$(ProjectProperties)" />
   </Target>
 
@@ -132,7 +219,7 @@
     <MSBuild Projects="@(Tools)" Properties="$(CommonProperties)" />
   </Target>
 
-  <Target Name="BuildNetFx" DependsOnTargets="RestoreNetFx;BuildSqlServerLib" Condition="'$(IsEnabledWindows)' == 'true'">
+  <Target Name="BuildNetFx" DependsOnTargets="RestoreNetFx;BuildSqlServerLib;BuildAbstractions" Condition="'$(IsEnabledWindows)' == 'true'">
     <MSBuild Projects="@(NetFxDriver)" Properties="$(CI);Platform=AnyCPU;$(ProjectProperties);$(NugetPackProperties);" />
   </Target>
 
@@ -149,11 +236,11 @@
     <MSBuild Projects="@(SqlServerLib)" Properties="$(CI);$(SqlServerLibProperties);Platform=$(Platform);" Condition="$(ReferenceType.Contains('Package'))" />
   </Target>
 
-  <Target Name="BuildNetCore" DependsOnTargets="RestoreNetCore;BuildSqlServerLib">
+  <Target Name="BuildNetCore" DependsOnTargets="RestoreNetCore;BuildSqlServerLib;BuildAbstractions">
     <MSBuild Projects="@(NetCoreDriver)" Properties="$(CI);Platform=AnyCPU;$(ProjectProperties)" />
   </Target>
 
-  <Target Name="BuildNetCoreAllOS" DependsOnTargets="RestoreNetCore;BuildSqlServerLib">
+  <Target Name="BuildNetCoreAllOS" DependsOnTargets="RestoreNetCore;BuildSqlServerLib;BuildAbstractions">
     <MSBuild Projects="@(NetCoreDriver)" Properties="$(CI);$(ProjectProperties);Platform=AnyCPU;OSGroup=Unix;" RemoveProperties="TargetsWindows;TargetsUnix;" />
     <MSBuild Projects="@(NetCoreDriver)" Properties="$(CI);$(ProjectProperties);Platform=AnyCPU;OSGroup=Windows_NT;" RemoveProperties="TargetsWindows;TargetsUnix;" Condition="'$(IsEnabledWindows)' == 'true'" />
     <MSBuild Projects="@(NetCoreDriver)" Properties="$(CI);$(ProjectProperties);Platform=AnyCPU;OSGroup=AnyOS;" RemoveProperties="TargetsWindows;TargetsUnix;" />
@@ -214,7 +301,7 @@
       <TestCommand>$([System.Text.RegularExpressions.Regex]::Replace($(TestCommand), "\s+", " "))</TestCommand>
     </PropertyGroup>
     <Message Text=">>> Running unit tests for Windows via command: $(TestCommand)"/>
     <Exec ConsoleToMsBuild="true" Command="$(TestCommand)"/>
   </Target>
 
   <!-- Run all unit tests applicable to Unix. -->
@@ -314,7 +401,7 @@
       <TestCommand>$(TestCommand.Replace($([System.Environment]::NewLine), " "))</TestCommand>
     </PropertyGroup>
     <Message Text=">>> Running Manual test for Windows via command: $(TestCommand)" />
     <Exec ConsoleToMsBuild="true" Command="$(TestCommand)" />
   </Target>
 
   <!-- Run all Manual tests applicable to Unix. -->
@@ -349,6 +436,7 @@
     <RemoveDir Directories='$([System.IO.Directory]::GetDirectories(".", "bin", SearchOption.AllDirectories))' />
     <RemoveDir Directories='$([System.IO.Directory]::GetDirectories(".", ".nuget", SearchOption.AllDirectories))' />
     <RemoveDir Directories='$([System.IO.Directory]::GetDirectories(".", "obj", SearchOption.AllDirectories))' />
+    <RemoveDir Directories='$([System.IO.Directory]::GetDirectories(".","packages", SearchOption.AllDirectories))' />
   </Target>
 
   <!-- AKV Targets ========================================================= -->

eng/pipelines/common/templates/jobs/run-tests-package-reference-job.yml

@@ -67,6 +67,5 @@ jobs:
     parameters:
       referenceType: Package
       buildConfiguration: Release
-      cleanFirst: true
       ${{ if parameters.isPreview }}:
         mdsPackageVersion: $(previewMdsPackageVersion)

eng/pipelines/common/templates/steps/build-and-run-tests-netcore-step.yml

@@ -28,10 +28,6 @@ parameters:
     type: string
     default: $(Platform)
 
-  - name: cleanFirst
-    type: boolean
-    default: false
-
   - name: TestTargetOS
     type: string
     default: Windowsnetcoreapp
@@ -45,13 +41,6 @@ parameters:
     default: 2
 
 steps:
-- ${{ if eq(parameters.cleanFirst, true)}}:
-    - task: MSBuild@1
-      displayName: 'Clean artifacts folder'
-      inputs:
-        solution: build.proj
-        msbuildArguments: '-t:clean'
-
 - task: MSBuild@1
   displayName: 'Build AKV Provider .NET'
   inputs:

eng/pipelines/common/templates/steps/build-and-run-tests-netfx-step.yml

@@ -28,10 +28,6 @@ parameters:
     type: string
     default: $(Platform)
 
-  - name: cleanFirst
-    type: boolean
-    default: false
-
   - name: TestTargetOS
     type: string
     default: Windowsnetfx
@@ -45,13 +41,6 @@ parameters:
     default: 2
 
 steps:
-- ${{ if eq(parameters.cleanFirst, true)}}:
-    - task: MSBuild@1
-      displayName: 'Clean artifacts folder'
-      inputs:
-        solution: build.proj
-        msbuildArguments: '-t:clean'
-
 - task: MSBuild@1
   displayName: 'Build AKV Provider .NET Framework'
   inputs:

eng/pipelines/common/templates/steps/ci-project-build-step.yml

@@ -78,7 +78,6 @@ steps:
             -p:GenerateDocumentationFile=false
             -p:BuildNumber=${{ parameters.buildNumber }}
             -p:MdsPackageVersion=${{ parameters.mdsPackageVersion }}
-          clean: true
 
     - ${{ if or(eq(parameters.build, 'MDS'), eq(parameters.build, 'all')) }}:
       - task: MSBuild@1
@@ -95,7 +94,6 @@ steps:
             -p:GenerateNuget=false
             -p:BuildNumber=${{ parameters.buildNumber }}
             -p:MdsPackageVersion=${{ parameters.mdsPackageVersion }}
-          clean: true
 
   - ${{ if or(eq(parameters.build, 'AKV'), eq(parameters.build, 'all'), eq(parameters.build, 'allNoDocs')) }}:
     - task: MSBuild@1