xcmonkey 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf6aac9a0ce5cf477ad675ca689b4120411e39a19b3b5cd7647b47dea04db9c1
-  data.tar.gz: fb564d25a9085e5bb9fdfa277a877278ab8055c502699f3a2b9430280a035046
+  metadata.gz: be6683e9fefe9666fb294e9939f5ebd83c71915307002dc6425413dfd1d9ae8b
+  data.tar.gz: d4782c2269b36dd950b7567c88d554c7b000cc81452f79e6659d4061135c1ebe
 SHA512:
-  metadata.gz: d25221ebda9c465da1f09740b10779fd4f4a12886d2c5b87c4096eeb9c3ef3076180e3365140ce8d5ff28afc6709445efae4b7ec8b9fdbae2317d8f4cf5a9ba1
-  data.tar.gz: d186b5ead7789373d0a3da5edb8ea11f4f2518e4fdd766c27a79adf315b830cfd95ae3f381543c55b02ba0f3da6ab3431394adcb99949d26b97dcda719de7eee
+  metadata.gz: d027d46289c6ea5bfba7359ff5c0b8172ea7d12d5d9cd1019a428b7b74416e6562930db5ce14508198937caed55ac2b5f1c68f1ce34c82fbe6ecbf3a92ea7100
+  data.tar.gz: 6d336b581f1bb93db017414b7080e038557200909e8a87b3a23c37fce4dfdd62b9fc5186c45272e662002f073c00a800f172488495b9bf84cd91d0a9089e275c

data/.github/FUNDING.yml

@@ -1,5 +1,2 @@
-# These are supported funding model platforms
-
-github: alteral
-ko_fi: alteral
 custom: [ 'https://revolut.me/alteral', 'https://paypal.me/aapesotskiy' ]
+ko_fi: alteral

data/.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  chat:
+    name: Automated Code Review
+    runs-on: macos-12
+    timeout-minutes: 30
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+    steps:
+      - uses: actions/checkout@v3.2.0
+
+      - uses: actions/setup-python@v4.4.0
+        with:
+          python-version: 3.11
+          cache: 'pip'
+
+      - run: bundle install
+
+      - run: brew install sonar-scanner
+
+      - run: brew install facebook/fb/idb-companion
+
+      - run: pip install -r requirements.txt
+
+      - run: bundle exec fastlane code_review
+
+      - run: bundle exec fastlane sonar_upload

data/README.md

