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

Commit 1c83e277 authored by Hawkwood Glazier's avatar Hawkwood Glazier
Browse files

Move PluginActionManager & PluginEnabler to kotlin 

Bug: 439580338
Flag: NONE Conversion to Kotlin
Test: Tested clocks integration with plugins
Change-Id: I097c240ee2060e451c9a36a78b9d8dbc28f9236b
parent 68e02762

packages/SystemUI/multivalentTests/src/com/android/systemui/shared/plugins/PluginActionManagerTest.java

deleted100644 → 0
+0 −308
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2016 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.systemui.shared.plugins;



import static junit.framework.Assert.assertFalse;

import static junit.framework.Assert.assertTrue;



import static org.mockito.ArgumentMatchers.any;

import static org.mockito.ArgumentMatchers.anyInt;

import static org.mockito.Mockito.mock;

import static org.mockito.Mockito.never;

import static org.mockito.Mockito.verify;

import static org.mockito.Mockito.when;



import android.app.Activity;

import android.app.NotificationManager;

import android.content.BroadcastReceiver;

import android.content.ComponentName;

import android.content.Context;

import android.content.Intent;

import android.content.IntentFilter;

import android.content.pm.ApplicationInfo;

import android.content.pm.PackageManager;

import android.content.pm.ResolveInfo;

import android.content.pm.ServiceInfo;



import androidx.test.filters.SmallTest;

import androidx.test.runner.AndroidJUnit4;



import com.android.systemui.SysuiTestCase;

import com.android.systemui.SysuiTestableContext;

import com.android.systemui.plugins.Plugin;

import com.android.systemui.plugins.PluginListener;

import com.android.systemui.plugins.annotations.Requires;

import com.android.systemui.util.concurrency.FakeExecutor;

import com.android.systemui.util.time.FakeSystemClock;



import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.mockito.ArgumentCaptor;

import org.mockito.Mockito;

import org.mockito.stubbing.Answer;



import java.util.ArrayList;

import java.util.Collections;

import java.util.List;



@SmallTest

@RunWith(AndroidJUnit4.class)

public class PluginActionManagerTest extends SysuiTestCase {



    private static final String PRIVILEGED_PACKAGE = "com.android.systemui.shared.plugins";

    private TestPlugin mMockPlugin;



    private PackageManager mMockPm;

    private PluginListener<TestPlugin> mMockListener;

    private PluginActionManager<TestPlugin> mPluginActionManager;

    private VersionInfo mMockVersionInfo;

    private PluginEnabler mMockEnabler;

    ComponentName mTestPluginComponentName =

            new ComponentName(PRIVILEGED_PACKAGE, TestPlugin.class.getName());

    private final FakeExecutor mFakeExecutor = new FakeExecutor(new FakeSystemClock());

    NotificationManager mNotificationManager;

    private PluginInstance<TestPlugin> mPluginInstance;

    private PluginInstance.Factory mPluginInstanceFactory = new PluginInstance.Factory(

            new VersionCheckerImpl(), this.getClass().getClassLoader(), Collections.emptyList(),

            new BuildInfo(BuildVariant.User, false)) {

        @Override

        public <T extends Plugin> PluginInstance<T> create(Context context, ApplicationInfo appInfo,

                ComponentName componentName, Class<T> pluginClass, PluginListener<T> listener) {

            return (PluginInstance<T>) mPluginInstance;

        }

    };



    private PluginActionManager.Factory mActionManagerFactory;



    @Before

    public void setup() throws Exception {

        mContext = new MyContextWrapper(mContext);

        mMockPm = mock(PackageManager.class);

        mMockListener = mock(PluginListener.class);

        mMockEnabler = mock(PluginEnabler.class);

        mMockVersionInfo = mock(VersionInfo.class);

        mNotificationManager = mock(NotificationManager.class);

        mMockPlugin = mock(TestPlugin.class);

        mPluginInstance = mock(PluginInstance.class);

        when(mPluginInstance.getComponentName()).thenReturn(mTestPluginComponentName);

        when(mPluginInstance.getPackageName())

                .thenReturn(mTestPluginComponentName.getPackageName());

        mActionManagerFactory = new PluginActionManager.Factory(getContext(), mMockPm,

                mFakeExecutor, mFakeExecutor, mNotificationManager, mMockEnabler,

                new ArrayList<>(), mPluginInstanceFactory);



        mPluginActionManager = mActionManagerFactory.create("myAction", mMockListener,

                TestPlugin.class, true, true);

        when(mMockPlugin.getVersion()).thenReturn(1);

    }



    @Test

