xcmonkey 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be6683e9fefe9666fb294e9939f5ebd83c71915307002dc6425413dfd1d9ae8b
-  data.tar.gz: d4782c2269b36dd950b7567c88d554c7b000cc81452f79e6659d4061135c1ebe
+  metadata.gz: 48bd9b79b2370e4f20366973e689af344f6c75729b361658fbc5bb2c02c38253
+  data.tar.gz: c207e8dbe7c820623f60a9c0b9e8ea8a7e5bce18bfe10f9d5c27e8928829889d
 SHA512:
-  metadata.gz: d027d46289c6ea5bfba7359ff5c0b8172ea7d12d5d9cd1019a428b7b74416e6562930db5ce14508198937caed55ac2b5f1c68f1ce34c82fbe6ecbf3a92ea7100
-  data.tar.gz: 6d336b581f1bb93db017414b7080e038557200909e8a87b3a23c37fce4dfdd62b9fc5186c45272e662002f073c00a800f172488495b9bf84cd91d0a9089e275c
+  metadata.gz: 9c0f1f52ad5e8118799556e4e1ba3a49574c504cf2a840fe0369e06c6dbab260fd0a9c275ada9efb789a865759ac48f7d46f9348cde5b2cb53a44969b5189cf9
+  data.tar.gz: 761ffee247c8646bc24dee5fd3f473414402033d3c9a773fe87623579aef93155ecbafc3d412111396945ae485d74b28d6916e5e287754a82b15fcfc792b0c47

data/README.md

@@ -11,13 +11,11 @@
 
 ## Description
 
-*xcmonkey* is a tool for doing randomised UI testing of iOS apps.
+*xcmonkey* is a tool for doing randomised UI testing of iOS apps. It's inspired by and has similar goals to [*monkey*](https://developer.android.com/studio/test/monkey) on Android.
 
