DeferredHandler was added when we were posting each icon separately, to prevent starvation. But since then we have moved to binding batct items during bind. Also fixing waitForIdle not waiting the second time. waitForIdle was using a global variable to maintain state, and was not waiting properly when its called the second time before binding deep shortcuts Original Change-Id: I9c1289cb3bfb74f86e53ec7ac6dd76bb39666b2d Change-Id: I9e6b3ae65fbd3aec3a46092efc5249c4525efedf
349 lines
14 KiB
Java
349 lines
14 KiB
Java
/*
|
|
* 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.ui.widget;
|
|
|
|
import android.appwidget.AppWidgetHost;
|
|
import android.content.ComponentName;
|
|
import android.content.ContentResolver;
|
|
import android.content.ContentValues;
|
|
import android.content.pm.PackageInstaller;
|
|
import android.content.pm.PackageInstaller.SessionParams;
|
|
import android.content.pm.PackageManager;
|
|
import android.database.Cursor;
|
|
import android.os.Bundle;
|
|
import android.support.test.uiautomator.UiSelector;
|
|
import android.test.suitebuilder.annotation.LargeTest;
|
|
|
|
import com.android.launcher3.Launcher;
|
|
import com.android.launcher3.LauncherAppWidgetHostView;
|
|
import com.android.launcher3.LauncherAppWidgetInfo;
|
|
import com.android.launcher3.LauncherAppWidgetProviderInfo;
|
|
import com.android.launcher3.LauncherModel;
|
|
import com.android.launcher3.LauncherSettings;
|
|
import com.android.launcher3.PendingAppWidgetHostView;
|
|
import com.android.launcher3.Workspace;
|
|
import com.android.launcher3.compat.AppWidgetManagerCompat;
|
|
import com.android.launcher3.compat.PackageInstallerCompat;
|
|
import com.android.launcher3.ui.LauncherInstrumentationTestCase;
|
|
import com.android.launcher3.util.ContentWriter;
|
|
import com.android.launcher3.util.LooperExecutor;
|
|
import com.android.launcher3.widget.PendingAddWidgetInfo;
|
|
import com.android.launcher3.widget.WidgetHostViewLoader;
|
|
|
|
import java.util.Set;
|
|
import java.util.concurrent.Callable;
|
|
import java.util.concurrent.TimeUnit;
|
|
|
|
/**
|
|
* Tests for bind widget flow.
|
|
*
|
|
* Note running these tests will clear the workspace on the device.
|
|
*/
|
|
@LargeTest
|
|
public class BindWidgetTest extends LauncherInstrumentationTestCase {
|
|
|
|
private ContentResolver mResolver;
|
|
private AppWidgetManagerCompat mWidgetManager;
|
|
|
|
// Objects created during test, which should be cleaned up in the end.
|
|
private Cursor mCursor;
|
|
// App install session id.
|
|
private int mSessionId = -1;
|
|
|
|
@Override
|
|
protected void setUp() throws Exception {
|
|
super.setUp();
|
|
|
|
mResolver = mTargetContext.getContentResolver();
|
|
mWidgetManager = AppWidgetManagerCompat.getInstance(mTargetContext);
|
|
grantWidgetPermission();
|
|
|
|
// Clear all existing data
|
|
LauncherSettings.Settings.call(mResolver, LauncherSettings.Settings.METHOD_CREATE_EMPTY_DB);
|
|
LauncherSettings.Settings.call(mResolver, LauncherSettings.Settings.METHOD_CLEAR_EMPTY_DB_FLAG);
|
|
}
|
|
|
|
@Override
|
|
protected void tearDown() throws Exception {
|
|
super.tearDown();
|
|
if (mCursor != null) {
|
|
mCursor.close();
|
|
}
|
|
|
|
if (mSessionId > -1) {
|
|
mTargetContext.getPackageManager().getPackageInstaller().abandonSession(mSessionId);
|
|
}
|
|
}
|
|
|
|
public void testBindNormalWidget_withConfig() {
|
|
LauncherAppWidgetProviderInfo info = findWidgetProvider(true);
|
|
LauncherAppWidgetInfo item = createWidgetInfo(info, true);
|
|
|
|
setupAndVerifyContents(item, LauncherAppWidgetHostView.class, info.label);
|
|
}
|
|
|
|
public void testBindNormalWidget_withoutConfig() {
|
|
LauncherAppWidgetProviderInfo info = findWidgetProvider(false);
|
|
LauncherAppWidgetInfo item = createWidgetInfo(info, true);
|
|
|
|
setupAndVerifyContents(item, LauncherAppWidgetHostView.class, info.label);
|
|
}
|
|
|
|
public void testUnboundWidget_removed() throws Exception {
|
|
LauncherAppWidgetProviderInfo info = findWidgetProvider(false);
|
|
LauncherAppWidgetInfo item = createWidgetInfo(info, false);
|
|
item.appWidgetId = -33;
|
|
|
|
// Since there is no widget to verify, just wait until the workspace is ready.
|
|
setupAndVerifyContents(item, Workspace.class, null);
|
|
|
|
waitUntilLoaderIdle();
|
|
// Item deleted from db
|
|
mCursor = mResolver.query(LauncherSettings.Favorites.getContentUri(item.id),
|
|
null, null, null, null, null);
|
|
assertEquals(0, mCursor.getCount());
|
|
|
|
// The view does not exist
|
|
assertFalse(mDevice.findObject(new UiSelector().description(info.label)).exists());
|
|
}
|
|
|
|
public void testPendingWidget_autoRestored() {
|
|
// A non-restored widget with no config screen gets restored automatically.
|
|
LauncherAppWidgetProviderInfo info = findWidgetProvider(false);
|
|
|
|
// Do not bind the widget
|
|
LauncherAppWidgetInfo item = createWidgetInfo(info, false);
|
|
item.restoreStatus = LauncherAppWidgetInfo.FLAG_ID_NOT_VALID;
|
|
|
|
setupAndVerifyContents(item, LauncherAppWidgetHostView.class, info.label);
|
|
}
|
|
|
|
public void testPendingWidget_withConfigScreen() throws Exception {
|
|
// A non-restored widget with config screen get bound and shows a 'Click to setup' UI.
|
|
LauncherAppWidgetProviderInfo info = findWidgetProvider(true);
|
|
|
|
// Do not bind the widget
|
|
LauncherAppWidgetInfo item = createWidgetInfo(info, false);
|
|
item.restoreStatus = LauncherAppWidgetInfo.FLAG_ID_NOT_VALID;
|
|
|
|
setupAndVerifyContents(item, PendingAppWidgetHostView.class, null);
|
|
waitUntilLoaderIdle();
|
|
// Item deleted from db
|
|
mCursor = mResolver.query(LauncherSettings.Favorites.getContentUri(item.id),
|
|
null, null, null, null, null);
|
|
mCursor.moveToNext();
|
|
|
|
// Widget has a valid Id now.
|
|
assertEquals(0, mCursor.getInt(mCursor.getColumnIndex(LauncherSettings.Favorites.RESTORED))
|
|
& LauncherAppWidgetInfo.FLAG_ID_NOT_VALID);
|
|
assertNotNull(mWidgetManager.getAppWidgetInfo(mCursor.getInt(mCursor.getColumnIndex(
|
|
LauncherSettings.Favorites.APPWIDGET_ID))));
|
|
}
|
|
|
|
public void testPendingWidget_notRestored_removed() throws Exception {
|
|
LauncherAppWidgetInfo item = getInvalidWidgetInfo();
|
|
item.restoreStatus = LauncherAppWidgetInfo.FLAG_ID_NOT_VALID
|
|
| LauncherAppWidgetInfo.FLAG_PROVIDER_NOT_READY;
|
|
|
|
setupAndVerifyContents(item, Workspace.class, null);
|
|
// The view does not exist
|
|
assertFalse(mDevice.findObject(
|
|
new UiSelector().className(PendingAppWidgetHostView.class)).exists());
|
|
waitUntilLoaderIdle();
|
|
// Item deleted from db
|
|
mCursor = mResolver.query(LauncherSettings.Favorites.getContentUri(item.id),
|
|
null, null, null, null, null);
|
|
assertEquals(0, mCursor.getCount());
|
|
}
|
|
|
|
public void testPendingWidget_notRestored_brokenInstall() throws Exception {
|
|
// A widget which is was being installed once, even if its not being
|
|
// installed at the moment is not removed.
|
|
LauncherAppWidgetInfo item = getInvalidWidgetInfo();
|
|
item.restoreStatus = LauncherAppWidgetInfo.FLAG_ID_NOT_VALID
|
|
| LauncherAppWidgetInfo.FLAG_RESTORE_STARTED
|
|
| LauncherAppWidgetInfo.FLAG_PROVIDER_NOT_READY;
|
|
|
|
setupAndVerifyContents(item, PendingAppWidgetHostView.class, null);
|
|
// Verify item still exists in db
|
|
waitUntilLoaderIdle();
|
|
mCursor = mResolver.query(LauncherSettings.Favorites.getContentUri(item.id),
|
|
null, null, null, null, null);
|
|
assertEquals(1, mCursor.getCount());
|
|
|
|
// Widget still has an invalid id.
|
|
mCursor.moveToNext();
|
|
assertEquals(LauncherAppWidgetInfo.FLAG_ID_NOT_VALID,
|
|
mCursor.getInt(mCursor.getColumnIndex(LauncherSettings.Favorites.RESTORED))
|
|
& LauncherAppWidgetInfo.FLAG_ID_NOT_VALID);
|
|
}
|
|
|
|
public void testPendingWidget_notRestored_activeInstall() throws Exception {
|
|
// A widget which is being installed is not removed
|
|
LauncherAppWidgetInfo item = getInvalidWidgetInfo();
|
|
item.restoreStatus = LauncherAppWidgetInfo.FLAG_ID_NOT_VALID
|
|
| LauncherAppWidgetInfo.FLAG_PROVIDER_NOT_READY;
|
|
|
|
// Create an active installer session
|
|
SessionParams params = new SessionParams(SessionParams.MODE_FULL_INSTALL);
|
|
params.setAppPackageName(item.providerName.getPackageName());
|
|
PackageInstaller installer = mTargetContext.getPackageManager().getPackageInstaller();
|
|
mSessionId = installer.createSession(params);
|
|
|
|
setupAndVerifyContents(item, PendingAppWidgetHostView.class, null);
|
|
// Verify item still exists in db
|
|
waitUntilLoaderIdle();
|
|
mCursor = mResolver.query(LauncherSettings.Favorites.getContentUri(item.id),
|
|
null, null, null, null, null);
|
|
assertEquals(1, mCursor.getCount());
|
|
|
|
// Widget still has an invalid id.
|
|
mCursor.moveToNext();
|
|
assertEquals(LauncherAppWidgetInfo.FLAG_ID_NOT_VALID,
|
|
mCursor.getInt(mCursor.getColumnIndex(LauncherSettings.Favorites.RESTORED))
|
|
& LauncherAppWidgetInfo.FLAG_ID_NOT_VALID);
|
|
}
|
|
|
|
/**
|
|
* Adds {@param item} on the homescreen on the 0th screen at 0,0, and verifies that the
|
|
* widget class is displayed on the homescreen.
|
|
* @param widgetClass the View class which is displayed on the homescreen
|
|
* @param desc the content description of the view or null.
|
|
*/
|
|
private void setupAndVerifyContents(
|
|
LauncherAppWidgetInfo item, Class<?> widgetClass, String desc) {
|
|
long screenId = Workspace.FIRST_SCREEN_ID;
|
|
// Update the screen id counter for the provider.
|
|
LauncherSettings.Settings.call(mResolver, LauncherSettings.Settings.METHOD_NEW_SCREEN_ID);
|
|
|
|
if (screenId > Workspace.FIRST_SCREEN_ID) {
|
|
screenId = Workspace.FIRST_SCREEN_ID;
|
|
}
|
|
ContentValues v = new ContentValues();
|
|
v.put(LauncherSettings.WorkspaceScreens._ID, screenId);
|
|
v.put(LauncherSettings.WorkspaceScreens.SCREEN_RANK, 0);
|
|
mResolver.insert(LauncherSettings.WorkspaceScreens.CONTENT_URI, v);
|
|
|
|
// Insert the item
|
|
ContentWriter writer = new ContentWriter(mTargetContext);
|
|
item.id = LauncherSettings.Settings.call(
|
|
mResolver, LauncherSettings.Settings.METHOD_NEW_ITEM_ID)
|
|
.getLong(LauncherSettings.Settings.EXTRA_VALUE);
|
|
item.screenId = screenId;
|
|
item.onAddToDatabase(writer);
|
|
writer.put(LauncherSettings.Favorites._ID, item.id);
|
|
mResolver.insert(LauncherSettings.Favorites.CONTENT_URI, writer.getValues(mTargetContext));
|
|
resetLoaderState();
|
|
|
|
// Launch the home activity
|
|
startLauncher();
|
|
// Verify UI
|
|
UiSelector selector = new UiSelector().packageName(mTargetContext.getPackageName())
|
|
.className(widgetClass);
|
|
if (desc != null) {
|
|
selector = selector.description(desc);
|
|
}
|
|
assertTrue(mDevice.findObject(selector).waitForExists(DEFAULT_UI_TIMEOUT));
|
|
}
|
|
|
|
/**
|
|
* Creates a LauncherAppWidgetInfo corresponding to {@param info}
|
|
* @param bindWidget if true the info is bound and a valid widgetId is assigned to
|
|
* the LauncherAppWidgetInfo
|
|
*/
|
|
private LauncherAppWidgetInfo createWidgetInfo(
|
|
LauncherAppWidgetProviderInfo info, boolean bindWidget) {
|
|
LauncherAppWidgetInfo item = new LauncherAppWidgetInfo(
|
|
LauncherAppWidgetInfo.NO_ID, info.provider);
|
|
item.spanX = info.minSpanX;
|
|
item.spanY = info.minSpanY;
|
|
item.minSpanX = info.minSpanX;
|
|
item.minSpanY = info.minSpanY;
|
|
item.user = info.getUser();
|
|
item.cellX = 0;
|
|
item.cellY = 1;
|
|
item.container = LauncherSettings.Favorites.CONTAINER_DESKTOP;
|
|
|
|
if (bindWidget) {
|
|
PendingAddWidgetInfo pendingInfo = new PendingAddWidgetInfo(info);
|
|
pendingInfo.spanX = item.spanX;
|
|
pendingInfo.spanY = item.spanY;
|
|
pendingInfo.minSpanX = item.minSpanX;
|
|
pendingInfo.minSpanY = item.minSpanY;
|
|
Bundle options = WidgetHostViewLoader.getDefaultOptionsForWidget(mTargetContext, pendingInfo);
|
|
|
|
AppWidgetHost host = new AppWidgetHost(mTargetContext, Launcher.APPWIDGET_HOST_ID);
|
|
int widgetId = host.allocateAppWidgetId();
|
|
if (!mWidgetManager.bindAppWidgetIdIfAllowed(widgetId, info, options)) {
|
|
host.deleteAppWidgetId(widgetId);
|
|
throw new IllegalArgumentException("Unable to bind widget id");
|
|
}
|
|
item.appWidgetId = widgetId;
|
|
}
|
|
return item;
|
|
}
|
|
|
|
/**
|
|
* Returns a LauncherAppWidgetInfo with package name which is not present on the device
|
|
*/
|
|
private LauncherAppWidgetInfo getInvalidWidgetInfo() {
|
|
String invalidPackage = "com.invalidpackage";
|
|
int count = 0;
|
|
String pkg = invalidPackage;
|
|
|
|
Set<String> activePackage = getOnUiThread(new Callable<Set<String>>() {
|
|
@Override
|
|
public Set<String> call() throws Exception {
|
|
return PackageInstallerCompat.getInstance(mTargetContext)
|
|
.updateAndGetActiveSessionCache().keySet();
|
|
}
|
|
});
|
|
while(true) {
|
|
try {
|
|
mTargetContext.getPackageManager().getPackageInfo(
|
|
pkg, PackageManager.GET_UNINSTALLED_PACKAGES);
|
|
} catch (Exception e) {
|
|
if (!activePackage.contains(pkg)) {
|
|
break;
|
|
}
|
|
}
|
|
pkg = invalidPackage + count;
|
|
count ++;
|
|
}
|
|
LauncherAppWidgetInfo item = new LauncherAppWidgetInfo(10,
|
|
new ComponentName(pkg, "com.test.widgetprovider"));
|
|
item.spanX = 2;
|
|
item.spanY = 2;
|
|
item.minSpanX = 2;
|
|
item.minSpanY = 2;
|
|
item.cellX = 0;
|
|
item.cellY = 1;
|
|
item.container = LauncherSettings.Favorites.CONTAINER_DESKTOP;
|
|
return item;
|
|
}
|
|
|
|
/**
|
|
* Blocks the current thread until all the jobs in the main worker thread are complete.
|
|
*/
|
|
private void waitUntilLoaderIdle() throws Exception {
|
|
new LooperExecutor(LauncherModel.getWorkerLooper())
|
|
.submit(new Runnable() {
|
|
@Override
|
|
public void run() { }
|
|
}).get(DEFAULT_WORKER_TIMEOUT_SECS, TimeUnit.SECONDS);
|
|
}
|
|
}
|