Merge branch 'main' into auth-params

Author: twsouthwick

BUILDGUIDE.md

@@ -30,6 +30,7 @@ Once the environment is setup properly, execute the desired set of commands belo
 |`RunTests`|Runs the functional and manual tests for the .NET Framework and .NET drivers|
 |`RunFunctionalTests`|Runs just the functional tests for the .NET Framework and .NET drivers|
 |`RunManualTests`|Runs just the manual tests for the .NET Framework and .NET drivers|
+|`BuildAkv`|Builds the Azure Key Vault Provider package for all supported platforms.|
 
 
 ### Parameters

azurepipelines-coverage.yml

@@ -0,0 +1,16 @@
+# Azure DevOps code coverage settings:
+#
+# https://learn.microsoft.com/en-us/azure/devops/pipelines/test/codecoverage-for-pullrequests?view=azure-devops#configuring-coverage-settings
+#
+coverage:
+  # Code coverage status will be posted to pull requests based on targets
+  # defined below.
+  status:
+    # Off by default. When on, details about coverage for each file changed will
+    # be posted as a pull request comment.
+    comments: on
+    # Diff coverage is code coverage only for the lines changed in a pull
+    # request.
+    diff:
+      # Set this to a desired %. Default is 70%.
+      target: 70%

eng/pipelines/common/templates/jobs/build-signed-akv-package-job.yml

@@ -20,7 +20,6 @@ parameters:
     default: MDS
     values:
     - MDS
-    - AKV
     - MSS
 
 steps:
@@ -49,18 +48,3 @@ steps:
       solution: '**/build.proj'
       configuration: '${{parameters.Configuration }}'
       msbuildArguments: '-p:AssemblyFileVersion=${{parameters.AssemblyFileVersion }} -t:BuildAllConfigurations -p:GenerateNuget=false -p:SigningKeyPath=$(Agent.TempDirectory)\netfxKeypair.snk'
-
-- ${{ if eq(parameters.product, 'AKV') }}:
-  - task: MSBuild@1
-    displayName: 'BuildAKVNetFx using build.proj'
-    inputs:
-      solution: '**/build.proj'
-      configuration: '${{parameters.Configuration }}'
-      msbuildArguments: '-p:AssemblyFileVersion=${{parameters.AssemblyFileVersion }} -t:BuildAKVNetFx -p:NugetPackageVersion=${{parameters.packageRefMdsVersion }} -p:ReferenceType=Package -p:SigningKeyPath=$(Agent.TempDirectory)\netfxKeypair.snk'
-
-  - task: MSBuild@1
-    displayName: 'BuildAKVNetCoreAllOS using build.proj'
-    inputs:
-      solution: '**/build.proj'
-      configuration: '${{parameters.Configuration }}'
-      msbuildArguments: '-p:AssemblyFileVersion=${{parameters.AssemblyFileVersion }} -t:BuildAKVNetCoreAllOS -p:NugetPackageVersion=${{parameters.packageRefMdsVersion }} -p:ReferenceType=Package -p:SigningKeyPath=$(Agent.TempDirectory)\netfxKeypair.snk'

eng/pipelines/common/templates/steps/build-all-configurations-signed-dlls-step.yml

@@ -22,7 +22,6 @@ parameters:
     default: MDS
     values:
     - MDS
-    - AKV
     - MSS
 
 steps:
@@ -35,14 +34,6 @@ steps:
         msBuildArchitecture: x64
         setupCommandlinePicker: vs2022
         msBuildCommandline: 'msbuild  ${{parameters.sourceRoot}}\build.proj -p:configuration=Release -p:GenerateNuget=false -p:BuildTools=false -p:SigningKeyPath=$(Agent.TempDirectory)\netfxKeypair.snk'
