xcmonkey 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be5b38b4ec7977038ba4f739a4516a376bc79652447a0cc52c10465ea85657d2
-  data.tar.gz: 97d3eefd65f8a438bfb2ed2919bdaa6bf42e0324235d10a7f7df5b0ede316d88
+  metadata.gz: c93c94403332c085a393877d88d354b2736788f6e52d118eb8b9faa70c91b1e5
+  data.tar.gz: ee0f3bfcd014151b4821a6df50f601205581ebd480b5626e33588bda2928981a
 SHA512:
-  metadata.gz: 94b8daa5da4df0d18b1644bf9d110978c070ba032e661d4bf1079f7fad90a2ed6df553bc8685a7267d7f819159ac615474c88c4ebdd6e00627b74339cc2f9e0e
-  data.tar.gz: 66fe245043c8f4887a3849c7e60bc6b8ee81cecfb56781f409e09a6651511d009acd2a2284e3534d67ef59abffb5432b3d85ff9495a951a4fc26dbd44bff38fb
+  metadata.gz: 0ab88db343b0e83363130a9e9c8ed965acbf9d58f56d597b301ff12da4df9d4e79b08c3b2284b870a65c9bfc3d05a8ba9df0d19409631620a28836c9d5785814
+  data.tar.gz: fe46af5c215273be9210f3c880617457a12c6063e0bd1901d6abbd10750f10935b77a4797ff374926c3f1cac6b1ef79032f210fb705e05917146e4c64cede97c

data/.github/{issue_template/feature_request.md → ISSUE_TEMPLATE/feature-request.md}

@@ -1,5 +1,5 @@
 ---
-name: Feature Request
+name: Feature request
 about: Got any ideas about new features? Let us know!
 title: ''
 labels: ''

data/.github/workflows/test.yml

@@ -17,10 +17,11 @@ jobs:
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      PR_NUMBER: ${{ github.event.number }}
     steps:
-      - uses: actions/checkout@v3.2.0
+      - uses: actions/checkout@v3.3.0
 
-      - uses: actions/setup-python@v4.4.0
+      - uses: actions/setup-python@v4.5.0
         with:
           python-version: 3.11
           cache: 'pip'

data/README.md

@@ -39,10 +39,32 @@ gem 'xcmonkey'
 ### To run a stress test
 
 ```bash
-$ 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
+$ xcmonkey test --duration 100 --bundle-id "com.apple.Maps" --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA"
+
+12:44:19.343: Device info: {
+  "name": "iPhone 14 Pro",
+  "udid": "413EA256-CFFB-4312-94A6-12592BEE4CBA",
+  "state": "Booted",
+  "type": "simulator",
+  "os_version": "iOS 16.2",
+  "architecture": "x86_64",
+  "path": "/tmp/idb/413EA256-CFFB-4312-94A6-12592BEE4CBA_companion.sock",
+  "is_local": true,
+  "companion": "/tmp/idb/413EA256-CFFB-4312-94A6-12592BEE4CBA_companion.sock"
+}
 
-12:44:22.550: App info: com.apple.Maps | Maps | system | arm64, x86_64 | Running | Not Debuggable | pid=74636
+12:44:22.550: App info: {
+  "bundle_id": "com.apple.Maps",
+  "name": "Maps",
+  "install_type": "system",
+  "architectures": [
+    "x86_64",
+    "arm64"
+  ],
+  "process_state": "Running",
+  "debuggable": false,
+  "pid": "49186"
+}
 
 12:44:23.203: Tap: {
   "x": 53,
@@ -66,59 +88,29 @@ $ xcmonkey test --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA" --bundle-id "com.a
 ### To repeat the stress test from generated session
 
 ```bash
-$ xcmonkey repeat --session-path "./xcmonkey-session.json"
-12:48:13.333: 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:48:16.542: App info: com.apple.Maps | Maps | system | arm64, x86_64 | Running | Not Debuggable | pid=73416
-
-12:48:20.195: Tap: {
-  "x": 53,
-  "y": 749
-}
-
-12:48:20.404: Swipe (0.5s): {
-  "x": 196,
-  "y": 426
-} => {
-  "x": 143,
-  "y": 447
-}
-
-12:48:21.155: Press (1.2s): {
-  "x": 143,
-  "y": 323
-}
+xcmonkey repeat --session-path "./xcmonkey-session.json"
 ```
 
 ### To describe the required point
 
 ```bash
