From 8028665dd5975b12234ac2c402211a7e4738d368 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 12 Jun 2025 13:40:23 +0000 Subject: [PATCH 1/3] Initial plan for issue From 06a4cb0d37da842c385c760f5e746bfdff2387b5 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 13 Jun 2025 15:53:48 +0000 Subject: [PATCH 2/3] Fix HTML logger exception with special characters in DataRow attributes Co-authored-by: nohwnd <5735905+nohwnd@users.noreply.github.com> --- .../HtmlTransformer.cs | 5 +- .../HtmlLoggerTests.cs | 60 ++++++++++ .../HtmlTransformerTests.cs | 103 ++++++++++++++++++ 3 files changed, 167 insertions(+), 1 deletion(-) create mode 100644 test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlTransformerTests.cs diff --git a/src/Microsoft.TestPlatform.Extensions.HtmlLogger/HtmlTransformer.cs b/src/Microsoft.TestPlatform.Extensions.HtmlLogger/HtmlTransformer.cs index af5313cf1b..d75c2e8311 100644 --- a/src/Microsoft.TestPlatform.Extensions.HtmlLogger/HtmlTransformer.cs +++ b/src/Microsoft.TestPlatform.Extensions.HtmlLogger/HtmlTransformer.cs @@ -36,7 +36,10 @@ public void Transform(string xmlFile, string htmlFile) using XmlReader xr = XmlReader.Create(xmlFile, new XmlReaderSettings() { CheckCharacters = false }); // Use output settings from the xslt, especially the output method, which is HTML, which avoids outputting broken
tags. - using XmlWriter xw = XmlWriter.Create(htmlFile, _xslTransform.OutputSettings); + // However, we also need to ensure the writer is tolerant of invalid XML characters, similar to the reader. + var outputSettings = _xslTransform.OutputSettings?.Clone() ?? new XmlWriterSettings(); + outputSettings.CheckCharacters = false; + using XmlWriter xw = XmlWriter.Create(htmlFile, outputSettings); _xslTransform.Transform(xr, xw); } diff --git a/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlLoggerTests.cs b/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlLoggerTests.cs index 821093aa91..523fb78c94 100644 --- a/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlLoggerTests.cs +++ b/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlLoggerTests.cs @@ -591,6 +591,66 @@ public void TestCompleteHandlerShouldNotDivideByZeroWhenThereAre0TestResults() Assert.AreEqual(0, _htmlLogger.TestRunDetails.Summary.PassPercentage); } + [TestMethod] + public void TestResultHandlerShouldHandleSpecialCharactersInDataRowWithoutThrowingException() + { + // This test is for the issue where HTML logger throws exception when DataRow contains special characters + var testCase = CreateTestCase("TestWithSpecialChars"); + testCase.DisplayName = "TestMethod(\"test with special chars: \\u0001\\u0002\\uFFFF\")"; + + var testResult = new ObjectModel.TestResult(testCase) + { + Outcome = TestOutcome.Passed, + DisplayName = "TestMethod(\"test with special chars: \\u0001\\u0002\\uFFFF\")", + ErrorMessage = "Error with special chars: \u0001\u0002\uFFFF" + }; + + // This should not throw an exception + try + { + _htmlLogger.TestResultHandler(new object(), new Mock(testResult).Object); + Assert.AreEqual(1, _htmlLogger.TotalTests, "Total Tests"); + } + catch (Exception ex) + { + Assert.Fail($"TestResultHandler threw an exception when handling special characters: {ex.Message}"); + } + } + + [TestMethod] + public void TestCompleteHandlerShouldHandleSpecialCharactersInDataRowDuringTransformation() + { + // Create a test case with special characters that would cause XML writing issues + var testCase = CreateTestCase("TestWithSpecialChars"); + testCase.DisplayName = "TestMethod with special characters"; + + var testResult = new ObjectModel.TestResult(testCase) + { + Outcome = TestOutcome.Failed, + DisplayName = "TestMethod(\"special chars: \u0001\u0002\")", + ErrorMessage = "Error message with special chars: \u0001\u0002\uFFFF", + ErrorStackTrace = "Stack trace with special chars: \u0001\u0002" + }; + + _mockFileHelper.Setup(x => x.GetStream(It.IsAny(), FileMode.OpenOrCreate, FileAccess.ReadWrite)) + .Returns(new MemoryStream()); + + try + { + _htmlLogger.TestResultHandler(new object(), new Mock(testResult).Object); + + // This is where the issue would typically occur - during TestRunCompleteHandler + // when XML is serialized and then transformed to HTML + _htmlLogger.TestRunCompleteHandler(new object(), new TestRunCompleteEventArgs(null, false, true, null, null, null, TimeSpan.Zero)); + + Assert.AreEqual(1, _htmlLogger.TotalTests, "Total Tests"); + } + catch (Exception ex) + { + Assert.Fail($"HTML logger threw an exception when handling special characters during transformation: {ex.Message}"); + } + } + private static TestCase CreateTestCase(string testCaseName) { return new TestCase(testCaseName, new Uri("some://uri"), "DummySourceFileName"); diff --git a/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlTransformerTests.cs b/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlTransformerTests.cs new file mode 100644 index 0000000000..24f68faf45 --- /dev/null +++ b/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlTransformerTests.cs @@ -0,0 +1,103 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using System; +using System.IO; +using System.Text; + +using Microsoft.VisualStudio.TestPlatform.Extensions.HtmlLogger; +using Microsoft.VisualStudio.TestTools.UnitTesting; + +namespace Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests; + +[TestClass] +public class HtmlTransformerTests +{ + [TestMethod] + public void TransformShouldHandleSpecialCharactersWithoutThrowingException() + { + // Create a simple XML with special characters that could cause issues + var xmlContent = @" + + + + + + Test failed with special chars: ￿ + Stack trace with special chars:  + + + + +"; + + var xmlFile = Path.GetTempFileName(); + var htmlFile = Path.ChangeExtension(xmlFile, ".html"); + + try + { + File.WriteAllText(xmlFile, xmlContent, Encoding.UTF8); + + var transformer = new HtmlTransformer(); + + // This should not throw an exception, even with special characters + try + { + transformer.Transform(xmlFile, htmlFile); + } + catch (Exception ex) + { + Assert.Fail($"HtmlTransformer.Transform should not throw an exception with special characters: {ex.Message}"); + } + + // Verify that HTML file was created + Assert.IsTrue(File.Exists(htmlFile), "HTML file should be created"); + + // Verify that HTML file has content + var htmlContent = File.ReadAllText(htmlFile); + Assert.IsFalse(string.IsNullOrEmpty(htmlContent), "HTML content should not be empty"); + } + finally + { + if (File.Exists(xmlFile)) File.Delete(xmlFile); + if (File.Exists(htmlFile)) File.Delete(htmlFile); + } + } + + [TestMethod] + public void TransformShouldCreateValidHtmlOutput() + { + // Create a basic XML structure + var xmlContent = @" + + + + + Test output + + + +"; + + var xmlFile = Path.GetTempFileName(); + var htmlFile = Path.ChangeExtension(xmlFile, ".html"); + + try + { + File.WriteAllText(xmlFile, xmlContent, Encoding.UTF8); + + var transformer = new HtmlTransformer(); + transformer.Transform(xmlFile, htmlFile); + + // Verify that HTML file was created and has content + Assert.IsTrue(File.Exists(htmlFile), "HTML file should be created"); + var htmlContent = File.ReadAllText(htmlFile); + Assert.IsFalse(string.IsNullOrEmpty(htmlContent), "HTML content should not be empty"); + } + finally + { + if (File.Exists(xmlFile)) File.Delete(xmlFile); + if (File.Exists(htmlFile)) File.Delete(htmlFile); + } + } +} \ No newline at end of file From 45e643b8c84b83d8444719577aff3ae567c08a59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Jare=C5=A1?= Date: Wed, 2 Jul 2025 11:53:02 +0200 Subject: [PATCH 3/3] Fix formatting --- .../HtmlTransformerTests.cs | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlTransformerTests.cs b/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlTransformerTests.cs index 24f68faf45..7284bb5512 100644 --- a/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlTransformerTests.cs +++ b/test/Microsoft.TestPlatform.Extensions.HtmlLogger.UnitTests/HtmlTransformerTests.cs @@ -37,9 +37,8 @@ public void TransformShouldHandleSpecialCharactersWithoutThrowingException() try { File.WriteAllText(xmlFile, xmlContent, Encoding.UTF8); - + var transformer = new HtmlTransformer(); - // This should not throw an exception, even with special characters try { @@ -49,10 +48,10 @@ public void TransformShouldHandleSpecialCharactersWithoutThrowingException() { Assert.Fail($"HtmlTransformer.Transform should not throw an exception with special characters: {ex.Message}"); } - + // Verify that HTML file was created Assert.IsTrue(File.Exists(htmlFile), "HTML file should be created"); - + // Verify that HTML file has content var htmlContent = File.ReadAllText(htmlFile); Assert.IsFalse(string.IsNullOrEmpty(htmlContent), "HTML content should not be empty"); @@ -85,10 +84,10 @@ public void TransformShouldCreateValidHtmlOutput() try { File.WriteAllText(xmlFile, xmlContent, Encoding.UTF8); - + var transformer = new HtmlTransformer(); transformer.Transform(xmlFile, htmlFile); - + // Verify that HTML file was created and has content Assert.IsTrue(File.Exists(htmlFile), "HTML file should be created"); var htmlContent = File.ReadAllText(htmlFile); @@ -100,4 +99,4 @@ public void TransformShouldCreateValidHtmlOutput() if (File.Exists(htmlFile)) File.Delete(htmlFile); } } -} \ No newline at end of file +}