Add crash report support to the CrashDump extension

src/Platform/Microsoft.Testing.Extensions.CrashDump/CrashDumpCommandLineOptions.cs

@@ -10,6 +10,7 @@ namespace Microsoft.Testing.Extensions.Diagnostics;
 internal static class CrashDumpCommandLineOptions
 {
     public const string CrashDumpOptionName = "crashdump";
+    public const string CrashReportOptionName = "crash-report";
     public const string CrashDumpFileNameOptionName = "crashdump-filename";
     public const string CrashDumpTypeOptionName = "crashdump-type";
 }

src/Platform/Microsoft.Testing.Extensions.CrashDump/CrashDumpCommandLineProvider.cs

@@ -11,6 +11,13 @@ namespace Microsoft.Testing.Extensions.Diagnostics;
 internal sealed class CrashDumpCommandLineProvider : ICommandLineOptionsProvider
 {
     private static readonly string[] DumpTypeOptions = ["Mini", "Heap", "Triage", "Full"];
+    private static readonly IReadOnlyCollection<CommandLineOption> CachedCommandLineOptions =
+    [
+        new(CrashDumpCommandLineOptions.CrashDumpOptionName, CrashDumpResources.CrashDumpOptionDescription, ArgumentArity.Zero, false),
+        new(CrashDumpCommandLineOptions.CrashReportOptionName, CrashDumpResources.CrashReportOptionDescription, ArgumentArity.Zero, false),
+        new(CrashDumpCommandLineOptions.CrashDumpFileNameOptionName, CrashDumpResources.CrashDumpFileNameOptionDescription, ArgumentArity.ExactlyOne, false),
+        new(CrashDumpCommandLineOptions.CrashDumpTypeOptionName, CrashDumpResources.CrashDumpTypeOptionDescription, ArgumentArity.ExactlyOne, false)
+    ];
 
     public string Uid => nameof(CrashDumpCommandLineProvider);
 
@@ -22,13 +29,7 @@ internal sealed class CrashDumpCommandLineProvider : ICommandLineOptionsProvider
 
     public Task<bool> IsEnabledAsync() => Task.FromResult(true);
 
-    public IReadOnlyCollection<CommandLineOption> GetCommandLineOptions()
-        =>
-        [
-            new CommandLineOption(CrashDumpCommandLineOptions.CrashDumpOptionName, CrashDumpResources.CrashDumpOptionDescription, ArgumentArity.Zero, false),
-            new CommandLineOption(CrashDumpCommandLineOptions.CrashDumpFileNameOptionName, CrashDumpResources.CrashDumpFileNameOptionDescription, ArgumentArity.ExactlyOne, false),
-            new CommandLineOption(CrashDumpCommandLineOptions.CrashDumpTypeOptionName, CrashDumpResources.CrashDumpTypeOptionDescription, ArgumentArity.ExactlyOne, false)
-        ];
+    public IReadOnlyCollection<CommandLineOption> GetCommandLineOptions() => CachedCommandLineOptions;
 
     public Task<ValidationResult> ValidateOptionArgumentsAsync(CommandLineOption commandOption, string[] arguments)
     {

src/Platform/Microsoft.Testing.Extensions.CrashDump/CrashDumpEnvironmentVariableProvider.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using Microsoft.Testing.Extensions.Diagnostics.Resources;
@@ -18,7 +18,9 @@ internal sealed class CrashDumpEnvironmentVariableProvider : ITestHostEnvironmen
     private const string MiniDumpNameVariable = "DbgMiniDumpName";
     private const string CreateDumpDiagnosticsVariable = "CreateDumpDiagnostics";
     private const string CreateDumpVerboseDiagnosticsVariable = "CreateDumpVerboseDiagnostics";
-    private const string EnableMiniDumpValue = "1";
+    private const string EnableCrashReportVariable = "EnableCrashReport";
+    private const string EnableCrashReportOnlyVariable = "EnableCrashReportOnly";
+    private const string EnabledValue = "1";
 
     private static readonly string[] Prefixes = ["DOTNET_", "COMPlus_"];
     private readonly IConfiguration _configuration;
@@ -54,15 +56,39 @@ public CrashDumpEnvironmentVariableProvider(
 
     /// <inheritdoc />
     public Task<bool> IsEnabledAsync()
-        => Task.FromResult(_commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashDumpOptionName) && _crashDumpGeneratorConfiguration.Enable);
+        => Task.FromResult(
+            (_commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashDumpOptionName) ||
+             _commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashReportOptionName)) &&
+            _crashDumpGeneratorConfiguration.Enable);
 
     public Task UpdateAsync(IEnvironmentVariables environmentVariables)
     {
+        bool crashDumpEnabled = _commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashDumpOptionName);
+        bool crashReportEnabled = _commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashReportOptionName);
+
+        if (crashDumpEnabled || crashReportEnabled)
+        {
+            foreach (string prefix in Prefixes)
+            {
+                environmentVariables.SetVariable(new($"{prefix}{EnableMiniDumpVariable}", EnabledValue, false, true));
+            }
+        }
+
         foreach (string prefix in Prefixes)
         {
-            environmentVariables.SetVariable(new($"{prefix}{EnableMiniDumpVariable}", EnableMiniDumpValue, false, true));
-            environmentVariables.SetVariable(new($"{prefix}{CreateDumpDiagnosticsVariable}", EnableMiniDumpValue, false, true));
-            environmentVariables.SetVariable(new($"{prefix}{CreateDumpVerboseDiagnosticsVariable}", EnableMiniDumpValue, false, true));
+            environmentVariables.SetVariable(new($"{prefix}{CreateDumpDiagnosticsVariable}", EnabledValue, false, true));
+            environmentVariables.SetVariable(new($"{prefix}{CreateDumpVerboseDiagnosticsVariable}", EnabledValue, false, true));
+        }
+
+        if (crashReportEnabled)
+        {
+            // When a dump is also requested, emit a crash report alongside it.
+            // Otherwise emit only the crash report (no dump file).
+            string reportVariable = crashDumpEnabled ? EnableCrashReportVariable : EnableCrashReportOnlyVariable;
+            foreach (string prefix in Prefixes)
+            {
+                environmentVariables.SetVariable(new($"{prefix}{reportVariable}", EnabledValue, false, true));
+            }
         }
 
         string miniDumpTypeValue = "4";