-$ 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.3}, {86, 130.6}}",
-  "AXUniqueId": "ShortcutsRowCell",
-  "frame": {
-    "y": 624.3,
-    "x": 19,
-    "width": 86,
-    "height": 130.6
-  },
-  "role_description": "button",
-  "AXLabel": "Home",
-  "content_required": false,
-  "type": "Button",
-  "title": null,
-  "help": null,
-  "custom_actions": [
+xcmonkey describe -x 20 -y 625 --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA"
+```
 
-  ],
-  "AXValue": "Add",
-  "enabled": true,
-  "role": "AXButton",
-  "subrole": null
-}
+## [fastlane](https://github.com/fastlane/fastlane) integration
+
+To run *xcmonkey* from *fastlane*, add the following code to your `Fastfile`:
+
+```ruby
+require 'xcmonkey'
+
+lane :test do
+  Xcmonkey.new(
+    duration: 100,
+    bundle_id: 'com.apple.Maps',
+    udid: '413EA256-CFFB-4312-94A6-12592BEE4CBA'
+  ).run
+end
 ```
 
 ## Code of Conduct

data/bin/xcmonkey

@@ -8,7 +8,7 @@ require_relative '../lib/xcmonkey/logger'
 require_relative '../lib/xcmonkey/driver'
 require_relative '../lib/xcmonkey/version'
 
-module Xcmonkey
+class Xcmonkey
   program :version, VERSION
   program :description, 'xcmonkey is a tool for doing randomised UI testing of iOS apps'
 
@@ -21,11 +21,6 @@ module Xcmonkey
     c.option('-k', '--enable-simulator-keyboard', 'Should simulator keyboard be enabled? Defaults to `true`')
     c.option('-s', '--session-path STRING', String, 'Path where monkey testing session should be saved. Defaults to current directory')
     c.action do |_, options|
-      options.default(
-        duration: 60,
-        session_path: Dir.pwd,
-        enable_simulator_keyboard: true
-      )
       params = {
         udid: options.udid,
         bundle_id: options.bundle_id,

data/lib/xcmonkey/describer.rb

@@ -1,21 +1,21 @@
 class Describer
-	attr_accessor :x, :y, :driver
+  attr_accessor :x, :y, :driver
 
-	def initialize(params)
-		ensure_required_params(params)
-		self.x = params[:x]
-		self.y = params[:y]
-		self.driver = Driver.new(params)
-	end
+  def initialize(params)
+    ensure_required_params(params)
+    self.x = params[:x]
+    self.y = params[:y]
+    self.driver = Driver.new(params)
+  end
 
-	def run
-		driver.ensure_device_exists
-		driver.describe_point(x, y)
-	end
+  def run
+    driver.ensure_device_exists
+    driver.describe_point(x, y)
+  end
 
-	def ensure_required_params(params)
-		Logger.error('UDID should be provided') if params[:udid].nil?
-		Logger.error('`x` point coordinate should be provided') if params[:x].nil? || params[:x].to_i.to_s != params[:x].to_s
-		Logger.error('`y` point coordinate should be provided') if params[:y].nil? || params[:y].to_i.to_s != params[:y].to_s
-	end
+  def ensure_required_params(params)
+    Logger.error('UDID should be provided') if params[:udid].nil?
+    Logger.error('`x` point coordinate should be provided') if params[:x].nil? || params[:x].to_i.to_s != params[:x].to_s
+    Logger.error('`y` point coordinate should be provided') if params[:y].nil? || params[:y].to_i.to_s != params[:y].to_s
+  end
 end

data/lib/xcmonkey/driver.rb

@@ -13,17 +13,19 @@ class Driver
   end
 
   def monkey_test_precondition
+    puts
     ensure_device_exists
     ensure_app_installed
-    terminate_app
-    open_home_screen(with_tracker: true)
-    launch_app
+    terminate_app(bundle_id)
+    launch_app(target_bundle_id: bundle_id, wait_for_state_update: true)
+    @running_apps = list_running_apps
   end
 
   def monkey_test(gestures)
     monkey_test_precondition
     app_elements = describe_ui.shuffle
     current_time = Time.now
+    counter = 0
     while Time.now < current_time + session_duration
       el1_coordinates = central_coordinates(app_elements.first)
       el2_coordinates = central_coordinates(app_elements.last)
@@ -51,17 +53,17 @@ class Driver
       else
         next
       end
+      detect_app_state_change
+      track_running_apps if counter % 5 == 0 # Track running apps after every 5th action to speed up the test
+      counter += 1
       app_elements = describe_ui.shuffle
-      next unless app_elements.include?(@home_tracker)
-
-      save_session
-      Logger.error('App lost')
     end
     save_session
   end
 
   def repeat_monkey_test
     monkey_test_precondition
+    counter = 0
     session_actions.each do |action|
       case action['type']
       when 'tap'
@@ -74,16 +76,15 @@ class Driver
           end_coordinates: { x: action['endX'], y: action['endY'] },
           duration: action['duration']
         )
+      else
+        next
       end
-      Logger.error('App lost') if describe_ui.shuffle.include?(@home_tracker)
+      detect_app_state_change
+      track_running_apps if counter % 5 == 0
+      counter += 1
     end
   end
 
-  def open_home_screen(with_tracker: false)
-    `idb ui button --udid #{udid} HOME`
-    detect_home_unique_element if with_tracker
-  end
-
   def describe_ui
     JSON.parse(`idb ui describe-all --udid #{udid}`)
   end
@@ -94,13 +95,13 @@ class Driver
     point_info
   end
 
-  def launch_app
-    `idb launch --udid #{udid} #{bundle_id}`
-    wait_until_app_launched
+  def launch_app(target_bundle_id:, wait_for_state_update: false)
+    `idb launch --udid #{udid} #{target_bundle_id}`
+    wait_until_app_launched(target_bundle_id) if wait_for_state_update
   end
 
-  def terminate_app
-    `idb terminate --udid #{udid} #{bundle_id} 2>/dev/null`
+  def terminate_app(target_bundle_id)
+    `idb terminate --udid #{udid} #{target_bundle_id} 2>/dev/null`
   end
 
   def boot_simulator
@@ -119,33 +120,38 @@ class Driver
   end
 
   def list_targets
-    @list_targets ||= `idb list-targets`.split("\n")
-    @list_targets
+    @targets ||= `idb list-targets --json`.split("\n").map! { |target| JSON.parse(target) }
+    @targets
+  end
+
+  def list_apps
+    `idb list-apps --udid #{udid} --json`.split("\n").map! { |app| JSON.parse(app) }
   end
 
-  def list_booted_simulators
-    `idb list-targets`.split("\n").grep(/Booted/)
+  def list_running_apps
+    list_apps.select { |app| app['process_state'] == 'Running' }
   end
 
   def ensure_app_installed
-    Logger.error("App #{bundle_id} is not installed on device #{udid}") unless list_apps.include?(bundle_id)
+    return if list_apps.any? { |app| app['bundle_id'] == bundle_id }
+
+    Logger.error("App #{bundle_id} is not installed on device #{udid}")
   end
 
   def ensure_device_exists
-    device = list_targets.detect { |target| target.include?(udid) }
+    device = list_targets.detect { |target| target['udid'] == udid }
     Logger.error("Can't find device #{udid}") if device.nil?
 
-    Logger.info('Device info:', payload: device)
-    if device.include?('simulator')
+    Logger.info('Device info:', payload: JSON.pretty_generate(device))
+    if device['type'] == 'simulator'
       configure_simulator_keyboard
       boot_simulator
+    else
+      Logger.error('xcmonkey does not support real devices yet. ' \
+                   'For more information see https://github.com/alteral/xcmonkey/issues/7')
     end
   end
 
-  def list_apps
-    `idb list-apps --udid #{udid}`
-  end
-
   def tap(coordinates:)
     Logger.info('Tap:', payload: JSON.pretty_generate(coordinates))
     @session[:actions] << { type: :tap, x: coordinates[:x], y: coordinates[:y] } unless session_actions
@@ -219,29 +225,57 @@ class Driver
     File.write("#{session_path}/xcmonkey-session.json", JSON.pretty_generate(@session))
   end
 
-  private
+  # This function takes ≈200ms
+  def track_running_apps
+    current_list_of_running_apps = list_running_apps
+    if @running_apps != current_list_of_running_apps
+      currently_running_bundle_ids = current_list_of_running_apps.map { |app| app['bundle_id'] }
+      previously_running_bundle_ids = @running_apps.map { |app| app['bundle_id'] }
+      new_apps = currently_running_bundle_ids - previously_running_bundle_ids
 
-  def ensure_driver_installed
-    Logger.error("'idb' doesn't seem to be installed") if `which idb`.strip.empty?
+      return if new_apps.empty?
+
+      launch_app(target_bundle_id: bundle_id)
+      new_apps.each do |id|
+        Logger.warn("Shutting down: #{id}")
+        terminate_app(id)
+      end
+    end
   end
 
-  def detect_home_unique_element
-    @home_tracker ||= describe_ui.reverse.detect do |el|
-      sleep(1)
-      !el['AXUniqueId'].nil? && !el['AXUniqueId'].empty? && el['type'] == 'Button'
+  # This function takes ≈300ms
+  def detect_app_state_change
+    return unless detect_app_in_background
+
+    target_app_is_running = list_running_apps.any? { |app| app['bundle_id'] == bundle_id }
+
+    if target_app_is_running
+      launch_app(target_bundle_id: bundle_id)
+    else
+      save_session
+      Logger.error("Target app has crashed or been terminated")
     end
-    @home_tracker
   end
 
-  def wait_until_app_launched
-    app_info = nil
+  def detect_app_in_background
+    current_app_label = describe_ui.detect { |el| el['type'] == 'Application' }['AXLabel']
+    current_app_label.nil? || current_app_label.strip.empty?
+  end
+
+  private
+
+  def ensure_driver_installed
+    Logger.error("'idb' doesn't seem to be installed") if `which idb`.strip.empty?
+  end
+
+  def wait_until_app_launched(target_bundle_id)
+    app_is_running = false
     current_time = Time.now
-    while app_info.nil? && Time.now < current_time + 5
-      app_info = list_apps.split("\n").detect do |app|
-        app =~ /#{bundle_id}.*Running/
-      end
+    while !app_is_running && Time.now < current_time + 5
+      app_info = list_apps.detect { |app| app['bundle_id'] == target_bundle_id }
+      app_is_running = app_info && app_info['process_state'] == 'Running'
     end
-    Logger.error("Can't run the app #{bundle_id}") if app_info.nil?
-    Logger.info('App info:', payload: app_info)
+    Logger.error("Can't run the app #{target_bundle_id}") unless app_is_running
+    Logger.info('App info:', payload: JSON.pretty_generate(app_info))
   end
 end

data/lib/xcmonkey/repeater.rb

@@ -1,39 +1,39 @@
 class Repeater
-	attr_accessor :udid, :bundle_id, :enable_simulator_keyboard, :actions
+  attr_accessor :udid, :bundle_id, :enable_simulator_keyboard, :actions
 
-	def initialize(params)
-		validate_session(params[:session_path])
-	end
+  def initialize(params)
+    validate_session(params[:session_path])
+  end
 
-	def run
-		params = {
-			udid: udid,
-			bundle_id: bundle_id,
-			enable_simulator_keyboard: enable_simulator_keyboard,
-			session_actions: actions
-		}
-		Driver.new(params).repeat_monkey_test
-	end
+  def run
+    params = {
+      udid: udid,
+      bundle_id: bundle_id,
+      enable_simulator_keyboard: enable_simulator_keyboard,
+      session_actions: actions
+    }
+    Driver.new(params).repeat_monkey_test
+  end
 
-	def validate_session(session_path)
-		Logger.error("Provided session can't be found: #{session_path}") unless File.exist?(session_path)
+  def validate_session(session_path)
+    Logger.error("Provided session can't be found: #{session_path}") unless File.exist?(session_path)
 
-		session = JSON.parse(File.read(session_path))
+    session = JSON.parse(File.read(session_path))
 
-		if session['params'].nil?
-			Logger.error('Provided session is not valid: `params` should not be `nil`')
-			return
-		end
+    if session['params'].nil?
+      Logger.error('Provided session is not valid: `params` should not be `nil`')
+      return
+    end
 
-		self.actions = session['actions']
-		Logger.error('Provided session is not valid: `actions` should not be `nil` or `empty`') if actions.nil? || actions.empty?
+    self.actions = session['actions']
+    Logger.error('Provided session is not valid: `actions` should not be `nil` or `empty`') if actions.nil? || actions.empty?
 
-		self.udid = session['params']['udid']
-		Logger.error('Provided session is not valid: `udid` should not be `nil`') if udid.nil?
+    self.udid = session['params']['udid']
+    Logger.error('Provided session is not valid: `udid` should not be `nil`') if udid.nil?
 
-		self.bundle_id = session['params']['bundle_id']
-		Logger.error('Provided session is not valid: `bundle_id` should not be `nil`') if bundle_id.nil?
+    self.bundle_id = session['params']['bundle_id']
+    Logger.error('Provided session is not valid: `bundle_id` should not be `nil`') if bundle_id.nil?
 
-		self.enable_simulator_keyboard = session['params']['enable_simulator_keyboard']
-	end
+    self.enable_simulator_keyboard = session['params']['enable_simulator_keyboard']
+  end
 end

data/lib/xcmonkey/version.rb

@@ -1,4 +1,3 @@
-module Xcmonkey
-  VERSION = '1.0.0'
-  GEM_NAME = 'xcmonkey'
+class Xcmonkey
+  VERSION = '1.2.0'
 end

data/lib/xcmonkey.rb

@@ -6,36 +6,37 @@ require_relative 'xcmonkey/version'
 require_relative 'xcmonkey/logger'
 require_relative 'xcmonkey/driver'
 
-module Xcmonkey
-	class Xcmonkey
-	  attr_accessor :driver
+class Xcmonkey
+  attr_accessor :driver
 
-	  def initialize(params)
-			ensure_required_params(params)
-			self.driver = Driver.new(params)
-	  end
+  def initialize(params)
+    params[:session_path] = Dir.pwd if params[:session_path].nil?
+    params[:duration] = 60 if params[:duration].nil?
+    params[:enable_simulator_keyboard] = true if params[:enable_simulator_keyboard].nil?
+    ensure_required_params(params)
+    self.driver = Driver.new(params)
+  end
 
-    def run
-			driver.monkey_test(gestures)
-    end
+  def run
+    driver.monkey_test(gestures)
+  end
 
-		def gestures
-			taps = [:precise_tap, :blind_tap] * 10
-			swipes = [:precise_swipe, :blind_swipe] * 5
-			presses = [:precise_press, :blind_press]
-			taps + swipes + presses
-		end
+  def gestures
+    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)
-			Logger.error('UDID should be provided') if params[:udid].nil?
+  def ensure_required_params(params)
+    Logger.error('UDID should be provided') if params[:udid].nil?
 
