Pipelines | Fix dotnet Installation on ARM64 (#3175)

benrr101 · MichelZ · web-flow · commit 93b6be2106d9 · 2025-04-25T11:46:03.000-05:00
* Use script to install .NET because of ARM bug

* YAML

* Add back steps:

* Fix name

* Try without ./

* Maybe they need to hang back a level

* Replace CURL

* Switch to powershell

* Need a Windows &amp; non-Windows version

* YAML

* Use .0 for WIndows and .X for other

* Update install command to include Quality and only install Runtime when SDK is false

* Improve way to specify SDK vs Runtime

* Make it a string

* Use whole number only

* We don't need to use "

* Add additional options, make output cleaner

* Runtime variables like Agent.OS do not work

* Path to ensure-dotnet-version

* Condition not possible on template

* Improve version detection

* String

* booleans...

* Use SDK for X86, use installDir

* InstallDir

* PS String comparison

* Cosmetics

* Add new steps to sln, formatting

* Cleaning up dotnet install task.

* Fixing call to the new task

* Same operation in a different file

* Default to LTS ?

* Version vs channel is kind of annoying

* Fix logic for determining which task to use, just always using 9.x

* ???

* Reinstate installing dotnet as part of ci-project-build-steps
Replace remaining CI usages of UseDotNet with ensure-dotnet-version

* Just don't use preview builds.

* Debug agent OS

* debug part 2

* Debug part 3?

* DEBUG PART 4.

* This should be the right way to get the agent os. Powershell task should be running on windows.

* Isn't this what I had originally?

* Ok but if that's right, then why won't the powershell task run?

* Well I'm dumb. Can't use templates with a runtime variable.

* More quotes.

* Replace 9.x and 8.x with 9.0 and 8.0, append .x to end of UseDotNetTask version param, add more notes about what is and isn't supported from version parameter.

* shouldn't have the $

* Very hacky attempt at fixing x86 dotnet installation for test runtime

* Make x86 version variable be loaded during runtime

* One more time ...

---------

Co-authored-by: Michel Zehnder &lt;MichelZ@users.noreply.github.com&gt;
diff --git a/eng/pipelines/common/templates/jobs/ci-code-coverage-job.yml b/eng/pipelines/common/templates/jobs/ci-code-coverage-job.yml
@@ -44,10 +44,10 @@ jobs:
   - task: NuGetAuthenticate@1
     displayName: 'NuGet Authenticate'
 
-  - task: UseDotNet@2
-    displayName: 'Use .NET SDK 8.0.x'
-    inputs:
-      version: 8.0.x
+  - template: ../steps/ensure-dotnet-version.yml@self
+    parameters:
+        packageType: 'sdk'
+        version: '8.0'
 
   - ${{ parameters.downloadArtifactsSteps }}
 
diff --git a/eng/pipelines/common/templates/jobs/ci-run-tests-job.yml b/eng/pipelines/common/templates/jobs/ci-run-tests-job.yml
@@ -231,26 +231,41 @@ jobs:
         referenceType: ${{ parameters.buildType }}
         testSet: ${{ parameters.testSet }}
         operatingSystem: ${{ parameters.operatingSystem }}
-  
-  - ${{ if and(eq(parameters.enableX86Test, true), eq(parameters.operatingSystem, 'Windows')) }}: # run x86 tests
-    - powershell: |
-        dotnet --info
-        
-        Invoke-WebRequest https://builds.dotnet.microsoft.com/dotnet/scripts/v1/dotnet-install.ps1 -OutFile dotnet-install.ps1
-        
-        # install .net x86
-        $version = "LTS"
-        if (!"${{parameters.targetFramework }}".StartsWith("net4"))
-        {
-            $version = "${{parameters.targetFramework }}".Substring(3, "${{parameters.targetFramework }}".Length-3)
-        }
-        
-        .\dotnet-install.ps1 -Channel $version -Architecture x86 -InstallDir "$(dotnetx86RootPath)"
-        
-        $(dotnetx86RootPath)dotnet.exe --info
-      displayName: 'Install .NET x86 '
-      condition: ne(variables['dotnetx86RootPath'], '')
-  
+
+  - ${{ if and(eq(parameters.enableX86Test, true), eq(parameters.operatingSystem, 'Windows')) }}:
+    # Set up for x86 tests by manually installing dotnet for x86 to an alternative location. This
+    # is only used to execute the test runtime (framework to test is specified in build params), so
+    # 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)
+
     - template: ../steps/run-all-tests-step.yml@self
       parameters:
         debug: ${{ parameters.debug }}
diff --git a/eng/pipelines/common/templates/steps/ci-prebuild-step.yml b/eng/pipelines/common/templates/steps/ci-prebuild-step.yml
@@ -20,17 +20,17 @@ parameters:
       - Package
 
 steps:
-- task: UseDotNet@2
-  displayName: 'Use .NET 9.x sdk'
-  inputs:
+- template: ensure-dotnet-version.yml
+  parameters:
     packageType: sdk
-    version: '9.x'
+    usePreview: false
+    version: 9.0
 
-- task: UseDotNet@2
-  displayName: 'Install .NET 8.x runtime'
-  inputs:
+- template: ensure-dotnet-version.yml
+  parameters:
     packageType: runtime
-    version: '8.x'
+    usePreview: false
+    version: 8.0
 
 - ${{if eq(parameters.debug, true)}}:
   - powershell: |
diff --git a/eng/pipelines/common/templates/steps/ci-project-build-step.yml b/eng/pipelines/common/templates/steps/ci-project-build-step.yml
@@ -35,17 +35,15 @@ parameters:
       - allNoDocs
 
 steps:
-- task: UseDotNet@2
-  displayName: 'Use .NET 9.x sdk'
-  inputs:
-    packageType: sdk
-    version: '9.x'
+- template: ./ensure-dotnet-version.yml@self
+  parameters:
+      packageType: 'sdk'
+      version: '9.0'
 
-- task: UseDotNet@2
-  displayName: 'Install .NET 8.x runtime'
-  inputs:
-    packageType: runtime
-    version: '8.x'
+- 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')) }}:
diff --git a/eng/pipelines/common/templates/steps/ensure-dotnet-version.yml b/eng/pipelines/common/templates/steps/ensure-dotnet-version.yml
@@ -0,0 +1,108 @@
+#################################################################################
+# 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.                #
+#################################################################################
+
+# Installs dotnet sdk/runtime using UseDotNet on non-windows agents, but uses a custom ps script
+# for installation on Windows.
+# 
+# Reason for not using UseDotNet task:
+#   [BUG]: UseDotNet task installs x86 build on Windows arm64
+#   https://github.com/microsoft/azure-pipelines-tasks/issues/20300
+
+parameters:
+    - # Directory where dotnet binaries should be installed. If not specified, defaults to the
+      # agent's tools directory.
+      name: installDir
+      type: string
+      default: ''
+
+    - # Whether to install the full SDK or the "dotnet" runtime
+      name: packageType
+      type: string
+      values:
+          - runtime
+          - sdk
+    
+    - # Whether to enable preview versions of dotnet
+      name: usePreview
+      type: boolean
+      default: false
+      
+    - # Version to install - supports full major.minor.patch, but can be shortened to major.minor
+      # to get the latest within a given channel. Do not append .x to the end (as per UseDotNet),
+      # it is not supported by dotnet-install script, and we will add it if we use UseDotNet task.
+      name: version
+      type: string
+      
+    - # Specifies the architecture to install, only applies on Windows agents. If not provided,
+      # defaults to the same architecture as the agent.
+      name: windowsArchitecture
+      type: string
+      default: '<auto>'
+      values:
+          - '<auto>'
+          - 'x86'
+          - 'x64'
+          - 'arm64'
+
+steps:
+    # Note: as much as I'd love to use template expressions here, I can't because ${{ }} is
+    #     evaluated at compile time, while Agent is not known until runtime.
+    - powershell: |-
+          # Propagate parameters from pipeline #######################
+          $agentToolsDir = '$(Agent.ToolsDirectory)'
+          echo "agentToolsDir= $agentToolsDir"
+          
+          $architecture = '${{ parameters.windowsArchitecture }}'
+          echo "architecture= $architecture"
+          
+          $installDir = '${{ parameters.installDir }}'
+          echo "installDir= $installDir"
+          
+          $packageType = '${{ parameters.packageType }}'
+          echo "packageType= $packageType"
+          
+          $usePreview = '${{ parameters.usePreview }}'
+          echo "usePreview= $usePreview"
+          
+          $version = '${{ parameters.version }}'
+          echo "version= $version"
+          
+          # Install dotnet ###########################################
+          Invoke-WebRequest -Uri "https://builds.dotnet.microsoft.com/dotnet/scripts/v1/dotnet-install.ps1" -OutFile "dotnet-install.ps1"
+          
+          $installDir = If ($installDir) { $installDir } Else { $agentToolsDir } 
+          $installParams = @{
+              Architecture = $architecture
+              Channel =      $version
+              InstallDir =   $installDir
+              Quality =      If ($usePreview) { "GA" } Else { "preview" }
+          }
+          
+          if ($packageType -eq 'runtime') {
+              $installParams.add('Runtime', 'dotnet')
+          }
+          
+          & ./dotnet-install.ps1 @installParams
+          Remove-Item dotnet-install.ps1 -ErrorAction:Ignore
+          
+          # Propagate values back out to pipeline ####################
+          Write-Host "##vso[task.setvariable variable=DOTNET_ROOT]${installDir}"
+          Write-Host "##vso[task.prependpath]${installDir}"
+      displayName: 'Install dotnet ${{ parameters.version }} ${{ parameters.packageType }} for Windows ${{ parameters.windowsArchitecture }}'
+      condition: eq(variables['Agent.OS'], 'Windows_NT')
+
+    - task: UseDotNet@2
+      displayName: 'Install dotnet ${{ parameters.version }} ${{ parameters.packageType }}'
+      inputs:
+          ${{ if ne(parameters.installDir, '') }}:
+              installationPath: '${{ parameters.installDir }}'
+          ${{ else }}:
+              installationPath: '$(Agent.ToolsDirectory)'
+          packageType: '${{ parameters.packageType }}'
+          version: '${{ parameters.version }}.x'
+
+          includePreviewVersions: '${{ parameters.usePreview }}'
+      condition: ne(variables['Agent.OS'], 'Windows_NT')
diff --git a/eng/pipelines/common/templates/steps/pre-build-step.yml b/eng/pipelines/common/templates/steps/pre-build-step.yml
@@ -4,17 +4,15 @@
 # See the LICENSE file in the project root for more information.                #
 #################################################################################
 steps:
-- task: UseDotNet@2
-  displayName: 'Use .NET 9.x sdk'
-  inputs:
-    packageType: sdk
-    version: '9.x'
+- template: ./ensure-dotnet-version.yml@self
+  parameters:
+    packageType: 'sdk'
+    version: '9.0'
 
-- task: UseDotNet@2
-  displayName: 'Install .NET 8.x runtime'
-  inputs:
-    packageType: runtime
-    version: '8.x'
+- template: ./ensure-dotnet-version.yml@self
+  parameters:
+    packageType: 'runtime'
+    version: '8.0'
 
 - script: SET
   displayName: 'Print Environment Variables'
diff --git a/src/Microsoft.Data.SqlClient.sln b/src/Microsoft.Data.SqlClient.sln
@@ -270,6 +270,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "steps", "steps", "{EABE3A3E
 		..\eng\pipelines\common\templates\steps\run-all-tests-step.yml = ..\eng\pipelines\common\templates\steps\run-all-tests-step.yml
 		..\eng\pipelines\common\templates\steps\update-config-file-step.yml = ..\eng\pipelines\common\templates\steps\update-config-file-step.yml
 		..\eng\pipelines\common\templates\steps\update-nuget-config-local-feed-step.yml = ..\eng\pipelines\common\templates\steps\update-nuget-config-local-feed-step.yml
+		..\eng\pipelines\common\templates\steps\configure-sql-server-macos-step.yml = ..\eng\pipelines\common\templates\steps\configure-sql-server-macos-step.yml
+		..\eng\pipelines\common\templates\steps\ensure-dotnet-version.yml = ..\eng\pipelines\common\templates\steps\ensure-dotnet-version.yml
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "libraries", "libraries", "{75BAE755-3A1F-41F2-9176-9F8FF9FEE2DD}"
