| /* |
| * 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 android.view.inputmethod.cts.util; |
| |
| import static com.android.compatibility.common.util.SystemUtil.runShellCommand; |
| |
| import android.app.Instrumentation; |
| import android.content.Context; |
| import android.os.PowerManager; |
| |
| import androidx.annotation.NonNull; |
| import androidx.test.InstrumentationRegistry; |
| |
| import com.android.compatibility.common.util.CommonTestUtils; |
| |
| import java.util.concurrent.TimeoutException; |
| import java.util.concurrent.atomic.AtomicBoolean; |
| import java.util.concurrent.atomic.AtomicReference; |
| import java.util.function.BooleanSupplier; |
| import java.util.function.Supplier; |
| |
| public final class TestUtils { |
| private static final long TIME_SLICE = 100; // msec |
| |
| /** |
| * Executes a call on the application's main thread, blocking until it is complete. |
| * |
| * <p>A simple wrapper for {@link Instrumentation#runOnMainSync(Runnable)}.</p> |
| * |
| * @param task task to be called on the UI thread |
| */ |
| public static void runOnMainSync(@NonNull Runnable task) { |
| InstrumentationRegistry.getInstrumentation().runOnMainSync(task); |
| } |
| |
| /** |
| * Retrieves a value that needs to be obtained on the main thread. |
| * |
| * <p>A simple utility method that helps to return an object from the UI thread.</p> |
| * |
| * @param supplier callback to be called on the UI thread to return a value |
| * @param <T> Type of the value to be returned |
| * @return Value returned from {@code supplier} |
| */ |
| public static <T> T getOnMainSync(@NonNull Supplier<T> supplier) { |
| final AtomicReference<T> result = new AtomicReference<>(); |
| final Instrumentation instrumentation = InstrumentationRegistry.getInstrumentation(); |
| instrumentation.runOnMainSync(() -> result.set(supplier.get())); |
| return result.get(); |
| } |
| |
| /** |
| * Does polling loop on the UI thread to wait until the given condition is met. |
| * |
| * @param condition Condition to be satisfied. This is guaranteed to run on the UI thread. |
| * @param timeout timeout in millisecond |
| * @param message message to display when timeout occurs. |
| * @throws TimeoutException when the no event is matched to the given condition within |
| * {@code timeout} |
| */ |
| public static void waitOnMainUntil( |
| @NonNull BooleanSupplier condition, long timeout, String message) |
| throws TimeoutException { |
| final AtomicBoolean result = new AtomicBoolean(); |
| |
| final Instrumentation instrumentation = InstrumentationRegistry.getInstrumentation(); |
| while (!result.get()) { |
| if (timeout < 0) { |
| throw new TimeoutException(message); |
| } |
| instrumentation.runOnMainSync(() -> { |
| if (condition.getAsBoolean()) { |
| result.set(true); |
| } |
| }); |
| try { |
| Thread.sleep(TIME_SLICE); |
| } catch (InterruptedException e) { |
| throw new IllegalStateException(e); |
| } |
| timeout -= TIME_SLICE; |
| } |
| } |
| |
| /** |
| * Does polling loop on the UI thread to wait until the given condition is met. |
| * |
| * @param condition Condition to be satisfied. This is guaranteed to run on the UI thread. |
| * @param timeout timeout in millisecond |
| * @throws TimeoutException when the no event is matched to the given condition within |
| * {@code timeout} |
| */ |
| public static void waitOnMainUntil(@NonNull BooleanSupplier condition, long timeout) |
| throws TimeoutException { |
| waitOnMainUntil(condition, timeout, ""); |
| } |
| |
| /** |
| * Call a command to turn screen On. |
| * |
| * This method will wait until the power state is interactive with {@link |
| * PowerManager#isInteractive()}. |
| */ |
| public static void turnScreenOn() throws Exception { |
| final Context context = InstrumentationRegistry.getInstrumentation().getContext(); |
| final PowerManager pm = context.getSystemService(PowerManager.class); |
| runShellCommand("input keyevent KEYCODE_WAKEUP"); |
| CommonTestUtils.waitUntil("Device does not wake up after 5 seconds", 5, |
| () -> pm != null && pm.isInteractive()); |
| } |
| |
| /** |
| * Call a command to turn screen off. |
| * |
| * This method will wait until the power state is *NOT* interactive with |
| * {@link PowerManager#isInteractive()}. |
| * Note that {@link PowerManager#isInteractive()} may not return {@code true} when the device |
| * enables Aod mode, recommend to add (@link DisableScreenDozeRule} in the test to disable Aod |
| * for making power state reliable. |
| */ |
| public static void turnScreenOff() throws Exception { |
| final Context context = InstrumentationRegistry.getInstrumentation().getContext(); |
| final PowerManager pm = context.getSystemService(PowerManager.class); |
| runShellCommand("input keyevent KEYCODE_SLEEP"); |
| CommonTestUtils.waitUntil("Device does not sleep after 5 seconds", 5, |
| () -> pm != null && !pm.isInteractive()); |
| } |
| |
| /** |
| * Call a command to unlock screen. |
| * |
| * Note that this method is originated from |
| * {@link android.server.wm.UiDeviceUtils#pressUnlockButton()}, which is only valid for |
| * unlocking insecure keyguard for test automation. |
| */ |
| public static void unlockScreen() throws Exception { |
| runShellCommand("input keyevent KEYCODE_MENU"); |
| } |
| } |