Forward to Swift runtime assertions if nothing is injected (#8)

Co-authored-by: Paul Schmiedmayer <[email protected]>

CONTRIBUTORS.md

@@ -12,3 +12,4 @@ XCTRuntimeAssertions contributors
 ====================
 
 * [Paul Schmiedmayer](https://github.com/PSchmiedmayer)
+* [Andreas Bauer](https://github.com/Supereg)

Sources/XCTRuntimeAssertions/Counter.swift

@@ -1,7 +1,7 @@
 //
 // This source file is part of the Stanford XCTRuntimeAssertions open-source project
 //
-// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+// SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
 //
 // SPDX-License-Identifier: MIT
 //

Sources/XCTRuntimeAssertions/NeverReturn.swift

@@ -1,7 +1,7 @@
 //
 // This source file is part of the Stanford XCTRuntimeAssertions open-source project
 //
-// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+// SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
 //
 // SPDX-License-Identifier: MIT
 //

Sources/XCTRuntimeAssertions/XCTRuntimeAssertion.swift

@@ -12,19 +12,19 @@ import Foundation
 
 /// `XCTRuntimeAssertion` allows you to test assertions of types that use the `assert` and `assertionFailure` functions of the `XCTRuntimeAssertions` target.
 /// - Parameters:
-///   - validateRuntimeAssertion: An optional closure that can be used to furhter validate the messages passed to the
+///   - validateRuntimeAssertion: An optional closure that can be used to further validate the messages passed to the
 ///                               `assert` and `assertionFailure` functions of the `XCTRuntimeAssertions` target.
 ///   - expectedFulfillmentCount: The expected fulfillment count on how often the `assert` and `assertionFailure` functions of
-///                               the `XCTRuntimeAssertions` target are called. The defailt value is 1.
+///                               the `XCTRuntimeAssertions` target are called. The default value is 1. The value must be non-zero.
 ///   - message: A message that is posted on failure.
 ///   - file: The file where the failure occurs. The default is the filename of the test case where you call this function.
 ///   - line: The line number where the failure occurs. The default is the line number where you call this function.
 ///   - expression: The expression that is evaluated.
-/// - Throws: Throws an `XCTFail` error if the expection does not trigger a runtime assertion with the parameters defined above.
+/// - Throws: Throws an `XCTFail` error if the expression does not trigger a runtime assertion with the parameters defined above.
 /// - Returns: The value of the function if it did not throw an error as it did not trigger a runtime assertion with the parameters defined above.
 public func XCTRuntimeAssertion<T>(
     validateRuntimeAssertion: ((String) -> Void)? = nil,
-    expectedFulfillmentCount: Int = 1,
+    expectedFulfillmentCount: UInt = 1,
     _ message: @autoclosure () -> String = "",
     file: StaticString = #filePath,
     line: UInt = #line,
@@ -35,24 +35,24 @@ public func XCTRuntimeAssertion<T>(
         fulfillmentCount: fulfillmentCount,
         validateRuntimeAssertion: validateRuntimeAssertion
     )
-    
+
     var result: Result<T, Error>
     do {
         result = .success(try expression())
     } catch {
         result = .failure(error)
     }
-    
+
     XCTRuntimeAssertionInjector.removeRuntimeAssertionInjector(withId: xctRuntimeAssertionId)
-    
+
     try assertFulfillmentCount(
         fulfillmentCount,
         expectedFulfillmentCount: expectedFulfillmentCount,
         message,
         file: file,
         line: line
     )
-    
+
     switch result {
     case let .success(returnValue):
         return returnValue
@@ -63,19 +63,19 @@ public func XCTRuntimeAssertion<T>(
 
 /// `XCTRuntimeAssertion` allows you to test async assertions of types that use the `assert` and `assertionFailure` functions of the `XCTRuntimeAssertions` target.
 /// - Parameters:
-///   - validateRuntimeAssertion: An optional closure that can be used to furhter validate the messages passed to the
+///   - validateRuntimeAssertion: An optional closure that can be used to further validate the messages passed to the
 ///                               `assert` and `assertionFailure` functions of the `XCTRuntimeAssertions` target.
 ///   - expectedFulfillmentCount: The expected fulfillment count on how often the `assert` and `assertionFailure` functions of
-///                               the `XCTRuntimeAssertions` target are called. The defailt value is 1.
+///                               the `XCTRuntimeAssertions` target are called. The default value is 1. The value must be non-zero.
 ///   - message: A message that is posted on failure.
 ///   - file: The file where the failure occurs. The default is the filename of the test case where you call this function.
 ///   - line: The line number where the failure occurs. The default is the line number where you call this function.
 ///   - expression: The async expression that is evaluated.
-/// - Throws: Throws an `XCTFail` error if the expection does not trigger a runtime assertion with the parameters defined above.
+/// - Throws: Throws an `XCTFail` error if the expression does not trigger a runtime assertion with the parameters defined above.
 /// - Returns: The value of the function if it did not throw an error as it did not trigger a runtime assertion with the parameters defined above.
 public func XCTRuntimeAssertion<T>(
     validateRuntimeAssertion: ((String) -> Void)? = nil,
-    expectedFulfillmentCount: Int = 1,
+    expectedFulfillmentCount: UInt = 1,
     _ message: @autoclosure () -> String = "",
     file: StaticString = #filePath,
     line: UInt = #line,
@@ -86,24 +86,24 @@ public func XCTRuntimeAssertion<T>(
         fulfillmentCount: fulfillmentCount,
         validateRuntimeAssertion: validateRuntimeAssertion
     )
-    
+
     var result: Result<T, Error>
     do {
         result = .success(try await expression())
     } catch {
         result = .failure(error)
     }
-    
+
     XCTRuntimeAssertionInjector.removeRuntimeAssertionInjector(withId: xctRuntimeAssertionId)
-    
+
     try assertFulfillmentCount(
         fulfillmentCount,
         expectedFulfillmentCount: expectedFulfillmentCount,
         message,
         file: file,
         line: line
     )
-    
+
     switch result {
     case let .success(returnValue):
         return returnValue
@@ -115,7 +115,7 @@ public func XCTRuntimeAssertion<T>(
 
 private func setupXCTRuntimeAssertionInjector(fulfillmentCount: Counter, validateRuntimeAssertion: ((String) -> Void)? = nil) -> UUID {
     let xctRuntimeAssertionId = UUID()
-    
+
     XCTRuntimeAssertionInjector.inject(
         runtimeAssertionInjector: XCTRuntimeAssertionInjector(
             id: xctRuntimeAssertionId,
@@ -133,23 +133,26 @@ private func setupXCTRuntimeAssertionInjector(fulfillmentCount: Counter, validat
             }
         )
     )
-    
+
     return xctRuntimeAssertionId
 }
 
+
 private func assertFulfillmentCount(
     _ fulfillmentCount: Counter,
-    expectedFulfillmentCount: Int,
+    expectedFulfillmentCount: UInt,
     _ message: () -> String,
     file: StaticString,
     line: UInt
 ) throws {
+    Swift.precondition(expectedFulfillmentCount > 0, "expectedFulfillmentCount has to be non-zero!")
+
     if fulfillmentCount.counter != expectedFulfillmentCount {
         throw XCTFail(
             message: """
-            Measured an fulfillment count of \(fulfillmentCount.counter), expected \(expectedFulfillmentCount).
-            \(message()) at \(file):\(line)
-            """
+                     Measured an fulfillment count of \(fulfillmentCount.counter), expected \(expectedFulfillmentCount).
+                     \(message()) at \(file):\(line)
+                     """
         )
     }
 }

Sources/XCTRuntimeAssertions/XCTRuntimeAssertionInjector.swift

@@ -35,8 +35,8 @@ class XCTRuntimeAssertionInjector {
     ) {
         self.id = id
         self._assert = assert
-        self._precondition = { _, condition, messsage, file, line in
-            Swift.precondition(condition(), messsage(), file: file, line: line)
+        self._precondition = { _, condition, message, file, line in
+            Swift.precondition(condition(), message(), file: file, line: line)
         }
     }
 
@@ -45,8 +45,8 @@ class XCTRuntimeAssertionInjector {
         precondition: @escaping (UUID, () -> Bool, () -> String, StaticString, UInt) -> Void
     ) {
         self.id = id
-        self._assert = { _, condition, messsage, file, line in
-            Swift.assert(condition(), messsage(), file: file, line: line)
+        self._assert = { _, condition, message, file, line in
+            Swift.assert(condition(), message(), file: file, line: line)
         }
         self._precondition = precondition
     }
@@ -55,11 +55,11 @@ class XCTRuntimeAssertionInjector {
         id: UUID
     ) {
         self.id = id
-        self._assert = { _, condition, messsage, file, line in
-            Swift.assert(condition(), messsage(), file: file, line: line)
+        self._assert = { _, condition, message, file, line in
+            Swift.assert(condition(), message(), file: file, line: line)
         }
-        self._precondition = { _, condition, messsage, file, line in
-            Swift.precondition(condition(), messsage(), file: file, line: line)
+        self._precondition = { _, condition, message, file, line in
+            Swift.precondition(condition(), message(), file: file, line: line)
         }
     }
 
@@ -74,12 +74,20 @@ class XCTRuntimeAssertionInjector {
 
 
     static func assert(_ condition: () -> Bool, message: () -> String, file: StaticString, line: UInt) {
+        if injected.isEmpty {
+            Swift.assert(condition(), message(), file: file, line: line)
+        }
+
         for runtimeAssertionInjector in injected {
             runtimeAssertionInjector._assert(runtimeAssertionInjector.id, condition, message, file, line)
         }
     }
 
     static func precondition(_ condition: () -> Bool, message: () -> String, file: StaticString, line: UInt) {
+        if injected.isEmpty {
+            Swift.precondition(condition(), message(), file: file, line: line)
+        }
+
         for runtimeAssertionInjector in injected {
             runtimeAssertionInjector._precondition(runtimeAssertionInjector.id, condition, message, file, line)
         }

Sources/XCTRuntimeAssertions/XCTRuntimePrecondition.swift

@@ -12,14 +12,14 @@ import Foundation
 
 /// `XCTRuntimePrecondition` allows you to test assertions of types that use the `precondition` and `preconditionFailure` functions of the `XCTRuntimeAssertions` target.
 /// - Parameters:
-///   - validateRuntimeAssertion: An optional closure that can be used to furhter validate the messages passed to the
+///   - validateRuntimeAssertion: An optional closure that can be used to further validate the messages passed to the
 ///                               `precondition` and `preconditionFailure` functions of the `XCTRuntimeAssertions` target.
 ///   - timeout: A timeout defining how long to wait for the precondition to be triggered.
 ///   - message: A message that is posted on failure.
 ///   - file: The file where the failure occurs. The default is the filename of the test case where you call this function.
 ///   - line: The line number where the failure occurs. The default is the line number where you call this function.
 ///   - expression: The expression that is evaluated.
-/// - Throws: Throws an `XCTFail` error if the expection does not trigger a runtime assertion with the parameters defined above.
+/// - Throws: Throws an `XCTFail` error if the expression does not trigger a runtime assertion with the parameters defined above.
 public func XCTRuntimePrecondition(
     validateRuntimeAssertion: ((String) -> Void)? = nil,
     timeout: Double = 0.01,
@@ -48,26 +48,26 @@ public func XCTRuntimePrecondition(
     usleep(useconds_t(1_000_000 * timeout))
     expressionWorkItem.cancel()
 
+    XCTRuntimeAssertionInjector.removeRuntimeAssertionInjector(withId: xctRuntimeAssertionId)
+
     try assertFulfillmentCount(
         fulfillmentCount,
         message,
         file: file,
         line: line
     )
-
-    XCTRuntimeAssertionInjector.removeRuntimeAssertionInjector(withId: xctRuntimeAssertionId)
 }
 
 /// `XCTRuntimePrecondition` allows you to test async assertions of types that use the `precondition` and `preconditionFailure` functions of the `XCTRuntimeAssertions` target.
 /// - Parameters:
-///   - validateRuntimeAssertion: An optional closure that can be used to furhter validate the messages passed to the
+///   - validateRuntimeAssertion: An optional closure that can be used to further validate the messages passed to the
 ///                               `precondition` and `preconditionFailure` functions of the `XCTRuntimeAssertions` target.
 ///   - timeout: A timeout defining how long to wait for the precondition to be triggered.
 ///   - message: A message that is posted on failure.
 ///   - file: The file where the failure occurs. The default is the filename of the test case where you call this function.
 ///   - line: The line number where the failure occurs. The default is the line number where you call this function.
 ///   - expression: The async expression that is evaluated.
-/// - Throws: Throws an `XCTFail` error if the expection does not trigger a runtime assertion with the parameters defined above.
+/// - Throws: Throws an `XCTFail` error if the expression does not trigger a runtime assertion with the parameters defined above.
 public func XCTRuntimePrecondition(
     validateRuntimeAssertion: ((String) -> Void)? = nil,
     timeout: Double = 0.01,
@@ -92,14 +92,14 @@ public func XCTRuntimePrecondition(
     usleep(useconds_t(1_000_000 * timeout))
     task.cancel()
 
+    XCTRuntimeAssertionInjector.removeRuntimeAssertionInjector(withId: xctRuntimeAssertionId)
+
     try assertFulfillmentCount(
         fulfillmentCount,
         message,
         file: file,
         line: line
     )
-
-    XCTRuntimeAssertionInjector.removeRuntimeAssertionInjector(withId: xctRuntimeAssertionId)
 }
 
 

Tests/XCTRuntimeAssertionsTests/XCTRuntimeAssertionsTests.swift

@@ -75,7 +75,7 @@ final class XCTRuntimeAssertionsTests: XCTestCase {
         await fulfillment(of: [expectation], timeout: 0.1)
     }
 
-    func testXCTRuntimeAssertationNotTriggered() throws {
+    func testXCTRuntimeAssertionNotTriggered() throws {
         struct XCTRuntimeAssertionNotTriggeredError: Error {}
 
         do {
@@ -95,4 +95,15 @@ final class XCTRuntimeAssertionsTests: XCTestCase {
             XCTAssertTrue(error.description.contains("Measured an fulfillment count of 0, expected 1."))
         }
     }
+
+    func testCallHappensWithoutInjection() {
+        var called = false
+
+        assert({
+            called = true
+            return true
+        }(), "This could fail")
+
+        XCTAssertTrue(called, "assert was never called!")
+    }
 }

Tests/XCTRuntimeAssertionsTests/XCTRuntimePreconditionsTests.swift

@@ -26,7 +26,7 @@ final class XCTRuntimePreconditionsTests: XCTestCase {
         ) {
             precondition(number != 42, "preconditionFailure()")
         }
-        
+
         wait(for: [expectation], timeout: 0.01)
 
 
@@ -78,7 +78,18 @@ final class XCTRuntimePreconditionsTests: XCTestCase {
             }
         } catch let error as XCTFail {
             try? await Task.sleep(for: .seconds(0.5))
-            XCTAssertTrue(error.description.contains("The precondition was never called."))
+            XCTAssertTrue(error.description.contains("The precondition was called multiple times."))
         }
     }
+
+    func testCallHappensWithoutInjection() {
+        var called = false
+
+        precondition({
+            called = true
+            return true
+        }(), "This could fail")
+
+        XCTAssertTrue(called, "precondition was never called!")
+    }
 }