xcmonkey 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a6aa190c1c4cfa28f97b20524c907da488aad2d78f2c1dda8f827899f6ee53f
-  data.tar.gz: 534245a695ed0f030df459986c326fb356b3593baec3bc6750eb1cc622d32390
+  metadata.gz: 48bd9b79b2370e4f20366973e689af344f6c75729b361658fbc5bb2c02c38253
+  data.tar.gz: c207e8dbe7c820623f60a9c0b9e8ea8a7e5bce18bfe10f9d5c27e8928829889d
 SHA512:
-  metadata.gz: 41415c8c576a3b6887ee87d44f4c4e571f1e7abda3a96f23abff52cebe77438be70ee76ab18f83a92b78cca2da429cf0c12305b2d3a8ca59b0b2e7e26405ec23
-  data.tar.gz: 93d86451b2b7b8d2a755744ea47be375d042763ea550ddbdef5faff530bbf775e46ab24ede0f6d9dfe424f02ef4c2a923ccd3f342d1872cd6f4d82dcefae7cef
+  metadata.gz: 9c0f1f52ad5e8118799556e4e1ba3a49574c504cf2a840fe0369e06c6dbab260fd0a9c275ada9efb789a865759ac48f7d46f9348cde5b2cb53a44969b5189cf9
+  data.tar.gz: 761ffee247c8646bc24dee5fd3f473414402033d3c9a773fe87623579aef93155ecbafc3d412111396945ae485d74b28d6916e5e287754a82b15fcfc792b0c47

data/.github/FUNDING.yml

@@ -1,3 +1,2 @@
 custom: [ 'https://revolut.me/alteral', 'https://paypal.me/aapesotskiy' ]
-github: alteral
 ko_fi: alteral

data/.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
   chat:
     name: Automated Code Review
     runs-on: macos-12
-    timeout-minutes: 15
+    timeout-minutes: 30
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

data/README.md

@@ -9,9 +9,13 @@
   <a href="/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat" /></a>
 </p>
 
-*xcmonkey* is a tool for doing randomised UI testing of iOS apps.
+## Description
 
-## Requirements
+*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.
+
+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).
+
+## Prerequisites
 
 ```bash
 brew install facebook/fb/idb-companion
@@ -24,22 +28,28 @@ pip3.6 install fb-idb
 gem install xcmonkey
 ```
 
