Refactored a11y snapshot hadling to be optionally enabled

Author: LukasLiebl

Sources/TestingExtensions/SnapshotTestBase.swift

@@ -13,6 +13,19 @@ import SwiftUI
 import XCTest
 import AccessibilitySnapshot
 
+extension SnapshotTestBase {
+    public typealias DeviceConfiguration = (name: String, device: ViewImageConfig)
+}
+
+extension SnapshotTestBase {
+    /// Configuration of Accessibility snapshots.
+    public enum A11ySnapshotConfiguration {
+        case disabled
+        case enabled
+        case enabledWithDevices([DeviceConfiguration])
+    }
+}
+
 open class SnapshotTestBase: XCTestCase {
     public var allowAnimations: Bool = false
 
@@ -21,7 +34,7 @@ open class SnapshotTestBase: XCTestCase {
         UIView.setAnimationsEnabled(allowAnimations)
     }
 
-    open var defaultDevices: [(name: String, device: ViewImageConfig)] {
+    open var defaultDevices: [DeviceConfiguration] {
         [
             ("iPhone8", .iPhone8),
             ("iPhone13proMax", .iPhone13ProMax),
@@ -30,16 +43,27 @@ open class SnapshotTestBase: XCTestCase {
         ]
     }
 
-    open var accessibilityDevices: [(name: String, device: ViewImageConfig)] {
+    open var a11yDefaultDevices: [DeviceConfiguration] {
         [
             ("iPhone13pro", .iPhone13)
         ]
     }
-
+    
+    /// Asserts snapshots on the given devices (or default) respecting it's parameters.
+    /// - Parameters:
+    ///   - view: The view to be snapshotted
+    ///   - devices: Specified devices, if not given it'll take default devices
+    ///   - a11ySnapshotConfiguration: Accessibility snapshot configuration, if enabled it adds a accessibility snapshot
+    ///   - style: `UIUserInterfaceStyle` to be applied
+    ///   - imageDiffPrecision: Precision of the compared images, 1 means it matches 100%, range is between 0 and 1.
+    ///   - file: The file this was executed from, it will be taken as the snapshot's file name.
+    ///   - testName: The test name taken as a part of the snapshot's file name.
+    ///   - line: The line number on which failure occurred. Defaults to the line number on which this
+    ///     function was called.
     open func assertSnapshotDevices<V: View>(
         _ view: V,
-        devices: [(name: String, device: ViewImageConfig)]? = nil,
-        accessibilityDevices: [(name: String, device: ViewImageConfig)]? = nil,
+        devices: [DeviceConfiguration]? = nil,
+        a11ySnapshotConfiguration: A11ySnapshotConfiguration = .disabled,
         style:  [UIUserInterfaceStyle] = [.unspecified],
         imageDiffPrecision: Float = 1.0,
         file: StaticString = #file,
@@ -74,7 +98,19 @@ open class SnapshotTestBase: XCTestCase {
             }
         }
 
-        (accessibilityDevices ?? self.accessibilityDevices).forEach { config in
+        let a11ySnapshotDevices: [DeviceConfiguration]? = {
+            switch a11ySnapshotConfiguration {
+            case .disabled:
+                return nil
+            case .enabled:
+                return a11yDefaultDevices
+            case .enabledWithDevices(let specifiedDevices):
+                return specifiedDevices
+            }
+        }()
+        
+        guard let a11ySnapshotDevices else { return }
+        a11ySnapshotDevices.forEach { config in
             let vc = UIHostingController(rootView: view)
             assertSnapshot(
                 of: vc,