-			Logger.error('Bundle identifier should be provided') if params[:bundle_id].nil?
+    Logger.error('Bundle identifier should be provided') if params[:bundle_id].nil?
 
-			Logger.error('Session path should be a directory') if params[:session_path].nil? || !File.directory?(params[:session_path])
+    Logger.error('Session path should be a directory') if params[:session_path].nil? || !File.directory?(params[:session_path])
 
-			if params[:duration].nil? || !params[:duration].kind_of?(Integer) || !params[:duration].positive?
-				Logger.error('Duration must be Integer and not less than 1 second')
-			end
-		end
-	end
+    if params[:duration].nil? || !params[:duration].kind_of?(Integer) || !params[:duration].positive?
+      Logger.error('Duration must be Integer and not less than 1 second')
+    end
+  end
 end

data/spec/describer_spec.rb

@@ -2,15 +2,17 @@ describe Describer do
   let(:udid) { `xcrun simctl list | grep " iPhone 14 Pro Max"`.split("\n")[0].split('(')[1].split(')')[0] }
   let(:driver) { Driver.new(udid: udid) }
 
-  it 'verifies that point can be described (integer)' do
+  before do
     allow(Logger).to receive(:info)
+  end
+
+  it 'verifies that point can be described (integer)' do
     driver.boot_simulator
     point_info = described_class.new(udid: udid, x: 10, y: 10).run
     expect(point_info).not_to be_empty
   end
 
   it 'verifies that point can be described (string)' do
