Add support for optional architecture input for cross-architecture .NET installs (#700)

* fix basic validation with npm command

* Revert "fix basic validation with npm command"

This reverts commit 27a0803.

* add architecture support

* updated installdir logic

* update architecture resolution

* update normalizeArch

Author: priya-kinthali

.github/workflows/e2e-tests.yml

@@ -623,3 +623,38 @@ jobs:
       - name: Verify dotnet
         shell: pwsh
         run: __tests__/verify-dotnet.ps1 -Patterns "^9\.0"
+
+  test-setup-with-architecture-input:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        arch: [x64, arm64]
+        exclude:
+          - os: windows-latest
+            arch: arm64
+          - os: ubuntu-latest
+            arch: arm64
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Clear toolcache
+        shell: pwsh
+        run: __tests__/clear-toolcache.ps1 ${{ runner.os }}
+
+      - name: Setup dotnet (${{ matrix.arch }})
+        uses: ./
+        with:
+          dotnet-version: |
+            8.0.416
+            8.0.x
+            9.0.308
+            10.0.101
+          architecture: ${{ matrix.arch }}
+
+      - name: Verify dotnet
+        shell: pwsh
+        run: __tests__/verify-dotnet.ps1 -Patterns "^8.0.416$", "^9.0.308$", "^10.0.101$", "^8.0"

README.md

@@ -59,6 +59,23 @@ The `dotnet-version` input supports following syntax:
 - **A.B.Cxx** (e.g. 8.0.4xx) - available since `.NET 5.0` release. Installs the latest version of the specific SDK release, including prerelease versions (preview, rc). 
 
 
+## Using the `architecture` input
+Using the architecture input, it is possible to specify the required .NET SDK architecture. Possible values:  `x64`, `x86`, `arm64`, `amd64`, `arm`, `s390x`, `ppc64le`, `riscv64`. If the input is not specified, the architecture defaults to the host OS architecture (not all of the architectures are available on all platforms).
+
+**Example: Install multiple SDK versions for a specific architecture**
+```yml
+steps:
+- uses: actions/checkout@v6
+- name: Setup dotnet (x86)
+  uses: actions/setup-dotnet@v5
+  with:
+    dotnet-version: |
+      8.0.x
+      9.0.x
+    architecture: x86
+- run: dotnet build <my project>
+```
+
 ## Using the `dotnet-quality` input
 This input sets up the action to install the latest build of the specified quality in the channel. The possible values of `dotnet-quality` are: **daily**, **signed**, **validated**, **preview**, **ga**.
 

__tests__/installer.test.ts

@@ -2,6 +2,7 @@ import each from 'jest-each';
 import semver from 'semver';
 import fs from 'fs';
 import fspromises from 'fs/promises';
+import os from 'os';
 import * as exec from '@actions/exec';
 import * as core from '@actions/core';
 import * as io from '@actions/io';
@@ -327,6 +328,143 @@ describe('installer tests', () => {
           );
         });
       }
