[DRAFT] Use global.json to restrict .NET SDK use

.config/CredScanSuppressions.json

@@ -1,6 +1,7 @@
 {
   "tool": "Credential Scanner",
-  "suppressions": [
+  "suppressions":
+  [
     {
       "file": "src/Microsoft.Data.SqlClient/tests/tools/TDS/TDS.Servers/TDSServerArguments.cs",
       "justification": "Test projects should be skipped"
@@ -12,6 +13,14 @@
     {
       "file": "doc/samples/SqlConnectionStringBuilder.cs",
       "justification": "Documentation could include sample data and can be ignored"
+    },
+    {
+      "file": "src/Microsoft.Data.SqlClient/tests/UnitTests/Fixtures/AlwaysEncrypted/NativeColumnEncryptionKeyCertificateBaselineFixture.cs",
+      "justification": "Test projects should be skipped"
+    },
+    {
+      "file": "src/Microsoft.Data.SqlClient/tests/UnitTests/Resources/AlwaysEncrypted/NativeColumnEncryptionKeyBaseline/Certificate.pfx",
+      "justification": "Test projects should be skipped"
     }
   ]
 }

.editorconfig

@@ -167,7 +167,9 @@ indent_size = 2
 
 # Shell scripts
 [*.sh]
+indent_size = 2
 end_of_line = lf
 
-[*.{cmd, bat}]
+[*.{bat,cmd,ps1}]
+indent_size = 2
 end_of_line = crlf

.github/workflows/codeql.yml

@@ -60,11 +60,7 @@ jobs:
     - name: Setup .NET Core SDK
       uses: actions/[email protected]
       with:
-        # TODO: Update this to .NET 10 once PR #3686 is complete.
-        # TODO: Replace this with global-json-file once PR #3797 is complete.
-        dotnet-version: 9.x
-        dotnet-quality: ga
-        #global-json-file: global.json
+        global-json-file: global.json
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

BUILDGUIDE.md

@@ -2,6 +2,15 @@
 
 This document provides all the necessary details to build the driver and run tests present in the repository.
 
+## .NET SDK
+
+The projects in this repo require the .NET 10.0 SDK to build.  Please ensure you
+have the latest version of that SDK installed.
+
+Tests and tools may require different .NET Runtimes that may be installed
+independently.  For example, tests targeting .NET 8.0 will need that runtime
+installed.
+
 ## Visual Studio Pre-Requisites
 
 This project should be built with Visual Studio 2019+ for the best compatibility. The required set of components are provided in the below file:

README.md

@@ -27,15 +27,15 @@ When targeting .NET on Windows, a package reference to [Microsoft.Data.SqlClient
 
 | Topic | Link to File |
 | :---- | :------------- |
-| Coding Style | [coding-style.md](/policy/coding-style.md) |
 | Best Practices | [coding-best-practices.md](/policy/coding-best-practices.md) |
-| Review Process | [review-process.md](/policy/review-process.md) |
-| Guidelines for building the driver | [BUILDGUIDE.md](BUILDGUIDE.md) |
-| Guidelines for Contributors | [CONTRIBUTING.md](CONTRIBUTING.md) |
-| Changelog for all driver releases | [CHANGELOG.md](CHANGELOG.md) |
-| Support Policy | [SUPPORT.md](SUPPORT.md) |
+| Build Guide | [BUILDGUIDE.md](/BUILDGUIDE.md) |
+| Changelog | [CHANGELOG.md](CHANGELOG.md) |
 | Code of Conduct | [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) |
+| Coding Style | [coding-style.md](/policy/coding-style.md) |
+| Contributing | [CONTRIBUTING.md](CONTRIBUTING.md) |
 | Copyright Information | [COPYRIGHT.md](COPYRIGHT.md) |
+| Review Process | [review-process.md](/policy/review-process.md) |
+| Support Policy | [SUPPORT.md](SUPPORT.md) |
 
 ## Our Featured Contributors
 

eng/pipelines/common/templates/jobs/ci-build-nugets-job.yml

@@ -46,6 +46,9 @@ jobs:
   - ${{ if ne(parameters.prebuildSteps, '') }}:
     - ${{ parameters.prebuildSteps }} # extra steps to run before the build like downloading sni and the required configuration
 
+  # Install the .NET SDK.
+  - template: /eng/pipelines/steps/install-dotnet.yml@self
+
   - template: ../steps/ci-project-build-step.yml@self
     parameters:
       platform: ${{ parameters.platform }}

eng/pipelines/common/templates/jobs/ci-code-coverage-job.yml

@@ -60,16 +60,12 @@ jobs:
         - pwsh: 'Get-ChildItem env: | Sort-Object Name'
           displayName: '[Debug] List Environment Variables'
 
-      - template: ../steps/ensure-dotnet-version.yml@self
+      # Install the .NET SDK.
+      - template: /eng/pipelines/steps/install-dotnet.yml@self
         parameters:
-            packageType: sdk
-            version: '10.0'
-
-      - template: ../steps/ensure-dotnet-version.yml@self
-        parameters:
-            packageType: runtime
-            version: '9.0'
+          debug: ${{ parameters.debug }}
 
+      # Install additional dotnet tools.
       - pwsh: |
           dotnet tool install --global dotnet-coverage
           dotnet tool install --global dotnet-reportgenerator-globaltool

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

@@ -81,6 +81,11 @@ parameters:
   # The timeout, in minutes, for this job.
   - name: timeout
     type: number
+
+  # True if this is an ARM64 job.
+  - name: isArm64
+    type: boolean
+    default: false
 
 jobs:
 - job: ${{ format('{0}', coalesce(parameters.jobDisplayName, parameters.image, 'unknown_image')) }}
@@ -102,6 +107,15 @@ jobs:
       value: '$(dotnetx86Path)'
 
   steps:
+
+  # Install the .NET SDK and Runtimes.
+  - template: /eng/pipelines/steps/install-dotnet.yml@self
+    parameters:
+      ${{ if parameters.isArm64 }}:
+        architecture: arm64
+      debug: ${{ parameters.debug }}
+      runtimes: ['8.0', '9.0']
+
   - ${{ if ne(parameters.prebuildSteps, '') }}:
     - ${{ parameters.prebuildSteps }} # extra steps to run before the build like downloading sni and the required configuration
 
@@ -121,6 +135,12 @@ jobs:
       }
     displayName: 'Verify Password'
 
+  - ${{ if eq(parameters.buildType, 'Project') }}:
+    - template: ../steps/ci-project-build-step.yml@self
+      parameters:
+        build: allNoDocs
+        buildConfiguration: ${{ parameters.buildConfiguration }}
+
   - ${{ if ne(parameters.configProperties, '{}') }}:
     - template: ../steps/update-config-file-step.yml@self # update config.json file
       parameters:
@@ -253,33 +273,14 @@ jobs:
     # it should be acceptable to just install a specific version in all cases.
     # @TODO: This setup is very confusing. Ideally we should just be utilizing the dotnet installation
     #    earlier in the job. There has to be a cleaner way of doing this.
-    #    As it stands now, we install dotnet LTS if we're running netfx tests, and the appropriate netX
-    #    version if we're running netcore tests. Technically LTS is not supported by the UseDotNet task
-    #    but we know we're using install-dotnet since we're on windows (for now ... this will not work
-    #    forever and needs a serious rethinking).
     - ${{ if ne(variables['dotnetx86RootPath'], '') }}:
-      - ${{ if startswith(parameters.targetFramework, 'net4')}}:
-        - template: ../steps/ensure-dotnet-version.yml
-          parameters:
-            installDir: "$(dotnetx86RootPath)"
-            packageType: "sdk"
-            usePreview: "false"
-            version: "LTS"
-            windowsArchitecture: "x86"
-      - ${{ else }}:
-        - script: |
-            set FrameworkVersion=${{ parameters.targetFramework }}
-            echo %FrameworkVersion%
-            set TrimmedFrameworkVersion=%FrameworkVersion:~3%
-            echo %TrimmedFrameworkVersion%
-            echo ##vso[task.setvariable variable=netVersionX86]%TrimmedFrameworkVersion%
-          displayName: "Trim dotnet version"
-        - template: ../steps/ensure-dotnet-version.yml
-          parameters:
-            installDir: "$(dotnetx86RootPath)"
-            packageType: "sdk"
-            usePreview: "false"
-            version: $(netVersionX86)
+      # Install the .NET SDK and Runtimes for x86.
+      - template: /eng/pipelines/steps/install-dotnet.yml@self
+        parameters:
+          architecture: x86
+          debug: ${{ parameters.debug }}
+          installDir: $(dotnetx86RootPath)
+          runtimes: ['8.0', '9.0']
 
     - template: ../steps/run-all-tests-step.yml@self
       parameters:

eng/pipelines/common/templates/stages/ci-run-tests-stage.yml

@@ -72,6 +72,7 @@ stages:
                       publishTestResults: true
                   configSqlFor: ${{ config.value.configSqlFor }}
                   operatingSystem: ${{ config.value.operatingSystem }}
+                  isArm64: ${{ eq(config.value.isArm64, 'true') }}
                   ${{if ne(config.value.configProperties, '{}') }}:
                     ${{ each x86TF in config.value.configProperties.x86TestTargetFrameworks }}:
                       ${{ if eq(x86TF, targetFramework) }}:
@@ -103,6 +104,7 @@ stages:
                         publishTestResults: true
                     configSqlFor: ${{ config.value.configSqlFor }}
                     operatingSystem: ${{ config.value.operatingSystem }}
+                    isArm64: ${{ eq(config.value.isArm64, 'true') }}
                     ${{if and(eq(usemanagedSNI, false), ne(config.value.configProperties, '{}')) }}:
                       ${{ each x86TF in config.value.configProperties.x86TestTargetFrameworks }}:
                         ${{ if eq(x86TF, targetFramework) }}:

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

@@ -25,34 +25,19 @@ parameters:
     - MSS
 
 steps:
-- task: DownloadSecureFile@1
-  displayName: 'Download Key Pair'
-  inputs:
-    secureFile: netfxKeypair.snk
-    retryCount: 5
-
-- task: UseDotNet@2
-  displayName: 'Use .NET 10.x sdk'
-  inputs:
-    packageType: sdk
-    version: '10.x'
-
-- task: UseDotNet@2
-  displayName: 'Use .NET 9.x runtime'
-  inputs:
-    packageType: runtime
-    version: '9.x'
+  - task: DownloadSecureFile@1
+    displayName: 'Download Key Pair'
+    inputs:
+      secureFile: netfxKeypair.snk
+      retryCount: 5
 
-- task: UseDotNet@2
-  displayName: 'Install .NET 8.x runtime'
-  inputs:
-    packageType: runtime
-    version: '8.x'
+  # Install the .NET SDK.
+  - template: /eng/pipelines/steps/install-dotnet.yml@self
 
-- ${{ if eq(parameters.product, 'MDS') }}:
-  - task: MSBuild@1
-    displayName: 'BuildAllConfigurations using build.proj'
-    inputs:
-      solution: '**/build.proj'
-      configuration: '${{parameters.buildConfiguration }}'
-      msbuildArguments: '-p:AssemblyFileVersion=${{parameters.AssemblyFileVersion }} -t:BuildAllConfigurations -p:GenerateNuget=false -p:SigningKeyPath=$(Agent.TempDirectory)\netfxKeypair.snk'
+  - ${{ if eq(parameters.product, 'MDS') }}:
+    - task: MSBuild@1
+      displayName: 'BuildAllConfigurations using build.proj'
+      inputs:
+        solution: '**/build.proj'
+        configuration: '${{parameters.buildConfiguration }}'
+        msbuildArguments: '-p:AssemblyFileVersion=${{parameters.AssemblyFileVersion }} -t:BuildAllConfigurations -p:GenerateNuget=false -p:SigningKeyPath=$(Agent.TempDirectory)\netfxKeypair.snk'

eng/pipelines/common/templates/steps/ci-prebuild-step.yml

@@ -25,24 +25,6 @@ parameters:
       - Package
 
 steps:
-- template: ensure-dotnet-version.yml
-  parameters:
-    packageType: sdk
-    usePreview: false
-    version: 10.0
-
-- template: ensure-dotnet-version.yml
-  parameters:
-    packageType: runtime
-    usePreview: false
-    version: 9.0
-
-- template: ensure-dotnet-version.yml
-  parameters:
-    packageType: runtime
-    usePreview: false
-    version: 8.0
-
 - ${{if eq(parameters.debug, true)}}:
   - powershell: |
       Get-ChildItem env: | Sort-Object Name
@@ -61,9 +43,3 @@ steps:
     parameters:
       downloadedNugetPath: $(Pipeline.Workspace)\${{parameters.artifactName }}
       debug: ${{ parameters.debug }}
-
-- ${{ else }}: # project
-  - template: ci-project-build-step.yml@self
-    parameters:
-      build: allNoDocs
-      buildConfiguration: ${{ parameters.buildConfiguration }}

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

@@ -37,21 +37,6 @@ parameters:
       - allNoDocs
 
 steps:
-- template: ./ensure-dotnet-version.yml@self
-  parameters:
-      packageType: 'sdk'
-      version: '10.0'
-
-- template: ./ensure-dotnet-version.yml@self
-  parameters:
-      packageType: 'runtime'
-      version: '9.0'
-
-- template: ./ensure-dotnet-version.yml@self
-  parameters:
-      packageType: 'runtime'
-      version: '8.0'
-
 - ${{ if or(eq(parameters.operatingSystem, 'Windows'), eq(parameters.operatingSystem, 'deferedToRuntime')) }}:
   - ${{ if or(eq(parameters.build, 'MDS'), eq(parameters.build, 'all'), eq(parameters.build, 'allNoDocs')) }}:
     - task: MSBuild@1