tests/tests/appwidget/src/android/appwidget/cts/RequestPinAppWidgetTest.java

/*
 * 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 android.appwidget.cts;

import android.app.PendingIntent;
import android.appwidget.AppWidgetManager;
import android.appwidget.cts.common.Constants;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.pm.LauncherApps;
import android.os.Bundle;
import android.os.Handler;

import java.util.Arrays;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

public class RequestPinAppWidgetTest extends AppWidgetTestCase {

    private static final String LAUNCHER_CLASS = "android.appwidget.cts.packages.Launcher";
    private static final String ACTION_PIN_RESULT = "android.appwidget.cts.ACTION_PIN_RESULT";

    private String mDefaultLauncher;

    @Override
    protected void setUp() throws Exception {
        super.setUp();
        mDefaultLauncher = getDefaultLauncher();
    }

    @Override
    protected void tearDown() throws Exception {
        super.tearDown();
        // Set the launcher back
        setLauncher(mDefaultLauncher);
    }

    private void runPinWidgetTest(final String launcherPkg) throws Exception {
        if (!hasAppWidgets()) {
            return;
        }
        setLauncher(launcherPkg + "/" + LAUNCHER_CLASS);

        Context context = getInstrumentation().getContext();

        // Request to pin widget
        BlockingReceiver setupReceiver = new BlockingReceiver()
                .register(Constants.ACTION_SETUP_REPLY);

        Bundle extras = new Bundle();
        extras.putString("dummy", launcherPkg + "-dummy");

        PendingIntent pinResult = PendingIntent.getBroadcast(context, 0,
                new Intent(ACTION_PIN_RESULT), PendingIntent.FLAG_ONE_SHOT);
        AppWidgetManager.getInstance(context).requestPinAppWidget(
                getFirstWidgetComponent(), extras, pinResult);

        setupReceiver.await();
        // Verify that the confirmation dialog was opened
        assertTrue(setupReceiver.mResult.getBooleanExtra(Constants.EXTRA_SUCCESS, false));
        assertEquals(launcherPkg, setupReceiver.mResult.getStringExtra(Constants.EXTRA_PACKAGE));
        setupReceiver.unregister();

        LauncherApps.PinItemRequest req =
                setupReceiver.mResult.getParcelableExtra(Constants.EXTRA_REQUEST);
        assertNotNull(req);
        // Verify that multiple calls to getAppWidgetProviderInfo have proper dimension.
        boolean[] providerInfo = verifyInstalledProviders(Arrays.asList(
                req.getAppWidgetProviderInfo(context), req.getAppWidgetProviderInfo(context)));
        assertTrue(providerInfo[0]);
        assertNotNull(req.getExtras());
        assertEquals(launcherPkg + "-dummy", req.getExtras().getString("dummy"));

        // Accept the request
        BlockingReceiver resultReceiver = new BlockingReceiver().register(ACTION_PIN_RESULT);
        context.sendBroadcast(new Intent(Constants.ACTION_CONFIRM_PIN)
                .setPackage(launcherPkg)
                .putExtra("dummy", "dummy-2"));
        resultReceiver.await();

        // Verify that the result contain the extras
        assertEquals("dummy-2", resultReceiver.mResult.getStringExtra("dummy"));
        resultReceiver.unregister();
    }

    public void testPinWidget_launcher1() throws Exception {
        runPinWidgetTest("android.appwidget.cts.packages.launcher1");
    }

    public void testPinWidget_launcher2() throws Exception {
        runPinWidgetTest("android.appwidget.cts.packages.launcher2");
    }

    public void verifyIsRequestPinAppWidgetSupported(String launcherPkg, boolean expectedSupport)
        throws Exception {
        if (!hasAppWidgets()) {
            return;
        }
        setLauncher(launcherPkg + "/" + LAUNCHER_CLASS);

        Context context = getInstrumentation().getContext();
        assertEquals(expectedSupport,
                AppWidgetManager.getInstance(context).isRequestPinAppWidgetSupported());
    }

    public void testIsRequestPinAppWidgetSupported_launcher1() throws Exception {
        verifyIsRequestPinAppWidgetSupported("android.appwidget.cts.packages.launcher1", true);
    }

    public void testIsRequestPinAppWidgetSupported_launcher2() throws Exception {
        verifyIsRequestPinAppWidgetSupported("android.appwidget.cts.packages.launcher2", true);
    }

    public void testIsRequestPinAppWidgetSupported_launcher3() throws Exception {
        verifyIsRequestPinAppWidgetSupported("android.appwidget.cts.packages.launcher3", false);
    }

    private String getDefaultLauncher() throws Exception {
        final String PREFIX = "Launcher: ComponentInfo{";
        final String POSTFIX = "}";
        for (String s : runShellCommand("cmd shortcut get-default-launcher")) {
            if (s.startsWith(PREFIX) && s.endsWith(POSTFIX)) {
                return s.substring(PREFIX.length(), s.length() - POSTFIX.length());
            }
        }
        throw new Exception("Default launcher not found");
    }

    private void setLauncher(String component) throws Exception {
        runShellCommand("cmd package set-home-activity --user "
                + getInstrumentation().getContext().getUserId() + " " + component);
    }

    private class BlockingReceiver extends BroadcastReceiver {
        private final CountDownLatch notifier = new CountDownLatch(1);

        private Intent mResult;

        @Override
        public void onReceive(Context context, Intent intent) {
            mResult = new Intent(intent);
            notifier.countDown();
        }

        public BlockingReceiver register(String action) {
            Context context = getInstrumentation().getContext();
            context.registerReceiver(this, new IntentFilter(action),
                    null, new Handler(context.getMainLooper()));
            return this;
        }

        public void await() throws Exception {
            assertTrue(notifier.await(20, TimeUnit.SECONDS));
        }

        public void unregister() {
            getInstrumentation().getContext().unregisterReceiver(this);
        }
    }
}