+
+      it(`should supply 'architecture' argument to the installation script when architecture is provided`, async () => {
+        const inputVersion = '10.0.101';
+        const inputQuality = '' as QualityOptions;
+        const inputArchitecture = 'x64';
+        const stdout = `Fictitious dotnet version ${inputVersion} is installed`;
+
+        getExecOutputSpy.mockImplementation(() => {
+          return Promise.resolve({
+            exitCode: 0,
+            stdout: `${stdout}`,
+            stderr: ''
+          });
+        });
+        maxSatisfyingSpy.mockImplementation(() => inputVersion);
+
+        const dotnetInstaller = new installer.DotnetCoreInstaller(
+          inputVersion,
+          inputQuality,
+          inputArchitecture
+        );
+
+        await dotnetInstaller.installDotnet();
+
+        const callIndex = 1;
+        const scriptArguments = (
+          getExecOutputSpy.mock.calls[callIndex][1] as string[]
+        ).join(' ');
+        const expectedArgument = IS_WINDOWS
+          ? `-Architecture ${inputArchitecture}`
+          : `--architecture ${inputArchitecture}`;
+
+        expect(scriptArguments).toContain(expectedArgument);
+      });
+
+      it(`should NOT supply 'architecture' argument when architecture is not provided`, async () => {
+        const inputVersion = '10.0.101';
+        const inputQuality = '' as QualityOptions;
+        const stdout = `Fictitious dotnet version ${inputVersion} is installed`;
+
+        getExecOutputSpy.mockImplementation(() => {
+          return Promise.resolve({
+            exitCode: 0,
+            stdout: `${stdout}`,
+            stderr: ''
+          });
+        });
+        maxSatisfyingSpy.mockImplementation(() => inputVersion);
+
+        const dotnetInstaller = new installer.DotnetCoreInstaller(
+          inputVersion,
+          inputQuality
+        );
+
+        await dotnetInstaller.installDotnet();
+
+        const callIndex = 1;
+        const scriptArguments = (
+          getExecOutputSpy.mock.calls[callIndex][1] as string[]
+        ).join(' ');
+
+        expect(scriptArguments).not.toContain('--architecture');
+        expect(scriptArguments).not.toContain('-Architecture');
+      });
+
+      it(`should supply 'install-dir' with arch subdirectory for cross-arch install`, async () => {
+        const inputVersion = '10.0.101';
+        const inputQuality = '' as QualityOptions;
+        const inputArchitecture = 'x64';
+        const stdout = `Fictitious dotnet version ${inputVersion} is installed`;
+
+        getExecOutputSpy.mockImplementation(() => {
+          return Promise.resolve({
+            exitCode: 0,
+            stdout: `${stdout}`,
+            stderr: ''
+          });
+        });
+        maxSatisfyingSpy.mockImplementation(() => inputVersion);
+
+        // Mock os.arch() to return a different arch to simulate cross-arch
+        const archSpy = jest.spyOn(os, 'arch').mockReturnValue('arm64');
+
+        const dotnetInstaller = new installer.DotnetCoreInstaller(
+          inputVersion,
+          inputQuality,
+          inputArchitecture
+        );
+
+        await dotnetInstaller.installDotnet();
+
+        const callIndex = 1;
+        const scriptArguments = (
+          getExecOutputSpy.mock.calls[callIndex][1] as string[]
+        ).join(' ');
+
+        const expectedInstallDirFlag = IS_WINDOWS
+          ? '-InstallDir'
+          : '--install-dir';
+
+        expect(scriptArguments).toContain(expectedInstallDirFlag);
+        expect(scriptArguments).toContain(inputArchitecture);
+
+        archSpy.mockRestore();
+      });
+
+      it(`should NOT supply 'install-dir' when architecture matches runner's native arch`, async () => {
+        const inputVersion = '10.0.101';
+        const inputQuality = '' as QualityOptions;
+        const nativeArch = os.arch().toLowerCase();
+        const stdout = `Fictitious dotnet version ${inputVersion} is installed`;
+
+        getExecOutputSpy.mockImplementation(() => {
+          return Promise.resolve({
+            exitCode: 0,
+            stdout: `${stdout}`,
+            stderr: ''
+          });
+        });
+        maxSatisfyingSpy.mockImplementation(() => inputVersion);
+
+        const dotnetInstaller = new installer.DotnetCoreInstaller(
+          inputVersion,
+          inputQuality,
+          nativeArch
+        );
+
+        await dotnetInstaller.installDotnet();
+
+        const callIndex = 1;
+        const scriptArguments = (
+          getExecOutputSpy.mock.calls[callIndex][1] as string[]
+        ).join(' ');
+
+        expect(scriptArguments).not.toContain('--install-dir');
+        expect(scriptArguments).not.toContain('-InstallDir');
+      });
     });
 
     describe('addToPath() tests', () => {
@@ -346,6 +484,32 @@ describe('installer tests', () => {
     });
   });
 