-  - ${{ if eq(parameters.product, 'AKV') }}:
-    - task: securedevelopmentteam.vss-secure-development-tools.build-task-roslynanalyzers.RoslynAnalyzers@3
-      displayName: 'Guardian Dotnet Analyzers '
-      inputs:
-        msBuildVersion: 17.0
-        msBuildArchitecture: x64
-        setupCommandlinePicker: vs2022
-        msBuildCommandline: 'msbuild  ${{parameters.sourceRoot}}\build.proj -p:configuration=Release -p:GenerateNuget=false -p:BuildTools=false -p:NugetPackageVersion=${{parameters.packageRefMdsVersion }} -p:ReferenceType=Package -t:BuildAKVNetCoreAllOS -p:SigningKeyPath=$(Agent.TempDirectory)\netfxKeypair.snk'
 
 - ${{ if or(eq(parameters.analyzeType, 'inspect'), eq(parameters.analyzeType, 'all')) }}:
   - task: securedevelopmentteam.vss-secure-development-tools.build-task-codeinspector.CodeInspector@2

eng/pipelines/common/templates/steps/code-analyze-step.yml

@@ -33,7 +33,6 @@ parameters:
     default: MDS
     values:
     - MDS
-    - AKV
     - MSS
 
 steps:
@@ -80,23 +79,6 @@ steps:
         Get-Location
       displayName: 'Prepare ${{ targetFramework }} Artifacts for Testing'
 
-  - ${{ if eq(parameters.product, 'AKV') }}:
-    - powershell: |
-        $software = '${{parameters.softwareFolder}}'
-        $tf = '${{ targetFramework }}'
-        md $software\win\$tf
-        
-        Copy-Item "artifacts\${{parameters.referenceType }}\bin\Windows_NT\${{parameters.Configuration }}.AnyCPU\AzureKeyVaultProvider\$tf\Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.dll" "$software\win\$tf" -recurse
-        
-        $symbols = '${{parameters.symbolsFolder}}'
-        md $symbols\win\$tf
-        
-        Copy-Item "artifacts\${{parameters.referenceType }}\bin\Windows_NT\${{parameters.Configuration }}.AnyCPU\AzureKeyVaultProvider\$tf\Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.pdb" "$symbols\win\$tf" -recurse
-            
-        Write-Host "Artifacts fetched for testing"
-        Get-Location
-      displayName: 'Prepare ${{ targetFramework }} Artifacts for Testing'
-
 - powershell: |
     $software = '${{parameters.softwareFolder}}'
     $symbols = '${{parameters.symbolsFolder}}'

eng/pipelines/common/templates/steps/copy-dlls-for-test-step.yml