@@ -133,31 +159,21 @@ public Task<ValidationResult> ValidateTestHostEnvironmentVariablesAsync(IReadOnl
         return ValidationResult.InvalidTask(CrashDumpResources.CrashDumpNotSupportedInNonNetCoreErrorMessage);
 #else
         StringBuilder errors = new();
-        foreach (string prefix in Prefixes)
-        {
-            if (!environmentVariables.TryGetVariable($"{prefix}{EnableMiniDumpVariable}", out OwnedEnvironmentVariable? enableMiniDump)
-            || enableMiniDump.Value != EnableMiniDumpValue)
-            {
-                AddError(errors, $"{prefix}{EnableMiniDumpVariable}", EnableMiniDumpValue, enableMiniDump?.Value);
-            }
-        }
+        bool crashDumpEnabled = _commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashDumpOptionName);
+        bool crashReportEnabled = _commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashReportOptionName);
 
-        foreach (string prefix in Prefixes)
+        if (crashDumpEnabled || crashReportEnabled)
         {
-            if (!environmentVariables.TryGetVariable($"{prefix}{CreateDumpDiagnosticsVariable}", out OwnedEnvironmentVariable? enableMiniDump)
-            || enableMiniDump.Value != EnableMiniDumpValue)
-            {
-                AddError(errors, $"{prefix}{CreateDumpDiagnosticsVariable}", EnableMiniDumpValue, enableMiniDump?.Value);
-            }
+            ValidateBothPrefixes(EnableMiniDumpVariable, EnabledValue);
         }
 
