From 5f401f42765652adc8324e4910a6c862082d1b60 Mon Sep 17 00:00:00 2001 From: Atneya Nair Date: Fri, 28 Apr 2023 14:29:58 -0700 Subject: [PATCH] Split ST middleware test cases to address flake The setup method of latency related tests is flaky, which leads to flake across unit tests, which aren't annotated and don't need the latency tracker. Split out the latency tracker related test cases into a separate test class. Leave those tests marked as flaky. Bug: 279774505 Test: FrameworkVoiceInteractionTests Change-Id: Id35624e4ff866056fe986e627a2e55d559049ee4 --- ...ndTriggerMiddlewareLoggingLatencyTest.java | 188 +++++++++++++++++ .../SoundTriggerMiddlewareLoggingTest.java | 193 ++---------------- 2 files changed, 201 insertions(+), 180 deletions(-) create mode 100644 services/tests/voiceinteractiontests/src/com/android/server/soundtrigger_middleware/SoundTriggerMiddlewareLoggingLatencyTest.java diff --git a/services/tests/voiceinteractiontests/src/com/android/server/soundtrigger_middleware/SoundTriggerMiddlewareLoggingLatencyTest.java b/services/tests/voiceinteractiontests/src/com/android/server/soundtrigger_middleware/SoundTriggerMiddlewareLoggingLatencyTest.java new file mode 100644 index 0000000000000..f8a068c7f1218 --- /dev/null +++ b/services/tests/voiceinteractiontests/src/com/android/server/soundtrigger_middleware/SoundTriggerMiddlewareLoggingLatencyTest.java @@ -0,0 +1,188 @@ +/* + * Copyright (C) 2023 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.soundtrigger_middleware; + +import static com.android.internal.util.LatencyTracker.ACTION_SHOW_VOICE_INTERACTION; + +import static com.google.common.truth.Truth.assertThat; + +import static org.mockito.ArgumentMatchers.anyInt; +import static org.mockito.Mockito.verify; + +import android.Manifest; +import android.app.ActivityThread; +import android.media.permission.Identity; +import android.media.permission.IdentityContext; +import android.media.soundtrigger.PhraseRecognitionEvent; +import android.media.soundtrigger.PhraseRecognitionExtra; +import android.media.soundtrigger.RecognitionEvent; +import android.media.soundtrigger.RecognitionStatus; +import android.media.soundtrigger_middleware.ISoundTriggerCallback; +import android.media.soundtrigger_middleware.ISoundTriggerModule; +import android.os.BatteryStatsInternal; +import android.os.Process; +import android.os.RemoteException; + +import androidx.test.filters.FlakyTest; +import androidx.test.platform.app.InstrumentationRegistry; + +import com.android.internal.util.FakeLatencyTracker; + +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.JUnit4; +import org.mockito.ArgumentCaptor; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; + +import java.util.Optional; + +@RunWith(JUnit4.class) +public class SoundTriggerMiddlewareLoggingLatencyTest { + + private FakeLatencyTracker mLatencyTracker; + @Mock + private BatteryStatsInternal mBatteryStatsInternal; + @Mock + private ISoundTriggerMiddlewareInternal mDelegateMiddleware; + @Mock + private ISoundTriggerCallback mISoundTriggerCallback; + @Mock + private ISoundTriggerModule mSoundTriggerModule; + private SoundTriggerMiddlewareLogging mSoundTriggerMiddlewareLogging; + + @Before + public void setUp() throws Exception { + MockitoAnnotations.initMocks(this); + + InstrumentationRegistry.getInstrumentation().getUiAutomation() + .adoptShellPermissionIdentity(Manifest.permission.WRITE_DEVICE_CONFIG, + Manifest.permission.READ_DEVICE_CONFIG); + + Identity identity = new Identity(); + identity.uid = Process.myUid(); + identity.pid = Process.myPid(); + identity.packageName = ActivityThread.currentOpPackageName(); + IdentityContext.create(identity); + + mLatencyTracker = FakeLatencyTracker.create(); + mLatencyTracker.forceEnabled(ACTION_SHOW_VOICE_INTERACTION, -1); + mSoundTriggerMiddlewareLogging = new SoundTriggerMiddlewareLogging(mLatencyTracker, + () -> mBatteryStatsInternal, + mDelegateMiddleware); + } + + @After + public void tearDown() { + InstrumentationRegistry.getInstrumentation().getUiAutomation() + .dropShellPermissionIdentity(); + } + + @Test + @FlakyTest(bugId = 275113847) + public void testSetUpAndTearDown() { + } + + @Test + @FlakyTest(bugId = 275113847) + public void testOnPhraseRecognitionStartsLatencyTrackerWithSuccessfulPhraseIdTrigger() + throws RemoteException { + ArgumentCaptor soundTriggerCallbackCaptor = ArgumentCaptor.forClass( + ISoundTriggerCallback.class); + mSoundTriggerMiddlewareLogging.attach(0, mISoundTriggerCallback); + verify(mDelegateMiddleware).attach(anyInt(), soundTriggerCallbackCaptor.capture()); + + triggerPhraseRecognitionEvent(soundTriggerCallbackCaptor.getValue(), + RecognitionStatus.SUCCESS, Optional.of(100) /* keyphraseId */); + + assertThat(mLatencyTracker.getActiveActionStartTime( + ACTION_SHOW_VOICE_INTERACTION)).isGreaterThan(-1); + } + + @Test + @FlakyTest(bugId = 275113847) + public void testOnPhraseRecognitionRestartsActiveSession() throws RemoteException { + ArgumentCaptor soundTriggerCallbackCaptor = ArgumentCaptor.forClass( + ISoundTriggerCallback.class); + mSoundTriggerMiddlewareLogging.attach(0, mISoundTriggerCallback); + verify(mDelegateMiddleware).attach(anyInt(), soundTriggerCallbackCaptor.capture()); + + triggerPhraseRecognitionEvent(soundTriggerCallbackCaptor.getValue(), + RecognitionStatus.SUCCESS, Optional.of(100) /* keyphraseId */); + long firstTriggerSessionStartTime = mLatencyTracker.getActiveActionStartTime( + ACTION_SHOW_VOICE_INTERACTION); + triggerPhraseRecognitionEvent(soundTriggerCallbackCaptor.getValue(), + RecognitionStatus.SUCCESS, Optional.of(100) /* keyphraseId */); + assertThat(mLatencyTracker.getActiveActionStartTime( + ACTION_SHOW_VOICE_INTERACTION)).isGreaterThan(-1); + assertThat(mLatencyTracker.getActiveActionStartTime( + ACTION_SHOW_VOICE_INTERACTION)).isNotEqualTo(firstTriggerSessionStartTime); + } + + @Test + @FlakyTest(bugId = 275113847) + public void testOnPhraseRecognitionNeverStartsLatencyTrackerWithNonSuccessEvent() + throws RemoteException { + ArgumentCaptor soundTriggerCallbackCaptor = ArgumentCaptor.forClass( + ISoundTriggerCallback.class); + mSoundTriggerMiddlewareLogging.attach(0, mISoundTriggerCallback); + verify(mDelegateMiddleware).attach(anyInt(), soundTriggerCallbackCaptor.capture()); + + triggerPhraseRecognitionEvent(soundTriggerCallbackCaptor.getValue(), + RecognitionStatus.ABORTED, Optional.of(100) /* keyphraseId */); + + assertThat( + mLatencyTracker.getActiveActionStartTime(ACTION_SHOW_VOICE_INTERACTION)).isEqualTo( + -1); + } + + @Test + @FlakyTest(bugId = 275113847) + public void testOnPhraseRecognitionNeverStartsLatencyTrackerWithNoKeyphraseId() + throws RemoteException { + ArgumentCaptor soundTriggerCallbackCaptor = ArgumentCaptor.forClass( + ISoundTriggerCallback.class); + mSoundTriggerMiddlewareLogging.attach(0, mISoundTriggerCallback); + verify(mDelegateMiddleware).attach(anyInt(), soundTriggerCallbackCaptor.capture()); + + triggerPhraseRecognitionEvent(soundTriggerCallbackCaptor.getValue(), + RecognitionStatus.SUCCESS, Optional.empty() /* keyphraseId */); + + assertThat( + mLatencyTracker.getActiveActionStartTime(ACTION_SHOW_VOICE_INTERACTION)).isEqualTo( + -1); + } + + private void triggerPhraseRecognitionEvent(ISoundTriggerCallback callback, + @RecognitionStatus int triggerEventStatus, Optional optionalKeyphraseId) + throws RemoteException { + // trigger a phrase recognition to start a latency tracker session + PhraseRecognitionEvent successEventWithKeyphraseId = new PhraseRecognitionEvent(); + successEventWithKeyphraseId.common = new RecognitionEvent(); + successEventWithKeyphraseId.common.status = triggerEventStatus; + if (optionalKeyphraseId.isPresent()) { + PhraseRecognitionExtra recognitionExtra = new PhraseRecognitionExtra(); + recognitionExtra.id = optionalKeyphraseId.get(); + successEventWithKeyphraseId.phraseExtras = + new PhraseRecognitionExtra[]{recognitionExtra}; + } + callback.onPhraseRecognition(0 /* modelHandle */, successEventWithKeyphraseId, + 0 /* captureSession */); + } +} diff --git a/services/tests/voiceinteractiontests/src/com/android/server/soundtrigger_middleware/SoundTriggerMiddlewareLoggingTest.java b/services/tests/voiceinteractiontests/src/com/android/server/soundtrigger_middleware/SoundTriggerMiddlewareLoggingTest.java index eb117d1283836..f92e0dbe94e07 100644 --- a/services/tests/voiceinteractiontests/src/com/android/server/soundtrigger_middleware/SoundTriggerMiddlewareLoggingTest.java +++ b/services/tests/voiceinteractiontests/src/com/android/server/soundtrigger_middleware/SoundTriggerMiddlewareLoggingTest.java @@ -18,186 +18,27 @@ package com.android.server.soundtrigger_middleware; import static com.android.server.soundtrigger_middleware.SoundTriggerMiddlewareLogging.ServiceEvent; import static com.android.server.soundtrigger_middleware.SoundTriggerMiddlewareLogging.SessionEvent; -import static com.android.internal.util.LatencyTracker.ACTION_SHOW_VOICE_INTERACTION; import static com.google.common.truth.Truth.assertThat; -import static org.mockito.ArgumentMatchers.anyInt; -import static org.mockito.Mockito.verify; - -import android.Manifest; -import android.app.ActivityThread; -import android.media.permission.Identity; -import android.media.permission.IdentityContext; -import android.media.soundtrigger.PhraseRecognitionEvent; -import android.media.soundtrigger.PhraseRecognitionExtra; -import android.media.soundtrigger.RecognitionEvent; -import android.media.soundtrigger.RecognitionStatus; -import android.media.soundtrigger_middleware.ISoundTriggerCallback; -import android.media.soundtrigger_middleware.ISoundTriggerModule; -import android.os.BatteryStatsInternal; -import android.os.Process; -import android.os.RemoteException; - -import androidx.test.filters.FlakyTest; -import androidx.test.platform.app.InstrumentationRegistry; - -import com.android.internal.util.FakeLatencyTracker; - -import org.junit.After; -import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; -import org.mockito.ArgumentCaptor; -import org.mockito.Mock; -import org.mockito.MockitoAnnotations; - -import java.util.Optional; @RunWith(JUnit4.class) public class SoundTriggerMiddlewareLoggingTest { private static final ServiceEvent.Type SERVICE_TYPE = ServiceEvent.Type.ATTACH; private static final SessionEvent.Type SESSION_TYPE = SessionEvent.Type.LOAD_MODEL; - private FakeLatencyTracker mLatencyTracker; - @Mock - private BatteryStatsInternal mBatteryStatsInternal; - @Mock - private ISoundTriggerMiddlewareInternal mDelegateMiddleware; - @Mock - private ISoundTriggerCallback mISoundTriggerCallback; - @Mock - private ISoundTriggerModule mSoundTriggerModule; - private SoundTriggerMiddlewareLogging mSoundTriggerMiddlewareLogging; - - @Before - public void setUp() throws Exception { - MockitoAnnotations.initMocks(this); - - InstrumentationRegistry.getInstrumentation().getUiAutomation() - .adoptShellPermissionIdentity(Manifest.permission.WRITE_DEVICE_CONFIG, - Manifest.permission.READ_DEVICE_CONFIG); - - Identity identity = new Identity(); - identity.uid = Process.myUid(); - identity.pid = Process.myPid(); - identity.packageName = ActivityThread.currentOpPackageName(); - IdentityContext.create(identity); - - mLatencyTracker = FakeLatencyTracker.create(); - mLatencyTracker.forceEnabled(ACTION_SHOW_VOICE_INTERACTION, -1); - mSoundTriggerMiddlewareLogging = new SoundTriggerMiddlewareLogging(mLatencyTracker, - () -> mBatteryStatsInternal, - mDelegateMiddleware); - } - - @After - public void tearDown() { - InstrumentationRegistry.getInstrumentation().getUiAutomation() - .dropShellPermissionIdentity(); - } - - @Test - @FlakyTest(bugId = 275113847) - public void testSetUpAndTearDown() { - } - - @Test - @FlakyTest(bugId = 275113847) - public void testOnPhraseRecognitionStartsLatencyTrackerWithSuccessfulPhraseIdTrigger() - throws RemoteException { - ArgumentCaptor soundTriggerCallbackCaptor = ArgumentCaptor.forClass( - ISoundTriggerCallback.class); - mSoundTriggerMiddlewareLogging.attach(0, mISoundTriggerCallback); - verify(mDelegateMiddleware).attach(anyInt(), soundTriggerCallbackCaptor.capture()); - - triggerPhraseRecognitionEvent(soundTriggerCallbackCaptor.getValue(), - RecognitionStatus.SUCCESS, Optional.of(100) /* keyphraseId */); - - assertThat(mLatencyTracker.getActiveActionStartTime( - ACTION_SHOW_VOICE_INTERACTION)).isGreaterThan(-1); - } - - @Test - @FlakyTest(bugId = 275113847) - public void testOnPhraseRecognitionRestartsActiveSession() throws RemoteException { - ArgumentCaptor soundTriggerCallbackCaptor = ArgumentCaptor.forClass( - ISoundTriggerCallback.class); - mSoundTriggerMiddlewareLogging.attach(0, mISoundTriggerCallback); - verify(mDelegateMiddleware).attach(anyInt(), soundTriggerCallbackCaptor.capture()); - - triggerPhraseRecognitionEvent(soundTriggerCallbackCaptor.getValue(), - RecognitionStatus.SUCCESS, Optional.of(100) /* keyphraseId */); - long firstTriggerSessionStartTime = mLatencyTracker.getActiveActionStartTime( - ACTION_SHOW_VOICE_INTERACTION); - triggerPhraseRecognitionEvent(soundTriggerCallbackCaptor.getValue(), - RecognitionStatus.SUCCESS, Optional.of(100) /* keyphraseId */); - assertThat(mLatencyTracker.getActiveActionStartTime( - ACTION_SHOW_VOICE_INTERACTION)).isGreaterThan(-1); - assertThat(mLatencyTracker.getActiveActionStartTime( - ACTION_SHOW_VOICE_INTERACTION)).isNotEqualTo(firstTriggerSessionStartTime); - } - - @Test - @FlakyTest(bugId = 275113847) - public void testOnPhraseRecognitionNeverStartsLatencyTrackerWithNonSuccessEvent() - throws RemoteException { - ArgumentCaptor soundTriggerCallbackCaptor = ArgumentCaptor.forClass( - ISoundTriggerCallback.class); - mSoundTriggerMiddlewareLogging.attach(0, mISoundTriggerCallback); - verify(mDelegateMiddleware).attach(anyInt(), soundTriggerCallbackCaptor.capture()); - - triggerPhraseRecognitionEvent(soundTriggerCallbackCaptor.getValue(), - RecognitionStatus.ABORTED, Optional.of(100) /* keyphraseId */); - - assertThat( - mLatencyTracker.getActiveActionStartTime(ACTION_SHOW_VOICE_INTERACTION)).isEqualTo( - -1); - } - - @Test - @FlakyTest(bugId = 275113847) - public void testOnPhraseRecognitionNeverStartsLatencyTrackerWithNoKeyphraseId() - throws RemoteException { - ArgumentCaptor soundTriggerCallbackCaptor = ArgumentCaptor.forClass( - ISoundTriggerCallback.class); - mSoundTriggerMiddlewareLogging.attach(0, mISoundTriggerCallback); - verify(mDelegateMiddleware).attach(anyInt(), soundTriggerCallbackCaptor.capture()); - - triggerPhraseRecognitionEvent(soundTriggerCallbackCaptor.getValue(), - RecognitionStatus.SUCCESS, Optional.empty() /* keyphraseId */); - - assertThat( - mLatencyTracker.getActiveActionStartTime(ACTION_SHOW_VOICE_INTERACTION)).isEqualTo( - -1); - } - - private void triggerPhraseRecognitionEvent(ISoundTriggerCallback callback, - @RecognitionStatus int triggerEventStatus, Optional optionalKeyphraseId) - throws RemoteException { - // trigger a phrase recognition to start a latency tracker session - PhraseRecognitionEvent successEventWithKeyphraseId = new PhraseRecognitionEvent(); - successEventWithKeyphraseId.common = new RecognitionEvent(); - successEventWithKeyphraseId.common.status = triggerEventStatus; - if (optionalKeyphraseId.isPresent()) { - PhraseRecognitionExtra recognitionExtra = new PhraseRecognitionExtra(); - recognitionExtra.id = optionalKeyphraseId.get(); - successEventWithKeyphraseId.phraseExtras = - new PhraseRecognitionExtra[]{recognitionExtra}; - } - callback.onPhraseRecognition(0 /* modelHandle */, successEventWithKeyphraseId, - 0 /* captureSession */); - } - @Test public void serviceEventException_getStringContainsInfo() { String packageName = "com.android.test"; Exception exception = new Exception("test"); Object param1 = new Object(); Object param2 = new Object(); - final var event = ServiceEvent.createForException( - SERVICE_TYPE, packageName, exception, param1, param2); + final var event = + ServiceEvent.createForException( + SERVICE_TYPE, packageName, exception, param1, param2); final var stringRep = event.eventToString(); assertThat(stringRep).contains(SERVICE_TYPE.name()); assertThat(stringRep).contains(packageName); @@ -211,8 +52,7 @@ public class SoundTriggerMiddlewareLoggingTest { public void serviceEventExceptionNoArgs_getStringContainsInfo() { String packageName = "com.android.test"; Exception exception = new Exception("test"); - final var event = ServiceEvent.createForException( - SERVICE_TYPE, packageName, exception); + final var event = ServiceEvent.createForException(SERVICE_TYPE, packageName, exception); final var stringRep = event.eventToString(); assertThat(stringRep).contains(SERVICE_TYPE.name()); assertThat(stringRep).contains(packageName); @@ -226,8 +66,8 @@ public class SoundTriggerMiddlewareLoggingTest { Object param1 = new Object(); Object param2 = new Object(); Object retValue = new Object(); - final var event = ServiceEvent.createForReturn( - SERVICE_TYPE, packageName, retValue, param1, param2); + final var event = + ServiceEvent.createForReturn(SERVICE_TYPE, packageName, retValue, param1, param2); final var stringRep = event.eventToString(); assertThat(stringRep).contains(SERVICE_TYPE.name()); assertThat(stringRep).contains(packageName); @@ -241,8 +81,7 @@ public class SoundTriggerMiddlewareLoggingTest { public void serviceEventReturnNoArgs_getStringContainsInfo() { String packageName = "com.android.test"; Object retValue = new Object(); - final var event = ServiceEvent.createForReturn( - SERVICE_TYPE, packageName, retValue); + final var event = ServiceEvent.createForReturn(SERVICE_TYPE, packageName, retValue); final var stringRep = event.eventToString(); assertThat(stringRep).contains(SERVICE_TYPE.name()); assertThat(stringRep).contains(packageName); @@ -255,8 +94,7 @@ public class SoundTriggerMiddlewareLoggingTest { Object param1 = new Object(); Object param2 = new Object(); Exception exception = new Exception("test"); - final var event = SessionEvent.createForException( - SESSION_TYPE, exception, param1, param2); + final var event = SessionEvent.createForException(SESSION_TYPE, exception, param1, param2); final var stringRep = event.eventToString(); assertThat(stringRep).contains(SESSION_TYPE.name()); assertThat(stringRep).contains(exception.toString()); @@ -268,8 +106,7 @@ public class SoundTriggerMiddlewareLoggingTest { @Test public void sessionEventExceptionNoArgs_getStringContainsInfo() { Exception exception = new Exception("test"); - final var event = SessionEvent.createForException( - SESSION_TYPE, exception); + final var event = SessionEvent.createForException(SESSION_TYPE, exception); final var stringRep = event.eventToString(); assertThat(stringRep).contains(SESSION_TYPE.name()); assertThat(stringRep).contains(exception.toString()); @@ -281,8 +118,7 @@ public class SoundTriggerMiddlewareLoggingTest { Object param1 = new Object(); Object param2 = new Object(); Object retValue = new Object(); - final var event = SessionEvent.createForReturn( - SESSION_TYPE, retValue, param1, param2); + final var event = SessionEvent.createForReturn(SESSION_TYPE, retValue, param1, param2); final var stringRep = event.eventToString(); assertThat(stringRep).contains(SESSION_TYPE.name()); assertThat(stringRep).contains(retValue.toString()); @@ -294,8 +130,7 @@ public class SoundTriggerMiddlewareLoggingTest { @Test public void sessionEventReturnNoArgs_getStringContainsInfo() { Object retValue = new Object(); - final var event = SessionEvent.createForReturn( - SESSION_TYPE, retValue); + final var event = SessionEvent.createForReturn(SESSION_TYPE, retValue); final var stringRep = event.eventToString(); assertThat(stringRep).contains(SESSION_TYPE.name()); assertThat(stringRep).contains(retValue.toString()); @@ -306,8 +141,7 @@ public class SoundTriggerMiddlewareLoggingTest { public void sessionEventVoid_getStringContainsInfo() { Object param1 = new Object(); Object param2 = new Object(); - final var event = SessionEvent.createForVoid( - SESSION_TYPE, param1, param2); + final var event = SessionEvent.createForVoid(SESSION_TYPE, param1, param2); final var stringRep = event.eventToString(); assertThat(stringRep).contains(SESSION_TYPE.name()); assertThat(stringRep).contains(param1.toString()); @@ -317,8 +151,7 @@ public class SoundTriggerMiddlewareLoggingTest { @Test public void sessionEventVoidNoArgs_getStringContainsInfo() { - final var event = SessionEvent.createForVoid( - SESSION_TYPE); + final var event = SessionEvent.createForVoid(SESSION_TYPE); final var stringRep = event.eventToString(); assertThat(stringRep).contains(SESSION_TYPE.name()); assertThat(stringRep).ignoringCase().doesNotContain("error");