-    allow(Logger).to receive(:info)
     driver.boot_simulator
     point_info = described_class.new(udid: udid, x: '10', y: '10').run
     expect(point_info).not_to be_empty

data/spec/driver_spec.rb

@@ -4,36 +4,22 @@ describe Driver do
   let(:driver) { described_class.new(udid: udid, bundle_id: bundle_id, session_path: Dir.pwd) }
   let(:driver_with_session) { described_class.new(udid: udid, bundle_id: bundle_id, session_actions: [{ type: 'tap', x: 0, y: 0 }]) }
 
+  before do
+    allow(Logger).to receive(:info)
+  end
+
   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.boot_simulator }.not_to raise_error
   end
 
-  it 'verifies that there are booted simulators' do
-    driver.boot_simulator
-    booted_simulators = driver.list_booted_simulators
-    expect(booted_simulators).not_to be_empty
-  end
-
   it 'verifies that ui can be described' do
     driver.boot_simulator
     ui = driver.describe_ui
     expect(ui).not_to be_empty
   end
 
-  it 'verifies that home screen can be opened' do
-    driver.boot_simulator
-    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
@@ -41,8 +27,8 @@ describe Driver do
 
   it 'verifies that list of apps can be showed' do
     driver.boot_simulator
-    list_apps = driver.list_apps
-    expect(list_apps).to include(bundle_id)
+    app_exists = driver.list_apps.any? { |app| app['bundle_id'] == bundle_id }
+    expect(app_exists).to be(true)
   end
 
   it 'verifies that app installed' do
