Add endpoints for lock/unlock

README.md

@@ -13,16 +13,14 @@
 
 ## Missing functionality
 
-* Setting geo location (https://github.com/appium/appium/issues/6856)
 * Auto accepting/dismissing alerts (https://github.com/appium/appium/issues/6863)
 * Touch Actions support is limited. Only basic actions, like drag-n-drop, long tap, double tap and tap are supported. Gestures, which are natively supported by XCTest, are implemented via the corresponding ["mobile:" endpoints](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/ios-xctest-mobile-gestures.md)
 
 
 ## Known issues
 
 * `shake` is implemented via AppleScript and works only on Simulator due to lack of support from Apple
-* `lock` and lock-screen interaction in general is not implemented due to lack of support from Apple
-* Setting geo-location is implemented via AppleScript and works only on Simulator due to lack of support from Apple
+* Setting geo-location is implemented via AppleScript and works only on Simulator due to lack of support from Apple. In order to make it work on real devices one should have `idevicelocation` tool available.
 * Through multi action API, `zoom` works but `pinch` does not, due to Apple issue.
 
 

lib/commands/index.js

@@ -16,6 +16,7 @@ import fileMovementExtensions from './file-movement';
 import screenshotExtensions from './screenshots';
 import pasteboardExtensions from './pasteboard';
 import locationExtensions from './location';
+import lockCommands from './lock';
 import recordscreenExtensions from './recordscreen';
 
 let commands = {};
@@ -25,7 +26,6 @@ Object.assign(commands, actionsCommands, contextCommands, executeExtensions,
   generalExtensions, logExtensions, webExtensions, timeoutExtensions,
   navigationExtensions, elementExtensions, fileMovementExtensions,
   alertExtensions, screenshotExtensions, pasteboardExtensions, locationExtensions,
-  recordscreenExtensions
-);
+  recordscreenExtensions, lockCommands);
 
 export default commands;

lib/commands/lock.js

@@ -0,0 +1,29 @@
+import B from 'bluebird';
+
+let commands = {};
+
+commands.lock = async function (seconds) {
+  await this.proxyCommand('/wda/lock', 'POST');
+  if (isNaN(seconds)) {
+    return;
+  }
+
+  const floatSeconds = parseFloat(seconds);
+  if (floatSeconds <= 0) {
+    return;
+  }
+
+  await B.delay(floatSeconds * 1000);
+  await this.proxyCommand('/wda/unlock', 'POST');
+};
+
+commands.unlock = async function () {
+  await this.proxyCommand('/wda/unlock', 'POST');
+};
+
+commands.isLocked = async function () {
+  return await this.proxyCommand('/wda/locked', 'GET');
+};
+
+export { commands };
+export default commands;

lib/driver.js

@@ -71,6 +71,8 @@ const NO_PROXY_NATIVE_LIST = [
   ['POST', /back/],
   ['POST', /session\/[^\/]+\/location/], // geo location, but not element location
   ['POST', /appium\/device\/lock/],
+  ['POST', /appium\/device\/unlock/],
+  ['POST', /appium\/device\/is_locked/],
   ['POST', /shake/],
   ['POST', /clear/],
 ];

test/functional/basic/basic-e2e-specs.js

@@ -242,8 +242,14 @@ describe('XCUITestDriver - basics', function () {
   });
 
   describe('lock', function () {
-    it('should throw a not-yet-implemented error', async function () {
-      await driver.lock().should.be.rejectedWith(/Method has not yet been implemented/);
+    it('should properly lock and unlock the device', async function () {
+      try {
+        await driver.lock();
+        (await driver.isLocked()).should.be.true;
+      } finally {
+        await driver.unlock();
+      }
+      (await driver.isLocked()).should.be.false;
     });
   });