Updated documentation

o-nnerb · o-nnerb · commit ebd1dbc2aa39 · 2025-06-29T11:53:02.000-03:00
diff --git a/README.md b/README.md
diff --git a/Sources/InlineSnapshotTesting/AssertInline.swift b/Sources/InlineSnapshotTesting/AssertInline.swift
@@ -1,13 +1,11 @@
 import Foundation
 @_spi(Internals) import XCTSnapshot
-@preconcurrency import XCTest
 
 #if canImport(SwiftSyntax601)
 @_spi(Internals) import XCTSnapshot
 import SwiftParser
 import SwiftSyntax
 import SwiftSyntaxBuilder
-import XCTest
 
 /// Asserts that a given value matches an inline string snapshot using the specified snapshot testing strategy.
 ///
@@ -74,15 +72,15 @@ public func assertInline<Input: Sendable, Output: BytesRepresentable>(
 
     switch failure.reason {
     case .doesNotMatch:
-        closureDescriptor.fail(
+        try closureDescriptor.fail(
             failure.message,
             fileID: fileID,
             file: filePath,
             line: line,
             column: column
         )
     default:
-        TestingSystem.shared.record(
+        try TestingSystem.shared.record(
             message: failure.message,
             fileID: fileID,
             filePath: filePath,
@@ -158,15 +156,15 @@ public func assertInline<Input, Output: BytesRepresentable>(
 
     switch failure.reason {
     case .doesNotMatch:
-        closureDescriptor.fail(
+        try closureDescriptor.fail(
             failure.message,
             fileID: fileID,
             file: filePath,
             line: line,
             column: column
         )
     default:
-        TestingSystem.shared.record(
+        try TestingSystem.shared.record(
             message: failure.message,
             fileID: fileID,
             filePath: filePath,
diff --git a/Sources/InlineSnapshotTesting/SnapshotInlineEngine.swift b/Sources/InlineSnapshotTesting/SnapshotInlineEngine.swift
@@ -1,6 +1,6 @@
 #if canImport(SwiftSyntax601)
 import SwiftSyntax
-import XCTest
+import Foundation
 @_spi(Internals) import XCTSnapshot
 
 struct SnapshotInlineEngine<Executor: SnapshotExecutor>: SnapshotEngine where Executor.Output: BytesRepresentable {
diff --git a/Sources/InlineSnapshotTesting/SnapshotInlineObservation.swift b/Sources/InlineSnapshotTesting/SnapshotInlineObservation.swift
@@ -1,5 +1,5 @@
 @_spi(Internals) import XCTSnapshot
-import XCTest
+import Foundation
 
 final class SnapshotInlineObservation: @unchecked Sendable {
 
diff --git a/Sources/InlineSnapshotTesting/SwiftSyntax/SnapshotClosureDescriptor.swift b/Sources/InlineSnapshotTesting/SwiftSyntax/SnapshotClosureDescriptor.swift
@@ -100,7 +100,7 @@ public struct SnapshotClosureDescriptor: Sendable, Hashable {
         file filePath: StaticString,
         line: UInt,
         column: UInt
-    ) {
+    ) throws {
         var trailingClosureLine: Int?
         if let testSource = InlineSnapshotManager.current[SnapshotURL(path: filePath)] {
             let visitor = SnapshotVisitor(
@@ -113,7 +113,7 @@ public struct SnapshotClosureDescriptor: Sendable, Hashable {
             trailingClosureLine = visitor.trailingClosureLine
         }
 
-        TestingSystem.shared.record(
+        try TestingSystem.shared.record(
             message: message(),
             fileID: fileID,
             filePath: filePath,
diff --git a/Sources/XCTSnapshot/Assert/Assert.swift b/Sources/XCTSnapshot/Assert/Assert.swift
@@ -1,4 +1,4 @@
-import XCTest
+import Foundation
 
 // MARK: - Assert snapshot
 
@@ -73,7 +73,7 @@ public func assert<Input: Sendable, Output: BytesRepresentable>(
 
     guard let message = failure else { return }
 
-    TestingSystem.shared.record(
+    try TestingSystem.shared.record(
         message: message,
         fileID: fileID,
         filePath: filePath,
@@ -295,7 +295,7 @@ public func assert<Input, Output: BytesRepresentable>(
 
     guard let message = failure else { return }
 
-    TestingSystem.shared.record(
+    try TestingSystem.shared.record(
         message: message,
         fileID: fileID,
         filePath: filePath,
diff --git a/Sources/XCTSnapshot/Assert/CleanCounterBetweenTestCases.swift b/Sources/XCTSnapshot/Assert/CleanCounterBetweenTestCases.swift
@@ -1,3 +1,4 @@
+#if canImport(XCTest)
 import XCTest
 
 final class CleanCounterBetweenTestCases: NSObject, XCTestObservation {
@@ -27,6 +28,7 @@ extension XCTestCase {
         CleanCounterBetweenTestCases.registerIfNeeded()
     }
 }
+#endif
 
 @_spi(Internals)
 public let XCTestBundleDidFinishNotification = Notification.Name(
diff --git a/Sources/XCTSnapshot/Diff/Defaults/DataDiffAttachmentGenerator.swift b/Sources/XCTSnapshot/Diff/Defaults/DataDiffAttachmentGenerator.swift
@@ -1,5 +1,4 @@
 import Foundation
-import XCTest
 
 /// A diff attachment generator that compares two data blobs (typically images or binary snapshots) and generates an attachment describing any differences.
 ///
diff --git a/Sources/XCTSnapshot/Diff/Defaults/ImageDiffAttachmentGenerator.swift b/Sources/XCTSnapshot/Diff/Defaults/ImageDiffAttachmentGenerator.swift
@@ -1,5 +1,3 @@
-@preconcurrency import XCTest
-
 #if os(iOS) || os(tvOS) || os(watchOS)
 import UIKit
 #elseif os(macOS)
diff --git a/Sources/XCTSnapshot/Diff/Defaults/StringDiffAttachmentGenerator.swift b/Sources/XCTSnapshot/Diff/Defaults/StringDiffAttachmentGenerator.swift
@@ -1,5 +1,4 @@
 import Foundation
-import XCTest
 
 /// A diff attachment generator that compares two UTF-8 strings line-by-line and produces a patch-style text diff
 /// as an `SnapshotAttachment`. Calculates differences between collections using the Longest Common
diff --git a/Sources/XCTSnapshot/Diff/DiffAttachmentGenerator.swift b/Sources/XCTSnapshot/Diff/DiffAttachmentGenerator.swift
@@ -1,5 +1,4 @@
 import Foundation
-@preconcurrency import XCTest
 
 /// Container for messages and attachments generated during snapshot comparisons.
 ///
diff --git a/Sources/XCTSnapshot/Tester/SnapshotFileEngine.swift b/Sources/XCTSnapshot/Tester/SnapshotFileEngine.swift
@@ -1,5 +1,4 @@
 import Foundation
-@preconcurrency import XCTest
 
 #if os(iOS) || os(macOS) || os(tvOS) || os(watchOS) || os(visionOS)
 import CoreServices
diff --git a/Sources/XCTSnapshot/Tester/SnapshotTester.swift b/Sources/XCTSnapshot/Tester/SnapshotTester.swift
@@ -1,5 +1,7 @@
 import Foundation
-@preconcurrency import XCTest
+#if canImport(XCTest)
+import XCTest
+#endif
 
 @_spi(Internals)
 public struct SnapshotTester<Engine: SnapshotEngine>: Sendable {
@@ -35,7 +37,9 @@ public struct SnapshotTester<Engine: SnapshotEngine>: Sendable {
         column: UInt
     ) {
         if !TestingSystem.shared.isSwiftTestingRunning {
+            #if canImport(XCTest)
             XCTestCase.registerObserverIfNeeded()
+            #endif
         }
 
         self.engine = engine
@@ -87,17 +91,21 @@ public struct SnapshotTester<Engine: SnapshotEngine>: Sendable {
         _ input: Input,
         for snapshot: Snapshot<Executor>
     ) throws -> SnapshotFailure? where Executor == Sync<Input, Output> {
-        let tookSnapshot = XCTestExpectation(description: "Took snapshot")
+        let dispatchGroup = DispatchGroup()
         let unsafeDiffable = UnsafeSyncDiffable<Output>()
 
+        dispatchGroup.enter()
         snapshot.executor(input) { result in
             unsafeDiffable.result = result
-            tookSnapshot.fulfill()
+            dispatchGroup.leave()
         }
 
-        let result = XCTWaiter.wait(for: [tookSnapshot], timeout: timeout)
+        let result = dispatchGroup.wait(
+            timeout: .now() + .nanoseconds(Int(timeout * 1_000_000_000))
+        )
+
         switch result {
-        case .completed:
+        case .success:
             return try assert(
                 diffable: unsafeDiffable.result.get(),
                 pathExtension: snapshot.pathExtension,
@@ -109,10 +117,6 @@ public struct SnapshotTester<Engine: SnapshotEngine>: Sendable {
                 snapshotURL: FileManager.default.temporaryDirectory,
                 didWriteNewSnapshot: false
             )
-        case .incorrectOrder, .invertedFulfillment, .interrupted:
-            throw XCTestExecutionError()
-        @unknown default:
-            throw XCTestExecutionError()
         }
     }
 }
@@ -377,8 +381,6 @@ extension SnapshotTester {
     }
 }
 
-struct XCTestExecutionError: Error {}
-
 struct UnsafeSyncDiffableError: Error {}
 
 final class UnsafeSyncDiffable<Output: Sendable>: @unchecked Sendable {
diff --git a/Sources/XCTSnapshot/TestingSystem.swift b/Sources/XCTSnapshot/TestingSystem.swift
@@ -1,4 +1,7 @@
+import Foundation
+#if canImport(XCTest)
 @preconcurrency import XCTest
+#endif
 
 @_spi(Internals)
 public struct TestingSystemEnvironment {
@@ -87,12 +90,12 @@ public final class TestingSystem: Sendable {
                 column: column
             )
         } else {
-            #if !os(Linux) && !os(Android) && !os(Windows)
+            #if canImport(XCTest) && (os(iOS) || os(tvOS) || os(macOS) || os(visionOS) || os(watchOS))
             performOnMainThread {
                 XCTContext.runActivity(named: name) { activity in
                     for attachment in attachments {
                         activity.add(
-                            XCTAttachment.init(
+                            XCTAttachment(
                                 uniformTypeIdentifier: attachment.uniformTypeIdentifier,
                                 name: attachment.name,
                                 payload: attachment.payload
@@ -111,7 +114,7 @@ public final class TestingSystem: Sendable {
         filePath: StaticString,
         line: UInt,
         column: UInt
-    ) {
+    ) throws {
         if let swiftTestingSystem = self as? SwiftTestingSystem, swiftTestingSystem.isRunning {
             swiftTestingSystem.record(
                 message: message,
@@ -121,7 +124,27 @@ public final class TestingSystem: Sendable {
                 column: column
             )
         } else {
+            #if canImport(XCTest)
             XCTFail(message, file: filePath, line: line)
+            #else
+            throw TestingFailure(
+                message: message,
+                fileID: fileID,
+                filePath: filePath,
+                line: line,
+                column: column
+            )
+            #endif
         }
     }
 }
+
+#if !canImport(XCTest)
+public struct TestingFailure: Error {
+    public let message: String
+    public let fileID: StaticString
+    public let filePath: StaticString
+    public let line: UInt
+    public let column: UInt
+}
+#endif
diff --git a/Tests/InlineSnapshotTestingTests/InlineSnapshotTestingTests.swift b/Tests/InlineSnapshotTestingTests/InlineSnapshotTestingTests.swift
@@ -1,5 +1,7 @@
 import Foundation
 import SnapshotTesting
+
+#if canImport(XCTest)
 import XCTest
 
 @testable import InlineSnapshotTesting
@@ -347,3 +349,4 @@ private func assertCustomInlineSnapshot(
         column: column
     )
 }
+#endif
diff --git a/Tests/InlineSnapshotTestingTests/Internal/BaseTestCase.swift b/Tests/InlineSnapshotTestingTests/Internal/BaseTestCase.swift
@@ -1,4 +1,6 @@
 import SnapshotTesting
+
+#if canImport(XCTest)
 import XCTest
 
 class BaseTestCase: XCTestCase {
@@ -11,3 +13,4 @@ class BaseTestCase: XCTestCase {
         }
     }
 }
+#endif
diff --git a/Tests/SnapshotTestingCustomDumpTests/CustomDumpTests.swift b/Tests/SnapshotTestingCustomDumpTests/CustomDumpTests.swift
@@ -1,5 +1,7 @@
 import SnapshotTestingCustomDump
 import XCTSnapshot
+
+#if canImport(XCTest)
 import XCTest
 
 class CustomDumpTests: XCTestCase {
@@ -74,3 +76,4 @@ class CustomDumpTests: XCTestCase {
         try assert(of: user, as: .customDump, named: "named")
     }
 }
+#endif
diff --git a/Tests/SnapshotTestingTests/Internal/TestHelpers.swift b/Tests/SnapshotTestingTests/Internal/TestHelpers.swift
diff --git a/Tests/XCTSnapshotTests/FoundationTests.swift b/Tests/XCTSnapshotTests/FoundationTests.swift
diff --git a/Tests/XCTSnapshotTests/Internal/BaseTestCase.swift b/Tests/XCTSnapshotTests/Internal/BaseTestCase.swift
diff --git a/Tests/XCTSnapshotTests/Internal/TestHelpers.swift b/Tests/XCTSnapshotTests/Internal/TestHelpers.swift
diff --git a/Tests/XCTSnapshotTests/UITests.swift b/Tests/XCTSnapshotTests/UITests.swift
diff --git a/Tests/XCTSnapshotTests/WithSnapshotTestingTests.swift b/Tests/XCTSnapshotTests/WithSnapshotTestingTests.swift

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+#if canImport(XCTest)`
`1`	`2`	`import XCTest`
`2`	`3`
`3`	`4`	`final class CleanCounterBetweenTestCases: NSObject, XCTestObservation {`
`@@ -27,6 +28,7 @@ extension XCTestCase {`
`27`	`28`	`CleanCounterBetweenTestCases.registerIfNeeded()`
`28`	`29`	`}`
`29`	`30`	`}`
	`31`	`+#endif`
`30`	`32`
`31`	`33`	`@_spi(Internals)`
`32`	`34`	`public let XCTestBundleDidFinishNotification = Notification.Name(`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`import Foundation`
`2`		`-import XCTest`
`3`	`2`
`4`	`3`	`/// A diff attachment generator that compares two data blobs (typically images or binary snapshots) and generates an attachment describing any differences.`
`5`	`4`	`///`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-@preconcurrency import XCTest`
`2`		`-`
`3`	`1`	`#if os(iOS) \|\| os(tvOS) \|\| os(watchOS)`
`4`	`2`	`import UIKit`
`5`	`3`	`#elseif os(macOS)`