+If you prefer to use [*bundler*](https://bundler.io/), add the following line to your `Gemfile`:
+
+```ruby
+gem 'xcmonkey'
+```
+
 ## Usage
 
-### Test
+### To run a stress test
 
 ```bash
-$ xcmonkey test --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA" --bundle-id "com.apple.mobilesafari"
+$ xcmonkey test --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA" --bundle-id "com.apple.Maps" --duration 100
 12:44:19.343: 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
 
-12:44:22.550: App info: com.apple.mobilesafari | MobileSafari | system | x86_64, arm64 | Running | Not Debuggable | pid=43398
+12:44:22.550: App info: com.apple.Maps | Maps | system | arm64, x86_64 | Running | Not Debuggable | pid=74636
 
 12:44:23.203: Tap: {
   "x": 53,
   "y": 749
 }
 
-12:44:23.511: Swipe: {
+12:44:23.511: Swipe (0.5s): {
   "x": 196,
   "y": 426
 } => {
@@ -47,39 +57,37 @@ $ xcmonkey test --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA" --bundle-id "com.a
   "y": 447
 }
 
-12:44:24.355: Tap: {
+12:44:24.355: Press (1.2s): {
   "x": 143,
   "y": 323
 }
 ```
 
-### Describe point
+### To describe the required point
 
 ```bash
-$ xcmonkey describe -x 125 -y 760 --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA"
-12:41:03.840: 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
+$ 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
 
-12:41:05.342: x:125 y:760 point info: {
-  "AXFrame": "{{120, 759}, {64, 64}}",
-  "AXUniqueId": "Safari",
+20:05:21.713: x:20 y:625 point info: {
+  "AXFrame": "{{19, 624.3}, {86, 130.6}}",
+  "AXUniqueId": "ShortcutsRowCell",
   "frame": {
-    "y": 759,
-    "x": 120,
-    "width": 64,
-    "height": 64
+    "y": 624.3,
+    "x": 19,
+    "width": 86,
+    "height": 130.6
   },
   "role_description": "button",
-  "AXLabel": "Safari",
+  "AXLabel": "Home",
   "content_required": false,
   "type": "Button",
   "title": null,
-  "help": "Double tap to open",
+  "help": null,
   "custom_actions": [
-    "Edit mode",
-    "Today",
-    "App Library"
+
   ],
-  "AXValue": "",
+  "AXValue": "Add",
   "enabled": true,
   "role": "AXButton",
   "subrole": null

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
 
@@ -18,11 +19,23 @@ class Driver
       when :precise_tap
         tap(coordinates: el1_coordinates)
       when :blind_tap
-        x = (el1_coordinates[:x] - el2_coordinates[:x]).abs
-        y = (el1_coordinates[:y] - el2_coordinates[:y]).abs
-        tap(coordinates: { x: x, y: y })
-      when :swipe
-        swipe(start_coordinates: el1_coordinates, end_coordinates: el2_coordinates)
+        tap(coordinates: random_coordinates)
+      when :precise_press
+        press(coordinates: el1_coordinates, duration: press_duration)
+      when :blind_press
+        press(coordinates: random_coordinates, duration: press_duration)
+      when :precise_swipe
+        swipe(
+          start_coordinates: el1_coordinates,
+          end_coordinates: el2_coordinates,
+          duration: swipe_duration
+        )
+      when :blind_swipe
+        swipe(
+          start_coordinates: random_coordinates,
+          end_coordinates: random_coordinates,
+          duration: swipe_duration
+        )
       else
         next
       end
@@ -31,9 +44,9 @@ class Driver
     end
   end
 
-  def open_home_screen(return_tracker: false)
+  def open_home_screen(with_tracker: false)
     `idb ui button --udid #{udid} HOME`
-    detect_home_unique_element if return_tracker
+    detect_home_unique_element if with_tracker
   end
 
   def describe_ui
@@ -57,13 +70,19 @@ class Driver
 
   def boot_simulator
     `idb boot #{udid}`
-    ensure_simulator_was_booted
+    Logger.error("Failed to boot #{udid}") if device_info['state'] != 'Booted'
   end
 
   def shutdown_simulator
     `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
@@ -80,13 +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')
-  end
 
-  def ensure_simulator_was_booted
-    sim = list_booted_simulators.detect { |target| target.include?(udid) }
-    Logger.error("Failed to boot #{udid}") if sim.nil?
+    Logger.info('Device info:', payload: device)
+    if device.include?('simulator')
+      configure_simulator_keyboard
+      boot_simulator
+    end
   end
 
   def list_apps
@@ -98,20 +116,58 @@ class Driver
     `idb ui tap --udid #{udid} #{coordinates[:x]} #{coordinates[:y]}`
   end
 
-  def swipe(start_coordinates:, end_coordinates:)
-    Logger.info('Swipe:', payload: "#{JSON.pretty_generate(start_coordinates)} => #{JSON.pretty_generate(end_coordinates)}")
+  def press(coordinates:, duration:)
+    Logger.info("Press (#{duration}s):", payload: JSON.pretty_generate(coordinates))
+    `idb ui tap --udid #{udid} --duration #{duration} #{coordinates[:x]} #{coordinates[:y]}`
+  end
+
+  def swipe(start_coordinates:, end_coordinates:, duration:)
+    Logger.info(
+      "Swipe (#{duration}s):",
+      payload: "#{JSON.pretty_generate(start_coordinates)} => #{JSON.pretty_generate(end_coordinates)}"
+    )
     coordinates = "#{start_coordinates[:x]} #{start_coordinates[:y]} #{end_coordinates[:x]} #{end_coordinates[:y]}"
-    `idb ui swipe --udid #{udid} --duration 0.5 #{coordinates}`
+    `idb ui swipe --udid #{udid} --duration #{duration} #{coordinates}`
   end
 
   def central_coordinates(element)
     frame = element['frame']
+    x = (frame['x'] + (frame['width'] / 2)).abs.to_i
+    y = (frame['y'] + (frame['height'] / 2)).abs.to_i
+    {
+      x: x > screen_size[:width].to_i ? rand(0..screen_size[:width].to_i) : x,
+      y: y > screen_size[:height].to_i ? rand(0..screen_size[:height].to_i) : y
+    }
+  end
+
+  def random_coordinates
     {
-      x: (frame['x'] + (frame['width'] / 2)).to_i,
-      y: (frame['y'] + (frame['height'] / 2)).to_i
+      x: rand(0..screen_size[:width].to_i),
+      y: rand(0..screen_size[:height].to_i)
     }
   end
 
+  def device_info
+    @device_info ||= JSON.parse(`idb describe --udid #{udid} --json`)
+    @device_info
+  end
+
+  def screen_size
+    screen_dimensions = device_info['screen_dimensions']
+    {
+      width: screen_dimensions['width_points'],
+      height: screen_dimensions['height_points']
+    }
+  end
+
+  def swipe_duration
+    rand(0.1..0.7).ceil(1)
+  end
+
+  def press_duration
+    rand(0.5..1.5).ceil(1)
+  end
+
   private
 
   def ensure_driver_installed

data/lib/xcmonkey/version.rb

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

data/lib/xcmonkey.rb

@@ -21,13 +21,16 @@ module Xcmonkey
 			driver.ensure_device_exists
 			driver.ensure_app_installed
 			driver.terminate_app
-			driver.open_home_screen(return_tracker: true)
+			driver.open_home_screen(with_tracker: true)
 			driver.launch_app
 			driver.monkey_test(gestures)
     end
 
 		def gestures
-			[:precise_tap, :blind_tap, :swipe]
+			taps = [:precise_tap, :blind_tap] * 10
+			swipes = [:precise_swipe, :blind_swipe] * 5
+			presses = [:precise_press, :blind_press]
+			taps + swipes + presses
 		end
 
 		def ensure_required_params(params)

data/spec/driver_spec.rb

@@ -6,8 +6,7 @@ describe Driver do
   it 'verifies that sumulator was booted' do
     error_message = "Failed to boot #{udid}"
     expect(Logger).not_to receive(:error).with(error_message, payload: nil)
-    expect(driver).to receive(:ensure_simulator_was_booted)
-    driver.boot_simulator
+    expect { driver.boot_simulator }.not_to raise_error
   end
 
   it 'verifies that there are booted simulators' do
@@ -24,10 +23,16 @@ describe Driver do
 
   it 'verifies that home screen can be opened' do
     driver.boot_simulator
-    home_tracker = driver.open_home_screen(return_tracker: true)
+    home_tracker = driver.open_home_screen(with_tracker: true)
     expect(home_tracker).not_to be_empty
   end
 
+  it 'verifies that home screen can be opened without tracker' do
+    driver.boot_simulator
+    home_tracker = driver.open_home_screen(with_tracker: false)
+    expect(home_tracker).to be_nil
+  end
+
   it 'verifies that list of targets can be showed' do
     list_targets = driver.list_targets
     expect(list_targets).not_to be_empty
@@ -85,6 +90,58 @@ describe Driver do
     expect(actual_coordinates).to eq(expected_coordinates)
   end
 
+  it 'verifies that device info can be for booted simulator' do
+    driver.boot_simulator
+    expect(driver.device_info).not_to be_empty
+  end
+
+  it 'verifies that device info can be for not booted simulator' do
+    driver.shutdown_simulator
+    expect(driver.device_info).not_to be_empty
+  end
+
+  it 'verifies that screen size can be found' do
+    driver.boot_simulator
+    screen_size = driver.screen_size
+    expect(screen_size[:width]).to be > 0
+    expect(screen_size[:height]).to be > 0
+  end
+
+  it 'verifies that random coordinates can be found' do
+    driver.boot_simulator
+    coordinates = driver.random_coordinates
+    expect(coordinates[:x]).to be > 0
+    expect(coordinates[:y]).to be > 0
+  end
+
+  it 'verifies swipe duration' do
+    expect(driver.swipe_duration).to be_between(0.1, 0.7)
+  end
+
+  it 'verifies press duration' 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)
@@ -93,10 +150,35 @@ describe Driver do
     expect { driver.launch_app }.not_to raise_error
   end
 