@@ -0,0 +1,81 @@
+#################################################################################
+# Licensed to the .NET Foundation under one or more agreements.                 #
+# The .NET Foundation licenses this file to you under the MIT license.          #
+# See the LICENSE file in the project root for more information.                #
+#################################################################################
+
+parameters:
+- name: SNIVersion
+  type: string
+
+- name: SNIValidationFeed
+  type: string
+
+steps:
+- task: PowerShell@2
+  displayName: Add SNI Validation Feed in Nuget.config
+  inputs:
+    targetType: inline
+    script: |
+      Write-Host "SNI validation feed to use = ${{parameters.SNIValidationFeed}}"
+
+      # define file to update
+      $NugetCfg = Join-Path -Path '.' -ChildPath 'NuGet.config'
+      type $NugetCfg
+            
+      # load content of xml from file defined above
+      $xml = New-Object XML
+      $xml.Load($NugetCfg)
+              
+      # define namespace used to read a node
+      $nsm = New-Object Xml.XmlNamespaceManager($xml.NameTable)
+      $nsm.AddNamespace('ns', $xml.DocumentElement.NamespaceURI)
+              
+      # get the package sources node
+      $packageSources = $xml.SelectSingleNode('//ns:packageSources', $nsm)
+              
+      # define new package source
+      $newSource = $xml.CreateElement("add")
+      $newSource.SetAttribute("key","SNIValidation")
+      $newSource.SetAttribute("value","${{parameters.SNIValidationFeed}}")
+              
+      # add the new package source
+      $packageSources.AppendChild($newSource)
+              
+      # save the xml file
+      $xml.Save($NugetCfg)
+      type $NugetCfg
+- task: PowerShell@2
+  displayName: Update SNI Version in Versions.props
+  inputs:
+    targetType: inline
+    script: |
+      Write-Host "SNI Version to test = ${{parameters.SNIVersion}}"
+
+      # define file to update
+      $PropsPath = Join-Path -Path '.' -ChildPath 'tools\props\Versions.props'
+      type $PropsPath
+
+      # load content of xml from file defined above
+      $xml = New-Object XML
+      $xml.Load($PropsPath)
+
+      # define namespace used to read a node 
+      $nsm = New-Object Xml.XmlNamespaceManager($xml.NameTable)
+      $nsm.AddNamespace('ns', $xml.DocumentElement.NamespaceURI)
+
+      # update the node inner text for netfx
+      $netFxSniVersion = $xml.SelectSingleNode('//ns:MicrosoftDataSqlClientSniVersion', $nsm)
+      Write-Host "Current .NET Framework SNI Version = $($netFxSniVersion.InnerText)"
+      $netFxSniVersion.InnerText = "${{parameters.SNIVersion}}"
+
+      # update the node inner text for net core
+      $netCoreSniVersion = $xml.SelectSingleNode('//ns:MicrosoftDataSqlClientSNIRuntimeVersion', $nsm)
+      Write-Host "Current .NET Core SNI Version = $($netCoreSniVersion.InnerText)"
+      $netCoreSniVersion.InnerText = "${{parameters.SNIVersion}}"
+
+      # save the xml file
+      $xml.Save($PropsPath)
+      type $PropsPath
+- task: NuGetAuthenticate@1
+  displayName: 'NuGet Authenticate with SNI Validation Feed'

eng/pipelines/common/templates/steps/override-sni-version.yml

@@ -45,7 +45,6 @@ parameters:
     default: MDS
     values:
     - MDS
-    - AKV
     - MSS
 
 steps:
@@ -71,24 +70,6 @@ steps:
       Pat: $(System.AccessToken)
     condition: and(succeeded(), ${{ eq(parameters.publishSymbols, 'true') }})
 
-- ${{ if eq(parameters.product, 'AKV') }}:
-  - task: PublishSymbols@2
-    displayName: 'Upload symbols to ${{parameters.SymAccount }} org'
-    inputs:
-      SymbolsFolder: '$(Build.SourcesDirectory)\artifacts\${{parameters.referenceType }}\bin'
-      SearchPattern: |
-        Windows_NT/$(Configuration).AnyCPU/AzureKeyVaultProvider/**/Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.pdb
-        AnyOS/$(Configuration).AnyCPU/AzureKeyVaultProvider/**/Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider.pdb
-      IndexSources: false
-      SymbolServerType: TeamServices
-      SymbolsMaximumWaitTime: 60
-      SymbolExpirationInDays: 1825 # 5 years
-      SymbolsProduct: Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider
-      SymbolsVersion: ${{parameters.symbolsVersion }}
-      SymbolsArtifactName: ${{parameters.symbolsArtifactName }}
-      Pat: $(System.AccessToken)
-    condition: and(succeeded(), ${{ eq(parameters.publishSymbols, 'true') }})
-
 - task: AzureCLI@2
   displayName: 'Publish symbols'
   condition: and(succeeded(), ${{ eq(parameters.publishSymbols, 'true') }})

eng/pipelines/common/templates/steps/publish-symbols-step.yml

@@ -41,6 +41,18 @@ parameters:
   type: object
   default: [false, true]
 
