android-10.0.0_r47/s

/*
 * Copyright (C) 2014 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.media.cts;

import android.platform.test.annotations.AppModeFull;
import com.android.compatibility.common.util.SystemUtil;

import android.content.Context;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.content.res.Resources;
import android.media.MediaSession2;
import android.media.Session2CommandGroup;
import android.media.Session2Token;
import android.media.session.MediaController;
import android.media.session.MediaSession;
import android.media.session.MediaSessionManager;
import android.media.session.PlaybackState;
import android.os.Handler;
import android.os.HandlerThread;
import android.os.Looper;
import android.os.Process;
import android.test.InstrumentationTestCase;
import android.test.UiThreadTest;
import android.view.KeyEvent;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Executor;
import java.util.concurrent.TimeUnit;

@AppModeFull(reason = "TODO: evaluate and port to instant")
public class MediaSessionManagerTest extends InstrumentationTestCase {
    private static final String TAG = "MediaSessionManagerTest";
    private static final int TIMEOUT_MS = 3000;
    private static final int WAIT_MS = 500;

    private MediaSessionManager mSessionManager;

    @Override
    protected void setUp() throws Exception {
        super.setUp();
        mSessionManager = (MediaSessionManager) getInstrumentation().getTargetContext()
                .getSystemService(Context.MEDIA_SESSION_SERVICE);
    }

    @Override
    protected void tearDown() throws Exception {
        super.tearDown();
    }

    public void testGetActiveSessions() throws Exception {
        try {
            List<MediaController> controllers = mSessionManager.getActiveSessions(null);
            fail("Expected security exception for unauthorized call to getActiveSessions");
        } catch (SecurityException e) {
            // Expected
        }
        // TODO enable a notification listener, test again, disable, test again
    }

    @UiThreadTest
    public void testAddOnActiveSessionsListener() throws Exception {
        try {
            mSessionManager.addOnActiveSessionsChangedListener(null, null);
            fail("Expected IAE for call to addOnActiveSessionsChangedListener");
        } catch (IllegalArgumentException e) {
            // Expected
        }

        MediaSessionManager.OnActiveSessionsChangedListener listener
                = new MediaSessionManager.OnActiveSessionsChangedListener() {
            @Override
            public void onActiveSessionsChanged(List<MediaController> controllers) {

            }
        };
        try {
            mSessionManager.addOnActiveSessionsChangedListener(listener, null);
            fail("Expected security exception for call to addOnActiveSessionsChangedListener");
        } catch (SecurityException e) {
            // Expected
        }

        // TODO enable a notification listener, test again, disable, verify
        // updates stopped
    }

    private void assertKeyEventEquals(KeyEvent lhs, int keyCode, int action, int repeatCount) {
        assertTrue(lhs.getKeyCode() == keyCode
                && lhs.getAction() == action
                && lhs.getRepeatCount() == repeatCount);
    }

    private void injectInputEvent(int keyCode, boolean longPress) throws IOException {
        // Injecting key with instrumentation requires a window/view, but we don't have it.
        // Inject key event through the adb commend to workaround.
        final String command = "input keyevent " + (longPress ? "--longpress " : "") + keyCode;
        SystemUtil.runShellCommand(getInstrumentation(), command);
    }

    public void testSetOnVolumeKeyLongPressListener() throws Exception {
        Context context = getInstrumentation().getTargetContext();
        if (context.getPackageManager().hasSystemFeature(PackageManager.FEATURE_LEANBACK)
                || context.getPackageManager().hasSystemFeature(PackageManager.FEATURE_WATCH)
                || context.getResources().getBoolean(Resources.getSystem().getIdentifier(
                        "config_handleVolumeKeysInWindowManager", "bool", "android"))) {
            // Skip this test, because the PhoneWindowManager dispatches volume key
            // events directly to the audio service to change the system volume.
            return;
        }
        Handler handler = createHandler();

        // Ensure that the listener is called for long-press.
        VolumeKeyLongPressListener listener = new VolumeKeyLongPressListener(3, handler);
        mSessionManager.setOnVolumeKeyLongPressListener(listener, handler);
        injectInputEvent(KeyEvent.KEYCODE_VOLUME_DOWN, true);
        assertTrue(listener.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
        assertEquals(listener.mKeyEvents.size(), 3);
        assertKeyEventEquals(listener.mKeyEvents.get(0),
                KeyEvent.KEYCODE_VOLUME_DOWN, KeyEvent.ACTION_DOWN, 0);
        assertKeyEventEquals(listener.mKeyEvents.get(1),
                KeyEvent.KEYCODE_VOLUME_DOWN, KeyEvent.ACTION_DOWN, 1);
        assertKeyEventEquals(listener.mKeyEvents.get(2),
                KeyEvent.KEYCODE_VOLUME_DOWN, KeyEvent.ACTION_UP, 0);

        // Ensure the the listener isn't called for short-press.
        listener = new VolumeKeyLongPressListener(1, handler);
        mSessionManager.setOnVolumeKeyLongPressListener(listener, handler);
        injectInputEvent(KeyEvent.KEYCODE_VOLUME_DOWN, false);
        assertFalse(listener.mCountDownLatch.await(WAIT_MS, TimeUnit.MILLISECONDS));
        assertEquals(listener.mKeyEvents.size(), 0);

        // Ensure that the listener isn't called anymore.
        mSessionManager.setOnVolumeKeyLongPressListener(null, handler);
        injectInputEvent(KeyEvent.KEYCODE_VOLUME_DOWN, true);
        assertFalse(listener.mCountDownLatch.await(WAIT_MS, TimeUnit.MILLISECONDS));
        assertEquals(listener.mKeyEvents.size(), 0);

        removeHandler(handler);
    }

    public void testSetOnMediaKeyListener() throws Exception {
        Handler handler = createHandler();
        MediaSession session = null;
        try {
            session = new MediaSession(getInstrumentation().getTargetContext(), TAG);
            MediaSessionCallback callback = new MediaSessionCallback(2, session);
            session.setFlags(MediaSession.FLAG_HANDLES_MEDIA_BUTTONS
                    | MediaSession.FLAG_HANDLES_TRANSPORT_CONTROLS);
            session.setCallback(callback, handler);
            PlaybackState state = new PlaybackState.Builder()
                    .setState(PlaybackState.STATE_PLAYING, 0, 1.0f).build();
            // Fake the media session service so this session can take the media key events.
            session.setPlaybackState(state);
            session.setActive(true);

            // A media playback is also needed to receive media key events.
            Utils.assertMediaPlaybackStarted(getInstrumentation().getTargetContext());

            // Ensure that the listener is called for media key event,
            // and any other media sessions don't get the key.
            MediaKeyListener listener = new MediaKeyListener(2, true, handler);
            mSessionManager.setOnMediaKeyListener(listener, handler);
            injectInputEvent(KeyEvent.KEYCODE_HEADSETHOOK, false);
            assertTrue(listener.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
            assertEquals(listener.mKeyEvents.size(), 2);
            assertKeyEventEquals(listener.mKeyEvents.get(0),
                    KeyEvent.KEYCODE_HEADSETHOOK, KeyEvent.ACTION_DOWN, 0);
            assertKeyEventEquals(listener.mKeyEvents.get(1),
                    KeyEvent.KEYCODE_HEADSETHOOK, KeyEvent.ACTION_UP, 0);
            assertFalse(callback.mCountDownLatch.await(WAIT_MS, TimeUnit.MILLISECONDS));
            assertEquals(callback.mKeyEvents.size(), 0);

            // Ensure that the listener is called for media key event,
            // and another media session gets the key.
            listener = new MediaKeyListener(2, false, handler);
            mSessionManager.setOnMediaKeyListener(listener, handler);
            injectInputEvent(KeyEvent.KEYCODE_HEADSETHOOK, false);
            assertTrue(listener.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
            assertEquals(listener.mKeyEvents.size(), 2);
            assertKeyEventEquals(listener.mKeyEvents.get(0),
                    KeyEvent.KEYCODE_HEADSETHOOK, KeyEvent.ACTION_DOWN, 0);
            assertKeyEventEquals(listener.mKeyEvents.get(1),
                    KeyEvent.KEYCODE_HEADSETHOOK, KeyEvent.ACTION_UP, 0);
            assertTrue(callback.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
            assertEquals(callback.mKeyEvents.size(), 2);
            assertKeyEventEquals(callback.mKeyEvents.get(0),
                    KeyEvent.KEYCODE_HEADSETHOOK, KeyEvent.ACTION_DOWN, 0);
            assertKeyEventEquals(callback.mKeyEvents.get(1),
                    KeyEvent.KEYCODE_HEADSETHOOK, KeyEvent.ACTION_UP, 0);

            // Ensure that the listener isn't called anymore.
            listener = new MediaKeyListener(1, true, handler);
            mSessionManager.setOnMediaKeyListener(listener, handler);
            mSessionManager.setOnMediaKeyListener(null, handler);
            injectInputEvent(KeyEvent.KEYCODE_HEADSETHOOK, false);
            assertFalse(listener.mCountDownLatch.await(WAIT_MS, TimeUnit.MILLISECONDS));
            assertEquals(listener.mKeyEvents.size(), 0);
        } finally {
            if (session != null) {
                session.release();
            }
            removeHandler(handler);
        }
    }

    public void testRemoteUserInfo() throws Exception {
        final Context context = getInstrumentation().getTargetContext();
        Handler handler = createHandler();

        MediaSession session = null;
        try {
            session = new MediaSession(context , TAG);
            MediaSessionCallback callback = new MediaSessionCallback(5, session);
            session.setFlags(MediaSession.FLAG_HANDLES_MEDIA_BUTTONS
                    | MediaSession.FLAG_HANDLES_TRANSPORT_CONTROLS);
            session.setCallback(callback, handler);
            PlaybackState state = new PlaybackState.Builder()
                    .setState(PlaybackState.STATE_PLAYING, 0, 1.0f).build();
            // Fake the media session service so this session can take the media key events.
            session.setPlaybackState(state);
            session.setActive(true);

            // A media playback is also needed to receive media key events.
            Utils.assertMediaPlaybackStarted(context);

            // Dispatch key events 5 times.
            KeyEvent event = new KeyEvent(KeyEvent.ACTION_DOWN, KeyEvent.KEYCODE_MEDIA_PLAY);
            // (1), (2): dispatch through key -- this will trigger event twice for up & down.
            injectInputEvent(KeyEvent.KEYCODE_HEADSETHOOK, false);
            // (3): dispatch through controller
            session.getController().dispatchMediaButtonEvent(event);

            // Creating another controller.
            MediaController controller = new MediaController(context, session.getSessionToken());
            // (4): dispatch through different controller.
            controller.dispatchMediaButtonEvent(event);
            // (5): dispatch through the same controller
            controller.dispatchMediaButtonEvent(event);

            // Wait.
            assertTrue(callback.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));

            // Caller of (1) ~ (4) shouldn't be the same as any others.
            for (int i = 0; i < 4; i ++) {
                for (int j = 0; j < i; j++) {
                    assertNotSame(callback.mCallers.get(i), callback.mCallers.get(j));
                }
            }
            // Caller of (5) should be the same as (4), since they're called from the same
            assertEquals(callback.mCallers.get(3), callback.mCallers.get(4));
        } finally {
            if (session != null) {
                session.release();
            }
            removeHandler(handler);
        }
    }

    public void testGetSession2Tokens() throws Exception {
        final Context context = getInstrumentation().getTargetContext();
        Handler handler = createHandler();
        Executor handlerExecutor = (runnable) -> {
            if (handler != null) {
                handler.post(() -> {
                    runnable.run();
                });
            }
        };

        Session2TokenListener listener = new Session2TokenListener();
        mSessionManager.addOnSession2TokensChangedListener(listener, handler);

        Session2Callback sessionCallback = new Session2Callback();
        try (MediaSession2 session = new MediaSession2.Builder(context)
                .setSessionCallback(handlerExecutor, sessionCallback)
                .build()) {
            assertTrue(sessionCallback.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
            assertTrue(listener.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));

            Session2Token currentToken = session.getToken();
            assertTrue(listContainsToken(listener.mTokens, currentToken));
            assertTrue(listContainsToken(mSessionManager.getSession2Tokens(), currentToken));
        }
    }

    public void testGetSession2TokensWithTwoSessions() throws Exception {
        final Context context = getInstrumentation().getTargetContext();
        Handler handler = createHandler();
        Executor handlerExecutor = (runnable) -> {
            if (handler != null) {
                handler.post(() -> {
                    runnable.run();
                });
            }
        };

        Session2TokenListener listener = new Session2TokenListener();
        mSessionManager.addOnSession2TokensChangedListener(listener, handler);

        try (MediaSession2 session1 = new MediaSession2.Builder(context)
                .setSessionCallback(handlerExecutor, new Session2Callback())
                .setId("testGetSession2TokensWithTwoSessions_session1")
                .build()) {

            assertTrue(listener.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
            Session2Token session1Token = session1.getToken();
            assertTrue(listContainsToken(mSessionManager.getSession2Tokens(), session1Token));

            // Create another session and check the result of getSession2Token().
            listener.resetCountDownLatch();
            Session2Token session2Token = null;
            try (MediaSession2 session2 = new MediaSession2.Builder(context)
                    .setSessionCallback(handlerExecutor, new Session2Callback())
                    .setId("testGetSession2TokensWithTwoSessions_session2")
                    .build()) {

                assertTrue(listener.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
                session2Token = session2.getToken();
                assertNotNull(session2Token);
                assertTrue(listContainsToken(mSessionManager.getSession2Tokens(), session1Token));
                assertTrue(listContainsToken(mSessionManager.getSession2Tokens(), session2Token));

                listener.resetCountDownLatch();
            }

            // Since the session2 is closed, getSession2Tokens() shouldn't include session2's token.
            assertTrue(listener.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
            assertTrue(listContainsToken(mSessionManager.getSession2Tokens(), session1Token));
            assertFalse(listContainsToken(mSessionManager.getSession2Tokens(), session2Token));
        }
    }

    public void testAddAndRemoveSession2TokensListener() throws Exception {
        final Context context = getInstrumentation().getTargetContext();
        Handler handler = createHandler();
        Executor handlerExecutor = (runnable) -> {
            if (handler != null) {
                handler.post(() -> {
                    runnable.run();
                });
            }
        };

        Session2TokenListener listener1 = new Session2TokenListener();
        mSessionManager.addOnSession2TokensChangedListener(listener1, handler);

        Session2Callback sessionCallback = new Session2Callback();
        try (MediaSession2 session = new MediaSession2.Builder(context)
                .setSessionCallback(handlerExecutor, sessionCallback)
                .build()) {
            assertTrue(listener1.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
            Session2Token currentToken = session.getToken();
            assertTrue(listContainsToken(listener1.mTokens, currentToken));

            // Test removing listener
            listener1.resetCountDownLatch();
            Session2TokenListener listener2 = new Session2TokenListener();
            mSessionManager.addOnSession2TokensChangedListener(listener2, handler);
            mSessionManager.removeOnSession2TokensChangedListener(listener1);

            session.close();
            assertFalse(listener1.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
            assertTrue(listener2.mCountDownLatch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS));
        }
    }

    private boolean listContainsToken(List<Session2Token> tokens, Session2Token token) {
        for (int i = 0; i < tokens.size(); i++) {
            if (tokens.get(i).equals(token)) {
                return true;
            }
        }
        return false;
    }

    private Handler createHandler() {
        HandlerThread handlerThread = new HandlerThread("MediaSessionManagerTest");
        handlerThread.start();
        return new Handler(handlerThread.getLooper());
    }

    private void removeHandler(Handler handler) {
        if (handler == null) {
            return;
        }
        handler.getLooper().quitSafely();
    }

    private class VolumeKeyLongPressListener
            implements MediaSessionManager.OnVolumeKeyLongPressListener {
        private final List<KeyEvent> mKeyEvents = new ArrayList<>();
        private final CountDownLatch mCountDownLatch;
        private final Handler mHandler;

        public VolumeKeyLongPressListener(int count, Handler handler) {
            mCountDownLatch = new CountDownLatch(count);
            mHandler = handler;
        }

        @Override
        public void onVolumeKeyLongPress(KeyEvent event) {
            mKeyEvents.add(event);
            // Ensure the listener is called on the thread.
            assertEquals(mHandler.getLooper(), Looper.myLooper());
            mCountDownLatch.countDown();
        }
    }

    private class MediaKeyListener implements MediaSessionManager.OnMediaKeyListener {
        private final CountDownLatch mCountDownLatch;
        private final boolean mConsume;
        private final Handler mHandler;
        private final List<KeyEvent> mKeyEvents = new ArrayList<>();

        public MediaKeyListener(int count, boolean consume, Handler handler) {
            mCountDownLatch = new CountDownLatch(count);
            mConsume = consume;
            mHandler = handler;
        }

        @Override
        public boolean onMediaKey(KeyEvent event) {
            mKeyEvents.add(event);
            // Ensure the listener is called on the thread.
            assertEquals(mHandler.getLooper(), Looper.myLooper());
            mCountDownLatch.countDown();
            return mConsume;
        }
    }

    private class MediaSessionCallback extends MediaSession.Callback {
        private final CountDownLatch mCountDownLatch;
        private final MediaSession mSession;
        private final List<KeyEvent> mKeyEvents = new ArrayList<>();
        private final List<MediaSessionManager.RemoteUserInfo> mCallers = new ArrayList<>();

        private MediaSessionCallback(int count, MediaSession session) {
            mCountDownLatch = new CountDownLatch(count);
            mSession = session;
        }

        public boolean onMediaButtonEvent(Intent mediaButtonIntent) {
            KeyEvent event = (KeyEvent) mediaButtonIntent.getParcelableExtra(
                    Intent.EXTRA_KEY_EVENT);
            assertNotNull(event);
            mKeyEvents.add(event);
            mCallers.add(mSession.getCurrentControllerInfo());
            mCountDownLatch.countDown();
            return true;
        }
    }

    private class Session2Callback extends MediaSession2.SessionCallback {
        private CountDownLatch mCountDownLatch;

        private Session2Callback() {
            mCountDownLatch = new CountDownLatch(1);
        }

        @Override
        public Session2CommandGroup onConnect(MediaSession2 session,
                MediaSession2.ControllerInfo controller) {
            if (controller.getUid() == Process.SYSTEM_UID) {
                // System server will try to connect here for monitor session.
                mCountDownLatch.countDown();
            }
            return new Session2CommandGroup.Builder().build();
        }
    }

    private class Session2TokenListener implements
            MediaSessionManager.OnSession2TokensChangedListener {
        private CountDownLatch mCountDownLatch;
        private List<Session2Token> mTokens;

        private Session2TokenListener() {
            mCountDownLatch = new CountDownLatch(1);
        }

        @Override
        public void onSession2TokensChanged(List<Session2Token> tokens) {
            mTokens = tokens;
            mCountDownLatch.countDown();
        }

        public void resetCountDownLatch() {
            mCountDownLatch = new CountDownLatch(1);
        }
    }
}