xcmonkey 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d3bd605b57ec05a83a3cca39707b5c2fc9529828131b9ac872f3dc478180bbb
-  data.tar.gz: 8793e64f73775a2c8de84d1b79d0aebd258df7c22b9c8f43de2618f63f306d4e
+  metadata.gz: be0e0b66cbc58704452a6defce61d6bd9f7ba88f7489796f4b7cc6a4f4489a11
+  data.tar.gz: 8551a6fd090f89cf20c2cd2e81bc8edc4856b9eb5516a50227db772cb0f013eb
 SHA512:
-  metadata.gz: 4e4634518e71dac0ed206d4fec26fc707fb9dbea8116c87db1959695261e8ee311246db203317790433d18b5e5250074f1f17bf567101dfec6767a1ed5db0670
-  data.tar.gz: 0e696e9804b94e6106f203b9bcda008f57dbe7fbda78a68ff7d57a8cfa980e4b691b533f430bac855ae8ed56ae0e7ac5085f305853bae8f03652095871287a94
+  metadata.gz: 5f3e1fe8bb0bccfd056c9f7087c32c2cd06adee0d0dca6a7b7ba6b8e038130e8d0f991c1e3bcb8d4b7c6d1c9ad63a5ae1fa718e979baaa8ff8f41ba98ae03b56
+  data.tar.gz: 1aabd404928c4cbc3e9d7a3fbe0c9f88ca155c25f745eb7e708cca7330a340740908343af231bc9fd9e5759d380f31816a920a53c40a6be6dbfa1916b50363db

data/.github/stale.yml