+- name: SNIVersion
+  displayName: |
+    SNI Version Override
+  type: string
+  default: ''
+
+- name: SNIValidationFeed
+  displayName: |
+    SNI Version Override Nuget Feed
+  type: string
+  default: https://sqlclientdrivers.pkgs.visualstudio.com/ADO.Net/_packaging/SNIValidation/nuget/v3/index.json
+
 - name: codeCovTargetFrameworks
   displayName: 'Code Coverage Target Frameworks'
   type: object
@@ -73,6 +85,12 @@ stages:
     - template: common/templates/jobs/ci-build-nugets-job.yml@self
       parameters:
         artifactName: $(artifactName)
+        ${{if ne(parameters.SNIVersion, '')}}:
+          prebuildSteps:
+            - template: common/templates/steps/override-sni-version.yml@self
+              parameters:
+                SNIVersion: ${{parameters.SNIVersion}}
+                SNIValidationFeed: ${{parameters.SNIValidationFeed}}
 
   - template: common/templates/stages/ci-run-tests-stage.yml@self
     parameters:
@@ -81,12 +99,24 @@ stages:
       ${{ if eq(parameters.buildType, 'Package') }}:
         dependsOn: build_nugets
 
-      prebuildSteps: # steps to run prior to building and running tests on each job
-      - template: common/templates/steps/ci-prebuild-step.yml@self
-        parameters:
-          debug: ${{ parameters.debug }}
-          artifactName: $(artifactName)
-          buildType: ${{ parameters.buildType }}
+      ${{if ne(parameters.SNIVersion, '')}}:
+        prebuildSteps: # steps to run prior to building and running tests on each job
+          - template: common/templates/steps/override-sni-version.yml@self
+            parameters:
+              SNIVersion: ${{parameters.SNIVersion}}
+              SNIValidationFeed: ${{parameters.SNIValidationFeed}}
+          - template: common/templates/steps/ci-prebuild-step.yml@self
+            parameters:
+              debug: ${{ parameters.debug }}
+              artifactName: $(artifactName)
+              buildType: ${{ parameters.buildType }}
+      ${{else}}:
+        prebuildSteps: # steps to run prior to building and running tests on each job
+          - template: common/templates/steps/ci-prebuild-step.yml@self
+            parameters:
+              debug: ${{ parameters.debug }}
+              artifactName: $(artifactName)
+              buildType: ${{ parameters.buildType }}
 
       ${{ if eq(parameters.buildType, 'Project') }}: # only run the code coverage job if the build type is project
         postTestJobs: # jobs to run after the tests are done

eng/pipelines/dotnet-sqlclient-ci-core.yml

@@ -45,11 +45,6 @@ parameters: # parameters are shown up in ADO UI in a build queue time
   type: boolean
   default: false
 
-- name: MDS_PackageRef_Version
-  displayName: 'MDS package version of AKV Provider (build AKV)'
-  type: string
-  default: 5.1.5
-
 - name: CurrentNetFxVersion
   displayName: 'Lowest supported .NET Framework version (MDS validation)'
   type: string
@@ -73,8 +68,6 @@ variables:
     value: drop_buildMDS_build_signed_package
   - name: PublishSymbols
     value: ${{ parameters['publishSymbols'] }}
-  - name: MDS_PackageRef_Version
-    value: ${{ parameters['MDS_PackageRef_Version'] }}
   - name: CurrentNetFxVersion
     value: ${{ parameters['CurrentNetFxVersion'] }}
 
@@ -130,15 +123,6 @@ extends:
         tsaOptionsPath: $(REPOROOT)\.config\tsaoptions.json
         disableLegacyManifest: true
     stages:
-    - stage: buildAKV
-      displayName: 'Build AKV Provider'
-      jobs:
-      - template: eng/pipelines/common/templates/jobs/build-signed-akv-package-job.yml@self
-        parameters:
-          symbolsFolder: $(symbolsFolder)
-          softwareFolder: $(softwareFolder)
-          publishSymbols: ${{ parameters['publishSymbols'] }}
-
     - stage: buildMDS
       displayName: 'Build MDS'
       jobs: