Skip to content

Add --arch option for --list-runtimes and --list-sdks in host #116078

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 3, 2025
Merged

Add --arch option for --list-runtimes and --list-sdks in host #116078

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1e3d128
Add --arch option for --list-runtimes and --list-sdks in host
elinor-fung May 27, 2025
5b55c3b
Add tests
elinor-fung May 27, 2025
f0aadc7
Put new tests in HostCommands test class
elinor-fung May 27, 2025
bdcc21a
Move existing host command tests to HostCommands class
elinor-fung May 27, 2025
fa0fac4
Let test override for default install path apply to all architectures
elinor-fung May 27, 2025
7f04627
Add tests for default install location, no registered location
elinor-fung May 28, 2025
0e3aca8
PR feedback
elinor-fung May 28, 2025
f7e6314
Update usage text
elinor-fung Jun 2, 2025
dfbb435
Add test for invalid architecture
elinor-fung Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 0 additions & 48 deletions src/installer/tests/HostActivation.Tests/DotnetArgValidation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

using System;
using System.IO;
using System.Text;
using Microsoft.DotNet.Cli.Build;
using Microsoft.DotNet.TestUtils;
using Xunit;

Expand Down Expand Up @@ -83,52 +81,6 @@ public void InvalidFileOrCommand_NoSDK_ListsPossibleIssues()
.And.FindAnySdk(false);
}

[Fact]
public void DotNetInfo_NoSDK()
{
TestContext.BuiltDotNet.Exec("--info")
.CaptureStdOut()
.CaptureStdErr()
.Execute()
.Should().Pass()
.And.HaveStdOutMatching($@"Architecture:\s*{TestContext.BuildArchitecture}")
.And.HaveStdOutMatching($@"RID:\s*{TestContext.BuildRID}");
}

[Fact]
public void DotNetInfo_Utf8Path()
{
string installLocation = Encoding.UTF8.GetString("utf8-龯蝌灋齅ㄥ䶱"u8);
DotNetCli dotnet = new DotNetBuilder(sharedTestState.BaseDirectory.Location, TestContext.BuiltDotNet.BinPath, installLocation)
.Build();

var result = dotnet.Exec("--info")
.DotNetRoot(Path.Combine(sharedTestState.BaseDirectory.Location, installLocation))
.CaptureStdErr()
.CaptureStdOut(Encoding.UTF8)
.Execute();

result.Should().Pass()
.And.HaveStdOutMatching($@"DOTNET_ROOT.*{installLocation}");
}

[Fact]
public void DotNetInfo_WithSDK()
{
DotNetCli dotnet = new DotNetBuilder(sharedTestState.BaseDirectory.Location, TestContext.BuiltDotNet.BinPath, "withSdk")
.AddMicrosoftNETCoreAppFrameworkMockHostPolicy("1.0.0")
.AddMockSDK("1.0.0", "1.0.0")
.Build();

dotnet.Exec("--info")
.WorkingDirectory(sharedTestState.BaseDirectory.Location)
.CaptureStdOut()
.CaptureStdErr()
.Execute()
.Should().Pass()
.And.NotHaveStdOutMatching($@"RID:\s*{TestContext.BuildRID}");
}

// Return a non-existent path that contains a mix of / and \
private string GetNonexistentAndUnnormalizedPath()
{
Expand Down
49 changes: 0 additions & 49 deletions src/installer/tests/HostActivation.Tests/FrameworkResolution/MultipleHives.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,55 +138,6 @@ private List<FrameworkInfo> GetExpectedFrameworks(bool? multiLevelLookup)
return expectedList;
}

