Mark XCTFail as @_disfavoredOverload (#46)

* fix filename typo * Add regression test * Fix regression test
pointfreeco · Jan 11, 2023 · 16b23a2 · 16b23a2
1 parent a9daebf
commit 16b23a2
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/Sources/XCTestDynamicOverlay/XCTFail.swift b/Sources/XCTestDynamicOverlay/XCTFail.swift
@@ -10,6 +10,7 @@
     ///
     /// - Parameter message: An optional description of the assertion, for inclusion in test
     ///   results.
+    @_disfavoredOverload
     public func XCTFail(_ message: String = "") {
       guard
         let currentTestCase = XCTCurrentTestCase,
@@ -42,6 +43,7 @@
     ///
     /// - Parameter message: An optional description of the assertion, for inclusion in test
     ///   results.
+    @_disfavoredOverload
     public func XCTFail(_ message: String = "", file: StaticString, line: UInt) {
       _XCTFailureHandler(nil, true, "\(file)", line, "\(message.isEmpty ? "failed" : message)", nil)
     }
@@ -57,7 +59,9 @@
     // NB: It seems to be safe to import XCTest on Linux
     @_exported import func XCTest.XCTFail
   #else
+    @_disfavoredOverload
     public func XCTFail(_ message: String = "") {}
+    @_disfavoredOverload
     public func XCTFail(_ message: String = "", file: StaticString, line: UInt) {}
   #endif
 #else
@@ -69,6 +73,7 @@
   ///
   /// - Parameter message: An optional description of the assertion, for inclusion in test
   ///   results.
+  @_disfavoredOverload
   public func XCTFail(_ message: String = "") {}
 
   /// This function generates a failure immediately and unconditionally.
@@ -79,5 +84,6 @@
   ///
   /// - Parameter message: An optional description of the assertion, for inclusion in test
   ///   results.
+  @_disfavoredOverload
   public func XCTFail(_ message: String = "", file: StaticString, line: UInt) {}
 #endif
diff --git a/Tests/XCTestDynamicOverlayTests/XCTFailRegressionTests.swift b/Tests/XCTestDynamicOverlayTests/XCTFailRegressionTests.swift
@@ -0,0 +1,17 @@
+import XCTest
+import XCTestDynamicOverlay
+
+// This ensures `XCTest.XCTFail` takes precedence over `XCTestDynamicOverlay.XCTFail` when both are imported.
+//
+// For full details, see https://github.com/pointfreeco/swift-dependencies/issues/13
+public enum Foo {
+  func exampleHelper(
+    file: StaticString = #filePath,
+    line: UInt = #line
+  ) {
+    XCTFail(
+      "This should compile.",
+      file: file, line: line
+    )
+  }
+}
diff --git a/...TestDynamicOverlayTests/XCFailTests.swift → ...estDynamicOverlayTests/XCTFailTests.swift b/...TestDynamicOverlayTests/XCFailTests.swift → ...estDynamicOverlayTests/XCTFailTests.swift