+  it 'verifies tap' do
+    driver.boot_simulator
+    coordinates = { x: 1, y: 1 }
+    expect(Logger).to receive(:info).with('Tap:', payload: JSON.pretty_generate(coordinates))
+    driver.tap(coordinates: coordinates)
+  end
+
+  it 'verifies press' do
+    driver.boot_simulator
+    duration = 0.5
+    coordinates = { x: 1, y: 1 }
+    expect(Logger).to receive(:info).with("Press (#{duration}s):", payload: JSON.pretty_generate(coordinates))
+    driver.press(coordinates: coordinates, duration: duration)
+  end
+
+  it 'verifies swipe' do
+    driver.boot_simulator
+    duration = 0.5
+    start_coordinates = { x: 1, y: 1 }
+    end_coordinates = { x: 2, y: 2 }
+    expect(Logger).to receive(:info).with("Swipe (#{duration}s):", payload: "#{JSON.pretty_generate(start_coordinates)} => #{JSON.pretty_generate(end_coordinates)}")
+    driver.swipe(start_coordinates: start_coordinates, end_coordinates: end_coordinates, duration: duration)
+  end
+
   it 'verifies that simulator was not booted' do
     driver.shutdown_simulator
     error_message = "Failed to boot #{udid}"
+    allow(driver).to receive(:device_info).and_return({ 'state' => 'Unknown' })
     expect(Logger).to receive(:log).with(error_message, color: :light_red, payload: nil)