@@ -62,11 +48,9 @@ describe Driver do
   end
 
   it 'verifies that device exists' do
-    error_message = "Can't find device #{udid}"
-    payload = driver.list_targets.detect { |target| target.include?(udid) }
-    expect(Logger).not_to receive(:error).with(error_message, payload: nil)
-    expect(Logger).to receive(:info).with('Device info:', payload: payload)
+    expect(Logger).not_to receive(:error)
     expect(driver).to receive(:boot_simulator)
+    expect(driver).to receive(:configure_simulator_keyboard)
     expect { driver.ensure_device_exists }.not_to raise_error
   end
 
@@ -143,18 +127,25 @@ describe Driver do
     expect(keyboard_state.first).to include('1')
   end
 
-  it 'verifies that app can be launched' do
+  it 'verifies that app can be launched with waiting' do
+    expect(Logger).not_to receive(:error)
+    expect(driver).to receive(:wait_until_app_launched)
+    driver.boot_simulator
+    driver.terminate_app(bundle_id)
+    expect { driver.launch_app(target_bundle_id: bundle_id, wait_for_state_update: true) }.not_to raise_error
+  end
+
+  it 'verifies that app can be launched without waiting' do
     expect(Logger).not_to receive(:error)
-    expect(Logger).to receive(:info)
+    expect(driver).not_to receive(:wait_until_app_launched)
     driver.boot_simulator
