/* * Copyright (C) 2021 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.android.systemui.biometrics import android.graphics.Rect import android.hardware.biometrics.BiometricRequestConstants.REASON_AUTH_BP import android.hardware.biometrics.BiometricRequestConstants.REASON_AUTH_KEYGUARD import android.hardware.biometrics.BiometricRequestConstants.REASON_AUTH_OTHER import android.hardware.biometrics.BiometricRequestConstants.REASON_AUTH_SETTINGS import android.hardware.biometrics.BiometricRequestConstants.REASON_ENROLL_ENROLLING import android.hardware.biometrics.BiometricRequestConstants.RequestReason import android.hardware.fingerprint.IUdfpsOverlayControllerCallback import android.testing.TestableLooper.RunWithLooper import android.view.LayoutInflater import android.view.MotionEvent import android.view.Surface import android.view.Surface.Rotation import android.view.View import android.view.ViewGroup import android.view.WindowManager import android.view.accessibility.AccessibilityManager import androidx.test.ext.junit.runners.AndroidJUnit4 import androidx.test.filters.SmallTest import com.android.keyguard.KeyguardUpdateMonitor import com.android.systemui.Flags import com.android.systemui.SysuiTestCase import com.android.systemui.animation.ActivityTransitionAnimator import com.android.systemui.biometrics.domain.interactor.UdfpsOverlayInteractor import com.android.systemui.biometrics.shared.model.UdfpsOverlayParams import com.android.systemui.biometrics.ui.viewmodel.DefaultUdfpsTouchOverlayViewModel import com.android.systemui.biometrics.ui.viewmodel.DeviceEntryUdfpsTouchOverlayViewModel import com.android.systemui.bouncer.domain.interactor.AlternateBouncerInteractor import com.android.systemui.bouncer.domain.interactor.PrimaryBouncerInteractor import com.android.systemui.dump.DumpManager import com.android.systemui.keyguard.data.repository.FakeKeyguardTransitionRepository import com.android.systemui.keyguard.data.repository.fakeKeyguardTransitionRepository import com.android.systemui.keyguard.domain.interactor.KeyguardTransitionInteractor import com.android.systemui.keyguard.domain.interactor.keyguardTransitionInteractor import com.android.systemui.keyguard.shared.model.KeyguardState import com.android.systemui.kosmos.testScope import com.android.systemui.plugins.statusbar.StatusBarStateController import com.android.systemui.power.data.repository.FakePowerRepository import com.android.systemui.power.data.repository.fakePowerRepository import com.android.systemui.power.domain.interactor.PowerInteractor import com.android.systemui.power.domain.interactor.powerInteractor import com.android.systemui.power.shared.model.WakeSleepReason import com.android.systemui.power.shared.model.WakefulnessState import com.android.systemui.res.R import com.android.systemui.shade.domain.interactor.ShadeInteractor import com.android.systemui.statusbar.LockscreenShadeTransitionController import com.android.systemui.statusbar.phone.StatusBarKeyguardViewManager import com.android.systemui.statusbar.phone.SystemUIDialogManager import com.android.systemui.statusbar.phone.UnlockedScreenOffAnimationController import com.android.systemui.statusbar.policy.ConfigurationController import com.android.systemui.statusbar.policy.KeyguardStateController import com.android.systemui.testKosmos import com.android.systemui.user.domain.interactor.SelectedUserInteractor import com.google.common.truth.Truth.assertThat import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.test.TestScope import kotlinx.coroutines.test.runCurrent import kotlinx.coroutines.test.runTest import org.junit.Before import org.junit.Rule import org.junit.Test import org.junit.runner.RunWith import org.mockito.ArgumentCaptor import org.mockito.ArgumentMatchers.any import org.mockito.ArgumentMatchers.eq import org.mockito.Captor import org.mockito.Mock import org.mockito.Mockito.mock import org.mockito.Mockito.never import org.mockito.Mockito.verify import org.mockito.Mockito.`when` as whenever import org.mockito.junit.MockitoJUnit private const val REQUEST_ID = 2L // Dimensions for the current display resolution. private const val DISPLAY_WIDTH = 1080 private const val DISPLAY_HEIGHT = 1920 private const val SENSOR_WIDTH = 30 private const val SENSOR_HEIGHT = 60 @ExperimentalCoroutinesApi @SmallTest @RunWith(AndroidJUnit4::class) @RunWithLooper(setAsMainLooper = true) class UdfpsControllerOverlayTest : SysuiTestCase() { private val kosmos = testKosmos() @JvmField @Rule var rule = MockitoJUnit.rule() @Mock private lateinit var inflater: LayoutInflater @Mock private lateinit var windowManager: WindowManager @Mock private lateinit var accessibilityManager: AccessibilityManager @Mock private lateinit var statusBarStateController: StatusBarStateController @Mock private lateinit var statusBarKeyguardViewManager: StatusBarKeyguardViewManager @Mock private lateinit var keyguardUpdateMonitor: KeyguardUpdateMonitor @Mock private lateinit var dialogManager: SystemUIDialogManager @Mock private lateinit var dumpManager: DumpManager @Mock private lateinit var transitionController: LockscreenShadeTransitionController @Mock private lateinit var configurationController: ConfigurationController @Mock private lateinit var keyguardStateController: KeyguardStateController @Mock private lateinit var unlockedScreenOffAnimationController: UnlockedScreenOffAnimationController @Mock private lateinit var udfpsDisplayMode: UdfpsDisplayModeProvider @Mock private lateinit var controllerCallback: IUdfpsOverlayControllerCallback @Mock private lateinit var udfpsController: UdfpsController @Mock private lateinit var udfpsView: UdfpsView @Mock private lateinit var mUdfpsKeyguardViewLegacy: UdfpsKeyguardViewLegacy @Mock private lateinit var mActivityTransitionAnimator: ActivityTransitionAnimator @Mock private lateinit var primaryBouncerInteractor: PrimaryBouncerInteractor @Mock private lateinit var alternateBouncerInteractor: AlternateBouncerInteractor @Mock private lateinit var mSelectedUserInteractor: SelectedUserInteractor @Mock private lateinit var deviceEntryUdfpsTouchOverlayViewModel: DeviceEntryUdfpsTouchOverlayViewModel @Mock private lateinit var defaultUdfpsTouchOverlayViewModel: DefaultUdfpsTouchOverlayViewModel @Mock private lateinit var udfpsKeyguardAccessibilityDelegate: UdfpsKeyguardAccessibilityDelegate private lateinit var keyguardTransitionRepository: FakeKeyguardTransitionRepository private lateinit var keyguardTransitionInteractor: KeyguardTransitionInteractor @Mock private lateinit var shadeInteractor: ShadeInteractor @Captor private lateinit var layoutParamsCaptor: ArgumentCaptor @Mock private lateinit var udfpsOverlayInteractor: UdfpsOverlayInteractor private lateinit var powerRepository: FakePowerRepository private lateinit var powerInteractor: PowerInteractor private lateinit var testScope: TestScope private val onTouch = { _: View, _: MotionEvent, _: Boolean -> true } private var overlayParams: UdfpsOverlayParams = UdfpsOverlayParams() private lateinit var controllerOverlay: UdfpsControllerOverlay @Before fun setup() { testScope = kosmos.testScope powerRepository = kosmos.fakePowerRepository powerInteractor = kosmos.powerInteractor keyguardTransitionRepository = kosmos.fakeKeyguardTransitionRepository keyguardTransitionInteractor = kosmos.keyguardTransitionInteractor whenever(inflater.inflate(R.layout.udfps_view, null, false)).thenReturn(udfpsView) whenever(inflater.inflate(R.layout.udfps_bp_view, null)) .thenReturn(mock(UdfpsBpView::class.java)) whenever(inflater.inflate(R.layout.udfps_keyguard_view_legacy, null)) .thenReturn(mUdfpsKeyguardViewLegacy) whenever(inflater.inflate(R.layout.udfps_fpm_empty_view, null)) .thenReturn(mock(UdfpsFpmEmptyView::class.java)) } private suspend fun withReasonSuspend( @RequestReason reason: Int, isDebuggable: Boolean = false, enableDeviceEntryUdfpsRefactor: Boolean = false, block: suspend () -> Unit, ) { withReason( reason, isDebuggable, enableDeviceEntryUdfpsRefactor, ) block() } private fun withReason( @RequestReason reason: Int, isDebuggable: Boolean = false, enableDeviceEntryUdfpsRefactor: Boolean = false, block: () -> Unit = {}, ) { if (enableDeviceEntryUdfpsRefactor) { mSetFlagsRule.enableFlags(Flags.FLAG_DEVICE_ENTRY_UDFPS_REFACTOR) } else { mSetFlagsRule.disableFlags(Flags.FLAG_DEVICE_ENTRY_UDFPS_REFACTOR) } controllerOverlay = UdfpsControllerOverlay( context, inflater, windowManager, accessibilityManager, statusBarStateController, statusBarKeyguardViewManager, keyguardUpdateMonitor, dialogManager, dumpManager, transitionController, configurationController, keyguardStateController, unlockedScreenOffAnimationController, udfpsDisplayMode, REQUEST_ID, reason, controllerCallback, onTouch, mActivityTransitionAnimator, primaryBouncerInteractor, alternateBouncerInteractor, isDebuggable, udfpsKeyguardAccessibilityDelegate, keyguardTransitionInteractor, mSelectedUserInteractor, { deviceEntryUdfpsTouchOverlayViewModel }, { defaultUdfpsTouchOverlayViewModel }, shadeInteractor, udfpsOverlayInteractor, powerInteractor, testScope, ) block() } @Test fun showUdfpsOverlay_bp() = withReason(REASON_AUTH_BP) { showUdfpsOverlay() } @Test fun showUdfpsOverlay_keyguard() = withReason(REASON_AUTH_KEYGUARD) { showUdfpsOverlay() verify(mUdfpsKeyguardViewLegacy).updateSensorLocation(eq(overlayParams.sensorBounds)) } @Test fun showUdfpsOverlay_other() = withReason(REASON_AUTH_OTHER) { showUdfpsOverlay() } private fun withRotation(@Rotation rotation: Int, block: () -> Unit) { // Sensor that's in the top left corner of the display in natural orientation. val sensorBounds = Rect(0, 0, SENSOR_WIDTH, SENSOR_HEIGHT) val overlayBounds = Rect(0, 0, DISPLAY_WIDTH, DISPLAY_HEIGHT) overlayParams = UdfpsOverlayParams( sensorBounds, overlayBounds, DISPLAY_WIDTH, DISPLAY_HEIGHT, scaleFactor = 1f, rotation ) block() } @Test fun showUdfpsOverlay_withRotation0() = withRotation(Surface.ROTATION_0) { withReason(REASON_AUTH_BP) { controllerOverlay.show(udfpsController, overlayParams) verify(windowManager) .addView(eq(controllerOverlay.getTouchOverlay()), layoutParamsCaptor.capture()) // ROTATION_0 is the native orientation. Sensor should stay in the top left corner. val lp = layoutParamsCaptor.value assertThat(lp.x).isEqualTo(0) assertThat(lp.y).isEqualTo(0) assertThat(lp.width).isEqualTo(DISPLAY_WIDTH) assertThat(lp.height).isEqualTo(DISPLAY_HEIGHT) } } @Test fun showUdfpsOverlay_withRotation180() = withRotation(Surface.ROTATION_180) { withReason(REASON_AUTH_BP) { controllerOverlay.show(udfpsController, overlayParams) verify(windowManager) .addView(eq(controllerOverlay.getTouchOverlay()), layoutParamsCaptor.capture()) // ROTATION_180 is not supported. Sensor should stay in the top left corner. val lp = layoutParamsCaptor.value assertThat(lp.x).isEqualTo(0) assertThat(lp.y).isEqualTo(0) assertThat(lp.width).isEqualTo(DISPLAY_WIDTH) assertThat(lp.height).isEqualTo(DISPLAY_HEIGHT) } } @Test fun showUdfpsOverlay_withRotation90() = withRotation(Surface.ROTATION_90) { withReason(REASON_AUTH_BP) { controllerOverlay.show(udfpsController, overlayParams) verify(windowManager) .addView(eq(controllerOverlay.getTouchOverlay()), layoutParamsCaptor.capture()) // Sensor should be in the bottom left corner in ROTATION_90. val lp = layoutParamsCaptor.value assertThat(lp.x).isEqualTo(0) assertThat(lp.y).isEqualTo(0) assertThat(lp.width).isEqualTo(DISPLAY_HEIGHT) assertThat(lp.height).isEqualTo(DISPLAY_WIDTH) } } @Test fun showUdfpsOverlay_withRotation270() = withRotation(Surface.ROTATION_270) { withReason(REASON_AUTH_BP) { controllerOverlay.show(udfpsController, overlayParams) verify(windowManager) .addView(eq(controllerOverlay.getTouchOverlay()), layoutParamsCaptor.capture()) // Sensor should be in the top right corner in ROTATION_270. val lp = layoutParamsCaptor.value assertThat(lp.x).isEqualTo(0) assertThat(lp.y).isEqualTo(0) assertThat(lp.width).isEqualTo(DISPLAY_HEIGHT) assertThat(lp.height).isEqualTo(DISPLAY_WIDTH) } } @Test fun showUdfpsOverlay_awake() = testScope.runTest { withReason(REASON_AUTH_KEYGUARD) { mSetFlagsRule.enableFlags(Flags.FLAG_UDFPS_VIEW_PERFORMANCE) powerRepository.updateWakefulness( rawState = WakefulnessState.AWAKE, lastWakeReason = WakeSleepReason.POWER_BUTTON, lastSleepReason = WakeSleepReason.OTHER, ) runCurrent() controllerOverlay.show(udfpsController, overlayParams) runCurrent() verify(windowManager).addView(any(), any()) } } @Test fun showUdfpsOverlay_whileGoingToSleep() = testScope.runTest { withReasonSuspend(REASON_AUTH_KEYGUARD) { mSetFlagsRule.enableFlags(Flags.FLAG_UDFPS_VIEW_PERFORMANCE) keyguardTransitionRepository.sendTransitionSteps( from = KeyguardState.OFF, to = KeyguardState.GONE, testScope = this, ) powerRepository.updateWakefulness( rawState = WakefulnessState.STARTING_TO_SLEEP, lastWakeReason = WakeSleepReason.POWER_BUTTON, lastSleepReason = WakeSleepReason.OTHER, ) runCurrent() // WHEN a request comes to show the view controllerOverlay.show(udfpsController, overlayParams) runCurrent() // THEN the view does not get added immediately verify(windowManager, never()).addView(any(), any()) // we hide to end the job that listens for the finishedGoingToSleep signal controllerOverlay.hide() } } @Test fun showUdfpsOverlay_whileAsleep() = testScope.runTest { withReasonSuspend(REASON_AUTH_KEYGUARD) { mSetFlagsRule.enableFlags(Flags.FLAG_UDFPS_VIEW_PERFORMANCE) keyguardTransitionRepository.sendTransitionSteps( from = KeyguardState.OFF, to = KeyguardState.GONE, testScope = this, ) powerRepository.updateWakefulness( rawState = WakefulnessState.ASLEEP, lastWakeReason = WakeSleepReason.POWER_BUTTON, lastSleepReason = WakeSleepReason.OTHER, ) runCurrent() // WHEN a request comes to show the view controllerOverlay.show(udfpsController, overlayParams) runCurrent() // THEN view isn't added yet verify(windowManager, never()).addView(any(), any()) // we hide to end the job that listens for the finishedGoingToSleep signal controllerOverlay.hide() } } @Test fun neverRemoveViewThatHasNotBeenAdded() = testScope.runTest { withReasonSuspend(REASON_AUTH_KEYGUARD) { mSetFlagsRule.enableFlags(Flags.FLAG_UDFPS_VIEW_PERFORMANCE) controllerOverlay.show(udfpsController, overlayParams) val view = controllerOverlay.getTouchOverlay() view?.let { // parent is null, signalling that the view was never added whenever(view.parent).thenReturn(null) } verify(windowManager, never()).removeView(eq(view)) } } @Test fun showUdfpsOverlay_afterFinishedTransitioningToAOD() = testScope.runTest { withReasonSuspend(REASON_AUTH_KEYGUARD) { mSetFlagsRule.enableFlags(Flags.FLAG_UDFPS_VIEW_PERFORMANCE) keyguardTransitionRepository.sendTransitionSteps( from = KeyguardState.OFF, to = KeyguardState.GONE, testScope = this, ) powerRepository.updateWakefulness( rawState = WakefulnessState.STARTING_TO_SLEEP, lastWakeReason = WakeSleepReason.POWER_BUTTON, lastSleepReason = WakeSleepReason.OTHER, ) runCurrent() // WHEN a request comes to show the view controllerOverlay.show(udfpsController, overlayParams) runCurrent() // THEN the view does not get added immediately verify(windowManager, never()).addView(any(), any()) // WHEN the device finishes transitioning to AOD keyguardTransitionRepository.sendTransitionSteps( from = KeyguardState.GONE, to = KeyguardState.AOD, testScope = this, ) runCurrent() // THEN the view gets added verify(windowManager) .addView(eq(controllerOverlay.getTouchOverlay()), layoutParamsCaptor.capture()) } } private fun showUdfpsOverlay() { val didShow = controllerOverlay.show(udfpsController, overlayParams) verify(windowManager).addView(eq(controllerOverlay.getTouchOverlay()), any()) verify(udfpsView).setUdfpsDisplayModeProvider(eq(udfpsDisplayMode)) verify(udfpsView).animationViewController = any() verify(udfpsView).addView(any()) assertThat(didShow).isTrue() assertThat(controllerOverlay.isShowing).isTrue() assertThat(controllerOverlay.isHiding).isFalse() assertThat(controllerOverlay.getTouchOverlay()).isNotNull() } @Test fun hideUdfpsOverlay_bp() = withReason(REASON_AUTH_BP) { hideUdfpsOverlay() } @Test fun hideUdfpsOverlay_keyguard() = withReason(REASON_AUTH_KEYGUARD) { hideUdfpsOverlay() } @Test fun hideUdfpsOverlay_settings() = withReason(REASON_AUTH_SETTINGS) { hideUdfpsOverlay() } @Test fun hideUdfpsOverlay_other() = withReason(REASON_AUTH_OTHER) { hideUdfpsOverlay() } private fun hideUdfpsOverlay() { val didShow = controllerOverlay.show(udfpsController, overlayParams) val view = controllerOverlay.getTouchOverlay() view?.let { whenever(view.parent).thenReturn(mock(ViewGroup::class.java)) } val didHide = controllerOverlay.hide() verify(windowManager).removeView(eq(view)) assertThat(didShow).isTrue() assertThat(didHide).isTrue() assertThat(controllerOverlay.getTouchOverlay()).isNull() assertThat(controllerOverlay.animationViewController).isNull() assertThat(controllerOverlay.isShowing).isFalse() assertThat(controllerOverlay.isHiding).isTrue() } @Test fun canNotHide() = withReason(REASON_AUTH_BP) { assertThat(controllerOverlay.hide()).isFalse() } @Test fun canNotReshow() = withReason(REASON_AUTH_BP) { assertThat(controllerOverlay.show(udfpsController, overlayParams)).isTrue() assertThat(controllerOverlay.show(udfpsController, overlayParams)).isFalse() } @Test fun cancels() = withReason(REASON_AUTH_BP) { controllerOverlay.cancel() verify(controllerCallback).onUserCanceled() } @Test fun unconfigureDisplayOnHide() = withReason(REASON_AUTH_BP) { whenever(udfpsView.isDisplayConfigured).thenReturn(true) controllerOverlay.show(udfpsController, overlayParams) controllerOverlay.hide() verify(udfpsView).unconfigureDisplay() } @Test fun matchesRequestIds() = withReason(REASON_AUTH_BP) { assertThat(controllerOverlay.matchesRequestId(REQUEST_ID)).isTrue() assertThat(controllerOverlay.matchesRequestId(REQUEST_ID + 1)).isFalse() } @Test fun smallOverlayOnEnrollmentWithA11y() = withRotation(Surface.ROTATION_0) { withReason(REASON_ENROLL_ENROLLING) { // When a11y enabled during enrollment whenever(accessibilityManager.isTouchExplorationEnabled).thenReturn(true) controllerOverlay.show(udfpsController, overlayParams) verify(windowManager) .addView(eq(controllerOverlay.getTouchOverlay()), layoutParamsCaptor.capture()) // Layout params should use sensor bounds val lp = layoutParamsCaptor.value assertThat(lp.width).isEqualTo(overlayParams.sensorBounds.width()) assertThat(lp.height).isEqualTo(overlayParams.sensorBounds.height()) } } @Test fun addViewPending_layoutIsNotUpdated() = testScope.runTest { withReasonSuspend(REASON_AUTH_KEYGUARD) { mSetFlagsRule.enableFlags(Flags.FLAG_UDFPS_VIEW_PERFORMANCE) mSetFlagsRule.enableFlags(Flags.FLAG_DEVICE_ENTRY_UDFPS_REFACTOR) // GIVEN going to sleep keyguardTransitionRepository.sendTransitionSteps( from = KeyguardState.OFF, to = KeyguardState.GONE, testScope = this, ) powerRepository.updateWakefulness( rawState = WakefulnessState.STARTING_TO_SLEEP, lastWakeReason = WakeSleepReason.POWER_BUTTON, lastSleepReason = WakeSleepReason.OTHER, ) runCurrent() // WHEN a request comes to show the view controllerOverlay.show(udfpsController, overlayParams) runCurrent() // THEN the view does not get added immediately verify(windowManager, never()).addView(any(), any()) // WHEN updateOverlayParams gets called when the view is pending to be added controllerOverlay.updateOverlayParams(overlayParams) // THEN the view layout is never updated verify(windowManager, never()).updateViewLayout(any(), any()) // CLEANUP we hide to end the job that listens for the finishedGoingToSleep signal controllerOverlay.hide() } } @Test fun updateOverlayParams_viewLayoutUpdated() = testScope.runTest { withReasonSuspend(REASON_AUTH_KEYGUARD) { mSetFlagsRule.enableFlags(Flags.FLAG_UDFPS_VIEW_PERFORMANCE) powerRepository.updateWakefulness( rawState = WakefulnessState.AWAKE, lastWakeReason = WakeSleepReason.POWER_BUTTON, lastSleepReason = WakeSleepReason.OTHER, ) runCurrent() controllerOverlay.show(udfpsController, overlayParams) runCurrent() verify(windowManager).addView(any(), any()) // WHEN updateOverlayParams gets called controllerOverlay.updateOverlayParams(overlayParams) // THEN the view layout is updated verify(windowManager).updateViewLayout(any(), any()) } } }