-    expect { driver.ensure_simulator_was_booted }.to raise_error(SystemExit) { |e| expect(e.status).to eq(1) }
+    expect { driver.boot_simulator }.to raise_error(SystemExit) { |e| expect(e.status).to eq(1) }
   end
 end

data/spec/logger_spec.rb

@@ -33,4 +33,24 @@ describe Logger do
     expect { described_class.error(message, payload: payload) }
       .to raise_error(SystemExit) { |e| expect(e.status).to eq(1) }
   end
+
+  it 'verifies custom log without payload' do
+    color = :blue
+    time = Time.now
+    allow(Time).to receive(:now).and_return(time)
+    expected_output = "#{time.strftime('%k:%M:%S.%L')}: #{message}".colorize(color)
+    expect do
+      described_class.log(message, color: color, payload: nil)
+    end.to output("#{expected_output}\n\n").to_stdout
+  end
+
+  it 'verifies custom log with payload' do
+    color = :blue
+    time = Time.now
+    allow(Time).to receive(:now).and_return(time)
+    expected_output = "#{time.strftime('%k:%M:%S.%L')}: #{message}".colorize(color)
+    expect do
+      described_class.log(message, color: color, payload: payload)
+    end.to output("#{expected_output} #{payload.colorize(:light_green)}\n\n").to_stdout
+  end
 end

data/spec/xcmonkey_spec.rb

@@ -5,7 +5,10 @@ describe Xcmonkey do
 
     it 'verifies gestures' do
       gestures = described_class.new(params).gestures
-      expect(gestures) =~ [:swipe, :precise_tap, :blind_tap]
+      taps = [:precise_tap, :blind_tap] * 10
+      swipes = [:precise_swipe, :blind_swipe] * 5
+      presses = [:precise_press, :blind_press]
+      expect(gestures) =~ presses + taps + swipes
     end
 
     it 'verifies required params' do
@@ -42,5 +45,14 @@ describe Xcmonkey do
       expect(Logger).to receive(:error).with(duration_error_msg)
       described_class.new(params)
     end
+
+    it 'verifies version' do
+      current_version = Gem::Version.new(Xcmonkey::VERSION)
+      expect(current_version).to be > Gem::Version.new('0.1.0')
+    end
+
+    it 'verifies gem name' do
+      expect(Xcmonkey::GEM_NAME).to eq('xcmonkey')
+    end
   end
 end

metadata

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