Skip to content

Make StackTraceHelper tests runtime-agnostic #64007

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 2 commits into
base: main
Choose a base branch
from
+39 −4
Open

Make StackTraceHelper tests runtime-agnostic #64007

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f177877
Make StackTraceHelper tests runtime-agnostic
medhatiwari Oct 12, 2025
db1e3c2
Use runtime-specific assertions for Mono compatibility
medhatiwari Oct 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
34 changes: 27 additions & 7 deletions src/Shared/test/Shared.Tests/StackTraceHelperTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,10 +176,27 @@ public void StackTraceHelper_ProducesReadableOutput()

// Act
var stackFrames = StackTraceHelper.GetFrames(exception, out _);
var methodNames = stackFrames.Select(stackFrame => stackFrame.MethodDisplayInfo.ToString()).ToArray();

// Assert
Assert.Equal(expectedCallStack, methodNames);
var methodNames = stackFrames.Select(stackFrame => stackFrame.MethodDisplayInfo.ToString()).ToList();

// Assert - Runtime-agnostic checks for essential stack trace components
// Instead of exact string matching, verify key components are present
Copy link
Member

Choose a reason for hiding this comment

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

While you are still verifying that key components are present, it does mean that we are a bit less strict in CoreCLR which could be a potential for regressions. Would it make sense to instead of relaxing some of these matches, to instead first do a Runtime check to see if running under CoreCLR or Mono, and then if CoreCLR we keep the stricter checks but for Mono we just validate key components? This way you are not losing any regression coverage, but you are making the tests pass on more runtimes.

Copy link
Contributor Author

@medhatiwari medhatiwari Oct 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@joperezr Good point! I've updated it with runtime-specific assertions as you suggested

Assert.Equal(expectedCallStack.Count, methodNames.Count);

// Check each frame contains the essential method information
Assert.Contains("Iterator()+MoveNext()", methodNames[0]);
Assert.Contains("string.Join", methodNames[1]);
Assert.Contains("GenericClass<T>.GenericMethod<V>", methodNames[2]);
Assert.Contains("MethodAsync(int value)", methodNames[3]);

// For async generic method, check for either resolved form or state machine form
var asyncGenericFrame = methodNames[4];
Assert.True(
asyncGenericFrame.Contains("MethodAsync<TValue>(TValue value)") || // CoreCLR resolved form
asyncGenericFrame.Contains("MethodAsync") && asyncGenericFrame.Contains("TValue"), // Mono state machine form
$"Expected async generic method info in: {asyncGenericFrame}");

Assert.Contains("Method(string value)", methodNames[5]);
Assert.Contains("StackTraceHelper_ProducesReadableOutput()", methodNames[6]);
}

[Fact]
Expand Down Expand Up @@ -242,9 +259,12 @@ public void GetFrames_DoesNotFailForDynamicallyGeneratedAssemblies()
// Assert
var frame = frames[0];
Assert.Null(frame.FilePath);
// lambda_method{RandomNumber}(Closure )
Assert.StartsWith("lambda_method", frame.MethodDisplayInfo.ToString());
Assert.EndsWith("(Closure )", frame.MethodDisplayInfo.ToString());
// Runtime-agnostic test: should contain "lambda_method" regardless of prefix
// CoreCLR: "lambda_method34(Closure )"
// Mono: "object.lambda_method34(Closure )"
var methodDisplay = frame.MethodDisplayInfo.ToString();
Assert.Contains("lambda_method", methodDisplay);
Assert.EndsWith("(Closure )", methodDisplay);
}

[MethodImpl(MethodImplOptions.NoOptimization | MethodImplOptions.NoInlining)]
Expand Down
Loading