Merge pull request #21 from GNMoseke/fix/failure-splitting

fix: split test failures around ' : ' to not mask XCTfail messages
GNMoseke · Jul 12, 2024 · 5cf8fc1 · 5cf8fc1
2 parents f004b0d + ab94a2e
commit 5cf8fc1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 11 deletions.
diff --git a/Sources/TestRunner.swift b/Sources/TestRunner.swift
@@ -358,7 +358,8 @@ class PeregrineRunner: TestRunner {
 
             var location = String(errorLocation.trimmingCharacters(in: [":", " "]))
             location.removeFirst(packagePathPrefix.count)
-            let failureComponents = testAndFail.split(separator: ":")
+            // The spaces are important here and this is quite beholden to spm output formatting, just be aware
+            let failureComponents = testAndFail.split(separator: " : ")
             guard
                 let testName = failureComponents.first?.trimmingCharacters(in: .whitespaces),
                 let failure = failureComponents.last

diff --git a/Tests/PeregrineTests/PeregrineTests.swift b/Tests/PeregrineTests/PeregrineTests.swift
@@ -70,7 +70,7 @@ class PeregrineTests: XCTestCase {
         var output = try await runner.runTests(tests: [])
         XCTAssertFalse(output.success)
         XCTAssertNil(output.backtraceLines)
-        var expectedErrors = [#"("Arthur Morgan") is not equal to ("Dutch Van Der Linde")"#]
+        var expectedErrors = [#"XCTAssertEqual failed: ("Arthur Morgan") is not equal to ("Dutch Van Der Linde")"#]
         XCTAssertEqual(output.results.map { $0.errors }.reduce([], +).map { $0.1 }, expectedErrors)
         XCTAssertEqual(output.results.map { $0.test }, [Test(suite: "SuiteOne", name: "testSingleFail")])
 
@@ -86,7 +86,10 @@ class PeregrineTests: XCTestCase {
         output = try await runner.runTests(tests: [])
         XCTAssertFalse(output.success)
         XCTAssertNil(output.backtraceLines)
-        expectedErrors = [#"("Hosea Matthews") is not equal to ("Dutch Van Der Linde") - Always listen to Hosea"#]
+        expectedErrors =
+            [
+                #"XCTAssertEqual failed: ("Hosea Matthews") is not equal to ("Dutch Van Der Linde") - Always listen to Hosea"#,
+            ]
         XCTAssertEqual(output.results.map { $0.errors }.reduce([], +).map { $0.1 }, expectedErrors)
         XCTAssertEqual(output.results.map { $0.test }, [Test(suite: "SuiteOne", name: "testCustomFailMessage")])
     }
@@ -103,10 +106,10 @@ class PeregrineTests: XCTestCase {
         XCTAssertFalse(output.success)
         XCTAssertNil(output.backtraceLines)
         let expectedErrors = Set([
-            #"("Calvin") is not equal to ("Hobbes")"#,
+            #"XCTAssertEqual failed: ("Calvin") is not equal to ("Hobbes")"#,
             #"XCTAssertTrue failed"#,
-            #"("1") is not equal to ("2")"#,
-            #""Zagreus""#,
+            #"XCTAssertEqual failed: ("1") is not equal to ("2")"#,
+            #"XCTAssertNil failed: "Zagreus""#,
         ])
         XCTAssertEqual(Set(output.results.map { $0.errors }.reduce([], +).map { $0.1 }), expectedErrors)
         XCTAssertEqual(
@@ -140,12 +143,12 @@ class PeregrineTests: XCTestCase {
         XCTAssertFalse(output.success)
         XCTAssertNil(output.backtraceLines)
         let expectedErrors = Set([
-            #"("Arthur Morgan") is not equal to ("Dutch Van Der Linde")"#,
-            #"("Hosea Matthews") is not equal to ("Dutch Van Der Linde") - Always listen to Hosea"#,
-            #"("Calvin") is not equal to ("Hobbes")"#,
+            #"XCTAssertEqual failed: ("Arthur Morgan") is not equal to ("Dutch Van Der Linde")"#,
+            #"XCTAssertEqual failed: ("Hosea Matthews") is not equal to ("Dutch Van Der Linde") - Always listen to Hosea"#,
+            #"XCTAssertEqual failed: ("Calvin") is not equal to ("Hobbes")"#,
             #"XCTAssertTrue failed"#,
-            #"("1") is not equal to ("2")"#,
-            #""Zagreus""#,
+            #"XCTAssertEqual failed: ("1") is not equal to ("2")"#,
+            #"XCTAssertNil failed: "Zagreus""#,
         ])
         XCTAssertEqual(Set(output.results.map { $0.errors }.reduce([], +).map { $0.1 }), expectedErrors)
         XCTAssertEqual(