    public void testNoPlugins() {

        when(mMockPm.queryIntentServices(any(), anyInt())).thenReturn(

                Collections.emptyList());

        mPluginActionManager.loadAll();



        mFakeExecutor.runAllReady();



        verify(mMockListener, never()).onPluginConnected(any(), any());

    }



    @Test

    public void testPluginCreate() throws Exception {

        //Debug.waitForDebugger();

        createPlugin();



        // Verify startup lifecycle

        verify(mPluginInstance).onCreate();

    }



    @Test

    public void testPluginDestroy() throws Exception {

        createPlugin(); // Get into valid created state.



        mPluginActionManager.destroy();



        mFakeExecutor.runAllReady();



        // Verify shutdown lifecycle

        verify(mPluginInstance).onDestroy();

    }



    @Test

    public void testReloadOnChange() throws Exception {

        createPlugin(); // Get into valid created state.



        mPluginActionManager.reloadPackage(PRIVILEGED_PACKAGE);



        mFakeExecutor.runAllReady();



        // Verify the old one was destroyed.

        verify(mPluginInstance).onDestroy();

        verify(mPluginInstance, Mockito.times(2))

                .onCreate();

    }



    @Test

    public void testNonDebuggable() throws Exception {

        // Create a version that thinks the build is not debuggable.

        mPluginActionManager = mActionManagerFactory.create("myAction", mMockListener,

                TestPlugin.class, true, false);

        setupFakePmQuery();



        mPluginActionManager.loadAll();



        mFakeExecutor.runAllReady();



        // Non-debuggable build should receive no plugins.

        verify(mMockListener, never()).onPluginConnected(any(), any());

    }



    @Test

    public void testNonDebuggable_privileged() throws Exception {

        // Create a version that thinks the build is not debuggable.

        PluginActionManager.Factory factory = new PluginActionManager.Factory(getContext(),

                mMockPm, mFakeExecutor, mFakeExecutor, mNotificationManager,

                mMockEnabler, Collections.singletonList(PRIVILEGED_PACKAGE),

                mPluginInstanceFactory);

        mPluginActionManager = factory.create("myAction", mMockListener,

                TestPlugin.class, true, false);

        setupFakePmQuery();



        mPluginActionManager.loadAll();



        mFakeExecutor.runAllReady();



        // Verify startup lifecycle

        verify(mPluginInstance).onCreate();

    }



    @Test

    public void testCheckAndDisable() throws Exception {

        createPlugin(); // Get into valid created state.



        // Start with an unrelated class.

        boolean result = mPluginActionManager.checkAndDisable(Activity.class.getName());

        assertFalse(result);

        verify(mMockEnabler, never()).setDisabled(any(ComponentName.class), anyInt());



        // Now hand it a real class and make sure it disables the plugin.

        result = mPluginActionManager.checkAndDisable(TestPlugin.class.getName());

        assertTrue(result);

        verify(mMockEnabler).setDisabled(

                mTestPluginComponentName, PluginEnabler.DISABLED_FROM_EXPLICIT_CRASH);

    }



    @Test

    public void testDisableAll() throws Exception {

        createPlugin(); // Get into valid created state.



        mPluginActionManager.disableAll();



        verify(mMockEnabler).setDisabled(

                mTestPluginComponentName, PluginEnabler.DISABLED_FROM_SYSTEM_CRASH);

    }



    @Test

    public void testDisablePrivileged() throws Exception {

        PluginActionManager.Factory factory = new PluginActionManager.Factory(getContext(),

                mMockPm, mFakeExecutor, mFakeExecutor, mNotificationManager,

                mMockEnabler, Collections.singletonList(PRIVILEGED_PACKAGE),

                mPluginInstanceFactory);

        mPluginActionManager = factory.create("myAction", mMockListener,

                TestPlugin.class, true, false);



        createPlugin(); // Get into valid created state.



        mPluginActionManager.disableAll();



        verify(mMockPm, never()).setComponentEnabledSetting(

                ArgumentCaptor.forClass(ComponentName.class).capture(),

                ArgumentCaptor.forClass(int.class).capture(),

                ArgumentCaptor.forClass(int.class).capture());

    }



