Initial implementation for AppLockSetupFlowCoordinator. (#1949)

Rename AppLockSettingsScreen to AppLockSetupSettingsScreen.
Implement forced logout and persist PIN entry attempts.

UnitTests/Sources/AppLock/AppLockScreenViewModelTests.swift

@@ -20,6 +20,7 @@ import XCTest
 
 @MainActor
 class AppLockScreenViewModelTests: XCTestCase {
+    var appSettings: AppSettings!
     var appLockService: AppLockService!
     var keychainController: KeychainControllerMock!
     var viewModel: AppLockScreenViewModelProtocol!
@@ -28,8 +29,9 @@ class AppLockScreenViewModelTests: XCTestCase {
     
     override func setUp() {
         AppSettings.reset()
+        appSettings = AppSettings()
         keychainController = KeychainControllerMock()
-        appLockService = AppLockService(keychainController: keychainController, appSettings: AppSettings())
+        appLockService = AppLockService(keychainController: keychainController, appSettings: appSettings)
         viewModel = AppLockScreenViewModel(appLockService: appLockService)
     }
     
@@ -51,4 +53,60 @@ class AppLockScreenViewModelTests: XCTestCase {
         // The app should become unlocked.
         XCTAssertEqual(result, .appUnlocked)
     }
+    
+    func testForgotPIN() {
+        // Given a fresh launch of the app.
+        XCTAssertNil(context.alertInfo, "No alert should be shown initially.")
+        
+        // When the user has forgotten their PIN.
+        context.send(viewAction: .forgotPIN)
+        
+        // Then an alert should be shown before logging out.
+        XCTAssertEqual(context.alertInfo?.id, .confirmResetPIN, "An alert should be shown before logging out.")
+    }
+    
+    func testUnlockFailure() async throws {
+        // Given an invalid PIN code.
+        let pinCode = "2024"
+        keychainController.pinCodeReturnValue = "2023"
+        XCTAssertEqual(context.viewState.numberOfPINAttempts, 0, "The shouldn't be any attempts yet.")
+        XCTAssertFalse(context.viewState.isSubtitleWarning, "No warning should be shown yet.")
+        XCTAssertNil(context.alertInfo, "No alert should be shown yet.")
+        
+        // When entering it on the lock screen.
+        viewModel.context.pinCode = pinCode
+        context.send(viewAction: .submitPINCode)
+        
+        // Then a failed attempt should be shown.
+        XCTAssertEqual(context.viewState.numberOfPINAttempts, 1, "A failed attempt should have been recorded.")
+        XCTAssertTrue(context.viewState.isSubtitleWarning, "A warning should now be shown.")
+        XCTAssertNil(context.alertInfo, "No alert should be shown yet.")
+        
+        // When entering twice more
+        context.send(viewAction: .submitPINCode)
+        context.send(viewAction: .submitPINCode)
+        
+        // Then an alert should be shown
+        XCTAssertEqual(context.viewState.numberOfPINAttempts, 3, "All the attempts should have been recorded.")
+        XCTAssertTrue(context.viewState.isSubtitleWarning, "The warning should still be shown.")
+        XCTAssertEqual(context.alertInfo?.id, .forcedLogout, "An alert should now be shown.")
+    }
+    
+    func testForceQuitRequiresLogout() {
+        // Given an app with a PIN set where the user attempted to unlock 3 times.
+        keychainController.pinCodeReturnValue = "2023"
+        appSettings.appLockNumberOfPINAttempts = 2
+        XCTAssertNil(context.alertInfo)
+        viewModel.context.pinCode = "0000"
+        context.send(viewAction: .submitPINCode)
+        XCTAssertEqual(appSettings.appLockNumberOfPINAttempts, 3, "The app should have 3 failed attempts before the force quit.")
+        XCTAssertEqual(context.alertInfo?.id, .forcedLogout, "The app should be showing the alert before the force quit.")
+        
+        // When force quitting the app and relaunching.
+        viewModel = nil
+        let freshViewModel = AppLockScreenViewModel(appLockService: appLockService)
+        
+        // Then the alert should remain in place
+        XCTAssertEqual(freshViewModel.context.alertInfo?.id, .forcedLogout, "The new view model from the fresh launch should also show the alert")
+    }
 }

UnitTests/Sources/AppLock/AppLockServiceTests.swift

@@ -175,4 +175,47 @@ class AppLockServiceTests: XCTestCase {
         XCTAssertFalse(service.isEnabled, "The service should no longer be enabled.")
         XCTAssertFalse(service.unlock(with: pinCode), "The initial PIN shouldn't work any more.")
     }
+    
+    func testResetAttemptsOnUnlock() {
+        // Given a service that is enabled and has failed unlock attempts.
+        let pinCode = "2023"
+        guard case .success = service.setupPINCode(pinCode) else {
+            XCTFail("The PIN should be valid.")
+            return
+        }
+        appSettings.appLockNumberOfPINAttempts = 2
+        appSettings.appLockNumberOfBiometricAttempts = 2
+        XCTAssertEqual(appSettings.appLockNumberOfPINAttempts, 2, "The initial conditions should be stored.")
+        XCTAssertEqual(appSettings.appLockNumberOfBiometricAttempts, 2, "The initial conditions should be stored.")
+        XCTAssertTrue(service.isEnabled, "The service should be enabled.")
+        
+        // When unlocking the service
+        XCTAssertTrue(service.unlock(with: pinCode), "The PIN should work.")
+        
+        // Then the attempts counts should both be reset.
+        XCTAssertEqual(appSettings.appLockNumberOfPINAttempts, 0, "The PIN attempts should be reset.")
+        XCTAssertEqual(appSettings.appLockNumberOfBiometricAttempts, 0, "The biometric attempts should be reset.")
+    }
+    
+    func testResetAttemptsOnDisable() {
+        // Given a service that is enabled and has failed unlock attempts.
+        let pinCode = "2023"
+        guard case .success = service.setupPINCode(pinCode) else {
+            XCTFail("The PIN should be valid.")
+            return
+        }
+        appSettings.appLockNumberOfPINAttempts = 2
+        appSettings.appLockNumberOfBiometricAttempts = 2
+        XCTAssertEqual(appSettings.appLockNumberOfPINAttempts, 2, "The initial conditions should be stored.")
+        XCTAssertEqual(appSettings.appLockNumberOfBiometricAttempts, 2, "The initial conditions should be stored.")
+        XCTAssertTrue(service.isEnabled, "The service should be enabled.")
+        
+        // When disabling the service
+        service.disable()
+        XCTAssertFalse(service.isEnabled, "The service should be disabled.")
+        
+        // Then the attempts counts should both be reset.
+        XCTAssertEqual(appSettings.appLockNumberOfPINAttempts, 0, "The PIN attempts should be reset.")
+        XCTAssertEqual(appSettings.appLockNumberOfBiometricAttempts, 0, "The biometric attempts should be reset.")
+    }
 }

UnitTests/Sources/AppLock/AppLockSettingsScreenViewModelTests.swift

@@ -19,12 +19,12 @@ import XCTest
 @testable import ElementX
 
 @MainActor
-class AppLockSettingsScreenViewModelTests: XCTestCase {
+class AppLockSetupSettingsScreenViewModelTests: XCTestCase {
     var appLockService: AppLockServiceProtocol!
     var keychainController: KeychainControllerMock!
-    var viewModel: AppLockSettingsScreenViewModelProtocol!
+    var viewModel: AppLockSetupSettingsScreenViewModelProtocol!
     
-    var context: AppLockSettingsScreenViewModelType.Context {
+    var context: AppLockSetupSettingsScreenViewModelType.Context {
         viewModel.context
     }
     
@@ -36,7 +36,7 @@ class AppLockSettingsScreenViewModelTests: XCTestCase {
         keychainController = KeychainControllerMock()
         appLockService = AppLockService(keychainController: keychainController, appSettings: appSettings)
         
-        viewModel = AppLockSettingsScreenViewModel(appLockService: AppLockServiceMock.mock())
+        viewModel = AppLockSetupSettingsScreenViewModel(appLockService: AppLockServiceMock.mock())
     }
     
     override func tearDown() {

UnitTests/Sources/AppLock/AppLockSetupPINScreenViewModelTests.swift

@@ -37,7 +37,7 @@ class AppLockSetupPINScreenViewModelTests: XCTestCase {
     }
 
     func testCreatePIN() async throws {
-        viewModel = AppLockSetupPINScreenViewModel(initialMode: .create, appLockService: appLockService)
+        viewModel = AppLockSetupPINScreenViewModel(initialMode: .create, isMandatory: false, appLockService: appLockService)
         XCTAssertEqual(context.viewState.mode, .create, "The mode should start as creation.")
         
         let createDeferred = deferFulfillment(context.$viewState, message: "A valid PIN needs confirming.") { $0.mode == .confirm }
@@ -53,7 +53,7 @@ class AppLockSetupPINScreenViewModelTests: XCTestCase {
     }
     
     func testCreateWeakPIN() async throws {
-        viewModel = AppLockSetupPINScreenViewModel(initialMode: .create, appLockService: appLockService)
+        viewModel = AppLockSetupPINScreenViewModel(initialMode: .create, isMandatory: false, appLockService: appLockService)
         XCTAssertEqual(context.viewState.mode, .create, "The mode should start as creation.")
         XCTAssertNil(context.alertInfo, "There shouldn't be an alert to begin with.")
         
@@ -65,7 +65,7 @@ class AppLockSetupPINScreenViewModelTests: XCTestCase {
     }
     
     func testCreatePINMismatch() async throws {
-        viewModel = AppLockSetupPINScreenViewModel(initialMode: .create, appLockService: appLockService)
+        viewModel = AppLockSetupPINScreenViewModel(initialMode: .create, isMandatory: false, appLockService: appLockService)
         XCTAssertEqual(context.viewState.mode, .create, "The mode should start as creation.")
         XCTAssertNil(context.alertInfo, "There shouldn't be an alert to begin with.")
         
@@ -83,7 +83,7 @@ class AppLockSetupPINScreenViewModelTests: XCTestCase {
     }
     
     func testUnlock() async throws {
-        viewModel = AppLockSetupPINScreenViewModel(initialMode: .unlock, appLockService: appLockService)
+        viewModel = AppLockSetupPINScreenViewModel(initialMode: .unlock, isMandatory: false, appLockService: appLockService)
         let pinCode = "2023"
         keychainController.pinCodeReturnValue = pinCode
         keychainController.containsPINCodeReturnValue = true