Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 62ad2da3 authored by Bryce Lee's avatar Bryce Lee
Browse files

Improve DreamService testability. 

This changelist refactors DreamService and associated classes to be
more amenable to testing. A significant change is the introduction of
a dependency injector, allowing test code to have more control over
the DreamService environment.

TestDreamEnvironment has been introduced to provide a scoped space for
interacting with DreamService. It allows tests to control moving through
the dream phases.

Bug: 334083490
Flag: N/A
Test: atest DreamServiceTest#testCreate
Test: atest DreamServiceTest#testBind
Test: atest DreamServiceTest#testDreamActivityCreate
Test: atest DreamServiceTest#testStart
Test: atest DreamServiceTest#testWake
Change-Id: I8720c1994ec638559fcd6505588b8f686b5b477e
parent 4a6154e6

core/java/android/service/dreams/DreamActivity.java

+47 −7
Original line number Diff line number Diff line
@@ -18,9 +18,12 @@ package android.service.dreams; 


import android.annotation.Nullable;

import android.app.Activity;

import android.content.Intent;

import android.os.Bundle;

import android.text.TextUtils;



import com.android.internal.annotations.VisibleForTesting;



/**

 * The Activity used by the {@link DreamService} to draw screensaver content

 * on the screen. This activity runs in dream application's process, but is started by a
@@ -41,6 +44,7 @@ import android.text.TextUtils; 
 *

 * @hide

 */

@VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)

public class DreamActivity extends Activity {

    static final String EXTRA_CALLBACK = "binder";

