/* * Copyright (C) 2018 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.util; import static android.util.Base64.NO_PADDING; import static android.util.Base64.NO_WRAP; import static androidx.test.platform.app.InstrumentationRegistry.getInstrumentation; import static com.android.launcher3.LauncherSettings.Settings.LAYOUT_DIGEST_KEY; import static com.android.launcher3.LauncherSettings.Settings.LAYOUT_DIGEST_LABEL; import static com.android.launcher3.LauncherSettings.Settings.LAYOUT_DIGEST_TAG; import static org.junit.Assert.assertTrue; import android.app.Instrumentation; import android.app.blob.BlobHandle; import android.app.blob.BlobStoreManager; import android.content.Context; import android.content.pm.LauncherApps; import android.content.res.Resources; import android.graphics.Point; import android.os.AsyncTask; import android.os.Handler; import android.os.Looper; import android.os.ParcelFileDescriptor.AutoCloseOutputStream; import android.os.Process; import android.os.UserHandle; import android.provider.Settings; import android.system.OsConstants; import android.util.Base64; import android.util.Log; import androidx.test.uiautomator.UiDevice; import com.android.launcher3.tapl.LauncherInstrumentation; import com.android.launcher3.tapl.Workspace; import org.junit.Assert; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.security.MessageDigest; import java.util.concurrent.Callable; import java.util.concurrent.CountDownLatch; import java.util.concurrent.ExecutorService; import java.util.concurrent.FutureTask; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; public class TestUtil { private static final String TAG = "TestUtil"; public static final String DUMMY_PACKAGE = "com.example.android.aardwolf"; public static final String DUMMY_CLASS_NAME = "com.example.android.aardwolf.Activity1"; public static final long DEFAULT_UI_TIMEOUT = 10000; public static void installDummyApp() throws IOException { final int defaultUserId = getMainUserId(); installDummyAppForUser(defaultUserId); } public static void installDummyAppForUser(int userId) throws IOException { Instrumentation instrumentation = getInstrumentation(); // Copy apk from resources to a local file and install from there. final Resources resources = instrumentation.getContext().getResources(); final InputStream in = resources.openRawResource( resources.getIdentifier("aardwolf_dummy_app", "raw", instrumentation.getContext().getPackageName())); final String apkFilename = instrumentation.getTargetContext() .getFilesDir().getPath() + "/dummy_app.apk"; try (PackageInstallCheck pic = new PackageInstallCheck()) { final FileOutputStream out = new FileOutputStream(apkFilename); byte[] buff = new byte[1024]; int read; while ((read = in.read(buff)) > 0) { out.write(buff, 0, read); } in.close(); out.close(); final String result = UiDevice.getInstance(instrumentation) .executeShellCommand(String.format("pm install -i %s --user ", instrumentation.getContext().getPackageName()) + userId + " " + apkFilename); Assert.assertTrue( "Failed to install wellbeing test apk; make sure the device is rooted", "Success".equals(result.replaceAll("\\s+", ""))); pic.mAddWait.await(); } catch (InterruptedException e) { throw new IOException(e); } } /** * Returns the main user ID. NOTE: For headless system it is NOT 0. Returns 0 by default, if * there is no main user. * * @return a main user ID */ public static int getMainUserId() throws IOException { Instrumentation instrumentation = getInstrumentation(); final String result = UiDevice.getInstance(instrumentation) .executeShellCommand("cmd user get-main-user"); try { return Integer.parseInt(result.trim()); } catch (NumberFormatException e) { return 0; } } /** * @return Grid coordinates from the center and corners of the Workspace. Those are not pixels. * See {@link Workspace#getIconGridDimensions()} */ public static Point[] getCornersAndCenterPositions(LauncherInstrumentation launcher) { final Point dimensions = launcher.getWorkspace().getIconGridDimensions(); return new Point[]{ new Point(0, 1), new Point(0, dimensions.y - 2), new Point(dimensions.x - 1, 1), new Point(dimensions.x - 1, dimensions.y - 2), new Point(dimensions.x / 2, dimensions.y / 2) }; } public static void uninstallDummyApp() throws IOException { UiDevice.getInstance(getInstrumentation()).executeShellCommand( "pm uninstall " + DUMMY_PACKAGE); } /** * Sets the default layout for Launcher and returns an object which can be used to clear * the data */ public static AutoCloseable setLauncherDefaultLayout( Context context, LauncherLayoutBuilder layoutBuilder) throws Exception { byte[] data = layoutBuilder.build().getBytes(); byte[] digest = MessageDigest.getInstance("SHA-256").digest(data); BlobHandle handle = BlobHandle.createWithSha256( digest, LAYOUT_DIGEST_LABEL, 0, LAYOUT_DIGEST_TAG); BlobStoreManager blobManager = context.getSystemService(BlobStoreManager.class); final long sessionId = blobManager.createSession(handle); CountDownLatch wait = new CountDownLatch(1); try (BlobStoreManager.Session session = blobManager.openSession(sessionId)) { try (OutputStream out = new AutoCloseOutputStream(session.openWrite(0, -1))) { out.write(data); } session.allowPublicAccess(); session.commit(AsyncTask.THREAD_POOL_EXECUTOR, i -> wait.countDown()); } String key = Base64.encodeToString(digest, NO_WRAP | NO_PADDING); Settings.Secure.putString(context.getContentResolver(), LAYOUT_DIGEST_KEY, key); wait.await(); return () -> Settings.Secure.putString(context.getContentResolver(), LAYOUT_DIGEST_KEY, null); } /** * Utility method to run a task synchronously which converts any exceptions to RuntimeException */ public static void runOnExecutorSync(ExecutorService executor, UncheckedRunnable task) { try { executor.submit(() -> { try { task.run(); } catch (Exception e) { throw new RuntimeException(e); } }).get(); } catch (Exception e) { throw new RuntimeException(e); } } /** * Runs the callback on the UI thread and returns the result. */ public static T getOnUiThread(final Callable callback) { try { FutureTask task = new FutureTask<>(callback); if (Looper.myLooper() == Looper.getMainLooper()) { task.run(); } else { new Handler(Looper.getMainLooper()).post(task); } return task.get(DEFAULT_UI_TIMEOUT, TimeUnit.MILLISECONDS); } catch (TimeoutException e) { Log.e(TAG, "Timeout in getOnUiThread, sending SIGABRT", e); Process.sendSignal(Process.myPid(), OsConstants.SIGABRT); throw new RuntimeException(e); } catch (Throwable e) { throw new RuntimeException(e); } } // Please don't add negative test cases for methods that fail only after a long wait. public static void expectFail(String message, Runnable action) { boolean failed = false; try { action.run(); } catch (AssertionError e) { failed = true; } assertTrue(message, failed); } /** Interface to indicate a runnable which can throw any exception. */ public interface UncheckedRunnable { /** Method to run the task */ void run() throws Exception; } private static class PackageInstallCheck extends LauncherApps.Callback implements AutoCloseable { final CountDownLatch mAddWait = new CountDownLatch(1); final LauncherApps mLauncherApps; PackageInstallCheck() { mLauncherApps = getInstrumentation().getTargetContext() .getSystemService(LauncherApps.class); mLauncherApps.registerCallback(this, new Handler(Looper.getMainLooper())); } private void verifyPackage(String packageName) { if (DUMMY_PACKAGE.equals(packageName)) { mAddWait.countDown(); } } @Override public void onPackageAdded(String packageName, UserHandle user) { verifyPackage(packageName); } @Override public void onPackageChanged(String packageName, UserHandle user) { verifyPackage(packageName); } @Override public void onPackageRemoved(String packageName, UserHandle user) { } @Override public void onPackagesAvailable(String[] packageNames, UserHandle user, boolean replacing) { for (String packageName : packageNames) { verifyPackage(packageName); } } @Override public void onPackagesUnavailable(String[] packageNames, UserHandle user, boolean replacing) { } @Override public void close() { mLauncherApps.unregisterCallback(this); } } }