-        foreach (string prefix in Prefixes)
+        ValidateBothPrefixes(CreateDumpDiagnosticsVariable, EnabledValue);
+        ValidateBothPrefixes(CreateDumpVerboseDiagnosticsVariable, EnabledValue);
+
+        if (crashReportEnabled)
         {
-            if (!environmentVariables.TryGetVariable($"{prefix}{CreateDumpVerboseDiagnosticsVariable}", out OwnedEnvironmentVariable? enableMiniDump)
-            || enableMiniDump.Value != EnableMiniDumpValue)
-            {
-                AddError(errors, $"{prefix}{CreateDumpVerboseDiagnosticsVariable}", EnableMiniDumpValue, enableMiniDump?.Value);
-            }
+            string reportVariable = crashDumpEnabled ? EnableCrashReportVariable : EnableCrashReportOnlyVariable;
+            ValidateBothPrefixes(reportVariable, EnabledValue);
         }
 
         foreach (string prefix in Prefixes)
@@ -199,6 +215,18 @@ static void AddError(StringBuilder errors, string variableName, string? expected
             string actualValueString = actualValue ?? "<null>";
             errors.AppendLine(string.Format(CultureInfo.InvariantCulture, CrashDumpResources.CrashDumpInvalidEnvironmentVariableValueErrorMessage, variableName, expectedValue, actualValueString));
         }
+
+        void ValidateBothPrefixes(string variableName, string expectedValue)
+        {
+            foreach (string prefix in Prefixes)
+            {
+                if (!environmentVariables.TryGetVariable($"{prefix}{variableName}", out OwnedEnvironmentVariable? variable)
+                    || variable.Value != expectedValue)
+                {
+                    AddError(errors, $"{prefix}{variableName}", expectedValue, variable?.Value);
+                }
+            }
+        }
 #endif
     }
 }

src/Platform/Microsoft.Testing.Extensions.CrashDump/CrashDumpProcessLifetimeHandler.cs

@@ -14,6 +14,9 @@ namespace Microsoft.Testing.Extensions.Diagnostics;
 
 internal sealed class CrashDumpProcessLifetimeHandler : ITestHostProcessLifetimeHandler, IDataProducer, IOutputDeviceDataProducer
 {
+    private const string CrashReportFileExtension = ".crashreport.json";
+    private const string CrashReportFileSearchPattern = "*" + CrashReportFileExtension;
+
     private readonly ICommandLineOptions _commandLineOptions;
     private readonly IMessageBus _messageBus;
     private readonly IOutputDevice _outputDisplay;
@@ -46,8 +49,10 @@ public CrashDumpProcessLifetimeHandler(
     public Type[] DataTypesProduced => [typeof(FileArtifact)];
 
     public Task<bool> IsEnabledAsync()
-        => Task.FromResult(_commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashDumpOptionName)
-        && _netCoreCrashDumpGeneratorConfiguration.Enable);
+        => Task.FromResult(
+            (_commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashDumpOptionName) ||
+             _commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashReportOptionName)) &&
+            _netCoreCrashDumpGeneratorConfiguration.Enable);
 
     public Task BeforeTestHostProcessStartAsync(CancellationToken _) => Task.CompletedTask;
 
@@ -63,22 +68,50 @@ public async Task OnTestHostProcessExitedAsync(ITestHostProcessInformation testH
         }
 
         ApplicationStateGuard.Ensure(_netCoreCrashDumpGeneratorConfiguration.DumpFileNamePattern is not null);