-    driver.terminate_app
-    expect { driver.launch_app }.not_to raise_error
+    driver.terminate_app(bundle_id)
+    expect { driver.launch_app(target_bundle_id: bundle_id) }.not_to raise_error
   end
 
   it 'verifies tap in new session' 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)
     expect(driver.instance_variable_get(:@session)[:actions]).not_to be_empty
   end
@@ -162,7 +153,6 @@ describe Driver do
   it 'verifies tap in old session' do
     driver_with_session.boot_simulator
     coordinates = { x: 1, y: 1 }
-    expect(Logger).to receive(:info).with('Tap:', payload: JSON.pretty_generate(coordinates))
     driver_with_session.tap(coordinates: coordinates)
     expect(driver_with_session.instance_variable_get(:@session)[:actions]).to be_empty
   end
@@ -171,7 +161,6 @@ describe Driver 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)
     expect(driver.instance_variable_get(:@session)[:actions]).not_to be_empty
   end
@@ -180,7 +169,6 @@ describe Driver do
     driver_with_session.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_with_session.press(coordinates: coordinates, duration: duration)
     expect(driver_with_session.instance_variable_get(:@session)[:actions]).to be_empty
   end
@@ -190,7 +178,6 @@ describe Driver do
     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)
     expect(driver.instance_variable_get(:@session)[:actions]).not_to be_empty
   end
@@ -200,7 +187,6 @@ describe Driver do
     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_with_session.swipe(start_coordinates: start_coordinates, end_coordinates: end_coordinates, duration: duration)
     expect(driver_with_session.instance_variable_get(:@session)[:actions]).to be_empty
   end
@@ -211,6 +197,98 @@ describe Driver do
     driver.save_session
   end
 