    static final String EXTRA_DREAM_TITLE = "title";
@@ -53,19 +57,55 @@ public class DreamActivity extends Activity { 
    public void onCreate(@Nullable Bundle bundle) {

        super.onCreate(bundle);



        final String title = getIntent().getStringExtra(EXTRA_DREAM_TITLE);

        final String title = getTitle(getIntent());

        if (!TextUtils.isEmpty(title)) {

            setTitle(title);

        }



        final Object callback = getIntent().getExtras().getBinder(EXTRA_CALLBACK);

        if (callback instanceof DreamService.DreamActivityCallbacks) {

            mCallback = (DreamService.DreamActivityCallbacks) callback;

            mCallback.onActivityCreated(this);

        } else {

            mCallback = null;

        mCallback = getCallback(getIntent());



        if (mCallback == null) {

            finishAndRemoveTask();

            return;

        }



        mCallback.onActivityCreated(this);

    }



    /**

     * Sets the title of the dream in the intent for starting the {@link DreamActivity}.

     */

    public static void setTitle(Intent intent, CharSequence title) {

        if (TextUtils.isEmpty(title)) {

            return;

        }



        intent.putExtra(DreamActivity.EXTRA_DREAM_TITLE, title);

    }



    /**

     * Gets the title of the dream from the intent used to start the {@link DreamActivity}.

     */

    public static String getTitle(Intent intent) {

        return intent.getStringExtra(EXTRA_DREAM_TITLE);

    }



    /**

     * Sets the dream callback in the intent for starting the {@link DreamActivity}.

     */

    public static void setCallback(Intent intent, DreamService.DreamActivityCallbacks callback) {

        intent.putExtra(DreamActivity.EXTRA_CALLBACK, callback);

    }



    /**

     * Retrieves the dream callback from the intent used to start the {@link DreamActivity}.

     */

    public static DreamService.DreamActivityCallbacks getCallback(Intent intent) {

        final Object binder = intent.getExtras().getBinder(EXTRA_CALLBACK);



        return (binder instanceof DreamService.DreamActivityCallbacks)

                ? (DreamService.DreamActivityCallbacks) binder

                : null;

    }



    @Override

core/java/android/service/dreams/DreamOverlayConnectionHandler.java

+1 −1
Original line number Diff line number Diff line
@@ -39,7 +39,7 @@ import java.util.function.Consumer; 
 *

 * @hide

 */

@VisibleForTesting

@VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)

public final class DreamOverlayConnectionHandler {

    private static final String TAG = "DreamOverlayConnection";

core/java/android/service/dreams/DreamService.java

+166 −37
Original line number Diff line number Diff line
@@ -72,6 +72,7 @@ import android.view.WindowManager.LayoutParams; 
import android.view.accessibility.AccessibilityEvent;



import com.android.internal.R;

import com.android.internal.annotations.VisibleForTesting;

import com.android.internal.util.DumpUtils;



import java.io.FileDescriptor;
@@ -192,13 +193,6 @@ public class DreamService extends Service implements Window.Callback { 
    public static final String SERVICE_INTERFACE =

            "android.service.dreams.DreamService";



    /**

     * The name of the extra where the dream overlay component is stored.

     * @hide

     */

    public static final String EXTRA_DREAM_OVERLAY_COMPONENT =

            "android.service.dream.DreamService.dream_overlay_component";



    /**

     * Name under which a Dream publishes information about itself.

     * This meta-data must reference an XML resource containing
@@ -223,6 +217,7 @@ public class DreamService extends Service implements Window.Callback { 
     * The default value for dream category

     * @hide

     */

    @VisibleForTesting

    public static final int DREAM_CATEGORY_DEFAULT = 0;



    /**
@@ -246,8 +241,14 @@ public class DreamService extends Service implements Window.Callback { 
    @Retention(RetentionPolicy.SOURCE)

    @interface DreamCategory {}



    /**

     * The name of the extra where the dream overlay component is stored.

     */

    static final String EXTRA_DREAM_OVERLAY_COMPONENT =

            "android.service.dream.DreamService.dream_overlay_component";



    private final IDreamManager mDreamManager;

    private final Handler mHandler = new Handler(Looper.getMainLooper());

    private final Handler mHandler;

    private IBinder mDreamToken;

    private Window mWindow;

    private Activity mActivity;
@@ -280,9 +281,126 @@ public class DreamService extends Service implements Window.Callback { 


    private Integer mTrackingConfirmKey = null;



    private final Injector mInjector;



    /**

     * A helper object to inject dependencies into {@link DreamService}.

     * @hide

     */

    @VisibleForTesting

    public interface Injector {

        /** Initializes the Injector */

        void init(Context context);



        /** Creates and returns the dream overlay connection */

        DreamOverlayConnectionHandler createOverlayConnection(ComponentName overlayComponent);



        /** Returns the {@link DreamActivity} component */

        ComponentName getDreamActivityComponent();



        /** Returns the dream component */

        ComponentName getDreamComponent();



        /** Returns the dream package name */

        String getDreamPackageName();



        /** Returns the {@link DreamManager} */

        IDreamManager getDreamManager();



        /** Returns the associated service info */

        ServiceInfo getServiceInfo();



        /** Returns the handler to be used for any posted operation */

        Handler getHandler();



        /** Returns the package manager */

        PackageManager getPackageManager();



        /** Returns the resources */

        Resources getResources();

    }



    private static final class DefaultInjector implements Injector {

        private Context mContext;

        private Class<?> mClassName;



        public void init(Context context) {

            mContext = context;

            mClassName = context.getClass();

        }



        @Override

        public DreamOverlayConnectionHandler createOverlayConnection(

                ComponentName overlayComponent) {

            final Resources resources = mContext.getResources();



            return new DreamOverlayConnectionHandler(

                    /* context= */ mContext,

                    Looper.getMainLooper(),

                    new Intent().setComponent(overlayComponent),

                    resources.getInteger(R.integer.config_minDreamOverlayDurationMs),

                    resources.getInteger(R.integer.config_dreamOverlayMaxReconnectAttempts),

                    resources.getInteger(R.integer.config_dreamOverlayReconnectTimeoutMs));

        }



        @Override

        public ComponentName getDreamActivityComponent() {

            return new ComponentName(mContext, DreamActivity.class);

        }



        @Override

        public ComponentName getDreamComponent() {

            return new ComponentName(mContext, mClassName);

        }



        @Override

        public String getDreamPackageName() {

            return mContext.getApplicationContext().getPackageName();

        }



        @Override

        public IDreamManager getDreamManager() {

            return IDreamManager.Stub.asInterface(ServiceManager.getService(DREAM_SERVICE));

        }



        @Override

        public ServiceInfo getServiceInfo() {

            return fetchServiceInfo(mContext, getDreamComponent());

        }



        @Override

        public Handler getHandler() {

            return new Handler(Looper.getMainLooper());

        }



        @Override

        public PackageManager getPackageManager() {

            return mContext.getPackageManager();

        }



        @Override

        public Resources getResources() {

            return mContext.getResources();

        }



    }



    public DreamService() {

        mDreamManager = IDreamManager.Stub.asInterface(ServiceManager.getService(DREAM_SERVICE));

        this(new DefaultInjector());

    }



    /**

     * Constructor for test purposes.

     *

     * @param injector used for providing dependencies

     * @hide

     */

    @VisibleForTesting

    public DreamService(Injector injector) {

        mInjector = injector;

        mInjector.init(this);

        mDreamManager = mInjector.getDreamManager();

        mHandler = mInjector.getHandler();

    }



    /**
@@ -990,9 +1108,9 @@ public class DreamService extends Service implements Window.Callback { 
    public void onCreate() {

        if (mDebug) Slog.v(mTag, "onCreate()");



        mDreamComponent = new ComponentName(this, getClass());

        mShouldShowComplications = fetchShouldShowComplications(getPackageManager(),

                fetchServiceInfo(this /*context*/, mDreamComponent));

        mDreamComponent = mInjector.getDreamComponent();

        mShouldShowComplications = fetchShouldShowComplications(mInjector.getPackageManager(),

                mInjector.getServiceInfo());

        mOverlayCallback = new IDreamOverlayCallback.Stub() {

            @Override

            public void onExitRequested() {
@@ -1059,16 +1177,7 @@ public class DreamService extends Service implements Window.Callback { 


        // Connect to the overlay service if present.

        if (!mWindowless && overlayComponent != null) {

            final Resources resources = getResources();

            final Intent overlayIntent = new Intent().setComponent(overlayComponent);



            mOverlayConnection = new DreamOverlayConnectionHandler(

                    /* context= */ this,

                    Looper.getMainLooper(),

                    overlayIntent,

                    resources.getInteger(R.integer.config_minDreamOverlayDurationMs),

                    resources.getInteger(R.integer.config_dreamOverlayMaxReconnectAttempts),

                    resources.getInteger(R.integer.config_dreamOverlayReconnectTimeoutMs));

            mOverlayConnection = mInjector.createOverlayConnection(overlayComponent);



            if (!mOverlayConnection.bind()) {

                // Binding failed.
@@ -1372,14 +1481,16 @@ public class DreamService extends Service implements Window.Callback { 
        // for the DreamActivity to report onActivityCreated via

        // DreamServiceWrapper.onActivityCreated.

        if (!mWindowless) {

            Intent i = new Intent(this, DreamActivity.class);

            i.setPackage(getApplicationContext().getPackageName());

            Intent i = new Intent();

            i.setComponent(mInjector.getDreamActivityComponent());

            i.setPackage(mInjector.getDreamPackageName());

            i.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK | Intent.FLAG_ACTIVITY_NO_USER_ACTION);

            i.putExtra(DreamActivity.EXTRA_CALLBACK, new DreamActivityCallbacks(mDreamToken));

            final ServiceInfo serviceInfo = fetchServiceInfo(this,

                    new ComponentName(this, getClass()));

            i.putExtra(DreamActivity.EXTRA_DREAM_TITLE,

                    fetchDreamLabel(this, serviceInfo, isPreviewMode));

            DreamActivity.setCallback(i, new DreamActivityCallbacks(mDreamToken));

            final ServiceInfo serviceInfo = mInjector.getServiceInfo();

            final CharSequence title = fetchDreamLabel(mInjector.getPackageManager(),

                    mInjector.getResources(), serviceInfo, isPreviewMode);



            DreamActivity.setTitle(i, title);



            try {

                mDreamManager.startDreamActivity(i);
@@ -1515,19 +1626,20 @@ public class DreamService extends Service implements Window.Callback { 
    }



    @Nullable

    private static CharSequence fetchDreamLabel(Context context,

    private static CharSequence fetchDreamLabel(

            PackageManager pm,

            Resources resources,

            @Nullable ServiceInfo serviceInfo,

            boolean isPreviewMode) {

        if (serviceInfo == null) {

            return null;

        }

        final PackageManager pm = context.getPackageManager();

        final CharSequence dreamLabel = serviceInfo.loadLabel(pm);

        if (!isPreviewMode || dreamLabel == null) {

            return dreamLabel;

        }

        // When in preview mode, return a special label indicating the dream is in preview.

        return context.getResources().getString(R.string.dream_preview_title, dreamLabel);

        return resources.getString(R.string.dream_preview_title, dreamLabel);

    }



    @Nullable
@@ -1609,14 +1721,16 @@ public class DreamService extends Service implements Window.Callback { 
    }



    /** @hide */

    final class DreamActivityCallbacks extends Binder {

    @VisibleForTesting

    public final class DreamActivityCallbacks extends Binder {

        private final IBinder mActivityDreamToken;



        DreamActivityCallbacks(IBinder token) {

            mActivityDreamToken = token;

        }



        void onActivityCreated(DreamActivity activity) {

        /** Callback when the {@link DreamActivity} has been created */

        public void onActivityCreated(DreamActivity activity) {

            if (mActivityDreamToken != mDreamToken || mFinished) {

                Slog.d(TAG, "DreamActivity was created after the dream was finished or "

                        + "a new dream started, finishing DreamActivity");
@@ -1638,8 +1752,8 @@ public class DreamService extends Service implements Window.Callback { 
            onWindowCreated(activity.getWindow());

        }



        // If DreamActivity is destroyed, wake up from Dream.

        void onActivityDestroyed() {

        /** Callback when the {@link DreamActivity} has been destroyed */

        public void onActivityDestroyed() {

            mActivity = null;

            mWindow = null;

            detach();
@@ -1651,6 +1765,7 @@ public class DreamService extends Service implements Window.Callback { 
     *

     * @hide

     */

    @VisibleForTesting

    @TestApi

    public static final class DreamMetadata {

        @Nullable
@@ -1666,7 +1781,11 @@ public class DreamService extends Service implements Window.Callback { 
        @FlaggedApi(Flags.FLAG_HOME_PANEL_DREAM)

        public final int dreamCategory;



        DreamMetadata(

        /**

         * @hide

         */

        @VisibleForTesting

        public DreamMetadata(

                ComponentName settingsActivity,

                Drawable previewImage,

                boolean showComplications,
@@ -1681,4 +1800,14 @@ public class DreamService extends Service implements Window.Callback { 
            }

        }

    }



    /**

     * Sets the dream overlay component to be used by the dream.

     *

     * @hide

     */

    @VisibleForTesting

    public static void setDreamOverlayComponent(Intent intent, ComponentName component) {

        intent.putExtra(DreamService.EXTRA_DREAM_OVERLAY_COMPONENT, component);

    }

}

services/core/java/com/android/server/dreams/DreamController.java

+1 −1
Original line number Diff line number Diff line
@@ -205,7 +205,7 @@ final class DreamController { 
            Intent intent = new Intent(DreamService.SERVICE_INTERFACE);

            intent.setComponent(name);

            intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);

            intent.putExtra(DreamService.EXTRA_DREAM_OVERLAY_COMPONENT, overlayComponentName);

            DreamService.setDreamOverlayComponent(intent, overlayComponentName);

            try {

                if (!mContext.bindServiceAsUser(intent, mCurrentDream,

                        Context.BIND_AUTO_CREATE | Context.BIND_FOREGROUND_SERVICE,

services/tests/dreamservicetests/Android.bp

+1 −0
Original line number Diff line number Diff line
@@ -19,6 +19,7 @@ android_test { 
        "services.core",

        "mockingservicestests-utils-mockito",

        "servicestests-utils",

        "testables",

    ],



    defaults: [