xcmonkey 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48bd9b79b2370e4f20366973e689af344f6c75729b361658fbc5bb2c02c38253
-  data.tar.gz: c207e8dbe7c820623f60a9c0b9e8ea8a7e5bce18bfe10f9d5c27e8928829889d
+  metadata.gz: be5b38b4ec7977038ba4f739a4516a376bc79652447a0cc52c10465ea85657d2
+  data.tar.gz: 97d3eefd65f8a438bfb2ed2919bdaa6bf42e0324235d10a7f7df5b0ede316d88
 SHA512:
-  metadata.gz: 9c0f1f52ad5e8118799556e4e1ba3a49574c504cf2a840fe0369e06c6dbab260fd0a9c275ada9efb789a865759ac48f7d46f9348cde5b2cb53a44969b5189cf9
-  data.tar.gz: 761ffee247c8646bc24dee5fd3f473414402033d3c9a773fe87623579aef93155ecbafc3d412111396945ae485d74b28d6916e5e287754a82b15fcfc792b0c47
+  metadata.gz: 94b8daa5da4df0d18b1644bf9d110978c070ba032e661d4bf1079f7fad90a2ed6df553bc8685a7267d7f819159ac615474c88c4ebdd6e00627b74339cc2f9e0e
+  data.tar.gz: 66fe245043c8f4887a3849c7e60bc6b8ee81cecfb56781f409e09a6651511d009acd2a2284e3534d67ef59abffb5432b3d85ff9495a951a4fc26dbd44bff38fb

data/.github/issue_template/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## What did you do?
+
+
+## What did you expect to happen?
+
+
+## What happened instead?
+
+
+## Environment
+
+- `xcmonkey` version:
+- `idb` version:
+- `xcode` version:
+- `macOS` version:
+
+## Additional context

data/.github/issue_template/feature_request.md

@@ -0,0 +1,26 @@
+---
+name: Feature Request
+about: Got any ideas about new features? Let us know!
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## What are you trying to achieve?
+
+
+## If possible, how can you achieve this currently?
+
+
+## What would be the better way?
+
+
+## Environment
+
+- `xcmonkey` version:
+- `idb` version:
+- `xcode` version:
+- `macOS` version:
+
+## Additional context

data/.github/pull_request_template.md

@@ -1,9 +1,14 @@
 # Changes
 
 ## References
+
 - https://github.com/alteral/xcmonkey/issues/XXX
 
+## Description
+
+
 ## Risks
+
 - [ ] None
 - [ ] Low
 - [ ] High

data/.gitignore

@@ -39,3 +39,6 @@ DerivedData
 
 # Sonar
 .scannerwork
+
+# Cache
+xcmonkey-session.json

data/README.md

@@ -11,7 +11,7 @@
 
 ## Description
 
-*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.
+*xcmonkey* is a tool for doing stress 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).
 
@@ -63,6 +63,33 @@ $ 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
+}
+```
+
 ### To describe the required point
 
 ```bash

data/bin/xcmonkey

@@ -3,6 +3,7 @@
 require 'commander/import'
 require_relative '../lib/xcmonkey'
 require_relative '../lib/xcmonkey/describer'
+require_relative '../lib/xcmonkey/repeater'
 require_relative '../lib/xcmonkey/logger'
 require_relative '../lib/xcmonkey/driver'
 require_relative '../lib/xcmonkey/version'
@@ -18,25 +19,41 @@ module Xcmonkey
     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.action do |args, options|
-      options.default(duration: 60, enable_simulator_keyboard: 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,
         duration: options.duration,
-        simulator_keyboard: options.enable_simulator_keyboard
+        session_path: options.session_path,
+        enable_simulator_keyboard: options.enable_simulator_keyboard
       }
       Xcmonkey.new(params).run
     end
   end
 
+  command :repeat do |c|
+    c.syntax = 'xcmonkey repeat [options]'
+    c.description = 'Repeats given session'
+    c.option('-s', '--session-path STRING', String, 'Path to monkey testing session')
+    c.action do |_, options|
+      params = { session_path: options.session_path }
+      Repeater.new(params).run
+    end
+  end
+
   command :describe do |c|
     c.syntax = 'xcmonkey describe [options]'
     c.description = 'Describes given point'
     c.option('-u', '--udid STRING', String, 'Set device UDID')
     c.option('-x', '--x STRING', 'Point `x` coordinate')
     c.option('-y', '--y STRING', 'Point `y` coordinate')
