Lawnchair/tests/multivalentTests/src/com/android/launcher3/model/DefaultLayoutProviderTest.java

/*
 * Copyright (C) 2019 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.model;

import static com.android.launcher3.LauncherSettings.Favorites.CONTAINER_DESKTOP;
import static com.android.launcher3.LauncherSettings.Favorites.CONTAINER_HOTSEAT;
import static com.android.launcher3.util.LauncherModelHelper.TEST_ACTIVITY;
import static com.android.launcher3.util.LauncherModelHelper.TEST_PACKAGE;
import static com.android.launcher3.util.ModelTestExtensions.getBgDataModel;

import static org.junit.Assert.assertEquals;
import static org.junit.Assume.assumeTrue;

import android.content.pm.LauncherApps;
import android.content.pm.PackageInstaller;
import android.content.pm.PackageInstaller.SessionParams;

import androidx.test.core.app.ApplicationProvider;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import androidx.test.filters.SmallTest;

import com.android.launcher3.LauncherAppState;
import com.android.launcher3.LauncherModel;
import com.android.launcher3.LauncherSettings;
import com.android.launcher3.icons.BitmapInfo;
import com.android.launcher3.model.data.FolderInfo;
import com.android.launcher3.model.data.ItemInfo;
import com.android.launcher3.util.LauncherLayoutBuilder;
import com.android.launcher3.util.ModelTestExtensions;
import com.android.launcher3.util.SandboxApplication;
import com.android.launcher3.util.rule.LayoutProviderRule;

import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;

import java.util.List;

/**
 * Tests for layout parser for remote layout
 */
@SmallTest
@RunWith(AndroidJUnit4.class)
public class DefaultLayoutProviderTest {

    @Rule public SandboxApplication mTargetContext = new SandboxApplication().withModelDependency();
    @Rule public LayoutProviderRule mLayoutProvider = new LayoutProviderRule(mTargetContext);

    private List<ItemInfo> getWorkspaceItems() {
        return getBgDataModel(getModel())
                .itemsIdMap
                .stream()
                .filter(i -> i.container == CONTAINER_DESKTOP || i.container == CONTAINER_HOTSEAT)
                .toList();
    }

    @Test
    public void testCustomProfileLoaded_with_icon_on_hotseat() throws Exception {
        writeLayoutAndLoad(new LauncherLayoutBuilder().atHotseat(0)
                .putApp(TEST_PACKAGE, TEST_ACTIVITY));

        // Verify one item in hotseat
        assertEquals(1, getWorkspaceItems().size());
        ItemInfo info = getWorkspaceItems().get(0);
        assertEquals(LauncherSettings.Favorites.CONTAINER_HOTSEAT, info.container);
        assertEquals(LauncherSettings.Favorites.ITEM_TYPE_APPLICATION, info.itemType);
    }

    @Test
    public void testCustomProfileLoaded_with_folder() throws Exception {
        writeLayoutAndLoad(new LauncherLayoutBuilder().atHotseat(0).putFolder(android.R.string.copy)
                .addApp(TEST_PACKAGE, TEST_ACTIVITY)
                .addApp(TEST_PACKAGE, TEST_ACTIVITY)
                .addApp(TEST_PACKAGE, TEST_ACTIVITY)
                .build());

        // Verify folder
        assertEquals(1, getWorkspaceItems().size());
        ItemInfo info = getWorkspaceItems().get(0);
        assertEquals(LauncherSettings.Favorites.ITEM_TYPE_FOLDER, info.itemType);
        assertEquals(3, ((FolderInfo) info).getContents().size());
    }

    @Test
    public void testCustomProfileLoaded_with_folder_custom_title() throws Exception {
        writeLayoutAndLoad(new LauncherLayoutBuilder().atHotseat(0).putFolder("CustomFolder")
                .addApp(TEST_PACKAGE, TEST_ACTIVITY)
                .addApp(TEST_PACKAGE, TEST_ACTIVITY)
                .addApp(TEST_PACKAGE, TEST_ACTIVITY)
                .build());

        // Verify folder
        assertEquals(1, getWorkspaceItems().size());
        ItemInfo info = getWorkspaceItems().get(0);
        assertEquals(LauncherSettings.Favorites.ITEM_TYPE_FOLDER, info.itemType);
        assertEquals(3, ((FolderInfo) info).getContents().size());
        assertEquals("CustomFolder", info.title.toString());
    }

    @Test
    public void testCustomProfileLoaded_with_widget() throws Exception {
        String pendingAppPkg = "com.test.pending";

        // Add a placeholder session info so that the widget exists
        SessionParams params = new SessionParams(SessionParams.MODE_FULL_INSTALL);
        params.setAppPackageName(pendingAppPkg);
        params.setAppIcon(BitmapInfo.LOW_RES_ICON);
        params.installerPackageName = ApplicationProvider.getApplicationContext().getPackageName();

        PackageInstaller installer = ApplicationProvider.getApplicationContext().getPackageManager()
                .getPackageInstaller();
        installer.createSession(params);

        writeLayoutAndLoad(new LauncherLayoutBuilder().atWorkspace(0, 1, 0)
                .putWidget(pendingAppPkg, "PlaceholderWidget", 2, 2));

        // Verify widget
        assertEquals(1, getWorkspaceItems().size());
        ItemInfo info = getWorkspaceItems().get(0);
        assertEquals(LauncherSettings.Favorites.ITEM_TYPE_APPWIDGET, info.itemType);
        assertEquals(2, info.spanX);
        assertEquals(2, info.spanY);
    }

    @Test
    public void testCustomProfileLoaded_with_shortcut_on_hotseat() throws Exception {
        assumeTrue(mTargetContext.getSystemService(LauncherApps.class).hasShortcutHostPermission());
        writeLayoutAndLoad(new LauncherLayoutBuilder().atHotseat(0)
                .putShortcut(TEST_PACKAGE, "shortcut2"));

        // Verify one item in hotseat
        assertEquals(1, getWorkspaceItems().size());
        ItemInfo info = getWorkspaceItems().get(0);
        assertEquals(LauncherSettings.Favorites.CONTAINER_HOTSEAT, info.container);
        assertEquals(LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT, info.itemType);
    }

    @Test
    public void testCustomProfileLoaded_with_shortcut_in_folder() throws Exception {
        assumeTrue(mTargetContext.getSystemService(LauncherApps.class).hasShortcutHostPermission());
        writeLayoutAndLoad(new LauncherLayoutBuilder().atHotseat(0).putFolder(android.R.string.copy)
                .addApp(TEST_PACKAGE, TEST_ACTIVITY)
                .addApp(TEST_PACKAGE, TEST_ACTIVITY)
                .addShortcut(TEST_PACKAGE, "shortcut2")
                .build());

        // Verify folder
        assertEquals(1, getWorkspaceItems().size());
        FolderInfo info = (FolderInfo) getWorkspaceItems().get(0);
        assertEquals(3, info.getContents().size());

        // Verify last icon
        assertEquals(LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT,
                info.getContents().get(info.getContents().size() - 1).itemType);
    }

    private void writeLayoutAndLoad(LauncherLayoutBuilder builder) throws Exception {
        mLayoutProvider.setupDefaultLayoutProvider(builder);
        ModelTestExtensions.INSTANCE.loadModelSync(getModel());
    }

    private LauncherModel getModel() {
        return LauncherAppState.getInstance(mTargetContext).getModel();
    }
}