Skip to content

Fix Verify snapshot naming for xunit v3 compatibility #10052

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
MichaelSimons merged 2 commits into from
Mar 25, 2026
Merged

Fix Verify snapshot naming for xunit v3 compatibility #10052

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28942df
Use UseFileName to prevent Verify parameter appending with MTP
MichaelSimons Mar 18, 2026
d49b839
Merge branch 'main' of https://github.com/dotnet/templating into fix-…
MichaelSimons Mar 18, 2026
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
10 changes: 8 additions & 2 deletions tools/Microsoft.TemplateEngine.Authoring.TemplateVerifier/VerificationEngine.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,20 +173,26 @@ internal static Task CreateVerificationTask(
}
}

// UseFileName replaces the entire type+method+parameters naming.
// This prevents Verify.XunitV3 from auto-appending [Theory] parameters
// to snapshot file paths, which breaks matching since TemplateVerifier
// already manages naming uniqueness via ScenarioName.
string scenarioPrefix = options.DoNotPrependTemplateNameToScenarioName ? string.Empty : options.TemplateName;
if (!options.DoNotPrependCallerMethodNameToScenarioName && !string.IsNullOrEmpty(callerInfo.CallerMethod))
{
scenarioPrefix = callerInfo.CallerMethod + (string.IsNullOrEmpty(scenarioPrefix) ? null : ".") + scenarioPrefix;
}
scenarioPrefix = string.IsNullOrEmpty(scenarioPrefix) ? "_" : scenarioPrefix;
verifySettings.UseTypeName(scenarioPrefix);
string scenarioName = GetScenarioName(options);
string fileName = string.IsNullOrEmpty(scenarioName) ? scenarioPrefix : $"{scenarioPrefix}.{scenarioName}";
verifySettings.UseFileName(fileName);

string snapshotsDir = options.SnapshotsDirectory ?? "Snapshots";
if (!string.IsNullOrEmpty(callerInfo.CallerDirectory) && !Path.IsPathRooted(snapshotsDir))
{
snapshotsDir = Path.Combine(callerInfo.CallerDirectory, snapshotsDir);
}
verifySettings.UseDirectory(snapshotsDir);
verifySettings.UseMethodName(GetScenarioName(options));
verifySettings.UseDiffPlex(OutputType.Compact);
verifySettings.UseSplitModeForUniqueDirectory();

Expand Down