Add UI Test suite

.github/workflows/ci.yml

@@ -132,9 +132,9 @@ jobs:
         run: fastlane test platform:${{ matrix.platform[0] }} version:${{ matrix.platform[1] }} scheme:Introspect
 
       - if: ${{ join(matrix.platform, ' ') != 'macos 11' }}
-        name: Run Tests (SwiftUIIntrospect, Debug)
+        name: Run Tests (SwiftUIIntrospect)
         run: fastlane test platform:${{ matrix.platform[0] }} version:${{ matrix.platform[1] }} scheme:SwiftUIIntrospectTests configuration:Debug
 
-      - if: ${{ join(matrix.platform, ' ') != 'macos 11' }}
-        name: Run Tests (SwiftUIIntrospect, Release)
-        run: fastlane test platform:${{ matrix.platform[0] }} version:${{ matrix.platform[1] }} scheme:SwiftUIIntrospectTests configuration:Release
+      - if: ${{ matrix.platform[0] == 'ios' && matrix.platform[1] >= '14' && matrix.platform[1] <= '16' }}
+        name: Run UI Tests (SwiftUIIntrospect)
+        run: fastlane test platform:${{ matrix.platform[0] }} version:${{ matrix.platform[1] }} scheme:SwiftUIIntrospectUITests configuration:Debug

SwiftUIIntrospect.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -0,0 +1,23 @@
+{
+  "pins" : [
+    {
+      "identity" : "simulatorstatusmagic",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/shinydevelopment/SimulatorStatusMagic",
+      "state" : {
+        "revision" : "76095ec820674457a11dc3cc621d8a5c369eea0e",
+        "version" : "2.7.0"
+      }
+    },
+    {
+      "identity" : "swift-snapshot-testing",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/pointfreeco/swift-snapshot-testing.git",
+      "state" : {
+        "revision" : "dc46eeb3928a75390651fac6c1ef7f93ad59a73b",
+        "version" : "1.11.1"
+      }
+    }
+  ],
+  "version" : 2
+}

Tests/Tests.xcodeproj/xcshareddata/xcschemes/SwiftUIIntrospectUITests.xcscheme

@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1500"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "D58D833E2A66C5EC00A203BE"
+               BuildableName = "UITestsHostApp.app"
+               BlueprintName = "UITestsHostApp"
+               ReferencedContainer = "container:Tests.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <TestPlans>
+         <TestPlanReference
+            reference = "container:UITests/UITests.xctestplan"
+            default = "YES">
+         </TestPlanReference>
+      </TestPlans>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "D58D833E2A66C5EC00A203BE"
+            BuildableName = "UITestsHostApp.app"
+            BlueprintName = "UITestsHostApp"
+            ReferencedContainer = "container:Tests.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "D58D833E2A66C5EC00A203BE"
+            BuildableName = "UITestsHostApp.app"
+            BlueprintName = "UITestsHostApp"
+            ReferencedContainer = "container:Tests.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

Tests/UITests/StatusBarStyleUITests.swift

@@ -0,0 +1,30 @@
+import SnapshotTesting
+import XCTest
+
+final class StatusBarStyleUITests: UITestCase {
+    override var testCase: TestCase {
+        .statusBarStyle
+    }
+
+    func test() throws {
+        guard #unavailable(iOS 17) else {
+            throw XCTSkip("SimulatorStatusMagic stopped working in iOS 17, so we can no longer consistently compare status bar screenshots")
+        }
+
+        app.buttons["Navigate To Detail"].tap()
+        app.buttons["Navigate To Detail"].tap()
+        app.buttons["Navigate Back"].tap()
+
+        let iOSDevice = UIDevice.current.userInterfaceIdiom == .pad ? "ipad" : "iphone"
+        let iOSVersion = ProcessInfo().operatingSystemVersion
+        func screenshotName(_ number: Int) -> String {
+            "\(iOSDevice)-ios-\(iOSVersion.majorVersion)-screenshot-\(number)"
+        }
+
+        assertSnapshot(
+            matching: app.windows.firstMatch.screenshot().image,
+            as: .image(perceptualPrecision: 0.95),
+            named: screenshotName(1)
+        )
+    }
+}

Tests/UITests/UITestCase.swift

@@ -0,0 +1,21 @@
+import SimulatorStatusMagic
+import XCTest
+
+class UITestCase: XCTestCase {
+    var testCase: TestCase {
+        preconditionFailure("Please override this property")
+    }
+
+    let app = XCUIApplication()
+
+    override func invokeTest() {
+        SDStatusBarManager.sharedInstance().enableOverrides()
+
+        continueAfterFailure = false
+
+        app.launchEnvironment["testCase"] = testCase.rawValue
+        app.launch()
+
+        super.invokeTest()
+    }
+}

Tests/UITests/UITests.xctestplan

@@ -0,0 +1,24 @@
+{
+  "configurations" : [
+    {
+      "id" : "DD0EEECD-4762-4A68-91A8-F7B5A2209B45",
+      "name" : "Test Scheme Action",
+      "options" : {
+
+      }
+    }
+  ],
+  "defaultOptions" : {
+
+  },
+  "testTargets" : [
+    {
+      "target" : {
+        "containerPath" : "container:Tests.xcodeproj",
+        "identifier" : "D58D832A2A66BDD500A203BE",
+        "name" : "UITests"
+      }
+    }
+  ],
+  "version" : 1
+}