-    c.action do |args, options|
+    c.action do |_, options|
       params = {
         udid: options.udid,
         x: options.x,

data/lib/xcmonkey/describer.rb

@@ -1,9 +1,8 @@
 class Describer
-	attr_accessor :udid, :x, :y, :driver
+	attr_accessor :x, :y, :driver
 
 	def initialize(params)
 		ensure_required_params(params)
-		self.udid = params[:udid]
 		self.x = params[:x]
 		self.y = params[:y]
 		self.driver = Driver.new(params)

data/lib/xcmonkey/driver.rb

@@ -1,18 +1,30 @@
 class Driver
-  attr_accessor :udid, :bundle_id, :duration, :enable_simulator_keyboard
+  attr_accessor :udid, :bundle_id, :enable_simulator_keyboard, :session_duration, :session_path, :session_actions
 
   def initialize(params)
     self.udid = params[:udid]
     self.bundle_id = params[:bundle_id]
-    self.duration = params[:duration]
+    self.session_duration = params[:duration]
+    self.session_path = params[:session_path]
     self.enable_simulator_keyboard = params[:enable_simulator_keyboard]
+    self.session_actions = params[:session_actions]
+    @session = { params: params, actions: [] }
     ensure_driver_installed
   end
 
+  def monkey_test_precondition
+    ensure_device_exists
+    ensure_app_installed
+    terminate_app
+    open_home_screen(with_tracker: true)
+    launch_app
+  end
+
   def monkey_test(gestures)
+    monkey_test_precondition
     app_elements = describe_ui.shuffle
     current_time = Time.now
-    while Time.now < current_time + duration
+    while Time.now < current_time + session_duration
       el1_coordinates = central_coordinates(app_elements.first)
       el2_coordinates = central_coordinates(app_elements.last)
       case gestures.sample
@@ -40,7 +52,30 @@ class Driver
         next
       end
       app_elements = describe_ui.shuffle
-      Logger.error('App lost') if app_elements.include?(@home_tracker)
+      next unless app_elements.include?(@home_tracker)
+
+      save_session
+      Logger.error('App lost')
+    end
+    save_session
+  end
+
+  def repeat_monkey_test
+    monkey_test_precondition
+    session_actions.each do |action|
+      case action['type']
+      when 'tap'
+        tap(coordinates: { x: action['x'], y: action['y'] })
+      when 'press'
+        press(coordinates: { x: action['x'], y: action['y'] }, duration: action['duration'])
+      when 'swipe'
+        swipe(
+          start_coordinates: { x: action['x'], y: action['y'] },
+          end_coordinates: { x: action['endX'], y: action['endY'] },
+          duration: action['duration']
+        )
+      end
+      Logger.error('App lost') if describe_ui.shuffle.include?(@home_tracker)
     end
   end
 
@@ -113,11 +148,13 @@ class Driver
 
   def tap(coordinates:)
     Logger.info('Tap:', payload: JSON.pretty_generate(coordinates))
+    @session[:actions] << { type: :tap, x: coordinates[:x], y: coordinates[:y] } unless session_actions
     `idb ui tap --udid #{udid} #{coordinates[:x]} #{coordinates[:y]}`
   end
 
   def press(coordinates:, duration:)
     Logger.info("Press (#{duration}s):", payload: JSON.pretty_generate(coordinates))
+    @session[:actions] << { type: :press, x: coordinates[:x], y: coordinates[:y], duration: duration } unless session_actions
     `idb ui tap --udid #{udid} --duration #{duration} #{coordinates[:x]} #{coordinates[:y]}`
   end
 
@@ -126,6 +163,16 @@ class Driver
       "Swipe (#{duration}s):",
       payload: "#{JSON.pretty_generate(start_coordinates)} => #{JSON.pretty_generate(end_coordinates)}"
     )
+    unless session_actions
+      @session[:actions] << {
+        type: :swipe,
+        x: start_coordinates[:x],
+        y: start_coordinates[:y],
+        endX: end_coordinates[:x],
+        endY: end_coordinates[:y],
+        duration: duration
+      }
+    end
     coordinates = "#{start_coordinates[:x]} #{start_coordinates[:y]} #{end_coordinates[:x]} #{end_coordinates[:y]}"
     `idb ui swipe --udid #{udid} --duration #{duration} #{coordinates}`
   end
@@ -168,6 +215,10 @@ class Driver
     rand(0.5..1.5).ceil(1)
   end
 
+  def save_session
+    File.write("#{session_path}/xcmonkey-session.json", JSON.pretty_generate(@session))
+  end
+
   private
 
   def ensure_driver_installed

data/lib/xcmonkey/repeater.rb

@@ -0,0 +1,39 @@
+class Repeater
+	attr_accessor :udid, :bundle_id, :enable_simulator_keyboard, :actions
+
+	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 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))
+
+		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.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.enable_simulator_keyboard = session['params']['enable_simulator_keyboard']
+	end
+end

data/lib/xcmonkey/version.rb

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

data/lib/xcmonkey.rb

@@ -1,28 +1,21 @@
 require 'json'
 require 'colorize'
 require_relative 'xcmonkey/describer'
