tests/tests/view/src/android/view/cts/AttachedSurfaceControlTest.java

/*
 * 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 android.view.cts;

import static android.content.res.Configuration.ORIENTATION_LANDSCAPE;
import static android.content.res.Configuration.ORIENTATION_PORTRAIT;
import static android.view.Display.DEFAULT_DISPLAY;

import android.annotation.SuppressLint;
import android.app.Activity;
import android.content.pm.ActivityInfo;
import android.content.pm.PackageManager;
import android.util.Log;
import android.server.wm.ActivityManagerTestBase;
import android.view.AttachedSurfaceControl;

import androidx.lifecycle.Lifecycle;
import androidx.test.core.app.ActivityScenario;
import androidx.test.filters.LargeTest;
import androidx.test.filters.RequiresDevice;
import androidx.test.platform.app.InstrumentationRegistry;
import androidx.test.runner.AndroidJUnit4;

import org.junit.Assert;
import org.junit.Assume;
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.TimeUnit;
import java.util.function.IntConsumer;

@RunWith(AndroidJUnit4.class)
@LargeTest
@SuppressLint("RtlHardcoded")
@RequiresDevice
public class AttachedSurfaceControlTest {
    private static final String TAG = "AttachedSurfaceControlTest";
    private ActivityManagerTestBase.IgnoreOrientationRequestSession mOrientationSession;

    private static class TransformHintListener implements
            AttachedSurfaceControl.OnBufferTransformHintChangedListener {
        Activity activity;
        int expectedOrientation;
        CountDownLatch latch = new CountDownLatch(1);
        IntConsumer hintConsumer;

        TransformHintListener(Activity activity, int expectedOrientation,
                IntConsumer hintConsumer) {
            this.activity = activity;
            this.expectedOrientation = expectedOrientation;
            this.hintConsumer = hintConsumer;
        }

        @Override
        public void onBufferTransformHintChanged(int hint) {
            int orientation = activity.getResources().getConfiguration().orientation;
            Log.d(TAG, "onBufferTransformHintChanged: orientation actual=" + orientation
                    + " expected=" + expectedOrientation + " transformHint=" + hint);
            Assert.assertEquals("Failed to switch orientation hint=" + hint, orientation,
                    expectedOrientation);
            hintConsumer.accept(hint);
            latch.countDown();
            activity.getWindow().getRootSurfaceControl()
                    .removeOnBufferTransformHintChangedListener(this);
        }
    }

    @Before
    public void setup() {
        PackageManager pm =
                InstrumentationRegistry.getInstrumentation().getContext().getPackageManager();
        boolean supportsRotation = pm.hasSystemFeature(PackageManager.FEATURE_SCREEN_PORTRAIT)
                && pm.hasSystemFeature(PackageManager.FEATURE_SCREEN_LANDSCAPE);
        Assume.assumeTrue(supportsRotation);
        mOrientationSession = new ActivityManagerTestBase.IgnoreOrientationRequestSession(DEFAULT_DISPLAY, false);
    }

    @After
    public void teardown() {
        mOrientationSession.close();
    }

    @Test
    public void testOnBufferTransformHintChangedListener() throws InterruptedException {
        final int[] transformHintResult = new int[2];
        final CountDownLatch[] firstCallback = new CountDownLatch[1];
        final CountDownLatch[] secondCallback = new CountDownLatch[1];
        try (ActivityScenario<HandleConfigurationActivity> scenario =
                     ActivityScenario.launch(HandleConfigurationActivity.class)) {
            scenario.moveToState(Lifecycle.State.RESUMED);
            scenario.onActivity(activity -> {
                int requestedOrientation = getRequestedOrientation(activity);
                TransformHintListener listener = new TransformHintListener(activity,
                        requestedOrientation, hint -> transformHintResult[0] = hint);
                firstCallback[0] = listener.latch;
                activity.getWindow().getRootSurfaceControl()
                        .addOnBufferTransformHintChangedListener(listener);
                setRequestedOrientation(activity, requestedOrientation);
            });
            // Check we get a callback since the orientation has changed and we expect transform
            // hint to change.
            Assert.assertTrue(firstCallback[0].await(3, TimeUnit.SECONDS));

            // Check the callback value matches the call to get the transform hint.
            scenario.onActivity(activity -> Assert.assertEquals(transformHintResult[0],
                    activity.getWindow().getRootSurfaceControl().getBufferTransformHint()));

            scenario.onActivity(activity -> {
                int requestedOrientation = getRequestedOrientation(activity);
                TransformHintListener listener = new TransformHintListener(activity,
                        requestedOrientation, hint -> transformHintResult[1] = hint);
                secondCallback[0] = listener.latch;
                activity.getWindow().getRootSurfaceControl()
                        .addOnBufferTransformHintChangedListener(listener);
                setRequestedOrientation(activity, requestedOrientation);
            });
            // Check we get a callback since the orientation has changed and we expect transform
            // hint to change.
            Assert.assertTrue(secondCallback[0].await(3, TimeUnit.SECONDS));

            // Check the callback value matches the call to get the transform hint.
            scenario.onActivity(activity -> Assert.assertEquals(transformHintResult[1],
                    activity.getWindow().getRootSurfaceControl().getBufferTransformHint()));
        }

        // If the app orientation was changed, we should get a different transform hint
        Assert.assertNotEquals(transformHintResult[0], transformHintResult[1]);
    }

    private int getRequestedOrientation(Activity activity) {
        int currentOrientation = activity.getResources().getConfiguration().orientation;
        return currentOrientation == ORIENTATION_LANDSCAPE ? ORIENTATION_PORTRAIT
                : ORIENTATION_LANDSCAPE;
    }

    private void setRequestedOrientation(Activity activity,
            /* @Configuration.Orientation */ int requestedOrientation) {
        /* @ActivityInfo.ScreenOrientation */
        Log.d(TAG, "setRequestedOrientation: requestedOrientation=" + requestedOrientation);
        int screenOrientation =
                requestedOrientation == ORIENTATION_LANDSCAPE
                        ? ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE
                        : ActivityInfo.SCREEN_ORIENTATION_PORTRAIT;
        activity.setRequestedOrientation(screenOrientation);
    }

    @Test
    public void testOnBufferTransformHintChangesFromLandToSea() throws InterruptedException {
        final int[] transformHintResult = new int[2];
        final CountDownLatch[] firstCallback = new CountDownLatch[1];
        final CountDownLatch[] secondCallback = new CountDownLatch[1];
        try (ActivityScenario<HandleConfigurationActivity> scenario =
                     ActivityScenario.launch(HandleConfigurationActivity.class)) {
            scenario.moveToState(Lifecycle.State.RESUMED);
            scenario.onActivity(activity -> {
                if (activity.getResources().getConfiguration().orientation
                        == ORIENTATION_LANDSCAPE) {
                    return;
                }
                TransformHintListener listener = new TransformHintListener(activity,
                        ORIENTATION_LANDSCAPE, hint -> transformHintResult[0] = hint);
                firstCallback[0] = listener.latch;
                activity.getWindow().getRootSurfaceControl()
                        .addOnBufferTransformHintChangedListener(listener);
                setRequestedOrientation(activity, ORIENTATION_LANDSCAPE);
            });

            // If the device is already in landscape, do nothing.
            if (firstCallback[0] != null) {
                Assert.assertTrue(firstCallback[0].await(3, TimeUnit.SECONDS));
                scenario.onActivity(activity -> Assert.assertEquals(transformHintResult[0],
                    activity.getWindow().getRootSurfaceControl().getBufferTransformHint()));
            }

            scenario.onActivity(activity -> {
                TransformHintListener listener = new TransformHintListener(activity,
                        ORIENTATION_LANDSCAPE, hint -> transformHintResult[1] = hint);
                secondCallback[0] = listener.latch;
                activity.getWindow().getRootSurfaceControl()
                        .addOnBufferTransformHintChangedListener(listener);
                activity.setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_REVERSE_LANDSCAPE);
            });
            // Check we get a callback since the orientation has changed and we expect transform
            // hint to change.
            Assert.assertTrue(secondCallback[0].await(3, TimeUnit.SECONDS));

            // Check the callback value matches the call to get the transform hint.
            scenario.onActivity(activity -> Assert.assertEquals(transformHintResult[1],
                    activity.getWindow().getRootSurfaceControl().getBufferTransformHint()));
        }

        // If the app orientation was changed, we should get a different transform hint
        Assert.assertNotEquals(transformHintResult[0], transformHintResult[1]);
    }

}