lawnchair/compose/tests/com/android/launcher3/widget/AddWidgetConfigTest.kt

/*
 * Copyright (C) 2017 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.launcher3.widget

import android.appwidget.AppWidgetManager
import android.view.View
import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.filters.LargeTest
import androidx.test.platform.app.InstrumentationRegistry
import com.android.launcher3.AbstractFloatingView
import com.android.launcher3.Launcher
import com.android.launcher3.model.data.ItemInfo
import com.android.launcher3.model.data.LauncherAppWidgetInfo
import com.android.launcher3.testcomponent.WidgetConfigActivity
import com.android.launcher3.util.BaseLauncherActivityTest
import com.android.launcher3.util.BlockingBroadcastReceiver
import com.android.launcher3.util.LauncherBindableItemsContainer.ItemOperator
import com.android.launcher3.util.Wait
import com.android.launcher3.util.rule.ShellCommandRule
import com.android.launcher3.util.ui.PortraitLandscapeRunner.PortraitLandscape
import com.android.launcher3.util.ui.TestViewHelpers
import com.android.launcher3.util.workspace.FavoriteItemsTransaction
import com.android.launcher3.widgetpicker.listeners.WidgetPickerAddItemListener
import com.android.launcher3.widgetpicker.shared.model.WidgetInfo
import com.google.common.truth.Truth.assertThat
import org.junit.Before
import org.junit.Rule
import org.junit.Test
import org.junit.runner.RunWith

/**
 * Test verifies that when adding a widget to homescreen using [WidgetPickerAddItemListener], if the
 * widget has a configuration activity, it is shown correctly.
 */
@LargeTest
@RunWith(AndroidJUnit4::class)
class AddWidgetConfigTest : BaseLauncherActivityTest<Launcher>() {
    @get:Rule val grantWidgetRule: ShellCommandRule = ShellCommandRule.grantWidgetBind()

    private lateinit var widgetInfo: LauncherAppWidgetProviderInfo
    private lateinit var appWidgetManager: AppWidgetManager

    private var widgetId = 0

    @Before
    @Throws(Exception::class)
    fun setUp() {
        widgetInfo = TestViewHelpers.findWidgetProvider(/* hasConfigureScreen= */ true)
        appWidgetManager = AppWidgetManager.getInstance(targetContext())
    }

    @Test
    @PortraitLandscape
    @Throws(Throwable::class)
    fun testWidgetConfig() {
        runTest(acceptConfig = true)
    }

    @Test
    @PortraitLandscape
    @Throws(Throwable::class)
    fun testConfigCancelled() {
        runTest(acceptConfig = false)
    }

    /** @param acceptConfig accept the config activity */
    @Throws(Throwable::class)
    private fun runTest(acceptConfig: Boolean) {
        FavoriteItemsTransaction(targetContext()).commit()
        loadLauncherSync()

        // Add widget to home screen
        val monitor = WidgetConfigStartupMonitor()
        launcherActivity.executeOnLauncher { l: Launcher ->
            val addItemListener = WidgetPickerAddItemListener(WidgetInfo.AppWidgetInfo(widgetInfo))
            addItemListener.init(l, /* isHomeStarted= */ true)
        }

        uiDevice.waitForIdle()

        // Widget id for which the config activity was opened
        widgetId = monitor.widgetId

        // Verify that the widget id is valid and bound
        assertThat(appWidgetManager.getAppWidgetInfo(widgetId)).isNotNull()
        setResult(acceptConfig)

        if (acceptConfig) {
            launcherActivity.getOnceNotNull("Widget was not added") { l: Launcher ->
                // Close the resize frame before searching for widget
                AbstractFloatingView.closeAllOpenViews(l)
                l.workspace.mapOverItems(WidgetSearchCondition())
            }
            assertThat(appWidgetManager.getAppWidgetInfo(widgetId)).isNotNull()
        } else {
            // Verify that the widget id is deleted.
            Wait.atMost(
                "no widget with id",
                { appWidgetManager.getAppWidgetInfo(widgetId) == null },
            )
        }
    }

    private fun setResult(success: Boolean) {
        InstrumentationRegistry.getInstrumentation()
            .targetContext
            .sendBroadcast(
                WidgetConfigActivity.getCommandIntent(
                    WidgetConfigActivity::class.java,
                    if (success) "clickOK" else "clickCancel",
                )
            )
        uiDevice.waitForIdle()
    }

    /** Condition for searching widget id */
    private inner class WidgetSearchCondition : ItemOperator {
        override fun evaluate(info: ItemInfo?, view: View): Boolean {
            return info is LauncherAppWidgetInfo &&
                info.providerName == widgetInfo.provider &&
                info.appWidgetId == widgetId
        }
    }

    /** Broadcast receiver for receiving widget config activity status. */
    private class WidgetConfigStartupMonitor :
        BlockingBroadcastReceiver(WidgetConfigActivity::class.java.name) {
        @get:Throws(InterruptedException::class)
        val widgetId: Int
            get() {
                val intent = checkNotNull(blockingGetExtraIntent())
                assertThat(AppWidgetManager.ACTION_APPWIDGET_CONFIGURE).isEqualTo(intent.action)
                val widgetId =
                    intent.getIntExtra(
                        AppWidgetManager.EXTRA_APPWIDGET_ID,
                        LauncherAppWidgetInfo.NO_ID,
                    )
                assertThat(widgetId).isNotEqualTo(LauncherAppWidgetInfo.NO_ID)
                return widgetId
            }
    }
}