Screenshot tests (#130)

* #9 Add snapshot testing library

* #9 Create script to boot test simulators

* #9 Create the UI test plan

* #9 Create shared schemes for test targets

* #9 Disable split view for UI tests

* #9 Fix fastlane dependencies

* #9 Add snapshot testing to the application

* #9 assert screenshots

* #9 fix swipe gestures on iPad

* #9 Fix accessing items in session verification screen

* #9 Workaround for flaky unit test

* #9 Specify scheme for alpha build

* #9 Add reference screenshots

* Update python script path and check assets for png check

* Update script path

* Use static timezone for simulator time

* Fix build after SwiftFormat

* Add changelog

* Upload failed screenshots artifact

* Always upload artifacts

* Update boot simulator script

* Update simulator overridden time

* Install pytz before tests

* Get time from Ruby script

* Disable SwiftUI animation when running UI tests

* Update screenshots after animation setting

* Include reference images in the artifact

* Update matching precision

* Update image matching precision & revert artifact content

* Include Xcode result in the artifact

* Update test output directory

* Disable gradient on splash screen for tests

* Tap next button explicitly

* Wait a bit before checking alert

* Wait 1 second

* Run SwiftFormat on project

* Ignore temporary screenshots

* Fix most of the PR remarks

* Fix conflicts

* Bump Python version to 3

* Update reference screenshots for authentication screens

* Update SwiftFormat

* Fix flakey session verification test.

* Update scheme.

Co-authored-by: Doug <douglase@element.io>

UnitTests/Sources/BugReportViewModelTests.swift

@@ -43,7 +43,7 @@ class BugReportViewModelTests: XCTestCase {
         let context = viewModel.context
 
         context.send(viewAction: .removeScreenshot)
-        await Task.yield()
+        try await Task.sleep(nanoseconds: 100_000_000)
         XCTAssertNil(context.viewState.screenshot)
     }
 }

UnitTests/Sources/ScreenshotDetectorTests.swift

@@ -27,14 +27,36 @@ class ScreenshotDetectorTests: XCTestCase {
             detector.autoRequestPHAuthorization = false
             detector.callback = { image, error in
 
+                defer {
+                    expectation.fulfill()
+                }
+
                 if PHPhotoLibrary.authorizationStatus(for: .readWrite) == .authorized {
                     //  if Photos already authorized on the simulator
 
-                    //  we should get an image
-                    XCTAssertNotNil(image)
+                    if PHAsset.fetchLastScreenshot() != nil {
+                        //  we should get an image
+                        XCTAssertNotNil(image)
 
-                    //  we should not get an error
-                    XCTAssertNil(error)
+                        //  we should not get an error
+                        XCTAssertNil(error)
+                    } else {
+                        //  otherwise we should not get an image
+                        XCTAssertNil(image)
+
+                        //  and get an error
+                        guard let error = error else {
+                            XCTFail("Should get an error")
+                            return
+                        }
+
+                        switch error {
+                        case ScreenshotDetectorError.loadFailed:
+                            break
+                        default:
+                            XCTFail("Unknown error")
+                        }
+                    }
                 } else {
                     //  otherwise we should not get an image
                     XCTAssertNil(image)
@@ -52,8 +74,6 @@ class ScreenshotDetectorTests: XCTestCase {
                         XCTFail("Unknown error")
                     }
                 }
-
-                expectation.fulfill()
             }
 
             NotificationCenter.default.post(name: UIApplication.userDidTakeScreenshotNotification, object: nil)

UnitTests/Sources/SessionVerificationViewModelTests.swift

@@ -31,7 +31,7 @@ class SessionVerificationViewModelTests: XCTestCase {
         viewModel = SessionVerificationViewModel(sessionVerificationControllerProxy: sessionVerificationController)
         context = viewModel.context
     }
-    
+
     func testRequestVerification() async {
         XCTAssertEqual(context.viewState.verificationState, .initial)