@@ -0,0 +1,18 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 14
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - important
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: >
+  This issue has been automatically closed due to inactivity.
+  Please open a new issue if it's still valid.

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# xcmonkey changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [1.3.0](https://github.com/alteral/xcmonkey/releases/tag/1.3.0)
+
+_January 29, 2023_
+
+### 🔄 Changed
+
+- `duration` option is renamed to `event-count`
+
+### ✅ Added
+
+- New test options that allow to
+  - specify gestures to exclude from the test
+  - set up throttle between events
+  - ignore app crashes
+
+## [1.2.0](https://github.com/alteral/xcmonkey/releases/tag/1.2.0)
+
+_January 23, 2023_
+
+### ✅ Added
+
+- Force keep xcmonkey in the target app
+
+## [1.1.0](https://github.com/alteral/xcmonkey/releases/tag/1.1.0)
+
+_January 20, 2023_
+
+### ✅ Added
+
+- Support [fastlane](https://github.com/fastlane/fastlane) integration
+
+## [1.0.0](https://github.com/alteral/xcmonkey/releases/tag/1.0.0)
+
+_January 09, 2023_
+
+### ✅ Added
+
+- xcmonkey `test`, `repeat` and `describe` commands

data/Gemfile

@@ -4,3 +4,17 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in xcmonkey.gemspec
 gemspec
+
+gem 'bundler'
+gem 'fasterer', '0.9.0'
+gem 'fastlane'
+gem 'rake'
+gem 'rspec'
+gem 'rspec_junit_formatter'
+gem 'rubocop', '1.44.0'
+gem 'rubocop-performance'
+gem 'rubocop-rake', '0.6.0'
+gem 'rubocop-require_tools'
+gem 'rubocop-rspec', '2.15.0'
+gem 'simplecov'
+gem 'solargraph'

data/README.md

@@ -39,7 +39,7 @@ gem 'xcmonkey'
 ### To run a stress test
 
 ```bash
-xcmonkey test --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA" --bundle-id "com.apple.Maps" --duration 100
+$ xcmonkey test --event-count 100 --bundle-id "com.apple.Maps" --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA"
 
 12:44:19.343: Device info: {
   "name": "iPhone 14 Pro",
@@ -97,6 +97,26 @@ xcmonkey repeat --session-path "./xcmonkey-session.json"
 xcmonkey describe -x 20 -y 625 --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA"
 ```
 
+### Test options reference
+
+The table below lists all options you can include on the `xcmonkey test` command line.
+
+| Category | Option | Description | Default |
+| --- | --- | --- | --- |
+| **General** | `-h, --help` | Display help documentation | |
+| | `-v, --version` | Display version information | |
+| | `-t, --trace` | Display backtrace when an error occurs | |
+| **Events** | `-u, --udid <string>` | Set device UDID | |
+| | `-b, --bundle-id <string>` | Set target bundle identifier | |
+| | `-s, --session-path <string>` | Path where test session should be saved | |
+| | `-e, --event-count <integer>` | Set events count | `60` |
+| | `--exclude-taps` | Exclude taps from gestures list | `false` |
+| | `--exclude-swipes` | Exclude swipes from gestures list | `false` |
+| | `--exclude-presses` | Exclude presses from gestures list | `false` |
+| | `--disable-simulator-keyboard` | Should simulator keyboard be disable? | `false` |
+| **Debugging** | `--ignore-crashes` | Should app crashes be ignored? | `false` |
+| | `--throttle <milliseconds>` | Fixed delay between events | `0` |
+
 ## [fastlane](https://github.com/fastlane/fastlane) integration
 
 To run *xcmonkey* from *fastlane*, add the following code to your `Fastfile`:
@@ -106,9 +126,9 @@ require 'xcmonkey'
 
 lane :test do
   Xcmonkey.new(
-    udid: '413EA256-CFFB-4312-94A6-12592BEE4CBA',
+    event_count: 100,
     bundle_id: 'com.apple.Maps',
-    duration: 100
+    udid: '413EA256-CFFB-4312-94A6-12592BEE4CBA'
   ).run
 end
 ```

data/bin/xcmonkey

@@ -17,16 +17,26 @@ class 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. Defaults to `60`')
-    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.option('-e', '--event-count NUMBER', Integer, 'Set events count. Defaults to `60`')
+    c.option('-s', '--session-path STRING', String, 'Path where test session should be saved')
+    c.option('--throttle MILLISECONDS', Integer, 'Fixed delay between events in milliseconds. Defaults to `0`')
+    c.option('--exclude-taps', 'Exclude taps from gestures list. Defaults to `false`')
+    c.option('--exclude-swipes', 'Exclude swipes from gestures list. Defaults to `false`')
+    c.option('--exclude-presses', 'Exclude presses from gestures list. Defaults to `false`')
+    c.option('--ignore-crashes', 'Should app crashes be ignored? Defaults to `false`')
+    c.option('--disable-simulator-keyboard', 'Should simulator keyboard be disable? Defaults to `false`')
     c.action do |_, options|
       params = {
         udid: options.udid,
         bundle_id: options.bundle_id,
-        duration: options.duration,
+        event_count: options.event_count,
+        throttle: options.throttle,
         session_path: options.session_path,
-        enable_simulator_keyboard: options.enable_simulator_keyboard
+        exclude_taps: options.exclude_taps,
+        exclude_swipes: options.exclude_swipes,
+        exclude_presses: options.exclude_presses,
+        ignore_crashes: options.ignore_crashes,
+        disable_simulator_keyboard: options.disable_simulator_keyboard
       }
       Xcmonkey.new(params).run
     end

data/fastlane/Fastfile

@@ -8,9 +8,9 @@ lane :release do
   set_github_release(
     repository_name: 'alteral/xcmonkey',
     api_token: ENV.fetch("GITHUB_TOKEN", nil),
-    name: "xcmonkey v#{version}",
-    tag_name: "v#{version}",
-    description: "v#{version}",
+    name: version,
+    tag_name: version,
+    description: "See [CHANGELOG.md](https://github.com/alteral/xcmonkey/blob/main/CHANGELOG.md##{version.delete('.')}})",
     commitish: git_branch,
     upload_assets: [gem_path]
   )

data/lib/xcmonkey/driver.rb

@@ -1,12 +1,14 @@
 class Driver
-  attr_accessor :udid, :bundle_id, :enable_simulator_keyboard, :session_duration, :session_path, :session_actions
+  attr_accessor :udid, :bundle_id, :disable_simulator_keyboard, :event_count, :session_path, :session_actions, :ignore_crashes, :throttle
 
   def initialize(params)
     self.udid = params[:udid]
+    self.throttle = params[:throttle]
     self.bundle_id = params[:bundle_id]
-    self.session_duration = params[:duration]
+    self.event_count = params[:event_count]
     self.session_path = params[:session_path]
-    self.enable_simulator_keyboard = params[:enable_simulator_keyboard]
+    self.ignore_crashes = params[:ignore_crashes]
+    self.disable_simulator_keyboard = params[:disable_simulator_keyboard]
     self.session_actions = params[:session_actions]
     @session = { params: params, actions: [] }
     ensure_driver_installed
@@ -16,16 +18,15 @@ class Driver
     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
-    while Time.now < current_time + session_duration
+    event_count.times do |counter|
+      app_elements = describe_ui.shuffle
       el1_coordinates = central_coordinates(app_elements.first)
       el2_coordinates = central_coordinates(app_elements.last)
       case gestures.sample
@@ -52,18 +53,14 @@ class Driver
       else
         next
       end
-      app_elements = describe_ui.shuffle
-      next unless app_elements.include?(@home_tracker)
-
-      save_session
-      Logger.error('App lost')
+      checkup(counter)
     end
     save_session
   end
 
   def repeat_monkey_test
     monkey_test_precondition
-    session_actions.each do |action|
+    session_actions.each_with_index do |action, counter|
       case action['type']
       when 'tap'
         tap(coordinates: { x: action['x'], y: action['y'] })
@@ -78,13 +75,16 @@ class Driver
       else
         next
       end
-      Logger.error('App lost') if describe_ui.shuffle.include?(@home_tracker)
+      checkup(counter)
     end
   end
 
-  def open_home_screen(with_tracker: false)
-    `idb ui button --udid #{udid} HOME`
-    detect_home_unique_element if with_tracker
+  def checkup(counter)
+    detect_app_state_change
+    if counter % 5 == 0 || throttle.to_i > 0 # Track running apps after every 5th action
+      track_running_apps                     # (unless `throttle` was provided) to speed up the test
+    end
+    check_speed_limit
   end
 
   def describe_ui
@@ -97,13 +97,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
@@ -117,7 +117,7 @@ class Driver
 
   def configure_simulator_keyboard
     shutdown_simulator
-    keyboard_status = enable_simulator_keyboard ? 0 : 1
+    keyboard_status = disable_simulator_keyboard ? 1 : 0
     `defaults write com.apple.iphonesimulator ConnectHardwareKeyboard #{keyboard_status}`
   end
 
@@ -130,6 +130,10 @@ class Driver
     `idb list-apps --udid #{udid} --json`.split("\n").map! { |app| JSON.parse(app) }
   end
 
+  def list_running_apps
+    list_apps.select { |app| app['process_state'] == 'Running' }
+  end
+
   def ensure_app_installed
     return if list_apps.any? { |app| app['bundle_id'] == bundle_id }
 
@@ -144,6 +148,9 @@ class Driver
     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
 
@@ -160,10 +167,8 @@ class Driver
   end
 
   def swipe(start_coordinates:, end_coordinates:, duration:)
-    Logger.info(
-      "Swipe (#{duration}s):",
-      payload: "#{JSON.pretty_generate(start_coordinates)} => #{JSON.pretty_generate(end_coordinates)}"
-    )
+    payload = "#{JSON.pretty_generate(start_coordinates)} => #{JSON.pretty_generate(end_coordinates)}"
+    Logger.info("Swipe (#{duration}s):", payload: payload)
     unless session_actions
       @session[:actions] << {
         type: :swipe,
@@ -183,8 +188,8 @@ class Driver
     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
+      x: x > screen_size[:width].to_i ? random_coordinates[:x] : x,
+      y: y > screen_size[:height].to_i ? random_coordinates[:y] : y
     }
   end
 
@@ -217,31 +222,67 @@ class Driver
   end
 
   def save_session
+    return if session_path.nil?
+
     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 || ignore_crashes
+      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
+  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
+
+  def check_speed_limit
+    sleep(throttle / 1000.0) if throttle.to_i > 0
+  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_is_running && Time.now < current_time + 5
-      app_info = list_apps.detect { |app| app['bundle_id'] == bundle_id }
+      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}") unless app_is_running
+    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,5 +1,5 @@
 class Repeater