+  it 'verifies that monkey_test_precondition works fine' do
+    driver.monkey_test_precondition
+    app_info = driver.list_apps.detect { |app| app['bundle_id'] == bundle_id }
+    app_is_running = app_info && app_info['process_state'] == 'Running'
+    expect(app_is_running).to be(true)
+    expect(driver.instance_variable_get(:@running_apps)).not_to be_nil
+  end
+
+  it 'verifies that monkey_test works fine' do
+    params = { udid: udid, bundle_id: bundle_id, duration: 1, session_path: Dir.pwd }
+    driver = described_class.new(params)
+    driver.monkey_test(Xcmonkey.new(params).gestures)
+    expect(driver.instance_variable_get(:@session)[:actions]).not_to be_empty
+  end
+
+  it 'verifies that repeat_monkey_test works fine' do
+    session_actions = [
+      { 'type' => 'tap', 'x' => 10, 'y' => 10 },
+      { 'type' => 'press', 'x' => 11, 'y' => 11, 'duration' => 1.4 },
+      { 'type' => 'swipe', 'x' => 12, 'y' => 12, 'endX' => 15, 'endY' => 15, 'duration' => 0.3 }
+    ]
+    driver = described_class.new(udid: udid, bundle_id: bundle_id, session_actions: session_actions)
+    expect(driver).to receive(:tap).with(coordinates: { x: 10, y: 10 })
+    expect(driver).to receive(:press).with(coordinates: { x: 11, y: 11 }, duration: 1.4)
+    expect(driver).to receive(:swipe).with(start_coordinates: { x: 12, y: 12 }, end_coordinates: { x: 15, y: 15 }, duration: 0.3)
+    driver.repeat_monkey_test
+    expect(driver.instance_variable_get(:@session)[:actions]).to be_empty
+  end
+
+  it 'verifies that unknown actions does not break repeat_monkey_test' do
+    driver = described_class.new(udid: udid, bundle_id: bundle_id, session_actions: [{ 'type' => 'test', 'x' => 10, 'y' => 10 }])
+    expect(driver).to receive(:monkey_test_precondition)
+    expect(driver).not_to receive(:tap)
+    expect(driver).not_to receive(:press)
+    expect(driver).not_to receive(:swipe)
+    driver.repeat_monkey_test
+    expect(driver.instance_variable_get(:@session)[:actions]).to be_empty
+  end
+
+  it 'verifies that running apps are tracked' do
+    new_app_bundle_id = 'com.apple.Preferences'
+    driver.terminate_app(new_app_bundle_id)
+    driver.monkey_test_precondition
+    driver.launch_app(target_bundle_id: new_app_bundle_id, wait_for_state_update: true)
+    expect(driver).to receive(:launch_app).with(target_bundle_id: bundle_id)
+    expect(driver).to receive(:terminate_app).with(new_app_bundle_id)
+    driver.track_running_apps
+  end
+
+  it 'verifies that running apps can be determined' do
+    driver.terminate_app(bundle_id)
+    sum = driver.list_running_apps.size
+    driver.launch_app(target_bundle_id: bundle_id)
+    expect(driver.list_running_apps.size).to eq(sum + 1)
+  end
+
+  it 'verifies that app state change can be determined' do
+    driver.launch_app(target_bundle_id: bundle_id)
+    allow(driver).to receive(:detect_app_in_background).and_return(true)
+    expect(driver).not_to receive(:save_session)
+    expect(driver).to receive(:launch_app)
+    expect { driver.detect_app_state_change }.not_to raise_error
+  end
+
+  it 'verifies that background is the invalid app state' do
+    driver.terminate_app(bundle_id)
+    expect(driver).to receive(:save_session)
+    expect { driver.detect_app_state_change }.to raise_error(SystemExit) { |e| expect(e.status).to eq(1) }
+  end
+
+  it 'verifies that foreground is the valid app state' do
+    driver.launch_app(target_bundle_id: bundle_id, wait_for_state_update: true)
+    expect { driver.detect_app_state_change }.not_to raise_error
+  end
+
+  it 'verifies that background state can be determined' do
+    driver.terminate_app(bundle_id)
+    expect(driver.detect_app_in_background).to be(true)
+  end
+
+  it 'verifies that foregroung state can be determined' do
+    driver.monkey_test_precondition
+    expect(driver.detect_app_in_background).to be(false)
+  end
+
+  it 'verifies that xcmonkey behaves as expected on real devices' do
+    udid = '1234-5678'
+    driver = described_class.new(udid: udid, bundle_id: bundle_id)
+    allow(driver).to receive(:list_targets).and_return([{ 'udid' => udid, 'type' => 'device' }])
+    expect { driver.ensure_device_exists }.to raise_error(SystemExit) { |e| expect(e.status).to eq(1) }
+  end
+
   it 'verifies that simulator was not booted' do
     driver.shutdown_simulator
     error_message = "Failed to boot #{udid}"