+  describe('normalizeArch() tests', () => {
+    it(`should normalize 'amd64' to 'x64'`, () => {
+      expect(installer.normalizeArch('amd64')).toBe('x64');
+    });
+
+    it(`should normalize 'AMD64' to 'x64' (case-insensitive)`, () => {
+      expect(installer.normalizeArch('AMD64')).toBe('x64');
+    });
+
+    it(`should pass through 'x64' unchanged`, () => {
+      expect(installer.normalizeArch('x64')).toBe('x64');
+    });
+
+    it(`should pass through 'arm64' unchanged`, () => {
+      expect(installer.normalizeArch('arm64')).toBe('arm64');
+    });
+
+    it(`should lowercase 'ARM64'`, () => {
+      expect(installer.normalizeArch('ARM64')).toBe('arm64');
+    });
+
+    it(`should pass through 'x86' unchanged`, () => {
+      expect(installer.normalizeArch('x86')).toBe('x86');
+    });
+  });
+
   describe('DotnetVersionResolver tests', () => {
     describe('createDotnetVersion() tests', () => {
       each([

__tests__/setup-dotnet.test.ts

@@ -2,7 +2,7 @@ import * as core from '@actions/core';
 import fs from 'fs';
 import semver from 'semver';
 import * as auth from '../src/authutil';
-
+import os from 'os';
 import * as setup from '../src/setup-dotnet';
 import {DotnetCoreInstaller, DotnetInstallDir} from '../src/installer';
 import * as cacheUtils from '../src/cache-utils';
@@ -221,5 +221,40 @@ describe('setup-dotnet tests', () => {
       await setup.run();
       expect(restoreCacheSpy).not.toHaveBeenCalled();
     });
+
+    it('should pass valid architecture input to DotnetCoreInstaller', async () => {
+      inputs['dotnet-version'] = ['10.0.101'];
+      inputs['dotnet-quality'] = '';
+      inputs['architecture'] = os.arch().toLowerCase();
+
+      installDotnetSpy.mockImplementation(() => Promise.resolve(''));
+
+      await setup.run();
+      expect(installDotnetSpy).toHaveBeenCalledTimes(1);
+      expect(DotnetInstallDir.addToPath).toHaveBeenCalledTimes(1);
+    });
+
+    it('should work with empty architecture input for auto-detection', async () => {
+      inputs['dotnet-version'] = ['10.0.101'];
+      inputs['dotnet-quality'] = '';
+      inputs['architecture'] = '';
+
+      installDotnetSpy.mockImplementation(() => Promise.resolve(''));
+
+      await setup.run();
+      expect(installDotnetSpy).toHaveBeenCalledTimes(1);
+      expect(DotnetInstallDir.addToPath).toHaveBeenCalledTimes(1);
+    });
+
+    it('should fail the action if unsupported architecture is provided', async () => {
+      inputs['dotnet-version'] = ['10.0.101'];
+      inputs['dotnet-quality'] = '';
+      inputs['architecture'] = 'x688';
+
+      const expectedErrorMessage = `Value 'x688' is not supported for the 'architecture' option. Supported values are: x64, x86, arm64, amd64, arm, s390x, ppc64le, riscv64.`;
+
+      await setup.run();
+      expect(setFailedSpy).toHaveBeenCalledWith(expectedErrorMessage);
+    });
   });
 });

action.yml

@@ -27,6 +27,9 @@ inputs:
   workloads:
     description: 'Optional SDK workloads to install for additional platform support. Examples: wasm-tools, maui, aspire.'
     required: false
+  architecture:
+    description: 'Optional architecture for the .NET install. Supported values: x64, x86, arm64, amd64, arm, s390x, ppc64le, riscv64. If not set, the installer auto-detects the current system architecture.'
+    required: false
 outputs:
   cache-hit:
     description: 'A boolean value to indicate if a cache was hit.'