Tests/UITestsHostApp/Assets.xcassets/AccentColor.colorset/Contents.json

@@ -0,0 +1,11 @@
+{
+  "colors" : [
+    {
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Tests/UITestsHostApp/Assets.xcassets/AppIcon.appiconset/Contents.json

@@ -0,0 +1,13 @@
+{
+  "images" : [
+    {
+      "idiom" : "universal",
+      "platform" : "ios",
+      "size" : "1024x1024"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Tests/UITestsHostApp/Assets.xcassets/Contents.json

@@ -0,0 +1,6 @@
+{
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Tests/UITestsHostApp/Info.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>UIViewControllerBasedStatusBarAppearance</key>
+	<true/>
+</dict>
+</plist>

Tests/UITestsHostApp/Preview Content/Preview Assets.xcassets/Contents.json

@@ -0,0 +1,6 @@
+{
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Tests/UITestsHostApp/StatusBarStyle/HostingController.swift

@@ -0,0 +1,32 @@
+//
+//  HostingController.swift
+//  Blago
+//
+//  Created by Dmytro Chumakov on 04.05.2023.
+//
+
+import SwiftUI
+
+final class HostingController<ContentView>: UIHostingController<ContentView> where ContentView: View {
+
+    var statusBarStyle: UIStatusBarStyle = .darkContent
+    var isInteractivePopGestureEnabled = true
+
+    override var preferredStatusBarStyle: UIStatusBarStyle {
+        statusBarStyle
+    }
+
+    override func viewDidLoad() {
+        super.viewDidLoad()
+        navigationController?.interactivePopGestureRecognizer?.isEnabled = isInteractivePopGestureEnabled
+    }
+
+    override func viewWillLayoutSubviews() {
+        super.viewWillLayoutSubviews()
+
+        guard #available(iOS 16, *) else {
+            navigationController?.setNavigationBarHidden(true, animated: false)
+            return
+        }
+    }
+}

Tests/UITestsHostApp/StatusBarStyle/NavigationView.swift

@@ -0,0 +1,44 @@
+
+//
+//  NavigationController.swift
+//  Blago
+//
+//  Created by Dmytro Chumakov on 11.05.2023.
+//
+
+import UIKit
+
+// MARK: - NavigationController
+
+final class NavigationController: UINavigationController {
+
+    static var shared: UINavigationController?
+
+    // MARK: Lifecycle
+
+    override init(rootViewController: UIViewController) {
+        super.init(rootViewController: rootViewController)
+        setNavigationBarHidden(true, animated: false)
+    }
+
+    required init?(coder _: NSCoder) {
+        fatalError("init(coder:) has not been implemented")
+    }
+
+    override var preferredStatusBarStyle: UIStatusBarStyle {
+        topViewController?.preferredStatusBarStyle ?? .default
+    }
+
+    override func viewDidLoad() {
+        super.viewDidLoad()
+        interactivePopGestureRecognizer?.delegate = self
+    }
+}
+
+// MARK: UIGestureRecognizerDelegate
+
+extension NavigationController: UIGestureRecognizerDelegate {
+    func gestureRecognizerShouldBegin(_: UIGestureRecognizer) -> Bool {
+        viewControllers.count > 1
+    }
+}

Tests/UITestsHostApp/StatusBarStyle/RootView.swift

@@ -0,0 +1,52 @@
+//
+//  RootView.swift
+//  Showcase
+//
+//  Created by Orackle on 14.07.2023.
+//
+
+import SwiftUI
+import SwiftUIIntrospect
+
+struct RootView: View {
+
+    var body: some View {
+        VStack {
+            Button("Navigate To Detail", action: navigateToDetail)
+        }
+    }
+
+    private func navigateToDetail() {
+        let controller = HostingController(rootView: DetailView())
+        controller.statusBarStyle = .lightContent
+        NavigationController.shared?.pushViewController(controller, animated: true)
+    }
+}
+
+struct DetailView: View {
+    @Environment(\.presentationMode) var dismiss
+
+    var body: some View {
+        ZStack {
+            Color.red.edgesIgnoringSafeArea(.all)
+
+            VStack {
+                Button("Navigate To Detail", action: navigateToDetail)
+                Button("Navigate Back", action: goBack)
+            }
+        }
+        .introspect(.viewController, on: .iOS(.v13, .v14, .v15, .v16)) { viewController in
+            /// some customizations there
+        }
+    }
+
+    private func goBack() {
+        dismiss.wrappedValue.dismiss()
+    }
+
+    private func navigateToDetail() {
+        let controller = HostingController(rootView: DetailView())
+        controller.statusBarStyle = .lightContent
+        NavigationController.shared?.pushViewController(controller, animated: true)
+    }
+}

Tests/UITestsHostApp/TestCases.swift

@@ -0,0 +1,3 @@
+public enum TestCase: String {
+    case statusBarStyle = "Status Bar Style"
+}