data/spec/repeater_spec.rb

@@ -7,7 +7,6 @@ describe Repeater do
   let(:session_file_content_without_bundle_id) { '{ "params": {"udid": "0", "enable_simulator_keyboard": true}, "actions": [{ "type": "tap", "x": 0, "y": 0 }] }' }
   let(:session_file_content_without_udid) { '{ "params": {"bundle_id": "0", "enable_simulator_keyboard": true}, "actions": [{ "type": "tap", "x": 0, "y": 0 }] }' }
 
-  # TESTME
   it 'verifies that session cannot be validated without params' do
     allow(File).to receive(:exist?).and_return(true)
     allow(File).to receive(:read).and_return(session_file_content_without_params)

data/spec/xcmonkey_spec.rb

@@ -1,58 +1,56 @@
 describe Xcmonkey do
-  describe Xcmonkey::Xcmonkey do
-    let(:params) { { udid: '123', bundle_id: 'example.com.app', duration: 10, session_path: Dir.pwd } }
-    let(:duration_error_msg) { 'Duration must be Integer and not less than 1 second' }
-
-    it 'verifies gestures' do
-      gestures = described_class.new(params).gestures
-      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
-      expect(Logger).not_to receive(:error)
-      described_class.new(params)
-    end
-
-    it 'verifies `udid` param is required' do
-      params[:udid] = nil
-      expect(Logger).to receive(:error).with('UDID should be provided')
-      described_class.new(params)
-    end
-
-    it 'verifies `bundle_id` param is required' do
-      params[:bundle_id] = nil
-      expect(Logger).to receive(:error).with('Bundle identifier should be provided')
-      described_class.new(params)
-    end
-
-    it 'verifies `duration` param is required' do
-      params[:duration] = nil
-      expect(Logger).to receive(:error).with(duration_error_msg)
-      described_class.new(params)
-    end
-
-    it 'verifies `duration` param cannot be equal to zero' do
-      params[:duration] = 0
-      expect(Logger).to receive(:error).with(duration_error_msg)
-      described_class.new(params)
-    end
-
-    it 'verifies `duration` param cannot be negative' do
-      params[:duration] = -1
-      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
+  let(:params) { { udid: '123', bundle_id: 'example.com.app', duration: 10, session_path: Dir.pwd } }
+  let(:duration_error_msg) { 'Duration must be Integer and not less than 1 second' }
+
+  before do
+    allow(Logger).to receive(:info)
+  end
+
+  it 'verifies gestures' do
+    gestures = described_class.new(params).gestures
+    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
+    expect(Logger).not_to receive(:error)
+    described_class.new(params)
+  end
+
+  it 'verifies `udid` param is required' do
+    params[:udid] = nil
+    expect(Logger).to receive(:error).with('UDID should be provided')
+    described_class.new(params)
+  end
+
+  it 'verifies `bundle_id` param is required' do
+    params[:bundle_id] = nil
+    expect(Logger).to receive(:error).with('Bundle identifier should be provided')
+    described_class.new(params)
+  end
+
+  it 'verifies `duration` param is optional' do
+    params[:duration] = nil
+    expect(Logger).not_to receive(:error)
+    described_class.new(params)
+  end
+
+  it 'verifies `duration` param cannot be equal to zero' do
+    params[:duration] = 0
+    expect(Logger).to receive(:error).with(duration_error_msg)
+    described_class.new(params)
+  end
+
+  it 'verifies `duration` param cannot be negative' do
+    params[:duration] = -1
+    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
 end

data/xcmonkey.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "xcmonkey/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = Xcmonkey::GEM_NAME
+  spec.name          = "xcmonkey"
   spec.version       = Xcmonkey::VERSION
   spec.authors       = ["alteral"]
   spec.email         = ["a.alterpesotskiy@mail.ru"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcmonkey
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - alteral
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -216,9 +216,9 @@ extra_rdoc_files: []
 files:
 - ".fasterer.yml"
 - ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature-request.md"
 - ".github/dependabot.yml"
-- ".github/issue_template/bug_report.md"
-- ".github/issue_template/feature_request.md"
 - ".github/pull_request_template.md"
 - ".github/workflows/test.yml"
 - ".gitignore"