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

Commit 56c25c6a authored by Fabian Kozynski's avatar Fabian Kozynski
Browse files

Fix QSFactoryImpl createTileInternal 

Implementations should modify createTileInternal instead of createTile
and default to calling super.

Test: atest SystemUITests
Fixes: 210163541
Change-Id: I196003b97cf3fecd0874c3ebe813ea29574f3d2e
parent 9a50b528

packages/SystemUI/src/com/android/systemui/qs/external/CustomTile.java

+3 −1
Original line number Diff line number Diff line
@@ -48,6 +48,7 @@ import androidx.annotation.NonNull; 
import androidx.annotation.Nullable;

import androidx.annotation.WorkerThread;



import com.android.internal.annotations.VisibleForTesting;

import com.android.internal.logging.MetricsLogger;

import com.android.internal.logging.nano.MetricsProto.MetricsEvent;

import com.android.systemui.Dependency;
@@ -562,7 +563,8 @@ public class CustomTile extends QSTileImpl<State> implements TileChangeListener 
            return this;

        }



        CustomTile build() {

        @VisibleForTesting

        public CustomTile build() {

            if (mUserContext == null) {

                throw new NullPointerException("UserContext cannot be null");

            }

packages/SystemUI/src/com/android/systemui/qs/tileimpl/QSFactoryImpl.java

+2 −2
Original line number Diff line number Diff line
@@ -169,7 +169,7 @@ public class QSFactoryImpl implements QSFactory { 
        mFgsManagerTileProvider = fgsManagerTileProvider;

    }



    public QSTile createTile(String tileSpec) {

    public final QSTile createTile(String tileSpec) {

        QSTileImpl tile = createTileInternal(tileSpec);

        if (tile != null) {

            tile.initialize();
@@ -178,7 +178,7 @@ public class QSFactoryImpl implements QSFactory { 
        return tile;

    }



    private QSTileImpl createTileInternal(String tileSpec) {

    protected QSTileImpl createTileInternal(String tileSpec) {

        // Stock tiles.

        switch (tileSpec) {

            case "wifi":

packages/SystemUI/src/com/android/systemui/qs/tiles/FgsManagerTile.kt

+1 −1
Original line number Diff line number Diff line
@@ -54,7 +54,7 @@ class FgsManagerTile @Inject constructor( 
    qsLogger: QSLogger?,

    private val fgsManagerDialogFactory: FgsManagerDialogFactory,

    private val runningFgsController: RunningFgsController

) : QSTileImpl<QSTile.State?>(host, backgroundLooper, mainHandler, falsingManager, metricsLogger,

) : QSTileImpl<QSTile.State>(host, backgroundLooper, mainHandler, falsingManager, metricsLogger,

        statusBarStateController, activityStarter, qsLogger), RunningFgsController.Callback {



    override fun handleInitialize() {

packages/SystemUI/tests/src/com/android/systemui/qs/tileimpl/QSFactoryImplTest.kt

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

 * 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 com.android.systemui.qs.tileimpl



import android.content.ComponentName

import android.testing.AndroidTestingRunner

import androidx.test.filters.SmallTest

import com.android.systemui.SysuiTestCase

import com.android.systemui.qs.QSHost

import com.android.systemui.qs.external.CustomTile

import com.android.systemui.qs.tiles.AirplaneModeTile

import com.android.systemui.qs.tiles.AlarmTile

import com.android.systemui.qs.tiles.BatterySaverTile

import com.android.systemui.qs.tiles.BluetoothTile

import com.android.systemui.qs.tiles.CameraToggleTile

import com.android.systemui.qs.tiles.CastTile

import com.android.systemui.qs.tiles.CellularTile

import com.android.systemui.qs.tiles.ColorInversionTile

import com.android.systemui.qs.tiles.DataSaverTile

import com.android.systemui.qs.tiles.DeviceControlsTile

import com.android.systemui.qs.tiles.DndTile

import com.android.systemui.qs.tiles.FgsManagerTile

import com.android.systemui.qs.tiles.FlashlightTile

import com.android.systemui.qs.tiles.HotspotTile

import com.android.systemui.qs.tiles.InternetTile

import com.android.systemui.qs.tiles.LocationTile

import com.android.systemui.qs.tiles.MicrophoneToggleTile

import com.android.systemui.qs.tiles.NfcTile

import com.android.systemui.qs.tiles.NightDisplayTile

import com.android.systemui.qs.tiles.OneHandedModeTile

import com.android.systemui.qs.tiles.QRCodeScannerTile

import com.android.systemui.qs.tiles.QuickAccessWalletTile

import com.android.systemui.qs.tiles.ReduceBrightColorsTile

import com.android.systemui.qs.tiles.RotationLockTile

import com.android.systemui.qs.tiles.ScreenRecordTile

import com.android.systemui.qs.tiles.UiModeNightTile

import com.android.systemui.qs.tiles.UserTile

import com.android.systemui.qs.tiles.WifiTile

import com.android.systemui.qs.tiles.WorkModeTile

import com.android.systemui.util.leak.GarbageMonitor

import com.google.common.truth.Truth.assertThat

import org.junit.Before

import org.junit.Test

import org.junit.runner.RunWith

import org.mockito.Answers

import org.mockito.Mock

import org.mockito.Mockito.inOrder

import org.mockito.MockitoAnnotations

import org.mockito.Mockito.`when` as whenever



private val specMap = mapOf(

        "wifi" to WifiTile::class.java,

        "internet" to InternetTile::class.java,

        "bt" to BluetoothTile::class.java,

        "cell" to CellularTile::class.java,

        "dnd" to DndTile::class.java,

        "inversion" to ColorInversionTile::class.java,

        "airplane" to AirplaneModeTile::class.java,

        "work" to WorkModeTile::class.java,

        "rotation" to RotationLockTile::class.java,

        "flashlight" to FlashlightTile::class.java,

        "location" to LocationTile::class.java,

        "cast" to CastTile::class.java,

        "hotspot" to HotspotTile::class.java,

        "user" to UserTile::class.java,

        "battery" to BatterySaverTile::class.java,

        "saver" to DataSaverTile::class.java,

        "night" to NightDisplayTile::class.java,

        "nfc" to NfcTile::class.java,

        "dark" to UiModeNightTile::class.java,

        "screenrecord" to ScreenRecordTile::class.java,

        "reduce_brightness" to ReduceBrightColorsTile::class.java,

        "cameratoggle" to CameraToggleTile::class.java,

        "mictoggle" to MicrophoneToggleTile::class.java,

        "controls" to DeviceControlsTile::class.java,

        "alarm" to AlarmTile::class.java,

        "wallet" to QuickAccessWalletTile::class.java,

        "qr_code_scanner" to QRCodeScannerTile::class.java,

        "onehanded" to OneHandedModeTile::class.java,

        "fgsmanager" to FgsManagerTile::class.java

)



@RunWith(AndroidTestingRunner::class)

@SmallTest

class QSFactoryImplTest : SysuiTestCase() {



    @Mock private lateinit var qsHost: QSHost

    @Mock(answer = Answers.RETURNS_SELF) private lateinit var customTileBuilder: CustomTile.Builder

    @Mock private lateinit var customTile: CustomTile



    @Mock private lateinit var wifiTile: WifiTile

    @Mock private lateinit var internetTile: InternetTile

    @Mock private lateinit var bluetoothTile: BluetoothTile

    @Mock private lateinit var cellularTile: CellularTile

    @Mock private lateinit var dndTile: DndTile

    @Mock private lateinit var colorInversionTile: ColorInversionTile

    @Mock private lateinit var airplaneTile: AirplaneModeTile

    @Mock private lateinit var workTile: WorkModeTile

    @Mock private lateinit var rotationTile: RotationLockTile

    @Mock private lateinit var flashlightTile: FlashlightTile

    @Mock private lateinit var locationTile: LocationTile

    @Mock private lateinit var castTile: CastTile

    @Mock private lateinit var hotspotTile: HotspotTile

    @Mock private lateinit var userTile: UserTile

    @Mock private lateinit var batterySaverTile: BatterySaverTile

    @Mock private lateinit var dataSaverTile: DataSaverTile

    @Mock private lateinit var nightDisplayTile: NightDisplayTile

    @Mock private lateinit var nfcTile: NfcTile

    @Mock private lateinit var memoryTile: GarbageMonitor.MemoryTile

    @Mock private lateinit var darkModeTile: UiModeNightTile

    @Mock private lateinit var screenRecordTile: ScreenRecordTile

    @Mock private lateinit var reduceBrightColorsTile: ReduceBrightColorsTile

    @Mock private lateinit var cameraToggleTile: CameraToggleTile

    @Mock private lateinit var microphoneToggleTile: MicrophoneToggleTile

    @Mock private lateinit var deviceControlsTile: DeviceControlsTile

    @Mock private lateinit var alarmTile: AlarmTile

    @Mock private lateinit var quickAccessWalletTile: QuickAccessWalletTile

    @Mock private lateinit var qrCodeScannerTile: QRCodeScannerTile

    @Mock private lateinit var oneHandedModeTile: OneHandedModeTile

    @Mock private lateinit var fgsManagerTile: FgsManagerTile



    private lateinit var factory: QSFactoryImpl



    @Before

    fun setUp() {

        MockitoAnnotations.initMocks(this)



        whenever(qsHost.context).thenReturn(mContext)

        whenever(qsHost.userContext).thenReturn(mContext)

        whenever(customTileBuilder.build()).thenReturn(customTile)



        factory = QSFactoryImpl(

                { qsHost },

                { customTileBuilder },

                { wifiTile },

                { internetTile },

                { bluetoothTile },

                { cellularTile },

                { dndTile },

                { colorInversionTile },

                { airplaneTile },

                { workTile },

                { rotationTile },

                { flashlightTile },

                { locationTile },

                { castTile },

                { hotspotTile },

                { userTile },

                { batterySaverTile },

                { dataSaverTile },

                { nightDisplayTile },

                { nfcTile },

                { memoryTile },

                { darkModeTile },

                { screenRecordTile },

                { reduceBrightColorsTile },

                { cameraToggleTile },

                { microphoneToggleTile },

                { deviceControlsTile },

                { alarmTile },

                { quickAccessWalletTile },

                { qrCodeScannerTile },

                { oneHandedModeTile },

                { fgsManagerTile }

        )

        // When adding/removing tiles, fix also [specMap]

    }



    @Test

    fun testCorrectTileClassStock() {

        specMap.forEach { spec, klazz ->

            assertThat(factory.createTile(spec)).isInstanceOf(klazz)

        }

    }



    @Test

    fun testCustomTileClass() {

        val customSpec = CustomTile.toSpec(ComponentName("test", "test"))

        assertThat(factory.createTile(customSpec)).isInstanceOf(CustomTile::class.java)

    }



    @Test

    fun testBadTileNull() {

        assertThat(factory.createTile("-432~")).isNull()

    }



    @Test

    fun testTileInitializedAndStale() {

        specMap.forEach { spec, _ ->

            val tile = factory.createTile(spec) as QSTileImpl<*>

            val inOrder = inOrder(tile)

            inOrder.verify(tile).initialize()

            inOrder.verify(tile).postStale()

        }



        val customSpec = CustomTile.toSpec(ComponentName("test", "test"))

        val tile = factory.createTile(customSpec) as QSTileImpl<*>

        val inOrder = inOrder(tile)

        inOrder.verify(tile).initialize()

        inOrder.verify(tile).postStale()

    }

}
 
 No newline at end of file