1 /*
2  * Copyright (C) 2019 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package android.platform.test.rule;
17 
18 import android.os.RemoteException;
19 
20 import androidx.test.uiautomator.By;
21 import androidx.test.uiautomator.BySelector;
22 
23 import org.junit.runner.Description;
24 
25 /** This rule will unlock phone screen before a test case. */
26 public class UnlockScreenRule extends TestWatcher {
27 
28     protected static final BySelector SCREEN_LOCK =
29             By.res("com.android.systemui", "keyguard_bottom_area");
30 
31     @Override
starting(Description description)32     protected void starting(Description description) {
33         try {
34             // Turn on the screen if necessary.
35             if (!getUiDevice().isScreenOn()) {
36                 getUiDevice().wakeUp();
37             }
38             if (getUiDevice().hasObject(SCREEN_LOCK)) {
39                 getUiDevice().pressMenu();
40                 getUiDevice().waitForIdle();
41             }
42         } catch (RemoteException e) {
43             throw new RuntimeException("Could not unlock device.", e);
44         }
45     }
46 }
47