Beam/UITests/Sources/AppLockUITests.swift

//
// Copyright 2022-2024 New Vector Ltd.
//
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
// Please see LICENSE files in the repository root for full details.
//

import XCTest

@MainActor
class AppLockUITests: XCTestCase {
    var app: XCUIApplication!
    
    enum Step {
        static let placeholder = 0
        static let lockScreen = 1
        static let failedUnlock = 2
        static let logoutAlert = 3
        static let forcedLogout = 4
        static let unlocked = 99
    }
    
    func testFlowEnabled() async throws {
        // Given an app with screen lock enabled.
        let client = try UITestsSignalling.Client(mode: .tests)
        app = Application.launch(.appLockFlow)
        await client.waitForApp()
        
        // Blank form representing an unlocked app.
        try await app.assertScreenshot(.appLockFlow, step: Step.unlocked)
        
        // When backgrounding the app.
        try client.send(.notification(name: UIApplication.didEnterBackgroundNotification))
        
        // Then the placeholder screen should obscure the content.
        try await app.assertScreenshot(.appLockFlow, step: Step.placeholder)
        
        // When foregrounding the app.
        try client.send(.notification(name: UIApplication.willEnterForegroundNotification))
        try? await Task.sleep(for: .milliseconds(100))
        try client.send(.notification(name: UIApplication.didBecomeActiveNotification))
        
        // Then the Lock Screen should be shown to enter a PIN.
        try await app.assertScreenshot(.appLockFlow, step: Step.lockScreen)
        
        // When entering a PIN
        enterPIN()
        
        // Then the app should be unlocked again.
        try await app.assertScreenshot(.appLockFlow, step: Step.unlocked)
    }
    
    func testFlowDisabled() async throws {
        // Given an app with screen lock enabled.
        let client = try UITestsSignalling.Client(mode: .tests)
        app = Application.launch(.appLockFlowDisabled)
        await client.waitForApp()
        
        // Blank form representing an unlocked app.
        try await app.assertScreenshot(.appLockFlow, step: Step.unlocked, delay: .seconds(0.5))
        
        // When backgrounding the app.
        try client.send(.notification(name: UIApplication.didEnterBackgroundNotification))
        
        // Then the app should remain unlocked.
        try await app.assertScreenshot(.appLockFlow, step: Step.unlocked, delay: .seconds(0.5))
        
        // When foregrounding the app.
        try client.send(.notification(name: UIApplication.willEnterForegroundNotification))
        try? await Task.sleep(for: .milliseconds(100))
        try client.send(.notification(name: UIApplication.didBecomeActiveNotification))
        
        // Then the app should still remain unlocked.
        try await app.assertScreenshot(.appLockFlow, step: Step.unlocked, delay: .seconds(0.5))
    }
    
    func testWrongPIN() async throws {
        // Given an app with screen lock enabled that is ready to unlock.
        let client = try UITestsSignalling.Client(mode: .tests)
        app = Application.launch(.appLockFlow)
        await client.waitForApp()
        
        try await app.assertScreenshot(.appLockFlow, step: Step.unlocked, delay: .seconds(0.5))
        try client.send(.notification(name: UIApplication.didEnterBackgroundNotification))
        try await Task.sleep(for: .milliseconds(500)) // Don't overwrite the previous signal immediately.
        
        try client.send(.notification(name: UIApplication.willEnterForegroundNotification))
        try? await Task.sleep(for: .milliseconds(100))
        try client.send(.notification(name: UIApplication.didBecomeActiveNotification))
        
        try await app.assertScreenshot(.appLockFlow, step: Step.lockScreen, delay: .seconds(0.5))
        
        // When entering an incorrect PIN
        enterWrongPIN()
        
        // Then the app should remain locked with a warning.
        try await app.assertScreenshot(.appLockFlow, step: Step.failedUnlock, delay: .seconds(0.5))
        
        // When entering it incorrectly twice more.
        enterWrongPIN()
        enterWrongPIN()
        
        // Then then the app should sign the user out.
        try await app.assertScreenshot(.appLockFlow, step: Step.logoutAlert, delay: .seconds(0.5))
        app.alerts.element.buttons[A11yIdentifiers.alertInfo.primaryButton].tap()
        try await app.assertScreenshot(.appLockFlow, step: Step.forcedLogout, delay: .seconds(0.5))
    }
    
    func testResignActive() async throws {
        // Given an app with screen lock enabled.
        let client = try UITestsSignalling.Client(mode: .tests)
        app = Application.launch(.appLockFlow)
        await client.waitForApp()
        
        // Blank form representing an unlocked app.
        try await app.assertScreenshot(.appLockFlow, step: Step.unlocked)
        
        // When the app resigns active but doesn't enter the background.
        try client.send(.notification(name: UIApplication.willResignActiveNotification))
        
        // Then the placeholder screen should obscure the content.
        try await app.assertScreenshot(.appLockFlow, step: Step.placeholder)
        
        // When the app becomes active again.
        try client.send(.notification(name: UIApplication.willEnterForegroundNotification))
        try? await Task.sleep(for: .milliseconds(100))
        try client.send(.notification(name: UIApplication.didBecomeActiveNotification))
        
        // Then the app should not have become unlock.
        try await app.assertScreenshot(.appLockFlow, step: Step.unlocked)
    }
    
    // MARK: - Helpers
    
    func enterPIN() {
        app.buttons[A11yIdentifiers.appLockScreen.numpad(2)].tap()
        app.buttons[A11yIdentifiers.appLockScreen.numpad(0)].tap()
        app.buttons[A11yIdentifiers.appLockScreen.numpad(2)].tap()
        app.buttons[A11yIdentifiers.appLockScreen.numpad(3)].tap()
    }
    
    func enterWrongPIN() {
        app.buttons[A11yIdentifiers.appLockScreen.numpad(0)].tap()
        app.buttons[A11yIdentifiers.appLockScreen.numpad(0)].tap()
        app.buttons[A11yIdentifiers.appLockScreen.numpad(0)].tap()
        app.buttons[A11yIdentifiers.appLockScreen.numpad(0)].tap()
    }
}