feat: add forceTurnOnSoftwareKeyboard capability #1327
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
| @@ -166,7 +166,7 @@ Capability | Description | |||
| |`appium:orientation`|Start a test in a certain orientation|`LANDSCAPE` or `PORTRAIT`| | |||
| |`appium:scaleFactor`|Simulator scale factor. This is useful to have if the default resolution of simulated device is greater than the actual display resolution. So you can scale the simulator to see the whole device screen without scrolling.|Acceptable values for simulators running Xcode SDK 8 and older are: `'1.0', '0.75', '0.5', '0.33' and '0.25'`, where '1.0' means 100% scale. For simulators running Xcode SDK 9 and above the value could be any valid positive float number. The capability must be of a string type.| | |||
| |`appium:connectHardwareKeyboard`|Set this option to `true` in order to enable hardware keyboard in Simulator. The preference works only when Appium launches a simulator instance with this value. It is set to `false` by default, because this helps to workaround some XCTest bugs.|`true` or `false`| | |||
| |`appium:forceTurnOnSoftwareKeyboard`|Set this option to `true` in order to turn software keyboard on since Appium 1.22.0. This option helps to avoid `Keyboard is not present` error. It is set to `true` by default. Appium respect preset simulator software/hardware keyboard preference when this value is `false`. |`true` or `false`| | |||
| |`appium:forceTurnOnSoftwareKeyboard`|Set this option to `true` in order to turn software keyboard on since Appium 1.22.0. This option helps to avoid `Keyboard is not present` error. It is set to `true` by default. Appium respect preset simulator software/hardware keyboard preference when this value is `false`. This preference is prior rather than `connectHardwareKeyboard`. |`true` or `false`| | |||
There was a problem hiding this comment.
This option has priority over ...
There was a problem hiding this comment.
Please also describe the point of having two capabilities (you could just copy appium/WebDriverAgent#524 (comment))
There was a problem hiding this comment.
note: will update here later
lib/driver.js
Outdated
| @@ -986,6 +986,7 @@ class XCUITestDriver extends BaseDriver { | |||
| shouldTerminateApp: this.opts.shouldTerminateApp ?? true, | |||
| forceAppLaunch: this.opts.forceAppLaunch ?? true, | |||
| useNativeCachingStrategy: this.opts.useNativeCachingStrategy ?? true, | |||
| forceTurnOnSoftwareKeyboard: this.opts.forceTurnOnSoftwareKeyboard ?? true, | |||
There was a problem hiding this comment.
would the default still work as expected is connectHardwareKeyboard is set to true?
There was a problem hiding this comment.
Yes, this caps works when creating a new session. the hardware keyboard is when preparing a simulator instance. This capability set the software keyboard when I tested on my local. (If I didn't missed some steps...)
README.md
Outdated
| @@ -165,7 +165,8 @@ Capability | Description | |||
| |----------|-----------|------| | |||
| |`appium:orientation`|Start a test in a certain orientation|`LANDSCAPE` or `PORTRAIT`| | |||
| |`appium:scaleFactor`|Simulator scale factor. This is useful to have if the default resolution of simulated device is greater than the actual display resolution. So you can scale the simulator to see the whole device screen without scrolling.|Acceptable values for simulators running Xcode SDK 8 and older are: `'1.0', '0.75', '0.5', '0.33' and '0.25'`, where '1.0' means 100% scale. For simulators running Xcode SDK 9 and above the value could be any valid positive float number. The capability must be of a string type.| | |||
| |`appium:connectHardwareKeyboard`|Set this option to `true` in order to enable hardware keyboard in Simulator. It is set to `false` by default, because this helps to workaround some XCTest bugs.|`true` or `false`| | |||
| |`appium:connectHardwareKeyboard`|Set this option to `true` in order to enable hardware keyboard in Simulator. The preference works only when Appium launches a simulator instance with this value. It is set to `false` by default, because this helps to workaround some XCTest bugs.|`true` or `false`| | |||
| |`appium:forceSimulatorSoftwareKeyboardPresence`|Set this option to `true` in order to turn software keyboard on and turn hardware keyboard off in Simulator since Appium 1.22.0. This option helps to avoid `Keyboard is not present` error. It is set to `true` by default. Appium respects preset simulator software/hardware keyboard preference when this value is `false`, so `connectHardwareKeyboard: false` and `forceSimulatorSoftwareKeyboardPresence: false` means Appium keeps preset simulator keyboard preference. This option has priority over `connectHardwareKeyboard`. |`true` or `false`| | |||
There was a problem hiding this comment.
..means for Appium to keep the current Simulator keyboard preferences
lib/driver.js
Outdated
| @@ -986,6 +986,7 @@ class XCUITestDriver extends BaseDriver { | |||
| shouldTerminateApp: this.opts.shouldTerminateApp ?? true, | |||
| forceAppLaunch: this.opts.forceAppLaunch ?? true, | |||
| useNativeCachingStrategy: this.opts.useNativeCachingStrategy ?? true, | |||
| forceSimulatorSoftwareKeyboardPresence: this.opts.forceSimulatorSoftwareKeyboardPresence ?? true, | |||
There was a problem hiding this comment.
how about
forceSimulatorSoftwareKeyboardPresence: this.opts.forceSimulatorSoftwareKeyboardPresence
?? (this.opts.connectHardwareKeyboard === true ? false : true) ,
There was a problem hiding this comment.
ok, no objection to it
…eKeyboard is true and no forceSimulatorSoftwareKeyboardPresence
README.md
Outdated
| @@ -165,7 +165,8 @@ Capability | Description | |||
| |----------|-----------|------| | |||
| |`appium:orientation`|Start a test in a certain orientation|`LANDSCAPE` or `PORTRAIT`| | |||
| |`appium:scaleFactor`|Simulator scale factor. This is useful to have if the default resolution of simulated device is greater than the actual display resolution. So you can scale the simulator to see the whole device screen without scrolling.|Acceptable values for simulators running Xcode SDK 8 and older are: `'1.0', '0.75', '0.5', '0.33' and '0.25'`, where '1.0' means 100% scale. For simulators running Xcode SDK 9 and above the value could be any valid positive float number. The capability must be of a string type.| | |||
| |`appium:connectHardwareKeyboard`|Set this option to `true` in order to enable hardware keyboard in Simulator. It is set to `false` by default, because this helps to workaround some XCTest bugs.|`true` or `false`| | |||
| |`appium:connectHardwareKeyboard`|Set this option to `true` in order to enable hardware keyboard in Simulator. The preference works only when Appium launches a simulator instance with this value. It is set to `false` by default, because this helps to workaround some XCTest bugs. `connectHardwareKeyboard: true` makes `forceSimulatorSoftwareKeyboardPresence: false` if no `forceSimulatorSoftwareKeyboardPresence` in the capability since Appium 1.22.0. |`true` or `false`| | |||
There was a problem hiding this comment.
... if no explicit value is set for forceSimulatorSoftwareKeyboardPresence capability ...
mykola-mokhnach
approved these changes
Aug 16, 2021
github-actions bot
pushed a commit
that referenced
this pull request
Aug 16, 2021
# [3.52.0](v3.51.1...v3.52.0) (2021-08-16) ### Features * add forceTurnOnSoftwareKeyboard capability ([#1327](#1327)) ([2a05efc](2a05efc))
|
🎉 This PR is included in version 3.52.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To make appium/WebDriverAgent#524 configurable via capabilities.
This Pr needs to bump WDA dependency after appium/WebDriverAgent#524 merge