tests/tests/car_builtin/src/android/car/cts/builtin/util/AssistUtilsHelperTest.java

/*
 * 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 android.car.cts.builtin.util;

import static com.google.common.truth.Truth.assertWithMessage;

import android.app.Instrumentation;
import android.car.builtin.util.AssistUtilsHelper;
import android.content.Context;
import android.util.Log;

import androidx.test.platform.app.InstrumentationRegistry;
import androidx.test.runner.AndroidJUnit4;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;

@RunWith(AndroidJUnit4.class)
public final class AssistUtilsHelperTest {
    private static final String TAG = AssistUtilsHelper.class.getSimpleName();
    private static final String PERMISSION_ACCESS_VOICE_INTERACTION_SERVICE =
            "android.permission.ACCESS_VOICE_INTERACTION_SERVICE";
    private static final int TIMEOUT = 20_000;

    private final Instrumentation mInstrumentation = InstrumentationRegistry.getInstrumentation();
    private final Context mContext = mInstrumentation.getContext();

    @Before
    public void setUp() throws Exception {
        mInstrumentation.getUiAutomation().adoptShellPermissionIdentity(
                PERMISSION_ACCESS_VOICE_INTERACTION_SERVICE);
    }

    @After
    public void cleanUp() {
        mInstrumentation.getUiAutomation().dropShellPermissionIdentity();
    }

    @Test
    public void testOnShownCallback() throws Exception {
        SessionShowCallbackHelperImpl callbackHelperImpl = new SessionShowCallbackHelperImpl();
        AssistUtilsHelper.showPushToTalkSessionForActiveService(mContext, callbackHelperImpl);
        callbackHelperImpl.waitForCallback();

        assertWithMessage("Voice session shown")
                .that(callbackHelperImpl.isSessionOnShown()).isTrue();

        hideSessionAndWait();
    }

    @Test
    public void testOnFailedCallback() throws Exception {
        // TODO (b/200609382): setup a failure scenario to cover session failed case and
        // call onFailed API
    }

    @Test
    public void isSessionRunning_whenSessionIsShown_succeeds() throws Exception {
        SessionShowCallbackHelperImpl callbackHelperImpl = new SessionShowCallbackHelperImpl();
        AssistUtilsHelper.showPushToTalkSessionForActiveService(mContext, callbackHelperImpl);
        callbackHelperImpl.waitForCallback();

        assertWithMessage("Voice interaction session running")
                .that(AssistUtilsHelper.isSessionRunning(mContext)).isTrue();

        hideSessionAndWait();
    }

    @Test
    public void registerVoiceInteractionSessionListenerHelper_onShowSession() throws Exception {
        VoiceInteractionSessionListener listener = new VoiceInteractionSessionListener();
        AssistUtilsHelper.registerVoiceInteractionSessionListenerHelper(mContext, listener);

        SessionShowCallbackHelperImpl callbackHelperImpl = new SessionShowCallbackHelperImpl();
        AssistUtilsHelper.showPushToTalkSessionForActiveService(mContext, callbackHelperImpl);
        callbackHelperImpl.waitForCallback();

        listener.waitForSessionChange();

        assertWithMessage("Voice interaction session shown")
                .that(listener.mIsSessionShown).isTrue();

        hideSessionAndWait();
    }

    @Test
    public void registerVoiceInteractionSessionListenerHelper_hideCurrentSession()
            throws Exception {
        VoiceInteractionSessionListener listener = new VoiceInteractionSessionListener();
        AssistUtilsHelper.registerVoiceInteractionSessionListenerHelper(mContext, listener);

        SessionShowCallbackHelperImpl callbackHelperImpl = new SessionShowCallbackHelperImpl();
        AssistUtilsHelper.showPushToTalkSessionForActiveService(mContext, callbackHelperImpl);
        callbackHelperImpl.waitForCallback();

        listener.waitForSessionChange();
        listener.reset();

        AssistUtilsHelper.hideCurrentSession(mContext);
        listener.waitForSessionChange();

        assertWithMessage("Voice interaction session shown")
                .that(listener.mIsSessionShown).isFalse();
    }

    private void hideSessionAndWait() throws Exception {
        if (!AssistUtilsHelper.isSessionRunning(mContext)) {
            return;
        }
        VoiceInteractionSessionListener listener = new VoiceInteractionSessionListener();
        AssistUtilsHelper.registerVoiceInteractionSessionListenerHelper(mContext, listener);

        listener.reset();
        listener.waitForSessionChange();
    }

    private static final class VoiceInteractionSessionListener implements
            AssistUtilsHelper.VoiceInteractionSessionListenerHelper {

        private final Semaphore mChangeWait = new Semaphore(0);
        private boolean mIsSessionShown;

        @Override
        public void onVoiceSessionShown() {
            mIsSessionShown = true;
            Log.d(TAG, "onVoiceSessionShown is called");
            mChangeWait.release();
        }

        @Override
        public void onVoiceSessionHidden() {
            mIsSessionShown = false;
            Log.d(TAG, "onVoiceSessionHidden is called");
            mChangeWait.release();
        }

        private void waitForSessionChange() throws Exception {
            if (!mChangeWait.tryAcquire(TIMEOUT, TimeUnit.MILLISECONDS)) {
                throw new IllegalStateException("Timed out waiting for session change");
            }
        }

        private void reset() {
            mChangeWait.drainPermits();
        }
    }

    private static final class SessionShowCallbackHelperImpl implements
            AssistUtilsHelper.VoiceInteractionSessionShowCallbackHelper {

        private final CountDownLatch mCallbackLatch = new CountDownLatch(1);
        private boolean mIsSessionOnShown = false;

        public void onShown() {
            mIsSessionOnShown = true;
            Log.d(TAG, "onShown is called");
            mCallbackLatch.countDown();
        }

        public void onFailed() {
            Log.d(TAG, "onFailed");
        }

        private boolean isSessionOnShown() {
            return mIsSessionOnShown;
        }

        private void waitForCallback() throws Exception {
            mCallbackLatch.await(TIMEOUT, TimeUnit.MILLISECONDS);
        }
    }
}