-  attr_accessor :udid, :bundle_id, :enable_simulator_keyboard, :actions
+  attr_accessor :udid, :bundle_id, :disable_simulator_keyboard, :ignore_crashes, :actions, :throttle
 
   def initialize(params)
     validate_session(params[:session_path])
@@ -8,8 +8,10 @@ class Repeater
   def run
     params = {
       udid: udid,
+      throttle: throttle,
       bundle_id: bundle_id,
-      enable_simulator_keyboard: enable_simulator_keyboard,
+      ignore_crashes: ignore_crashes,
+      disable_simulator_keyboard: disable_simulator_keyboard,
       session_actions: actions
     }
     Driver.new(params).repeat_monkey_test
@@ -34,6 +36,10 @@ class Repeater
     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']
+    self.throttle = session['params']['throttle']
+
+    self.ignore_crashes = session['params']['ignore_crashes']
+
+    self.disable_simulator_keyboard = session['params']['disable_simulator_keyboard']
   end
 end

data/lib/xcmonkey/version.rb

@@ -1,3 +1,3 @@
 class Xcmonkey
-  VERSION = '1.1.0'
+  VERSION = '1.3.0'
 end

data/lib/xcmonkey.rb

@@ -7,14 +7,15 @@ require_relative 'xcmonkey/logger'
 require_relative 'xcmonkey/driver'
 
 class Xcmonkey
