Force Software Keyboard in iOS Simulator for XCUITest

Question

I am using XCUITest to test UI behaviour when the keyboard is present - for example, if content properly moves up when the keyboard appears.

For some reason, the iOS simulator insists on regularly just disabling the software keyboard. Sometimes while the simulator is restarted, but sometimes even just when switching textfields in the middle of a test.

Is there a way to always force the software keyboard in the simulator? e.g. a command line argument or a property on XCUIDevice? I am running these tests on a CI, so manually enabling the software keyboard in the simulator is not an option.

score 16 · Answer 1 · edited Jun 20 '23 at 08:43

16

I added a prescript in Xcode. It writes defaults ConnectHardwareKeyboard NO to ~/Library/Preferences/com.apple.iphonesimulator.plist file AND quits the Simulator. Quitting simulator is important because when the tests relaunch the simulator, only then it takes into account the defaults value we wrote.

killall Simulator
defaults write com.apple.iphonesimulator ConnectHardwareKeyboard -bool false

edited Jun 20 '23 at 08:43

Marián Černý

15,096
4
70
83

answered Jul 30 '19 at 10:21

Hasaan Ali

1,192
16
22

3

killall Simulator defaults write com.apple.iphonesimulator ConnectHardwareKeyboard -bool false – kubilay Oct 22 '20 at 12:56
Please someone approve the answer update to include the script. – Pedro Paulo Amorim Oct 21 '22 at 18:23
This wont work with Xcode project with Multiple Testplans (esp when one is Unit Testplan and another is UITestplan) – Abhishek Bedi Nov 16 '22 at 07:46

score 4 · Answer 2 · edited Feb 28 '20 at 12:03

4

external_kb_connected=false

osascript -e 'quit app "Simulator"'

SIMUS_KEYBOARD=$(/usr/libexec/PlistBuddy -c "Print :DevicePreferences" ~/Library/Preferences/com.apple.iphonesimulator.plist | perl -lne 'print $1 if /^    (\S*) =/')

echo "$SIMUS_KEYBOARD" | while read -r a; do /usr/libexec/PlistBuddy -c "Set :DevicePreferences:$a:ConnectHardwareKeyboard $external_kb_connected" ~/Library/Preferences/com.apple.iphonesimulator.plist || /usr/libexec/PlistBuddy -c  "Add :DevicePreferences:$a:ConnectHardwareKeyboard bool $external_kb_connected" ~/Library/Preferences/com.apple.iphonesimulator.plist; done

Running the above script in a "Build phase" of the test target will disable the external keyboard in all simulators.

edited Feb 28 '20 at 12:03

Nick

3,958
4
32
47

answered Apr 25 '19 at 18:45

NormalGuy

97
14

It sure would be nice if Apple had a default to allow the hardware keyboard to be connected AND set the keyboard to be displayed. : / – Alex Zavatone Feb 04 '20 at 18:07
It might also be good to copy the current settings file in this script and add it to a Before Run script and have an After Run script to restore it. If I have time, I'll add it in another reply. – Alex Zavatone Feb 05 '20 at 16:56
Beautiful. Thank you! – Mike Collins Jan 14 '21 at 03:49

score -2 · Answer 3 · edited Jun 20 '20 at 09:12

-2

I had the same issue and this worked for me:

(Click on Simulator) > Hardware > Keyboard

then uncheck "Connect Hardware Keyboard"

edited Jun 20 '20 at 09:12

Community

1
1

answered Mar 27 '19 at 17:08

Len_X

825
11
29

4

Thanks for the response. I should have mentioned that the tests are run on a CI, so any manual fix for this is unfortunately not possible. Still voted the answer up since it might help somebody who is having this issue on their local machine. – BlackWolf Mar 27 '19 at 20:34
1

I think it is implied in the question that the test is automated - thus, no manual clicking on the Simulator menu to enable software keyboard. – Jacob M. Barnard Oct 09 '19 at 14:22

Force Software Keyboard in iOS Simulator for XCUITest

3 Answers3