|
| 1 | +// Copyright (c) Microsoft. All rights reserved. |
| 2 | + |
| 3 | +using System.Text; |
| 4 | + |
| 5 | +namespace VerifySamples; |
| 6 | + |
| 7 | +/// <summary> |
| 8 | +/// Writes a Markdown summary of sample verification results. |
| 9 | +/// </summary> |
| 10 | +internal static class MarkdownResultWriter |
| 11 | +{ |
| 12 | + /// <summary> |
| 13 | + /// Writes the results to a Markdown file at the specified path. |
| 14 | + /// </summary> |
| 15 | + public static async Task WriteAsync( |
| 16 | + string path, |
| 17 | + IReadOnlyList<VerificationResult> orderedResults, |
| 18 | + IReadOnlyList<(string Name, string Reason)> skipped, |
| 19 | + TimeSpan elapsed) |
| 20 | + { |
| 21 | + var passCount = orderedResults.Count(r => r.Passed); |
| 22 | + var failCount = orderedResults.Count(r => !r.Passed); |
| 23 | + |
| 24 | + var sb = new StringBuilder(); |
| 25 | + sb.AppendLine("# Sample Verification Results"); |
| 26 | + sb.AppendLine(); |
| 27 | + sb.AppendLine($"**{passCount} passed, {failCount} failed, {skipped.Count} skipped** | Elapsed: {elapsed.Hours:D2}:{elapsed.Minutes:D2}:{elapsed.Seconds:D2}"); |
| 28 | + sb.AppendLine(); |
| 29 | + |
| 30 | + // Results table |
| 31 | + sb.AppendLine("| Sample | Status | Failed Checks | Failures |"); |
| 32 | + sb.AppendLine("|--------|--------|---------------|----------|"); |
| 33 | + |
| 34 | + foreach (var result in orderedResults) |
| 35 | + { |
| 36 | + var status = result.Passed ? "✅ PASSED" : "❌ FAILED"; |
| 37 | + var failedChecks = result.Failures.Count; |
| 38 | + var failures = MdEscape(string.Join("; ", result.Failures)); |
| 39 | + sb.AppendLine($"| {MdEscape(result.SampleName)} | {status} | {failedChecks} | {failures} |"); |
| 40 | + } |
| 41 | + |
| 42 | + foreach (var (name, reason) in skipped) |
| 43 | + { |
| 44 | + sb.AppendLine($"| {MdEscape(name)} | ⏭️ SKIPPED | 0 | {MdEscape(reason)} |"); |
| 45 | + } |
| 46 | + |
| 47 | + // Collapsible AI reasoning details for failures |
| 48 | + var failures2 = orderedResults.Where(r => !r.Passed && !string.IsNullOrEmpty(r.AIReasoning)).ToList(); |
| 49 | + if (failures2.Count > 0) |
| 50 | + { |
| 51 | + sb.AppendLine(); |
| 52 | + sb.AppendLine("## Failure Details"); |
| 53 | + sb.AppendLine(); |
| 54 | + |
| 55 | + foreach (var result in failures2) |
| 56 | + { |
| 57 | + sb.AppendLine($"<details><summary><strong>{HtmlEscape(result.SampleName)}</strong></summary>"); |
| 58 | + sb.AppendLine(); |
| 59 | + if (result.Failures.Count > 0) |
| 60 | + { |
| 61 | + foreach (var failure in result.Failures) |
| 62 | + { |
| 63 | + sb.AppendLine($"- {MdEscape(failure)}"); |
| 64 | + } |
| 65 | + |
| 66 | + sb.AppendLine(); |
| 67 | + } |
| 68 | + |
| 69 | + sb.AppendLine("**AI Reasoning:**"); |
| 70 | + sb.AppendLine(); |
| 71 | + sb.AppendLine("```"); |
| 72 | + sb.AppendLine(result.AIReasoning); |
| 73 | + sb.AppendLine("```"); |
| 74 | + sb.AppendLine(); |
| 75 | + sb.AppendLine("</details>"); |
| 76 | + sb.AppendLine(); |
| 77 | + } |
| 78 | + } |
| 79 | + |
| 80 | + await File.WriteAllTextAsync(path, sb.ToString()); |
| 81 | + } |
| 82 | + |
| 83 | + /// <summary> |
| 84 | + /// Escapes pipe characters and newlines for use inside Markdown table cells. |
| 85 | + /// </summary> |
| 86 | + private static string MdEscape(string value) |
| 87 | + { |
| 88 | + return value.Replace("|", "\\|").Replace("\n", " ").Replace("\r", ""); |
| 89 | + } |
| 90 | + |
| 91 | + /// <summary> |
| 92 | + /// Escapes HTML special characters for use inside HTML tags. |
| 93 | + /// </summary> |
| 94 | + private static string HtmlEscape(string value) |
| 95 | + { |
| 96 | + return value.Replace("&", "&").Replace("<", "<").Replace(">", ">").Replace("\"", """); |
| 97 | + } |
| 98 | +} |
0 commit comments