-  attr_accessor :driver
+  attr_accessor :params, :driver
 
   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)
+    params[:event_count] = 60 if params[:event_count].nil?
+    params[:ignore_crashes] = false if params[:ignore_crashes].nil?
+    params[:disable_simulator_keyboard] = false if params[:disable_simulator_keyboard].nil?
+    self.params = params
     self.driver = Driver.new(params)
+    ensure_required_params
   end
 
   def run
@@ -22,21 +23,21 @@ class Xcmonkey
   end
 
   def gestures
-    taps = [:precise_tap, :blind_tap] * 10
-    swipes = [:precise_swipe, :blind_swipe] * 5
-    presses = [:precise_press, :blind_press]
+    taps = params[:exclude_taps] ? [] : [:precise_tap, :blind_tap] * 10
+    swipes = params[:exclude_swipes] ? [] : [:precise_swipe, :blind_swipe] * 5
+    presses = params[:exclude_presses] ? [] : [:precise_press, :blind_press]
     taps + swipes + presses
   end
 
-  def ensure_required_params(params)
+  def ensure_required_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('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] && !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')
+    if params[:event_count].nil? || !params[:event_count].kind_of?(Integer) || !params[:event_count].positive?
+      Logger.error('Event count must be Integer and not less than 1')
     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

@@ -1,9 +1,13 @@
 describe Driver do
   let(:udid) { `xcrun simctl list | grep " iPhone 14 Pro Max"`.split("\n")[0].split('(')[1].split(')')[0] }
   let(:bundle_id) { 'com.apple.Maps' }
-  let(:driver) { described_class.new(udid: udid, bundle_id: bundle_id, session_path: Dir.pwd) }
+  let(:driver) { described_class.new(udid: udid, bundle_id: bundle_id) }
   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)
@@ -16,18 +20,6 @@ describe Driver do
     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
@@ -56,9 +48,7 @@ describe Driver do
   end
 
   it 'verifies that device exists' do
-    payload = driver.list_targets.detect { |target| target['udid'] == udid }
     expect(Logger).not_to receive(:error)
-    expect(Logger).to receive(:info).with('Device info:', payload: JSON.pretty_generate(payload))
     expect(driver).to receive(:boot_simulator)
     expect(driver).to receive(:configure_simulator_keyboard)
     expect { driver.ensure_device_exists }.not_to raise_error
@@ -119,7 +109,7 @@ describe Driver do
 
   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)
+    driver = described_class.new(udid: udid, bundle_id: bundle_id, disable_simulator_keyboard: false)
     expect(driver).to receive(:shutdown_simulator)
     driver.configure_simulator_keyboard
     keyboard_state = `defaults read com.apple.iphonesimulator`.split("\n").grep(/ConnectHardwareKeyboard/)
@@ -129,7 +119,7 @@ describe Driver do
 
   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)
+    driver = described_class.new(udid: udid, bundle_id: bundle_id, disable_simulator_keyboard: true)
     expect(driver).to receive(:shutdown_simulator)
     driver.configure_simulator_keyboard
     keyboard_state = `defaults read com.apple.iphonesimulator`.split("\n").grep(/ConnectHardwareKeyboard/)
@@ -137,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
@@ -156,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
@@ -165,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
@@ -174,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
@@ -184,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
@@ -194,28 +187,33 @@ 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
 
   it 'verifies that session can be saved' do
+    driver = described_class.new(udid: udid, bundle_id: bundle_id, session_path: Dir.pwd)
     expect(File).to receive(:write)
     driver.instance_variable_set(:@session, { params: {}, actions: [] })
     driver.save_session
   end
 
