Merge pull request #206 from cashapp/entin/text-field-cursor

Hide text field and text view cursors while snapshotting

Author: NickEntin

Example/SnapshotTests/DefaultControlsTests.swift

@@ -101,6 +101,27 @@ final class DefaultControlsTests: SnapshotTestCase {
         SnapshotVerifyAccessibility(container)
     }
 
+    // MARK: - Text Input
+
+    func testTextFieldHidesCursor() {
+        let textField = UITextField()
+        textField.tintColor = .red
+        textField.isAccessibilityElement = false
+        textField.text = "Hello world"
+        textField.becomeFirstResponder()
+
+        let container = ContainerView(control: textField)
+        container.bounds.size = .init(width: 120, height: 44)
+
+        // This is testing flaky behavior, so run the test multiple times to ensure it's consistent.
+        for _ in 0..<10 {
+            SnapshotVerifyAccessibility(container)
+        }
+
+        // Ensure the tint color is restored.
+        XCTAssertEqual(textField.tintColor, .red)
+    }
+
 }
 
 // MARK: -

Example/SnapshotTests/ReferenceImages/_64/SnapshotTests.DefaultControlsTests/[email protected]

@@ -48,6 +48,22 @@ extension UIView {
     ) throws -> UIImage {
         let renderer = UIGraphicsImageRenderer(bounds: bounds)
 
+        // Hide the cursor of text inputs to prevent test flakes.
+        var viewTintsToRestore: [UIView: UIColor] = [:]
+        recursiveForEach(viewType: UITextField.self) { inputView in
+            viewTintsToRestore[inputView] = inputView.tintColor
+            inputView.tintColor = .clear
+        }
+        recursiveForEach(viewType: UITextView.self) { inputView in
+            viewTintsToRestore[inputView] = inputView.tintColor
+            inputView.tintColor = .clear
+        }
+        defer {
+            viewTintsToRestore.forEach { inputView, tintColor in
+                inputView.tintColor = tintColor
+            }
+        }
+
         var error: Error?
 
         let snapshot = renderer.image { context in
@@ -191,4 +207,14 @@ extension UIView {
 
     private static let tileSideLength: CGFloat = 2000
 
+    private func recursiveForEach<ViewType: UIView>(
+        viewType: ViewType.Type,
+        _ block: (ViewType) -> Void
+    ) {
+        if let view = self as? ViewType {
+            block(view)
+        }
+        subviews.forEach { $0.recursiveForEach(viewType: viewType, block) }
+    }
+
 }