    private void setupFakePmQuery() throws Exception {

        List<ResolveInfo> list = new ArrayList<>();

        ResolveInfo info = new ResolveInfo();

        info.serviceInfo = mock(ServiceInfo.class);

        info.serviceInfo.packageName = mTestPluginComponentName.getPackageName();

        info.serviceInfo.name = mTestPluginComponentName.getClassName();

        when(info.serviceInfo.loadLabel(any())).thenReturn("Test Plugin");

        list.add(info);

        when(mMockPm.queryIntentServices(any(), Mockito.anyInt())).thenReturn(list);

        when(mMockPm.getServiceInfo(any(), anyInt())).thenReturn(info.serviceInfo);



        when(mMockPm.checkPermission(Mockito.anyString(), Mockito.anyString())).thenReturn(

                PackageManager.PERMISSION_GRANTED);



        when(mMockPm.getApplicationInfo(Mockito.anyString(), anyInt())).thenAnswer(

                (Answer<ApplicationInfo>) invocation -> {

                    ApplicationInfo appInfo = getContext().getApplicationInfo();

                    appInfo.packageName = invocation.getArgument(0);

                    return appInfo;

                });

        when(mMockEnabler.isEnabled(mTestPluginComponentName)).thenReturn(true);

    }



    private void createPlugin() throws Exception {

        setupFakePmQuery();



        mPluginActionManager.loadAll();



        mFakeExecutor.runAllReady();

    }



    // Real context with no registering/unregistering of receivers.

    private static class MyContextWrapper extends SysuiTestableContext {

        MyContextWrapper(Context base) {

            super(base);

        }



        @Override

        public Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter) {

            return null;

        }



        @Override

        public void unregisterReceiver(BroadcastReceiver receiver) {

        }



        @Override

        public void sendBroadcast(Intent intent) {

            // Do nothing.

        }

    }



    // This target class doesn't matter, it just needs to have a Requires to hit the flow where

    // the mock version info is called.

    @Requires(target = PluginManagerTest.class, version = 1)

    public static class TestPlugin implements Plugin {

        @Override

        public int getVersion() {

            return 1;

        }



        @Override

        public void onCreate(Context sysuiContext, Context pluginContext) {

        }



        @Override

        public void onDestroy() {

        }

    }

}

packages/SystemUI/multivalentTests/src/com/android/systemui/shared/plugins/PluginActionManagerTest.kt

0 → 100644
+351 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2025 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.systemui.shared.plugins



import android.app.Activity

import android.app.NotificationManager

import android.content.BroadcastReceiver

import android.content.ComponentName

import android.content.Context

import android.content.Intent

import android.content.IntentFilter

import android.content.pm.ApplicationInfo

import android.content.pm.PackageManager

import android.content.pm.ResolveInfo

import androidx.test.filters.SmallTest

import androidx.test.runner.AndroidJUnit4

import com.android.systemui.SysuiTestCase

import com.android.systemui.SysuiTestableContext

import com.android.systemui.plugins.Plugin

import com.android.systemui.plugins.PluginListener

import com.android.systemui.plugins.annotations.Requires

import com.android.systemui.shared.plugins.PluginEnabler.DisableReason

import com.android.systemui.util.concurrency.FakeExecutor

import com.android.systemui.util.time.FakeSystemClock

import junit.framework.TestCase.assertFalse

import junit.framework.TestCase.assertTrue

import org.junit.Before

import org.junit.Test

import org.junit.runner.RunWith

import org.mockito.ArgumentMatchers.anyInt

import org.mockito.ArgumentMatchers.anyString

import org.mockito.Mock

import org.mockito.Mockito.never

import org.mockito.MockitoAnnotations

import org.mockito.invocation.InvocationOnMock

import org.mockito.kotlin.any

import org.mockito.kotlin.argumentCaptor

import org.mockito.kotlin.mock

import org.mockito.kotlin.times

import org.mockito.kotlin.verify

import org.mockito.kotlin.whenever

import org.mockito.stubbing.Answer



@SmallTest

@RunWith(AndroidJUnit4::class)

class PluginActionManagerTest : SysuiTestCase() {

    @Mock private lateinit var mMockPlugin: TestPlugin

    @Mock private lateinit var mMockPm: PackageManager

    @Mock private lateinit var mMockListener: PluginListener<TestPlugin>

    private lateinit var mPluginActionManager: PluginActionManager<TestPlugin>

    @Mock private lateinit var mMockEnabler: PluginEnabler

    private val mTestPluginComponentName =

        ComponentName(PRIVILEGED_PACKAGE, TestPlugin::class.java.name)

    private val mFakeExecutor = FakeExecutor(FakeSystemClock())

    @Mock private lateinit var mNotificationManager: NotificationManager

    @Mock private lateinit var mPluginInstance: PluginInstance<TestPlugin>

    private val mPluginInstanceFactory: PluginInstance.Factory =

        object :