+  it "verifies that session won't be saved if path is not provided" do
+    expect(File).not_to receive(:write)
+    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 }
+    params = { udid: udid, bundle_id: bundle_id, event_count: 1, session_path: Dir.pwd }
     driver = described_class.new(params)
-    expect(driver).to receive(:monkey_test_precondition)
     driver.monkey_test(Xcmonkey.new(params).gestures)
     expect(driver.instance_variable_get(:@session)[:actions]).not_to be_empty
   end
@@ -227,8 +225,6 @@ describe Driver do
       { '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)
-    allow(Logger).to receive(:info).twice
-    expect(driver).to receive(:monkey_test_precondition)
     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)
@@ -238,7 +234,6 @@ describe Driver do
 
   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 }])
-    allow(Logger).to receive(:info).twice
     expect(driver).to receive(:monkey_test_precondition)
     expect(driver).not_to receive(:tap)
     expect(driver).not_to receive(:press)
@@ -247,6 +242,90 @@ describe Driver do
     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 app crashes can be ignored' do
+    driver = described_class.new(udid: udid, bundle_id: bundle_id, session_path: Dir.pwd, ignore_crashes: true)
+    driver.terminate_app(bundle_id)
+    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 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 test can be slowed down' do
+    throttle = 1000
+    driver = described_class.new(udid: udid, bundle_id: bundle_id, session_path: Dir.pwd, throttle: throttle)
+    expect(driver).to receive(:sleep).with(throttle / 1000.0)
+    driver.check_speed_limit
+  end
+
+  it 'verifies that test ignores throttle by default' do
+    expect(driver).not_to receive(:sleep)
+    driver.check_speed_limit
+  end
+
+  it 'verifies that running apps are tracked on second entry with throttle' do
+    driver = described_class.new(udid: udid, bundle_id: bundle_id, session_path: Dir.pwd, throttle: 1)
+    expect(driver).to receive(:track_running_apps)
+    driver.checkup(1)
+  end
+
+  it 'verifies that running apps are not tracked on second entry without throttle' do
+    expect(driver).not_to receive(:track_running_apps)
+    driver.checkup(1)
+  end
+
   it 'verifies that simulator was not booted' do
     driver.shutdown_simulator
     error_message = "Failed to boot #{udid}"

data/spec/repeater_spec.rb

@@ -1,11 +1,11 @@
 describe Repeater do
   let(:session_path) { 'test/path/session.json' }
-  let(:session_file_content_full) { '{ "params": {"udid": "0", "bundle_id": "0", "enable_simulator_keyboard": true}, "actions": [{ "type": "tap", "x": 0, "y": 0 }] }' }
+  let(:session_file_content_full) { '{ "params": {"udid": "0", "bundle_id": "0", "disable_simulator_keyboard": false}, "actions": [{ "type": "tap", "x": 0, "y": 0 }] }' }
   let(:session_file_content_without_params) { '{ "actions": [{ "type": "tap", "x": 0, "y": 0 }] }' }
-  let(:session_file_content_with_empty_actions) { '{ "params": {"udid": "0", "bundle_id": "0", "enable_simulator_keyboard": true}, "actions": [] }' }
-  let(:session_file_content_without_actions) { '{ "params": {"udid": "0", "bundle_id": "0", "enable_simulator_keyboard": true} }' }
-  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 }] }' }
+  let(:session_file_content_with_empty_actions) { '{ "params": {"udid": "0", "bundle_id": "0", "disable_simulator_keyboard": false}, "actions": [] }' }
+  let(:session_file_content_without_actions) { '{ "params": {"udid": "0", "bundle_id": "0", "disable_simulator_keyboard": false} }' }
+  let(:session_file_content_without_bundle_id) { '{ "params": {"udid": "0", "disable_simulator_keyboard": false}, "actions": [{ "type": "tap", "x": 0, "y": 0 }] }' }
+  let(:session_file_content_without_udid) { '{ "params": {"bundle_id": "0", "disable_simulator_keyboard": false}, "actions": [{ "type": "tap", "x": 0, "y": 0 }] }' }
 
   it 'verifies that session cannot be validated without params' do
     allow(File).to receive(:exist?).and_return(true)

data/spec/xcmonkey_spec.rb

@@ -1,6 +1,10 @@
 describe 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' }
+  let(:params) { { udid: '123', bundle_id: 'example.com.app', event_count: 10, session_path: Dir.pwd } }
+  let(:event_count_error_msg) { 'Event count must be Integer and not less than 1' }
+
+  before do
+    allow(Logger).to receive(:info)
+  end
 
   it 'verifies gestures' do
     gestures = described_class.new(params).gestures
