Skip to content

Fix hangdump not working under dotnet test with .NET 10 SDK #6968

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
+35 −10
Open

Fix hangdump not working under dotnet test with .NET 10 SDK #6968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
34ad699
Initial plan
Copilot Nov 21, 2025
ff3d149
Add tests demonstrating hangdump issue with dotnet test
Copilot Nov 21, 2025
eb7bc8d
Replace unit tests with integration acceptance test for dotnet test h…
Copilot Nov 21, 2025
d4b165f
Update test
Youssef1313 Nov 21, 2025
4cdbf1d
Fix HangDumpActivityIndicator for server
Youssef1313 Nov 21, 2025
3263c97
Fix HangDumpEnvironmentVariableProvider for server
Youssef1313 Nov 21, 2025
44eace9
Fix HangDumpProcessLifetimeHandler for server
Youssef1313 Nov 21, 2025
e7c0a14
Adjust exit code expectation
Youssef1313 Nov 21, 2025
2404650
Improve assertion
Youssef1313 Nov 21, 2025
394be0f
Cleanup
Youssef1313 Nov 21, 2025
07f1ef6
The other test as well
Youssef1313 Nov 21, 2025
1be1742
Fix error
Youssef1313 Nov 21, 2025
34a352d
Update HangDumpTests.cs
Youssef1313 Nov 21, 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
6 changes: 2 additions & 4 deletions src/Platform/Microsoft.Testing.Extensions.HangDump/HangDumpActivityIndicator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ public HangDumpActivityIndicator(
_environment = environment;
_task = task;
_clock = clock;
if (_commandLineOptions.IsOptionSet(HangDumpCommandLineProvider.HangDumpOptionName) &&
!_commandLineOptions.IsOptionSet(PlatformCommandLineProvider.ServerOptionKey))
if (_commandLineOptions.IsOptionSet(HangDumpCommandLineProvider.HangDumpOptionName))
Copy link
Member

@Evangelink Evangelink Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description mentions checking both server and pipe cli options but the 2 parts of the implementation don't do that. Is this expected?

Copy link
Member

@Youssef1313 Youssef1313 Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's worth any special casing here at all. Even if this ended up being used in Test Explorer and it doesn't work, I don't think it's a big concern.

{
string namedPipeSuffix = _environment.GetEnvironmentVariable(HangDumpConfiguration.MutexNameSuffix)
?? throw new InvalidOperationException($"Expected {HangDumpConfiguration.MutexNameSuffix} environment variable set.");
Expand All @@ -82,8 +81,7 @@ public HangDumpActivityIndicator(

public string Description => ExtensionResources.HangDumpExtensionDescription;

public Task<bool> IsEnabledAsync() => Task.FromResult(_commandLineOptions.IsOptionSet(HangDumpCommandLineProvider.HangDumpOptionName) &&
!_commandLineOptions.IsOptionSet(PlatformCommandLineProvider.ServerOptionKey));
public Task<bool> IsEnabledAsync() => Task.FromResult(_commandLineOptions.IsOptionSet(HangDumpCommandLineProvider.HangDumpOptionName));

public async Task OnTestSessionStartingAsync(ITestSessionContext testSessionContext)
{
Expand Down
3 changes: 1 addition & 2 deletions src/Platform/Microsoft.Testing.Extensions.HangDump/HangDumpEnvironmentVariableProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ public HangDumpEnvironmentVariableProvider(ICommandLineOptions commandLineOption

public string Description => ExtensionResources.HangDumpExtensionDescription;

public Task<bool> IsEnabledAsync() => Task.FromResult(_commandLineOptions.IsOptionSet(HangDumpCommandLineProvider.HangDumpOptionName) &&
!_commandLineOptions.IsOptionSet(PlatformCommandLineProvider.ServerOptionKey));
public Task<bool> IsEnabledAsync() => Task.FromResult(_commandLineOptions.IsOptionSet(HangDumpCommandLineProvider.HangDumpOptionName));

public Task UpdateAsync(IEnvironmentVariables environmentVariables)
{
Expand Down
3 changes: 1 addition & 2 deletions src/Platform/Microsoft.Testing.Extensions.HangDump/HangDumpProcessLifetimeHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,7 @@ public HangDumpProcessLifetimeHandler(

public Type[] DataTypesProduced => [typeof(FileArtifact)];

public Task<bool> IsEnabledAsync() => Task.FromResult(_commandLineOptions.IsOptionSet(HangDumpCommandLineProvider.HangDumpOptionName) &&
!_commandLineOptions.IsOptionSet(PlatformCommandLineProvider.ServerOptionKey));
public Task<bool> IsEnabledAsync() => Task.FromResult(_commandLineOptions.IsOptionSet(HangDumpCommandLineProvider.HangDumpOptionName));

public async Task BeforeTestHostProcessStartAsync(CancellationToken cancellationToken)
{
Expand Down
33 changes: 31 additions & 2 deletions .../IntegrationTests/Microsoft.Testing.Platform.Acceptance.IntegrationTests/HangDumpTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,37 @@ public async Task HangDump_DefaultSetting_CreateDump(string tfm)
},
cancellationToken: TestContext.CancellationToken);
testHostResult.AssertExitCodeIs(ExitCodes.TestHostProcessExitedNonGracefully);
string? dumpFile = Directory.GetFiles(resultDirectory, "HangDump*.dmp", SearchOption.AllDirectories).SingleOrDefault();
Assert.IsNotNull(dumpFile, $"Dump file not found '{tfm}'\n{testHostResult}'");
string[] dumpFiles = Directory.GetFiles(resultDirectory, "HangDump*.dmp", SearchOption.AllDirectories);
Assert.ContainsSingle(dumpFiles, $"Expected single dump file. Found: {Environment.NewLine}{string.Join(Environment.NewLine, dumpFiles)}{Environment.NewLine}{testHostResult}");
}

[TestMethod]
public async Task HangDump_WithDotnetTest_CreateDump()
{
if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
Copy link
Member

@Evangelink Evangelink Nov 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: we can use the oscondition attribute here instead

{
// TODO: Investigate failures on macos
return;
}

string resultDirectory = Path.Combine(AssetFixture.TargetAssetPath, Guid.NewGuid().ToString("N"), TargetFrameworks.NetCurrent);

DotnetMuxerResult testResult = await DotnetCli.RunAsync(
$"test --project \"{AssetFixture.TargetAssetPath}\" -f {TargetFrameworks.NetCurrent} --hangdump --hangdump-timeout 8s --results-directory \"{resultDirectory}\"",
AcceptanceFixture.NuGetGlobalPackagesFolder.Path,
environmentVariables: new Dictionary<string, string?>
{
{ "SLEEPTIMEMS1", "4000" },
{ "SLEEPTIMEMS2", "600000" },
},
workingDirectory: AssetFixture.TargetAssetPath,
failIfReturnValueIsNotZero: false,
cancellationToken: TestContext.CancellationToken);

// This should be TestHostProcessExitedNonGracefully instead of GenericFailure. This will likely be fixed by https://github.com/dotnet/sdk/pull/51857
testResult.AssertExitCodeIs(ExitCodes.GenericFailure);
string[] dumpFiles = Directory.GetFiles(resultDirectory, "HangDump*.dmp", SearchOption.AllDirectories);
Assert.ContainsSingle(dumpFiles, $"Expected single dump file. Found: {Environment.NewLine}{string.Join(Environment.NewLine, dumpFiles)}{Environment.NewLine}{testResult}");
}

[TestMethod]
Expand Down
Loading