[Theory]
[InlineData(true)]
[InlineData(null)]
[InlineData(false)]
public void ListRuntimes(bool? multiLevelLookup)
{
// Multi-level lookup is only supported on Windows.
if (!OperatingSystem.IsWindows() && multiLevelLookup != false)
return;

string expectedOutput = string.Join(
string.Empty,
GetExpectedFrameworks(false) // MLL Is always disabled for dotnet --list-runtimes
.Select(t => $"{MicrosoftNETCoreApp} {t.Version} [{Path.Combine(t.Path, "shared", MicrosoftNETCoreApp)}]{Environment.NewLine}"));

// !!IMPORTANT!!: This test verifies the exact match of the entire output of the command (not a substring!)
// This is important as the output of --list-runtimes is considered machine readable and thus must not change even in a minor way (unintentionally)
RunTest(
new TestSettings().WithCommandLine("--list-runtimes"),
multiLevelLookup,
testApp: null)
.Should().HaveStdOut(expectedOutput)
.And.HaveStdErrContaining("Ignoring FX version [9999.9.9] without .deps.json");
}

[Theory]
[InlineData(true)]
[InlineData(null)]
[InlineData(false)]
public void DotnetInfo(bool? multiLevelLookup)
{
// Multi-level lookup is only supported on Windows.
if (!OperatingSystem.IsWindows() && multiLevelLookup != false)
return;

string expectedOutput =
$".NET runtimes installed:{Environment.NewLine}" +
string.Join(string.Empty,
GetExpectedFrameworks(false) // MLL is always disabled for dotnet --info
.Select(t => $" {MicrosoftNETCoreApp} {t.Version} [{Path.Combine(t.Path, "shared", MicrosoftNETCoreApp)}]{Environment.NewLine}"));

RunTest(
new TestSettings().WithCommandLine("--info"),
multiLevelLookup,
testApp: null)
.Should().HaveStdOutContaining(expectedOutput)
.And.HaveStdErrContaining("Ignoring FX version [9999.9.9] without .deps.json");
}

[Theory]
[InlineData("net6.0", true, true)]
[InlineData("net6.0", null, true)]
Expand Down
269 changes: 269 additions & 0 deletions src/installer/tests/HostActivation.Tests/HostCommands.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,269 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.IO;
using System.Linq;
using System.Text;
using Microsoft.DotNet.Cli.Build;
using Microsoft.DotNet.CoreSetup.Test;
using Microsoft.DotNet.CoreSetup.Test.HostActivation;
using Xunit;