            PluginInstance.Factory(

                VersionCheckerImpl(),

                this::class.java.classLoader!!,

                emptyList(),

                BuildInfo(BuildVariant.User, isDebuggable = false),

            ) {

            override fun <T : Plugin> create(

                hostContext: Context,

                pluginAppInfo: ApplicationInfo,

                componentName: ComponentName,

                pluginClass: Class<T>,

                listener: PluginListener<T>,

            ): PluginInstance<T> {

                return mPluginInstance as PluginInstance<T>

            }

        }



    private lateinit var mActionManagerFactory: PluginActionManager.Factory



    @Before

    @Throws(Exception::class)

    fun setup() {

        mContext = MyContextWrapper(mContext)

        MockitoAnnotations.openMocks(this)

        whenever(mPluginInstance.componentName).thenReturn(mTestPluginComponentName)

        whenever(mPluginInstance.packageName).thenReturn(mTestPluginComponentName.packageName)

        mActionManagerFactory =

            PluginActionManager.Factory(

                context,

                mMockPm,

                mFakeExecutor,

                mFakeExecutor,

                mNotificationManager,

                mMockEnabler,

                ArrayList(),

                mPluginInstanceFactory,

            )



        mPluginActionManager =

            mActionManagerFactory.create(

                "myAction",

                mMockListener,

                TestPlugin::class.java,

                allowMultiple = true,

                isDebuggable = true,

            )

        whenever(mMockPlugin.version).thenReturn(1)

    }



    @Test

    fun testNoPlugins() {

        whenever(mMockPm.queryIntentServices(any(), anyInt())).thenReturn(emptyList())

        mPluginActionManager.loadAll()



        mFakeExecutor.runAllReady()



        verify(mMockListener, never()).onPluginConnected(any(), any())

    }



    @Test

    @Throws(Exception::class)

    fun testPluginCreate() {

        // Debug.waitForDebugger();

        createPlugin()



        // Verify startup lifecycle

        verify(mPluginInstance).onCreate()

    }



    @Test

    @Throws(Exception::class)

    fun testPluginDestroy() {

        createPlugin() // Get into valid created state.



        mPluginActionManager.destroy()



        mFakeExecutor.runAllReady()



        // Verify shutdown lifecycle

        verify(mPluginInstance).onDestroy()

    }



    @Test

    @Throws(Exception::class)

    fun testReloadOnChange() {

        createPlugin() // Get into valid created state.



        mPluginActionManager.reloadPackage(PRIVILEGED_PACKAGE)



        mFakeExecutor.runAllReady()



        // Verify the old one was destroyed.

        verify(mPluginInstance).onDestroy()

        verify(mPluginInstance, times(2)).onCreate()

    }



    @Test

    @Throws(Exception::class)

    fun testNonDebuggable() {

        // Create a version that thinks the build is not debuggable.

        mPluginActionManager =

            mActionManagerFactory.create(

                "myAction",

                mMockListener,

                TestPlugin::class.java,

                allowMultiple = true,

                isDebuggable = false,

            )

        setupFakePmQuery()



        mPluginActionManager.loadAll()



        mFakeExecutor.runAllReady()



        // Non-debuggable build should receive no plugins.

        verify(mMockListener, never()).onPluginConnected(any(), any())

    }



    @Test

    @Throws(Exception::class)

    fun testNonDebuggable_privileged() {

        // Create a version that thinks the build is not debuggable.

        val factory =

            PluginActionManager.Factory(

                context,

                mMockPm,

                mFakeExecutor,

                mFakeExecutor,

                mNotificationManager,

                mMockEnabler,

                listOf(PRIVILEGED_PACKAGE),

                mPluginInstanceFactory,

            )

        mPluginActionManager =

            factory.create(

                "myAction",

                mMockListener,

                TestPlugin::class.java,

                allowMultiple = true,

                isDebuggable = false,

            )

        setupFakePmQuery()



        mPluginActionManager.loadAll()



        mFakeExecutor.runAllReady()



        // Verify startup lifecycle

        verify(mPluginInstance).onCreate()

    }



    @Test

    @Throws(Exception::class)

    fun testCheckAndDisable() {

        createPlugin() // Get into valid created state.



        // Start with an unrelated class.

        var result = mPluginActionManager.checkAndDisable(Activity::class.java.name)

        assertFalse(result)

        verify(mMockEnabler, never()).setDisabled(any(), any())



        // Now hand it a real class and make sure it disables the plugin.

        result = mPluginActionManager.checkAndDisable(TestPlugin::class.java.name)

        assertTrue(result)

        verify(mMockEnabler)

            .setDisabled(mTestPluginComponentName, DisableReason.DISABLED_FROM_EXPLICIT_CRASH)

    }