-        await _outputDisplay.DisplayAsync(this, new ErrorMessageOutputDeviceData(string.Format(CultureInfo.InvariantCulture, CrashDumpResources.CrashDumpProcessCrashedDumpFileCreated, testHostProcessInformation.PID)), cancellationToken).ConfigureAwait(false);
+        bool generateDump = _commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashDumpOptionName);
+        bool generateCrashReport = _commandLineOptions.IsOptionSet(CrashDumpCommandLineOptions.CrashReportOptionName);
+
+        string processCrashedMessage = generateDump && generateCrashReport
+            ? string.Format(CultureInfo.InvariantCulture, CrashDumpResources.CrashDumpProcessCrashedDumpAndReportFileCreated, testHostProcessInformation.PID)
+            : generateCrashReport
+                ? string.Format(CultureInfo.InvariantCulture, CrashDumpResources.CrashDumpProcessCrashedReportFileCreated, testHostProcessInformation.PID)
+                : string.Format(CultureInfo.InvariantCulture, CrashDumpResources.CrashDumpProcessCrashedDumpFileCreated, testHostProcessInformation.PID);
+        await _outputDisplay.DisplayAsync(this, new ErrorMessageOutputDeviceData(processCrashedMessage), cancellationToken).ConfigureAwait(false);
 
         // TODO: Crash dump supports more placeholders that we don't handle here.
         // See "Dump name formatting" in:
         // https://github.com/dotnet/runtime/blob/82742628310076fff22d7e7ee216a74384352056/docs/design/coreclr/botr/xplat-minidump-generation.md
         string expectedDumpFile = _netCoreCrashDumpGeneratorConfiguration.DumpFileNamePattern.Replace("%p", testHostProcessInformation.PID.ToString(CultureInfo.InvariantCulture));
-        if (File.Exists(expectedDumpFile))
+        if (generateDump)
         {
-            await _messageBus.PublishAsync(this, new FileArtifact(new FileInfo(expectedDumpFile), CrashDumpResources.CrashDumpArtifactDisplayName, CrashDumpResources.CrashDumpArtifactDescription)).ConfigureAwait(false);
+            if (File.Exists(expectedDumpFile))
+            {
+                await _messageBus.PublishAsync(this, new FileArtifact(new FileInfo(expectedDumpFile), CrashDumpResources.CrashDumpArtifactDisplayName, CrashDumpResources.CrashDumpArtifactDescription)).ConfigureAwait(false);
+            }
+            else
+            {
+                await _outputDisplay.DisplayAsync(this, new ErrorMessageOutputDeviceData(string.Format(CultureInfo.InvariantCulture, CrashDumpResources.CannotFindExpectedCrashDumpFile, expectedDumpFile)), cancellationToken).ConfigureAwait(false);
+                foreach (string dumpFile in Directory.GetFiles(Path.GetDirectoryName(expectedDumpFile)!, "*.dmp"))
+                {
+                    await _messageBus.PublishAsync(this, new FileArtifact(new FileInfo(dumpFile), CrashDumpResources.CrashDumpDisplayName, CrashDumpResources.CrashDumpArtifactDescription)).ConfigureAwait(false);
+                }
+            }
         }
-        else
+
+        if (generateCrashReport)
         {
-            await _outputDisplay.DisplayAsync(this, new ErrorMessageOutputDeviceData(string.Format(CultureInfo.InvariantCulture, CrashDumpResources.CannotFindExpectedCrashDumpFile, expectedDumpFile)), cancellationToken).ConfigureAwait(false);
-            foreach (string dumpFile in Directory.GetFiles(Path.GetDirectoryName(expectedDumpFile)!, "*.dmp"))
+            string expectedCrashReportFile = $"{expectedDumpFile}{CrashReportFileExtension}";
+            if (File.Exists(expectedCrashReportFile))
+            {
+                await _messageBus.PublishAsync(this, new FileArtifact(new FileInfo(expectedCrashReportFile), CrashDumpResources.CrashReportArtifactDisplayName, CrashDumpResources.CrashReportArtifactDescription)).ConfigureAwait(false);
+            }
+            else
             {
-                await _messageBus.PublishAsync(this, new FileArtifact(new FileInfo(dumpFile), CrashDumpResources.CrashDumpDisplayName, CrashDumpResources.CrashDumpArtifactDescription)).ConfigureAwait(false);
+                await _outputDisplay.DisplayAsync(this, new ErrorMessageOutputDeviceData(string.Format(CultureInfo.InvariantCulture, CrashDumpResources.CannotFindExpectedCrashReportFile, expectedCrashReportFile, CrashReportFileSearchPattern)), cancellationToken).ConfigureAwait(false);
+                foreach (string crashReportFile in Directory.GetFiles(Path.GetDirectoryName(expectedCrashReportFile)!, CrashReportFileSearchPattern))
+                {
+                    await _messageBus.PublishAsync(this, new FileArtifact(new FileInfo(crashReportFile), CrashDumpResources.CrashReportArtifactDisplayName, CrashDumpResources.CrashReportArtifactDescription)).ConfigureAwait(false);
+                }
             }
         }
     }