-It is inspired by and has similar goals to Android [monkey](https://developer.android.com/studio/test/monkey).
+Under the hood, *xcmonkey* uses [iOS Development Bridge](https://fbidb.io/) as a driver, that's why it's pretty smart and can do a lot of things, such as taps, swipes and presses. All that comes «pseudo-random» because it has access to the screen hierarchy, and so can either do actions blindly (like tapping on random points) or precisely (like tapping on the existing elements).
 
-*xcmonkey* uses [idb](https://fbidb.io) as a driver that's why it's quite smart and can do a lot of things, such as taps, swipes and presses. Because *xcmonkey* has access to the screen hierarchy, it can either do things blindly (like tapping on random points) or precisely (like tapping on the existing elements).
-
-## Requirements
+## Prerequisites
 
 ```bash
 brew install facebook/fb/idb-companion
@@ -30,7 +28,7 @@ pip3.6 install fb-idb
 gem install xcmonkey
 ```
 
-If you prefer to use [bundler](https://bundler.io/), add the following line to your `Gemfile`:
+If you prefer to use [*bundler*](https://bundler.io/), add the following line to your `Gemfile`:
 
 ```ruby
 gem 'xcmonkey'
@@ -72,13 +70,13 @@ $ xcmonkey describe -x 20 -y 625 --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA"
 20:05:20.212: Device info: iPhone 14 Pro | 413EA256-CFFB-4312-94A6-12592BEE4CBA | Booted | simulator | iOS 16.2 | x86_64 | /tmp/idb/413EA256-CFFB-4312-94A6-12592BEE4CBA_companion.sock
 
 20:05:21.713: x:20 y:625 point info: {
-  "AXFrame": "{{19, 624.33333333333337}, {86, 130.66666666666663}}",
+  "AXFrame": "{{19, 624.3}, {86, 130.6}}",
   "AXUniqueId": "ShortcutsRowCell",
   "frame": {
-    "y": 624.3333333333334,
+    "y": 624.3,
     "x": 19,
     "width": 86,
-    "height": 130.66666666666663
+    "height": 130.6
   },
   "role_description": "button",
   "AXLabel": "Home",

data/bin/xcmonkey

@@ -16,13 +16,15 @@ module Xcmonkey
     c.description = 'Runs monkey test'
     c.option('-u', '--udid STRING', String, 'Set device UDID')
     c.option('-b', '--bundle-id STRING', String, 'Set target bundle identifier')
-    c.option('-d', '--duration SECONDS', Integer, 'Test duration in seconds')
+    c.option('-d', '--duration SECONDS', Integer, 'Test duration in seconds. Defaults to `60`')
+    c.option('-k', '--enable-simulator-keyboard', 'Should simulator keyboard be enabled? Defaults to `true`')
     c.action do |args, options|
-      options.default(duration: 60)
+      options.default(duration: 60, enable_simulator_keyboard: true)
       params = {
         udid: options.udid,
         bundle_id: options.bundle_id,
-        duration: options.duration
+        duration: options.duration,
+        simulator_keyboard: options.enable_simulator_keyboard
       }
       Xcmonkey.new(params).run
     end

data/lib/xcmonkey/driver.rb

@@ -1,10 +1,11 @@
 class Driver
-  attr_accessor :udid, :bundle_id, :duration
+  attr_accessor :udid, :bundle_id, :duration, :enable_simulator_keyboard
 
   def initialize(params)
     self.udid = params[:udid]
     self.bundle_id = params[:bundle_id]
     self.duration = params[:duration]
+    self.enable_simulator_keyboard = params[:enable_simulator_keyboard]
     ensure_driver_installed
   end
 
@@ -76,6 +77,12 @@ class Driver
     `idb shutdown #{udid}`
   end
 
+  def configure_simulator_keyboard
+    shutdown_simulator
+    keyboard_status = enable_simulator_keyboard ? 0 : 1
+    `defaults write com.apple.iphonesimulator ConnectHardwareKeyboard #{keyboard_status}`
+  end
+
   def list_targets
     @list_targets ||= `idb list-targets`.split("\n")
     @list_targets
@@ -92,8 +99,12 @@ class Driver
   def ensure_device_exists
     device = list_targets.detect { |target| target.include?(udid) }
     Logger.error("Can't find device #{udid}") if device.nil?
+
     Logger.info('Device info:', payload: device)
-    boot_simulator if device.include?('simulator')
+    if device.include?('simulator')
+      configure_simulator_keyboard
+      boot_simulator
+    end
   end
 
   def list_apps

data/lib/xcmonkey/version.rb

@@ -1,4 +1,4 @@
 module Xcmonkey
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
   GEM_NAME = 'xcmonkey'
 end

data/spec/driver_spec.rb

@@ -122,6 +122,26 @@ describe Driver do
     expect(driver.press_duration).to be_between(0.5, 1.5)
   end
 
+  it 'verifies that simulator keyboard can be enabled' do
+    allow(driver).to receive(:is_simulator_keyboard_enabled?).and_return(false)
+    driver = described_class.new(udid: udid, bundle_id: bundle_id, enable_simulator_keyboard: true)
+    expect(driver).to receive(:shutdown_simulator)
+    driver.configure_simulator_keyboard
+    keyboard_state = `defaults read com.apple.iphonesimulator`.split("\n").grep(/ConnectHardwareKeyboard/)
+    expect(keyboard_state).not_to be_empty
+    expect(keyboard_state.first).to include('0')
+  end
+
+  it 'verifies that simulator keyboard can be disabled' do
+    allow(driver).to receive(:is_simulator_keyboard_enabled?).and_return(true)
+    driver = described_class.new(udid: udid, bundle_id: bundle_id, enable_simulator_keyboard: false)
+    expect(driver).to receive(:shutdown_simulator)
+    driver.configure_simulator_keyboard
+    keyboard_state = `defaults read com.apple.iphonesimulator`.split("\n").grep(/ConnectHardwareKeyboard/)
+    expect(keyboard_state).not_to be_empty
+    expect(keyboard_state.first).to include('1')
+  end
+
   it 'verifies that app can be launched' do
     expect(Logger).not_to receive(:error)
     expect(Logger).to receive(:info)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcmonkey
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - alteral
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2023-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler