| /* |
| * Copyright (C) 2022 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.server.biometrics.sensors.fingerprint.aidl; |
| |
| import static com.google.common.truth.Truth.assertThat; |
| |
| import static org.mockito.ArgumentMatchers.anyBoolean; |
| import static org.mockito.ArgumentMatchers.anyFloat; |
| import static org.mockito.ArgumentMatchers.anyInt; |
| import static org.mockito.ArgumentMatchers.eq; |
| import static org.mockito.Mockito.any; |
| import static org.mockito.Mockito.inOrder; |
| import static org.mockito.Mockito.never; |
| import static org.mockito.Mockito.same; |
| import static org.mockito.Mockito.times; |
| import static org.mockito.Mockito.verify; |
| import static org.mockito.Mockito.when; |
| |
| import android.hardware.biometrics.common.OperationContext; |
| import android.hardware.biometrics.fingerprint.ISession; |
| import android.hardware.biometrics.fingerprint.PointerContext; |
| import android.hardware.fingerprint.Fingerprint; |
| import android.hardware.fingerprint.FingerprintManager; |
| import android.hardware.fingerprint.FingerprintSensorPropertiesInternal; |
| import android.hardware.fingerprint.ISidefpsController; |
| import android.hardware.fingerprint.IUdfpsOverlayController; |
| import android.os.IBinder; |
| import android.os.RemoteException; |
| import android.platform.test.annotations.Presubmit; |
| import android.testing.TestableContext; |
| |
| import androidx.test.filters.SmallTest; |
| import androidx.test.platform.app.InstrumentationRegistry; |
| |
| import com.android.server.biometrics.log.BiometricContext; |
| import com.android.server.biometrics.log.BiometricLogger; |
| import com.android.server.biometrics.log.CallbackWithProbe; |
| import com.android.server.biometrics.log.Probe; |
| import com.android.server.biometrics.sensors.BiometricUtils; |
| import com.android.server.biometrics.sensors.ClientMonitorCallback; |
| import com.android.server.biometrics.sensors.ClientMonitorCallbackConverter; |
| |
| import org.junit.Before; |
| import org.junit.Rule; |
| import org.junit.Test; |
| import org.mockito.ArgumentCaptor; |
| import org.mockito.Captor; |
| import org.mockito.InOrder; |
| import org.mockito.Mock; |
| import org.mockito.junit.MockitoJUnit; |
| import org.mockito.junit.MockitoRule; |
| |
| import java.util.function.Consumer; |
| |
| @Presubmit |
| @SmallTest |
| public class FingerprintEnrollClientTest { |
| |
| private static final byte[] HAT = new byte[69]; |
| private static final int USER_ID = 8; |
| private static final long REQUEST_ID = 9; |
| private static final int POINTER_ID = 0; |
| private static final int TOUCH_X = 8; |
| private static final int TOUCH_Y = 20; |
| private static final float TOUCH_MAJOR = 4.4f; |
| private static final float TOUCH_MINOR = 5.5f; |
| |
| @Rule |
| public final TestableContext mContext = new TestableContext( |
| InstrumentationRegistry.getInstrumentation().getTargetContext(), null); |
| |
| @Mock |
| private ISession mHal; |
| @Mock |
| private IBinder mToken; |
| @Mock |
| private ClientMonitorCallbackConverter mClientMonitorCallbackConverter; |
| @Mock |
| private BiometricLogger mBiometricLogger; |
| @Mock |
| private BiometricContext mBiometricContext; |
| @Mock |
| private BiometricUtils<Fingerprint> mBiometricUtils; |
| @Mock |
| private IUdfpsOverlayController mUdfpsOverlayController; |
| @Mock |
| private ISidefpsController mSideFpsController; |
| @Mock |
| private FingerprintSensorPropertiesInternal mSensorProps; |
| @Mock |
| private ClientMonitorCallback mCallback; |
| @Mock |
| private Sensor.HalSessionCallback mHalSessionCallback; |
| @Mock |
| private Probe mLuxProbe; |
| @Captor |
| private ArgumentCaptor<OperationContext> mOperationContextCaptor; |
| @Captor |
| private ArgumentCaptor<PointerContext> mPointerContextCaptor; |
| @Captor |
| private ArgumentCaptor<Consumer<OperationContext>> mContextInjector; |
| |
| @Rule |
| public final MockitoRule mockito = MockitoJUnit.rule(); |
| |
| @Before |
| public void setup() { |
| when(mBiometricLogger.getAmbientLightProbe(anyBoolean())).thenAnswer(i -> |
| new CallbackWithProbe<>(mLuxProbe, i.getArgument(0))); |
| when(mBiometricContext.updateContext(any(), anyBoolean())).thenAnswer( |
| i -> i.getArgument(0)); |
| } |
| |
| @Test |
| public void enrollNoContext_v1() throws RemoteException { |
| final FingerprintEnrollClient client = createClient(1); |
| |
| client.start(mCallback); |
| |
| verify(mHal).enroll(any()); |
| verify(mHal, never()).enrollWithContext(any(), any()); |
| } |
| |
| @Test |
| public void enrollWithContext_v2() throws RemoteException { |
| final FingerprintEnrollClient client = createClient(2); |
| |
| client.start(mCallback); |
| |
| InOrder order = inOrder(mHal, mBiometricContext); |
| order.verify(mBiometricContext).updateContext( |
| mOperationContextCaptor.capture(), anyBoolean()); |
| order.verify(mHal).enrollWithContext(any(), same(mOperationContextCaptor.getValue())); |
| verify(mHal, never()).enroll(any()); |
| } |
| |
| @Test |
| public void pointerUp_v1() throws RemoteException { |
| final FingerprintEnrollClient client = createClient(1); |
| client.start(mCallback); |
| client.onPointerUp(); |
| |
| verify(mHal).onPointerUp(eq(POINTER_ID)); |
| verify(mHal, never()).onPointerUpWithContext(any()); |
| } |
| |
| @Test |
| public void pointerDown_v1() throws RemoteException { |
| final FingerprintEnrollClient client = createClient(1); |
| client.start(mCallback); |
| client.onPointerDown(TOUCH_X, TOUCH_Y, TOUCH_MAJOR, TOUCH_MINOR); |
| |
| verify(mHal).onPointerDown(eq(0), |
| eq(TOUCH_X), eq(TOUCH_Y), eq(TOUCH_MAJOR), eq(TOUCH_MINOR)); |
| verify(mHal, never()).onPointerDownWithContext(any()); |
| } |
| |
| @Test |
| public void pointerUpWithContext_v2() throws RemoteException { |
| final FingerprintEnrollClient client = createClient(2); |
| client.start(mCallback); |
| client.onPointerUp(); |
| |
| verify(mHal).onPointerUpWithContext(mPointerContextCaptor.capture()); |
| verify(mHal, never()).onPointerUp(eq(POINTER_ID)); |
| |
| final PointerContext pContext = mPointerContextCaptor.getValue(); |
| assertThat(pContext.pointerId).isEqualTo(POINTER_ID); |
| } |
| |
| @Test |
| public void pointerDownWithContext_v2() throws RemoteException { |
| final FingerprintEnrollClient client = createClient(2); |
| client.start(mCallback); |
| client.onPointerDown(TOUCH_X, TOUCH_Y, TOUCH_MAJOR, TOUCH_MINOR); |
| |
| verify(mHal).onPointerDownWithContext(mPointerContextCaptor.capture()); |
| verify(mHal, never()).onPointerDown(anyInt(), anyInt(), anyInt(), anyFloat(), anyFloat()); |
| |
| final PointerContext pContext = mPointerContextCaptor.getValue(); |
| assertThat(pContext.pointerId).isEqualTo(POINTER_ID); |
| } |
| |
| @Test |
| public void luxProbeWhenFingerDown() throws RemoteException { |
| final FingerprintEnrollClient client = createClient(); |
| client.start(mCallback); |
| |
| client.onPointerDown(TOUCH_X, TOUCH_Y, TOUCH_MAJOR, TOUCH_MINOR); |
| verify(mLuxProbe).enable(); |
| |
| client.onAcquired(2, 0); |
| verify(mLuxProbe, never()).disable(); |
| |
| client.onPointerUp(); |
| verify(mLuxProbe).disable(); |
| |
| client.onPointerDown(TOUCH_X, TOUCH_Y, TOUCH_MAJOR, TOUCH_MINOR); |
| verify(mLuxProbe, times(2)).enable(); |
| } |
| |
| @Test |
| public void notifyHalWhenContextChanges() throws RemoteException { |
| final FingerprintEnrollClient client = createClient(); |
| client.start(mCallback); |
| |
| verify(mHal).enrollWithContext(any(), mOperationContextCaptor.capture()); |
| OperationContext opContext = mOperationContextCaptor.getValue(); |
| |
| // fake an update to the context |
| verify(mBiometricContext).subscribe(eq(opContext), mContextInjector.capture()); |
| mContextInjector.getValue().accept(opContext); |
| verify(mHal).onContextChanged(eq(opContext)); |
| |
| client.stopHalOperation(); |
| verify(mBiometricContext).unsubscribe(same(opContext)); |
| } |
| |
| @Test |
| public void showHideOverlay_cancel() throws RemoteException { |
| showHideOverlay(c -> c.cancel()); |
| } |
| |
| @Test |
| public void showHideOverlay_stop() throws RemoteException { |
| showHideOverlay(c -> c.stopHalOperation()); |
| } |
| |
| @Test |
| public void showHideOverlay_error() throws RemoteException { |
| showHideOverlay(c -> c.onError(0, 0)); |
| verify(mCallback).onClientFinished(any(), eq(false)); |
| } |
| |
| @Test |
| public void showHideOverlay_result() throws RemoteException { |
| showHideOverlay(c -> c.onEnrollResult(new Fingerprint("", 1, 1), 0)); |
| } |
| |
| private void showHideOverlay(Consumer<FingerprintEnrollClient> block) |
| throws RemoteException { |
| final FingerprintEnrollClient client = createClient(); |
| |
| client.start(mCallback); |
| |
| verify(mUdfpsOverlayController).showUdfpsOverlay(eq(REQUEST_ID), anyInt(), anyInt(), any()); |
| verify(mSideFpsController).show(anyInt(), anyInt()); |
| |
| block.accept(client); |
| |
| verify(mUdfpsOverlayController).hideUdfpsOverlay(anyInt()); |
| verify(mSideFpsController).hide(anyInt()); |
| } |
| |
| private FingerprintEnrollClient createClient() throws RemoteException { |
| return createClient(500); |
| } |
| |
| private FingerprintEnrollClient createClient(int version) throws RemoteException { |
| when(mHal.getInterfaceVersion()).thenReturn(version); |
| |
| final AidlSession aidl = new AidlSession(version, mHal, USER_ID, mHalSessionCallback); |
| return new FingerprintEnrollClient(mContext, () -> aidl, mToken, REQUEST_ID, |
| mClientMonitorCallbackConverter, 0 /* userId */, |
| HAT, "owner", mBiometricUtils, 8 /* sensorId */, |
| mBiometricLogger, mBiometricContext, mSensorProps, mUdfpsOverlayController, |
| mSideFpsController, 6 /* maxTemplatesPerUser */, FingerprintManager.ENROLL_ENROLL); |
| } |
| } |