+require_relative 'xcmonkey/repeater'
 require_relative 'xcmonkey/version'
 require_relative 'xcmonkey/logger'
 require_relative 'xcmonkey/driver'
 
 module Xcmonkey
 	class Xcmonkey
-	  attr_accessor :udid, :bundle_id, :duration, :driver
+	  attr_accessor :driver
 
 	  def initialize(params)
 			ensure_required_params(params)
-	    self.udid = params[:udid]
-	    self.bundle_id = params[:bundle_id]
-	    self.duration = params[:duration]
 			self.driver = Driver.new(params)
 	  end
 
     def run
-			driver.ensure_device_exists
-			driver.ensure_app_installed
-			driver.terminate_app
-			driver.open_home_screen(with_tracker: true)
-			driver.launch_app
 			driver.monkey_test(gestures)
     end
 
@@ -35,7 +28,11 @@ module Xcmonkey
 
 		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('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

data/spec/driver_spec.rb

@@ -1,7 +1,8 @@
 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) }
+  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 }]) }
 
   it 'verifies that sumulator was booted' do
     error_message = "Failed to boot #{udid}"
@@ -150,28 +151,64 @@ describe Driver do
     expect { driver.launch_app }.not_to raise_error
   end
 
-  it 'verifies tap' do
+  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
 
-  it 'verifies press' 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
+
+  it 'verifies press in new session' 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
+
+  it 'verifies press in old session' 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
 
-  it 'verifies swipe' do
+  it 'verifies swipe in new session' 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)
+    expect(driver.instance_variable_get(:@session)[:actions]).not_to be_empty
+  end
+
+  it 'verifies swipe in old session' do
+    driver_with_session.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_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
+    expect(File).to receive(:write)
+    driver.instance_variable_set(:@session, { params: {}, actions: [] })
+    driver.save_session
   end
 
   it 'verifies that simulator was not booted' do

data/spec/repeater_spec.rb

@@ -0,0 +1,52 @@
+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_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 }] }' }
+
+  # 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)
+    expect(Logger).to receive(:error).with('Provided session is not valid: `params` should not be `nil`')
+    described_class.new(session_path: session_path)
+  end
+
+  it 'verifies that session cannot be validated without actions' do
+    allow(File).to receive(:exist?).and_return(true)
+    allow(File).to receive(:read).and_return(session_file_content_without_actions)
+    expect(Logger).to receive(:error).with('Provided session is not valid: `actions` should not be `nil` or `empty`')
+    described_class.new(session_path: session_path)
+  end
+
+  it 'verifies that session cannot be validated with empty actions' do
+    allow(File).to receive(:exist?).and_return(true)
+    allow(File).to receive(:read).and_return(session_file_content_with_empty_actions)
+    expect(Logger).to receive(:error).with('Provided session is not valid: `actions` should not be `nil` or `empty`')
+    described_class.new(session_path: session_path)
+  end
+
+  it 'verifies that session cannot be validated without bundle id' do
+    allow(File).to receive(:exist?).and_return(true)
+    allow(File).to receive(:read).and_return(session_file_content_without_bundle_id)
+    expect(Logger).to receive(:error).with('Provided session is not valid: `bundle_id` should not be `nil`')
+    described_class.new(session_path: session_path)
+  end
+
+  it 'verifies that session cannot be validated without udid' do
+    allow(File).to receive(:exist?).and_return(true)
+    allow(File).to receive(:read).and_return(session_file_content_without_udid)
+    expect(Logger).to receive(:error).with('Provided session is not valid: `udid` should not be `nil`')
+    described_class.new(session_path: session_path)
+  end
+
+  it 'verifies that session validation can pass' do
+    allow(File).to receive(:exist?).and_return(true)
+    allow(File).to receive(:read).and_return(session_file_content_full)
+    expect(Logger).not_to receive(:error)
+    described_class.new(session_path: session_path)
+  end
+end

data/spec/xcmonkey_spec.rb

@@ -1,6 +1,6 @@
 describe Xcmonkey do
   describe Xcmonkey::Xcmonkey do
-    let(:params) { { udid: '123', bundle_id: 'example.com.app', duration: 10 } }
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcmonkey
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - alteral
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-08 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -217,6 +217,8 @@ files:
 - ".fasterer.yml"
 - ".github/FUNDING.yml"
 - ".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"
@@ -236,12 +238,14 @@ files:
 - lib/xcmonkey/describer.rb
 - lib/xcmonkey/driver.rb
 - lib/xcmonkey/logger.rb
+- lib/xcmonkey/repeater.rb
 - lib/xcmonkey/version.rb
 - requirements.txt
 - sonar-project.properties
 - spec/describer_spec.rb
 - spec/driver_spec.rb
 - spec/logger_spec.rb
+- spec/repeater_spec.rb
 - spec/spec_helper.rb
 - spec/xcmonkey_spec.rb
 - xcmonkey.gemspec