@@ -10,6 +14,30 @@ describe Xcmonkey do
     expect(gestures) =~ presses + taps + swipes
   end
 
+  it 'verifies gestures without taps' do
+    params[:exclude_taps] = true
+    gestures = described_class.new(params).gestures
+    swipes = [:precise_swipe, :blind_swipe] * 5
+    presses = [:precise_press, :blind_press]
+    expect(gestures) =~ presses + swipes
+  end
+
+  it 'verifies gestures without swipes' do
+    params[:exclude_swipes] = true
+    gestures = described_class.new(params).gestures
+    taps = [:precise_tap, :blind_tap] * 10
+    presses = [:precise_press, :blind_press]
+    expect(gestures) =~ presses + taps
+  end
+
+  it 'verifies gestures without presses' do
+    params[:exclude_presses] = true
+    gestures = described_class.new(params).gestures
+    taps = [:precise_tap, :blind_tap] * 10
+    swipes = [:precise_swipe, :blind_swipe] * 5
+    expect(gestures) =~ swipes + taps
+  end
+
   it 'verifies required params' do
     expect(Logger).not_to receive(:error)
     described_class.new(params)
@@ -27,21 +55,21 @@ describe Xcmonkey do
     described_class.new(params)
   end
 
-  it 'verifies `duration` param is optional' do
-    params[:duration] = nil
+  it 'verifies `event_count` param is optional' do
+    params[:event_count] = 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)
+  it 'verifies `event_count` param cannot be equal to zero' do
+    params[:event_count] = 0
+    expect(Logger).to receive(:error).with(event_count_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)
+  it 'verifies `event_count` param cannot be negative' do
+    params[:event_count] = -1
+    expect(Logger).to receive(:error).with(event_count_error_msg)
     described_class.new(params)
   end
 

data/xcmonkey.gemspec

@@ -1,42 +1,32 @@
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "xcmonkey/version"
+require 'xcmonkey/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "xcmonkey"
+  spec.name          = 'xcmonkey'
   spec.version       = Xcmonkey::VERSION
-  spec.authors       = ["alteral"]
-  spec.email         = ["a.alterpesotskiy@mail.ru"]
+  spec.authors       = ['alteral']
+  spec.email         = ['a.alterpesotskiy@mail.ru']
 
-  spec.summary       = "xcmonkey is a tool for doing randomised UI testing of iOS apps"
-  spec.homepage      = "https://github.com/alteral/xcmonkey"
-  spec.license       = "MIT"
+  spec.summary       = 'xcmonkey is a tool for doing randomised UI testing of iOS apps'
+  spec.homepage      = 'https://github.com/alteral/xcmonkey'
+  spec.license       = 'MIT'
 
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
-  spec.bindir        = "bin"
-  spec.executables   = ["xcmonkey"]
+  spec.bindir        = 'bin'
+  spec.executables   = ['xcmonkey']
   spec.files         = `git ls-files -z`.split("\x0")
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.4'
-  spec.add_development_dependency('bundler')
-  spec.add_development_dependency('fasterer', '0.9.0')
-  spec.add_development_dependency('fastlane')
-  spec.add_development_dependency('rake')
-  spec.add_development_dependency('rspec')
-  spec.add_development_dependency('rspec_junit_formatter')
-  spec.add_development_dependency('rubocop', '1.38')
-  spec.add_development_dependency('rubocop-performance')
-  spec.add_development_dependency('rubocop-rake', '0.6.0')
-  spec.add_development_dependency('rubocop-require_tools')
-  spec.add_development_dependency('rubocop-rspec', '2.15.0')
-  spec.add_development_dependency('simplecov')
-  spec.add_dependency("colorize", "~> 0.8.1")
-  spec.add_dependency("commander")
-spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.add_dependency('colorize', '~> 0.8.1')
+  spec.add_dependency('commander')
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,183 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: xcmonkey
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - alteral
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-01-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: fasterer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-- !ruby/object:Gem::Dependency
-  name: fastlane
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '1.38'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '1.38'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-require_tools
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.15.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.15.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -220,10 +52,12 @@ files:
 - ".github/ISSUE_TEMPLATE/feature-request.md"
 - ".github/dependabot.yml"
 - ".github/pull_request_template.md"
+- ".github/stale.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE