Improved the XML escaping and address some comments

Author: bkhouri

Sources/Commands/SwiftTestCommand.swift

@@ -342,7 +342,6 @@ public struct SwiftTestCommand: AsyncSwiftCommand {
                 try generateXUnitOutputIfRequested(
                     for: testResults,
                     swiftCommandState: swiftCommandState,
-                    detailedFailureMessage: self.options.shouldShowDetailedFailureMessage
                 )
                 results.append(result)
             }
@@ -420,7 +419,6 @@ public struct SwiftTestCommand: AsyncSwiftCommand {
     private func generateXUnitOutputIfRequested(
         for testResults: [ParallelTestRunner.TestResult],
         swiftCommandState: SwiftCommandState,
-        detailedFailureMessage: Bool
     ) throws {
         guard let xUnitOutput = options.xUnitOutput else {
             return
@@ -430,7 +428,10 @@ public struct SwiftTestCommand: AsyncSwiftCommand {
             fileSystem: swiftCommandState.fileSystem,
             results: testResults
         )
-        try generator.generate(at: xUnitOutput, detailedFailureMessage: detailedFailureMessage)
+        try generator.generate(
+            at: xUnitOutput,
+            detailedFailureMessage: self.options.shouldShowDetailedFailureMessage
+        )
     }
 
     // MARK: - Common implementation
@@ -1418,14 +1419,7 @@ final class XUnitGenerator {
                 """
 
             if !result.success {
-                var failureMessage: String = "failed"
-                if detailedFailureMessage {
-                    failureMessage = result.output
-                    failureMessage.replace("&", with: "&")
-                    failureMessage.replace("\"", with:""")
-                    failureMessage.replace(">", with: ">")
-                    failureMessage.replace("<", with: "&lt;")
-                }
+                let failureMessage = detailedFailureMessage ? result.output.map(_escapeForXML).joined() : "failure"
                 content += "<failure message=\"\(failureMessage)\"></failure>\n"
             }
 
@@ -1443,6 +1437,32 @@ final class XUnitGenerator {
     }
 }
 
+/// Escape a single Unicode character for use in an XML-encoded string.
+///
+/// - Parameters:
+///   - character: The character to escape.
+///
+/// - Returns: `character`, or a string containing its escaped form.
+private func _escapeForXML(_ character: Character) -> String {
+    switch character {
+    case "\"":
+        "&quot;"
+    case "<":
+        "&lt;"
+    case ">":
+        "&gt;"
+    case "&":
+        "&amp;"
+    case _ where !character.isASCII || character.isNewline:
+    character.unicodeScalars.lazy
+        .map(\.value)
+        .map { "&#\($0);" }
+        .joined()
+    default:
+    String(character)
+    }
+}
+
 extension SwiftCommandState {
     func buildParametersForTest(
         options: TestCommandOptions

Sources/_InternalTestSupport/SwiftPMProduct.swift

@@ -76,14 +76,15 @@ extension SwiftPM {
     ///         - args: The arguments to pass.
     ///         - env: Additional environment variables to pass. The values here are merged with default env.
     ///         - packagePath: Adds argument `--package-path <path>` if not nil.
+    ///         - throwIfCommandFails: If set, will throw an error if the command does not have a 0 return code.
     ///
     /// - Returns: The output of the process.
     @discardableResult
     public func execute(
         _ args: [String] = [],
         packagePath: AbsolutePath? = nil,
         env: Environment? = nil,
-        errorIfCommandUnsuccessful: Bool = true
+        throwIfCommandFails: Bool = true
     ) async throws -> (stdout: String, stderr: String) {
         let result = try await executeProcess(
             args,
@@ -95,7 +96,7 @@ extension SwiftPM {
         let stderr = try result.utf8stderrOutput()
 
         let returnValue = (stdout: stdout, stderr: stderr)
-        if (!errorIfCommandUnsuccessful) { return returnValue }
+        if (!throwIfCommandFails) { return returnValue }
 
         if result.exitStatus == .terminated(code: 0) {
             return returnValue

Tests/CommandsTests/TestCommandTests.swift

@@ -21,9 +21,9 @@ final class TestCommandTests: CommandsTestCase {
     private func execute(
         _ args: [String],
         packagePath: AbsolutePath? = nil,
-        errorIfCommandUnsuccessful: Bool = true
+        throwIfCommandFails: Bool = true
     ) async throws -> (stdout: String, stderr: String) {
-        try await SwiftPM.Test.execute(args, packagePath: packagePath, errorIfCommandUnsuccessful: errorIfCommandUnsuccessful)
+        try await SwiftPM.Test.execute(args, packagePath: packagePath, throwIfCommandFails: throwIfCommandFails)
     }
 
     func testUsage() async throws {
@@ -208,7 +208,7 @@ final class TestCommandTests: CommandsTestCase {
                     xUnitOutput.pathString
                 ] + extraCommandArgs,
                 packagePath: fixturePath,
-                errorIfCommandUnsuccessful: false
+                throwIfCommandFails: false
             )
 
             // THEN we expect \(xUnitUnderTest) to exists