Bugfix: send KEYCODE_MENU event may cause issue when taking screenshot

agent/src/main/java/com/microsoft/hydralab/agent/runner/TestRunDeviceOrchestrator.java

@@ -60,6 +60,14 @@ public void wakeUpDevice(@NotNull TestRunDevice testRunDevice, @Nullable Logger
         }
     }
 
+    public void unlockDevice(@NotNull TestRunDevice testRunDevice, @Nullable Logger logger) {
+        if (testRunDevice instanceof TestRunDeviceCombo) {
+            ((TestRunDeviceCombo) testRunDevice).getDevices().forEach(testRunDevice1 -> deviceDriverManager.unlockDevice(testRunDevice1.getDeviceInfo(), logger));
+        } else {
+            deviceDriverManager.unlockDevice(testRunDevice.getDeviceInfo(), logger);
+        }
+    }
+
     public boolean installApp(@NotNull TestRunDevice testRunDevice, @NotNull String packagePath, @Nullable Logger logger) {
         if (testRunDevice instanceof TestRunDeviceCombo) {
             boolean isInstalled = true;

agent/src/main/java/com/microsoft/hydralab/agent/runner/TestRunner.java

@@ -191,6 +191,7 @@ protected void setUp(TestRunDevice testRunDevice, TestTask testTask, TestRun tes
         testRun.getLogger().info("Start setup device");
         testRunDeviceOrchestrator.testDeviceSetup(testRunDevice, testRun.getLogger());
         testRunDeviceOrchestrator.wakeUpDevice(testRunDevice, testRun.getLogger());
+        testRunDeviceOrchestrator.unlockDevice(testRunDevice, testRun.getLogger());
         ThreadUtils.safeSleep(1000);
         checkTestTaskCancel(testTask);
         reInstallApp(testRunDevice, testTask, testRun.getLogger());

common/src/main/java/com/microsoft/hydralab/common/management/device/DeviceDriver.java

@@ -23,6 +23,8 @@ public interface DeviceDriver {
 
     void wakeUpDevice(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger);
 
+    void unlockDevice(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger);
+
     void backToHome(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger);
 
     void grantPermission(@NotNull DeviceInfo deviceInfo, @NotNull String packageName,

common/src/main/java/com/microsoft/hydralab/common/management/device/impl/AbstractDeviceDriver.java

@@ -100,6 +100,8 @@ public File getScreenShotWithStrategy(@NotNull DeviceInfo deviceInfo, @Nullable
 
     public abstract void wakeUpDevice(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger);
 
+    public abstract void unlockDevice(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger);
+
     public abstract void backToHome(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger);
 
     public abstract void grantPermission(@NotNull DeviceInfo deviceInfo, @NotNull String packageName,

common/src/main/java/com/microsoft/hydralab/common/management/device/impl/AndroidDeviceDriver.java

@@ -156,6 +156,10 @@ public void init() {
     @Override
     public void wakeUpDevice(DeviceInfo deviceInfo, Logger logger) {
         sendKeyEvent(deviceInfo, KEYCODE_WAKEUP, logger);
+    }
+
+    @Override
+    public void unlockDevice(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger) {
         sendKeyEvent(deviceInfo, KEYCODE_MENU, logger);
     }
 
@@ -586,6 +590,7 @@ public boolean grantProjectionAndBatteryPermission(DeviceInfo deviceInfo, String
         boolean isProjectionPermissionGranted = false;
         stopPackageProcess(deviceInfo, recordPackageName, logger);
         wakeUpDevice(deviceInfo, logger);
+        unlockDevice(deviceInfo, logger);
         startRecordActivity(deviceInfo, logger);
         ThreadUtils.safeSleep(2000);
         if (!clickNodeOnDeviceWithText(deviceInfo, logger, "Start now", "Allow", "允许")) {

common/src/main/java/com/microsoft/hydralab/common/management/device/impl/DeviceDriverManager.java

@@ -70,6 +70,11 @@ public void wakeUpDevice(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger
         getDeviceDriver(deviceInfo.getType()).wakeUpDevice(deviceInfo, logger);
     }
 
+    @Override
+    public void unlockDevice(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger) {
+        getDeviceDriver(deviceInfo.getType()).unlockDevice(deviceInfo, logger);
+    }
+
     @Override
     public void backToHome(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger) {
         getDeviceDriver(deviceInfo.getType()).backToHome(deviceInfo, logger);

common/src/main/java/com/microsoft/hydralab/common/management/device/impl/IOSDeviceDriver.java

@@ -71,6 +71,12 @@ public void wakeUpDevice(DeviceInfo deviceInfo, Logger logger) {
         getAppiumServerManager().getIOSDriver(deviceInfo, logger).unlockDevice();
     }
 
+    @Override
+    public void unlockDevice(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger) {
+        classLogger.info("Unlocking may not work as expected, please keep your device wake.");
+        getAppiumServerManager().getIOSDriver(deviceInfo, logger).unlockDevice();
+    }
+
     @Override
     public void backToHome(DeviceInfo deviceInfo, Logger logger) {
 //        classLogger.info("Nothing Implemented for iOS in " + currentMethodName());

common/src/main/java/com/microsoft/hydralab/common/management/device/impl/WindowsDeviceDriver.java

@@ -67,6 +67,11 @@ public void wakeUpDevice(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger
 
     }
 
+    @Override
+    public void unlockDevice(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger) {
+
+    }
+
     @Override
     public void backToHome(@NotNull DeviceInfo deviceInfo, @Nullable Logger logger) {
 

common/src/main/java/com/microsoft/hydralab/common/screen/PhoneAppScreenRecorder.java

@@ -65,6 +65,7 @@ public void setupDevice() {
         }
         try {
             deviceDriver.wakeUpDevice(deviceInfo, logger);
+            deviceDriver.unlockDevice(deviceInfo, logger);
             deviceDriver.grantAllPackageNeededPermissions(deviceInfo, recordApk, recordPackageName, false, logger);
             deviceDriver.grantPermission(deviceInfo, recordPackageName, "android.permission.FOREGROUND_SERVICE", logger);
             deviceDriver.addToBatteryWhiteList(deviceInfo, recordPackageName, logger);