src/Platform/Microsoft.Testing.Extensions.CrashDump/PACKAGE.md

@@ -1,6 +1,6 @@
 # Microsoft.Testing.Extensions.CrashDump
 
-Microsoft.Testing.Extensions.CrashDump is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that captures a crash dump of the test host process when an unhandled exception or crash occurs.
+Microsoft.Testing.Extensions.CrashDump is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that captures a crash dump or crash report for the test host process when an unhandled exception or crash occurs.
 
 Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.CrashDump` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository.
 
@@ -15,11 +15,13 @@ dotnet add package Microsoft.Testing.Extensions.CrashDump
 This package extends Microsoft.Testing.Platform with:
 
 - **Crash dump collection**: automatically captures a memory dump when the test process crashes
+- **Crash report collection**: optionally emits a lightweight JSON crash report to help diagnose crashes without uploading a full dump
 - **Post-mortem debugging**: collected dumps can be analyzed with tools like Visual Studio, WinDbg, or `dotnet-dump`
 - **Cross-platform**: supported on Windows, Linux, and macOS. Note that dumps collected on macOS can only be analyzed on macOS
 - **Runtime behavior**: supported for .NET 6+; on .NET Framework this extension is ignored
 
 Enable crash dump collection via the `--crashdump` command line option.
+Add `--crash-report` to generate a JSON crash report; combine `--crashdump --crash-report` to produce both a dump and a report.
 
 ## Related packages
 

src/Platform/Microsoft.Testing.Extensions.CrashDump/Resources/CrashDumpResources.resx

@@ -120,6 +120,9 @@
   <data name="CannotFindExpectedCrashDumpFile" xml:space="preserve">
     <value>Expected crash dump file '{0}' could not be found, all files matching the '*.dmp' pattern will be copied to the result folder</value>
   </data>
+  <data name="CannotFindExpectedCrashReportFile" xml:space="preserve">
+    <value>Expected crash report file '{0}' could not be found, all files matching the '{1}' pattern will be copied to the result folder</value>
+  </data>
   <data name="CrashDumpArtifactDescription" xml:space="preserve">
     <value>The testhost process crash dump file</value>
   </data>
@@ -144,9 +147,24 @@
   <data name="CrashDumpOptionDescription" xml:space="preserve">
     <value>[net6.0+ only] Generate a dump file if the test process crashes</value>
   </data>
+  <data name="CrashReportArtifactDescription" xml:space="preserve">
+    <value>The testhost process crash report file</value>
+  </data>
+  <data name="CrashReportArtifactDisplayName" xml:space="preserve">
+    <value>Crash report file</value>
+  </data>
+  <data name="CrashReportOptionDescription" xml:space="preserve">
+    <value>Generate a JSON crash report when the test process crashes. Combine with '--crashdump' to also generate a dump file. Requires .NET 7+ when used alone; .NET 6+ when combined with '--crashdump'.</value>
+  </data>
+  <data name="CrashDumpProcessCrashedDumpAndReportFileCreated" xml:space="preserve">
+    <value>Test host process with PID '{0}' crashed, a dump file and crash report were generated</value>
+  </data>
   <data name="CrashDumpProcessCrashedDumpFileCreated" xml:space="preserve">
     <value>Test host process with PID '{0}' crashed, a dump file was generated</value>
   </data>
+  <data name="CrashDumpProcessCrashedReportFileCreated" xml:space="preserve">
+    <value>Test host process with PID '{0}' crashed, a crash report was generated</value>
+  </data>
   <data name="CrashDumpTypeOptionDescription" xml:space="preserve">
     <value>Specify the type of the dump.
 Valid values are 'Mini', 'Heap', 'Triage' or 'Full'. Default type is 'Full'.