namespace HostActivation.Tests
{
public class HostCommands : IClassFixture<HostCommands.SharedTestState>
{
private SharedTestState SharedState { get; }

public HostCommands(SharedTestState sharedState)
{
SharedState = sharedState;
}

[Fact]
public void Info()
{
string expectedSdksOutput =
$"""
.NET SDKs installed:
{GetListSdksOutput(SharedState.DotNet.BinPath, SharedState.InstalledVersions, " ")}
""";
string expectedRuntimesOutput =
$"""
.NET runtimes installed:
{GetListRuntimesOutput(SharedState.DotNet.BinPath, SharedState.InstalledVersions, " ")}
""";
SharedState.DotNet.Exec("--info")
.CaptureStdOut()
.Execute()
.Should().Pass()
.And.HaveStdOutContaining(expectedSdksOutput)
.And.HaveStdOutContaining(expectedRuntimesOutput)
.And.HaveStdOutMatching($@"Architecture:\s*{TestContext.BuildArchitecture}")
// If an SDK exists, we rely on it to print the RID. The host should not print it again.
.And.NotHaveStdOutMatching($@"RID:\s*{TestContext.BuildRID}");
}

[Fact]
public void Info_NoSDK()
{
string expectedSdksOutput =
"""
.NET SDKs installed:
No SDKs were found
""";
string expectedRuntimesOutput =
$"""
.NET runtimes installed:
{GetListRuntimesOutput(TestContext.BuiltDotNet.BinPath, [TestContext.MicrosoftNETCoreAppVersion], " ")}
""";
TestContext.BuiltDotNet.Exec("--info")
.CaptureStdOut()
.Execute()
.Should().Pass()
.And.HaveStdOutContaining(expectedSdksOutput)
.And.HaveStdOutContaining(expectedRuntimesOutput)
.And.HaveStdOutMatching($@"Architecture:\s*{TestContext.BuildArchitecture}")
.And.HaveStdOutMatching($@"RID:\s*{TestContext.BuildRID}");
}

[Fact]
public void Info_Utf8Path()
{
string installLocation = Encoding.UTF8.GetString("utf8-龯蝌灋齅ㄥ䶱"u8);
DotNetCli dotnet = new DotNetBuilder(SharedState.Artifact.Location, TestContext.BuiltDotNet.BinPath, installLocation)
.Build();

dotnet.Exec("--info")
.DotNetRoot(Path.Combine(SharedState.Artifact.Location, installLocation))
.CaptureStdOut(Encoding.UTF8)
.Execute()
.Should().Pass()
.And.HaveStdOutMatching($@"DOTNET_ROOT.*{installLocation}");
}

[Fact]
public void ListRuntimes()
{
// Verify exact match of command output. The output of --list-runtimes is intended to be machine-readable
// and must not change in a way that breaks existing parsing.
string expectedOutput = GetListRuntimesOutput(SharedState.DotNet.BinPath, SharedState.InstalledVersions);
SharedState.DotNet.Exec("--list-runtimes")
.CaptureStdOut()
.Execute()
.Should().Pass()
.And.HaveStdOut(expectedOutput);
}

[Theory]
[InlineData(true)]
[InlineData(false)]
public void ListRuntimes_OtherArchitecture(bool useRegisteredLocation)
{
using (var registeredInstallLocationOverride = new RegisteredInstallLocationOverride(SharedState.DotNet.GreatestVersionHostFxrFilePath))
{
if (useRegisteredLocation)
{
registeredInstallLocationOverride.SetInstallLocation(SharedState.OtherArchInstallLocations);
}

foreach ((string arch, string installLocation) in SharedState.OtherArchInstallLocations)
{
// Verify exact match of command output. The output of --list-runtimes is intended to be machine-readable
// and must not change in a way that breaks existing parsing.
string expectedOutput = GetListRuntimesOutput(installLocation, SharedState.InstalledVersions);
SharedState.DotNet.Exec("--list-runtimes", "--arch", arch)
.ApplyRegisteredInstallLocationOverride(registeredInstallLocationOverride)
.EnvironmentVariable(Constants.TestOnlyEnvironmentVariables.DefaultInstallPath, useRegisteredLocation ? null : installLocation)
.CaptureStdOut()
.Execute()
.Should().Pass()
.And.HaveStdOut(expectedOutput);
}
}
}

[Fact]
public void ListRuntimes_OtherArchitecture_NoInstalls()
{
// Non-host architecture - arm64 if current architecture is x64, otherwise x64
string arch = TestContext.BuildArchitecture == "x64" ? "arm64" : "x64";
using (var registeredInstallLocationOverride = new RegisteredInstallLocationOverride(SharedState.DotNet.GreatestVersionHostFxrFilePath))
{
// Register a location that should have no runtimes installed
registeredInstallLocationOverride.SetInstallLocation((arch, SharedState.Artifact.Location));
SharedState.DotNet.Exec("--list-runtimes", "--arch", arch)
.ApplyRegisteredInstallLocationOverride(registeredInstallLocationOverride)
.CaptureStdOut()
.Execute()
.Should().Pass()
.And.HaveStdOut(string.Empty);
}
}

[Fact]
public void ListSdks()
{
// Verify exact match of command output. The output of --list-sdks is intended to be machine-readable
// and must not change in a way that breaks existing parsing.
string expectedOutput = GetListSdksOutput(SharedState.DotNet.BinPath, SharedState.InstalledVersions);
SharedState.DotNet.Exec("--list-sdks")
.CaptureStdOut()
.Execute()
.Should().Pass()
.And.HaveStdOut(expectedOutput);
}

[Theory]
[InlineData(true)]
[InlineData(false)]
public void ListSdks_OtherArchitecture(bool useRegisteredLocation)
{
using (var registeredInstallLocationOverride = new RegisteredInstallLocationOverride(SharedState.DotNet.GreatestVersionHostFxrFilePath))
{
if (useRegisteredLocation)
{
registeredInstallLocationOverride.SetInstallLocation(SharedState.OtherArchInstallLocations);
}

foreach ((string arch, string installLocation) in SharedState.OtherArchInstallLocations)
{
// Verify exact match of command output. The output of --list-sdks is intended to be machine-readable
// and must not change in a way that breaks existing parsing.
string expectedOutput = GetListSdksOutput(installLocation, SharedState.InstalledVersions);
SharedState.DotNet.Exec("--list-sdks", "--arch", arch)
.ApplyRegisteredInstallLocationOverride(registeredInstallLocationOverride)
.EnvironmentVariable(Constants.TestOnlyEnvironmentVariables.DefaultInstallPath, useRegisteredLocation ? null : installLocation)
.CaptureStdOut()
.Execute()
.Should().Pass()
.And.HaveStdOut(expectedOutput);
}
}
}

[Fact]
public void ListSdks_OtherArchitecture_NoInstalls()
{
// Non-host architecture - arm64 if current architecture is x64, otherwise x64
string arch = TestContext.BuildArchitecture == "x64" ? "arm64" : "x64";
using (var registeredInstallLocationOverride = new RegisteredInstallLocationOverride(SharedState.DotNet.GreatestVersionHostFxrFilePath))
{
// Register a location that should have no SDKs installed
registeredInstallLocationOverride.SetInstallLocation((arch, SharedState.Artifact.Location));
SharedState.DotNet.Exec("--list-sdks", "--arch", arch)
.ApplyRegisteredInstallLocationOverride(registeredInstallLocationOverride)
.CaptureStdOut()
.Execute()
.Should().Pass()
.And.HaveStdOut(string.Empty);
}
}

private static string GetListRuntimesOutput(string installLocation, string[] versions, string prefix = "")
{
string runtimePath = Path.Combine(installLocation, "shared", Constants.MicrosoftNETCoreApp);
return string.Join(string.Empty, versions.Select(v => $"{prefix}{Constants.MicrosoftNETCoreApp} {v} [{runtimePath}]{Environment.NewLine}"));
}

private static string GetListSdksOutput(string installLocation, string[] versions, string prefix = "")
{
string sdkPath = Path.Combine(installLocation, "sdk");
return string.Join(string.Empty, versions.Select(v => $"{prefix}{v} [{sdkPath}]{Environment.NewLine}"));
}

public sealed class SharedTestState : IDisposable
{
public TestArtifact Artifact { get; }
public DotNetCli DotNet { get; }

// Versions are assumed to be in ascending order. We use this property to check against the
// exact expected output of --list-sdks and --list-runtimes.
public string[] InstalledVersions { get; } = ["5.0.5", "10.0.0", "9999.0.1"];

public (string, string)[] OtherArchInstallLocations { get; }

public SharedTestState()
{
Artifact = TestArtifact.Create(nameof(HostCommands));

var builder = new DotNetBuilder(Artifact.Location, TestContext.BuiltDotNet.BinPath, "exe");
foreach (string version in InstalledVersions)
{
builder.AddMicrosoftNETCoreAppFrameworkMockHostPolicy(version);
builder.AddMockSDK(version, version);
}

DotNet = builder.Build();

// Add runtimes and SDKs for other architectures
string[] otherArchs = new[] { "arm64", "x64", "x86" }.Where(a => a != TestContext.BuildArchitecture).ToArray();
OtherArchInstallLocations = new (string, string)[otherArchs.Length];
for (int i = 0; i < otherArchs.Length; i++)
{
string arch = otherArchs[i];
string installLocation = Directory.CreateDirectory(Path.Combine(Artifact.Location, arch)).FullName;
foreach (string version in InstalledVersions)
{
DotNetBuilder.AddMicrosoftNETCoreAppFrameworkMockHostPolicy(installLocation, version);
DotNetBuilder.AddMockSDK(installLocation, version, version);
}

OtherArchInstallLocations[i] = (arch, installLocation);
}


// Enable test-only behavior for the copied .NET. We don't bother disabling the behaviour later,
// as we just delete the entire copy after the tests run.
_ = TestOnlyProductBehavior.Enable(DotNet.GreatestVersionHostFxrFilePath);

}

public void Dispose()
{
Artifact.Dispose();
}
}
}
}
Loading
Loading