    @Test

    @Throws(Exception::class)

    fun testDisableAll() {

        createPlugin() // Get into valid created state.



        mPluginActionManager.disableAll()



        verify(mMockEnabler)

            .setDisabled(mTestPluginComponentName, DisableReason.DISABLED_FROM_SYSTEM_CRASH)

    }



    @Test

    @Throws(Exception::class)

    fun testDisablePrivileged() {

        val factory =

            PluginActionManager.Factory(

                context,

                mMockPm,

                mFakeExecutor,

                mFakeExecutor,

                mNotificationManager,

                mMockEnabler,

                listOf(PRIVILEGED_PACKAGE),

                mPluginInstanceFactory,

            )

        mPluginActionManager =

            factory.create(

                "myAction",

                mMockListener,

                TestPlugin::class.java,

                allowMultiple = true,

                isDebuggable = false,

            )



        createPlugin() // Get into valid created state.



        mPluginActionManager.disableAll()



        verify(mMockPm, never())

            .setComponentEnabledSetting(

                argumentCaptor<ComponentName>().capture(),

                argumentCaptor<Int>().capture(),

                argumentCaptor<Int>().capture(),

            )

    }



    @Throws(Exception::class)

    private fun setupFakePmQuery() {

        val list: MutableList<ResolveInfo> = ArrayList()

        val info = ResolveInfo()

        info.serviceInfo = mock()

        info.serviceInfo.packageName = mTestPluginComponentName.packageName

        info.serviceInfo.name = mTestPluginComponentName.className

        whenever(info.serviceInfo.loadLabel(any())).thenReturn("Test Plugin")

        list.add(info)

        whenever(mMockPm.queryIntentServices(any(), anyInt())).thenReturn(list)

        whenever(mMockPm.getServiceInfo(any(), anyInt())).thenReturn(info.serviceInfo)



        whenever(mMockPm.checkPermission(anyString(), anyString()))

            .thenReturn(PackageManager.PERMISSION_GRANTED)



        whenever(mMockPm.getApplicationInfo(anyString(), anyInt()))

            .thenAnswer(

                Answer { invocation: InvocationOnMock ->

                    val appInfo = context.applicationInfo

                    appInfo.packageName = invocation.getArgument(0)

                    appInfo

                }

                    as Answer<ApplicationInfo>

            )

        whenever(mMockEnabler.isEnabled(mTestPluginComponentName)).thenReturn(true)

    }



    @Throws(Exception::class)

    private fun createPlugin() {

        setupFakePmQuery()



        mPluginActionManager.loadAll()



        mFakeExecutor.runAllReady()

    }



    // Real context with no registering/unregistering of receivers.

    private class MyContextWrapper(base: Context?) : SysuiTestableContext(base) {

        override fun registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter): Intent? {

            return null

        }



        override fun unregisterReceiver(receiver: BroadcastReceiver) {}



        override fun sendBroadcast(intent: Intent) {

            // Do nothing.

        }

    }



    // This target class doesn't matter, it just needs to have a Requires to hit the flow where

    // the mock version info is called.

    @Requires(target = PluginManagerTest::class, version = 1)

    class TestPlugin : Plugin {

        override fun getVersion(): Int {

            return 1

        }



        override fun onCreate(sysuiContext: Context, pluginContext: Context) {}



        override fun onDestroy() {}

    }



    companion object {

        private const val PRIVILEGED_PACKAGE = "com.android.systemui.shared.plugins"

    }

}

packages/SystemUI/multivalentTests/src/com/android/systemui/shared/plugins/PluginManagerTest.java

+1 −1
Original line number Diff line number Diff line
@@ -179,7 +179,7 @@ public class PluginManagerTest extends SysuiTestCase { 
        mPluginManager.onReceive(mContext, intent);

        verify(nm).cancel(eq(testComponent.getClassName()), eq(SystemMessage.NOTE_PLUGIN));

        verify(mMockPluginEnabler).setDisabled(testComponent,

                PluginEnabler.DISABLED_INVALID_VERSION);

                PluginEnabler.DisableReason.DISABLED_INVALID_VERSION);

    }



    private void captureExceptionHandler() {

packages/SystemUI/shared/src/com/android/systemui/shared/plugins/PluginActionManager.java

deleted100644 → 0
+0 −455

File deleted.

Preview size limit exceeded, changes collapsed.

packages/SystemUI/shared/src/com/android/systemui/shared/plugins/PluginActionManager.kt

0 → 100644
+383 −0

File added.

Preview size limit exceeded, changes collapsed.