@@ -1,36 +1,99 @@
-*xcmonkey* is a tool for doing randomised UI testing of iOS apps 🐒
+<p align="center">
+  <img src="/assets/images/xcmonkey.png"/>
+</p>
+
+<p align="center">
+  <a href="https://github.com/alteral/xcmonkey/actions"><img src="https://github.com/alteral/xcmonkey/actions/workflows/test.yml/badge.svg" /></a>
+  <a href="https://sonarcloud.io/summary/new_code?id=alteral_xcmonkey"><img src="https://sonarcloud.io/api/project_badges/measure?project=alteral_xcmonkey&metric=coverage" /></a>
+  <a href="https://rubygems.org/gems/xcmonkey"><img src="https://img.shields.io/gem/v/xcmonkey.svg?style=flat" /></a>
+  <a href="/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat" /></a>
+</p>
+
+## Description
+
+*xcmonkey* is a tool for doing randomised UI testing of iOS apps.
+
+It is inspired by and has similar goals to Android [monkey](https://developer.android.com/studio/test/monkey).
+
+*xcmonkey* uses [idb](https://fbidb.io) as a driver that's why it's quite smart and can do a lot of things, such as taps, swipes and presses. Because *xcmonkey* has access to the screen hierarchy, it can either do things blindly (like tapping on random points) or precisely (like tapping on the existing elements).
 
 ## Requirements
 
 ```bash
-brew tap facebook/fb
-brew install idb-companion
+brew install facebook/fb/idb-companion
+pip3.6 install fb-idb
 ```
 
 ## Installation
 
 ```bash
-brew install xcmonkey
+gem install xcmonkey
 ```
 
-or
+If you prefer to use [bundler](https://bundler.io/), add the following line to your `Gemfile`:
 
-```bash
-gem install xcmonkey
+```ruby
+gem 'xcmonkey'
 ```
 
 ## Usage
 
-### Test
+### To run a stress test
 
 ```bash
-xcmonkey test --udid "30694803-2018-460F-BBA6-97D7911A1AC0" --bundle-id "com.example.app"
+$ xcmonkey test --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA" --bundle-id "com.apple.Maps" --duration 100
+12:44:19.343: Device info: iPhone 14 Pro | 413EA256-CFFB-4312-94A6-12592BEE4CBA | Booted | simulator | iOS 16.2 | x86_64 | /tmp/idb/413EA256-CFFB-4312-94A6-12592BEE4CBA_companion.sock
+
+12:44:22.550: App info: com.apple.Maps | Maps | system | arm64, x86_64 | Running | Not Debuggable | pid=74636
+
+12:44:23.203: Tap: {
+  "x": 53,
+  "y": 749
+}
+
+12:44:23.511: Swipe (0.5s): {
+  "x": 196,
+  "y": 426
+} => {
+  "x": 143,
+  "y": 447
+}
+
+12:44:24.355: Press (1.2s): {
+  "x": 143,
+  "y": 323
+}
 ```
 
-### Describe point
+### To describe the required point
 
 ```bash
-xcmonkey describe -x 10 -y 10 --udid "20694801-2018-460F-BBA6-97D7911A1AC0"
+$ xcmonkey describe -x 20 -y 625 --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA"
+20:05:20.212: Device info: iPhone 14 Pro | 413EA256-CFFB-4312-94A6-12592BEE4CBA | Booted | simulator | iOS 16.2 | x86_64 | /tmp/idb/413EA256-CFFB-4312-94A6-12592BEE4CBA_companion.sock
+
+20:05:21.713: x:20 y:625 point info: {
+  "AXFrame": "{{19, 624.33333333333337}, {86, 130.66666666666663}}",
+  "AXUniqueId": "ShortcutsRowCell",
+  "frame": {
+    "y": 624.3333333333334,
+    "x": 19,
+    "width": 86,
+    "height": 130.66666666666663
+  },
+  "role_description": "button",
+  "AXLabel": "Home",
+  "content_required": false,
+  "type": "Button",
+  "title": null,
+  "help": null,
+  "custom_actions": [
+
+  ],
+  "AXValue": "Add",
+  "enabled": true,
+  "role": "AXButton",
+  "subrole": null
+}
 ```
 
 ## Code of Conduct

data/fastlane/Fastfile

@@ -20,6 +20,34 @@ lane :code_review do
   sh('bundle exec rake')
 end
 
+lane :sonar_upload do
+  update_simplecov_report
+  sonar_options =
+    if ENV['GITHUB_EVENT_NAME'] == 'pull_request'
+      {
+        sonar_login: ENV.fetch('SONAR_TOKEN', nil),
+        pull_request_branch: ENV.fetch('GITHUB_HEAD_REF', nil),
+        pull_request_base: ENV.fetch('GITHUB_BASE_REF', nil),
+        pull_request_key: ENV.fetch('PR_NUMBER', nil)
+      }
+    else
+      {
+        sonar_login: ENV.fetch('SONAR_TOKEN', nil),
+        branch_name: ENV['BRANCH_NAME'] || git_branch,
+        project_version: version
+      }
+    end
+
+  sonar(sonar_options)
+end
+
+private_lane :update_simplecov_report do
+  coverage = JSON.parse(File.read('../coverage/.resultset.json'))["RSpec"]["coverage"]
+  transformed_values = coverage.transform_values { |l| l["lines"] }
+  new_format = { "RSpec" => { "coverage" => transformed_values, "timestamp" => Time.now.to_i } }
+  File.write('../coverage/.sonar.json', JSON.pretty_generate(new_format))
+end
+
 def version
   version_path = '../lib/xcmonkey/version.rb'
   File.read(version_path).scan(/\d+/).join('.')

data/lib/xcmonkey/driver.rb

@@ -18,20 +18,34 @@ class Driver
       when :precise_tap
         tap(coordinates: el1_coordinates)
       when :blind_tap
-        x = (el1_coordinates[:x] - el2_coordinates[:x]).abs
-        y = (el1_coordinates[:y] - el2_coordinates[:y]).abs
-        tap(coordinates: { x: x, y: y })
-      when :swipe
-        swipe(start_coordinates: el1_coordinates, end_coordinates: el2_coordinates)
+        tap(coordinates: random_coordinates)
+      when :precise_press
+        press(coordinates: el1_coordinates, duration: press_duration)
+      when :blind_press
+        press(coordinates: random_coordinates, duration: press_duration)
+      when :precise_swipe
+        swipe(
+          start_coordinates: el1_coordinates,
+          end_coordinates: el2_coordinates,
+          duration: swipe_duration
+        )
+      when :blind_swipe
+        swipe(
+          start_coordinates: random_coordinates,
+          end_coordinates: random_coordinates,
+          duration: swipe_duration
+        )
+      else
+        next
       end
       app_elements = describe_ui.shuffle
       Logger.error('App lost') if app_elements.include?(@home_tracker)
     end
   end
 
-  def open_home_screen(return_tracker: false)
+  def open_home_screen(with_tracker: false)
     `idb ui button --udid #{udid} HOME`
-    detect_home_unique_element if return_tracker
+    detect_home_unique_element if with_tracker
   end
 
   def describe_ui
@@ -46,6 +60,7 @@ class Driver
 
   def launch_app
     `idb launch --udid #{udid} #{bundle_id}`
+    wait_until_app_launched
   end
 
   def terminate_app
@@ -54,7 +69,7 @@ class Driver
 
   def boot_simulator
     `idb boot #{udid}`
-    ensure_simulator_was_booted
+    Logger.error("Failed to boot #{udid}") if device_info['state'] != 'Booted'
   end
 
   def shutdown_simulator
@@ -81,11 +96,6 @@ class Driver
     boot_simulator if device.include?('simulator')
   end
 
-  def ensure_simulator_was_booted
-    sim = list_booted_simulators.detect { |target| target.include?(udid) }
-    Logger.error("Failed to boot #{udid}") if sim.nil?
-  end
-
   def list_apps
     `idb list-apps --udid #{udid}`
   end
@@ -95,20 +105,58 @@ class Driver
     `idb ui tap --udid #{udid} #{coordinates[:x]} #{coordinates[:y]}`
   end
 
-  def swipe(start_coordinates:, end_coordinates:)
-    Logger.info('Swipe:', payload: "#{JSON.pretty_generate(start_coordinates)} => #{JSON.pretty_generate(end_coordinates)}")
+  def press(coordinates:, duration:)
+    Logger.info("Press (#{duration}s):", payload: JSON.pretty_generate(coordinates))
+    `idb ui tap --udid #{udid} --duration #{duration} #{coordinates[:x]} #{coordinates[:y]}`
+  end
+
+  def swipe(start_coordinates:, end_coordinates:, duration:)
+    Logger.info(
+      "Swipe (#{duration}s):",
+      payload: "#{JSON.pretty_generate(start_coordinates)} => #{JSON.pretty_generate(end_coordinates)}"
+    )
     coordinates = "#{start_coordinates[:x]} #{start_coordinates[:y]} #{end_coordinates[:x]} #{end_coordinates[:y]}"
-    `idb ui swipe --udid #{udid} --duration 0.5 #{coordinates}`
+    `idb ui swipe --udid #{udid} --duration #{duration} #{coordinates}`
   end
 
   def central_coordinates(element)
     frame = element['frame']
+    x = (frame['x'] + (frame['width'] / 2)).abs.to_i
+    y = (frame['y'] + (frame['height'] / 2)).abs.to_i
+    {
+      x: x > screen_size[:width].to_i ? rand(0..screen_size[:width].to_i) : x,
+      y: y > screen_size[:height].to_i ? rand(0..screen_size[:height].to_i) : y
+    }
+  end
+
+  def random_coordinates
     {
-      x: (frame['x'] + (frame['width'] / 2)).to_i,
-      y: (frame['y'] + (frame['height'] / 2)).to_i
+      x: rand(0..screen_size[:width].to_i),
+      y: rand(0..screen_size[:height].to_i)
     }
   end
 
+  def device_info
+    @device_info ||= JSON.parse(`idb describe --udid #{udid} --json`)
+    @device_info
+  end
+
+  def screen_size
+    screen_dimensions = device_info['screen_dimensions']
+    {
+      width: screen_dimensions['width_points'],
+      height: screen_dimensions['height_points']
+    }
+  end
+
+  def swipe_duration
+    rand(0.1..0.7).ceil(1)
+  end
+
+  def press_duration
+    rand(0.5..1.5).ceil(1)
+  end
+
   private
 
   def ensure_driver_installed
@@ -122,4 +170,16 @@ class Driver
     end
     @home_tracker
   end
+
+  def wait_until_app_launched
+    app_info = nil
+    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
+    end
+    Logger.error("Can't run the app #{bundle_id}") if app_info.nil?
+    Logger.info('App info:', payload: app_info)
+  end
 end

data/lib/xcmonkey/version.rb

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

data/lib/xcmonkey.rb

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

data/requirements.txt

@@ -0,0 +1 @@
+fb-idb

data/sonar-project.properties

@@ -0,0 +1,11 @@
+sonar.projectKey=alteral_xcmonkey
+sonar.projectName=xcmonkey
+sonar.host.url=https://sonarcloud.io
+sonar.organization=alteral
+sonar.ruby.coverage.reportPaths=coverage/.sonar.json
+sonar.ruby.coverage.framework=RSpec
+sonar.sources=lib/
+sonar.inclusions=lib/**/*.rb
+sonar.exclusions=lib/**/version.rb
+sonar.tests=spec/
+sonar.test.inclusions=spec/*_spec.rb

data/spec/driver_spec.rb

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

data/spec/logger_spec.rb

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

data/spec/xcmonkey_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcmonkey
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - alteral
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-27 00:00:00.000000000 Z
+date: 2022-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -218,7 +218,7 @@ files:
 - ".github/FUNDING.yml"
 - ".github/dependabot.yml"
 - ".github/pull_request_template.md"
-- ".github/workflows/Test.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -227,6 +227,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- assets/images/xcmonkey.png
 - bin/console
 - bin/setup
 - bin/xcmonkey
@@ -236,6 +237,8 @@ files:
 - lib/xcmonkey/driver.rb
 - lib/xcmonkey/logger.rb
 - lib/xcmonkey/version.rb
+- requirements.txt
+- sonar-project.properties
 - spec/describer_spec.rb
 - spec/driver_spec.rb
 - spec/logger_spec.rb

data/.github/workflows/Test.yml

@@ -1,29 +0,0 @@
-name: Test
-
-on:
-  pull_request:
-    types: [opened, synchronize]
-
-jobs:
-  chat:
-    name: Checks
-    timeout-minutes: 15
-    runs-on: macos-12
-    steps:
-      - uses: actions/checkout@v3.1.0
-        with:
-          fetch-depth: '0'
-      - uses: actions/cache@v3
-        id: bundler-cache
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-
-      - name: Bundler
-        run: |
-          gem install bundler
-          bundle config path vendor/bundle
-          bundle check || bundle install --jobs 4 --retry 3
-      - name: Rubocop
-        run: bundle exec rake