xcmonkey 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd9f0e62a4820d7e9041cf5219b79941fd416829f2943c68a354ed5dd46dd6aa
+  data.tar.gz: 80debe535a05457eb8cce60b1c9f43feae95e00b1849206f1e8c2d0c2194ae44
+SHA512:
+  metadata.gz: 8ef6ae85c92902d29d04d59b0d2ec4ebed20877054edaa8c00f767db88e3c6d5232f8603159b78478562a53b154a7249ac6721ab20b14524d755367daaf73100
+  data.tar.gz: 57e3829a912bb9d7997f8bfa94e7748cefbe9ea4130efaa3fe8167ae91b70d8e90bbb1d30a5dccf997717ac2c83626cf761947f826239d85883c7f2936791794

data/.fasterer.yml

@@ -0,0 +1,5 @@
+speedups:
+  each_with_index_vs_while: false
+
+exclude_paths:
+  - 'vendor/**/*.rb'

data/.github/FUNDING.yml

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

data/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 1
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 1

data/.github/pull_request_template.md

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

data/.github/workflows/Test.yml

@@ -0,0 +1,29 @@
+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

data/.gitignore

@@ -0,0 +1,15 @@
+.DS_Store
+/.idea/
+/pkg/
+/PageObjects/
+/attach/
+/Attachments/
+/XCResults/
+*.lock
+*.xcuserdatad
+*.png
+*.html
+port
+/vendor/
+coverage/
+test-results/

data/.rspec

@@ -0,0 +1,5 @@
+--require spec_helper
+--color
+--format d
+--format RspecJunitFormatter
+--out test-results/rspec/rspec.xml

data/.rubocop.yml

@@ -0,0 +1,198 @@
+---
+require:
+- rubocop/require_tools
+- rubocop-performance
+- rubocop-rspec
+- rubocop-rake
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+  Include:
+  - "**/*.rb"
+  - "**/*file"
+  - "**/*.gemspec"
+  - "*/lib/assets/*Template"
+  - "*/lib/assets/*TemplateAndroid"
+  Exclude:
+  - "**/lib/assets/custom_action_template.rb"
+  - "./vendor/**/*"
+  - "**/lib/assets/DefaultFastfileTemplate"
+  - "**/lib/assets/MatchfileTemplate"
+  - "**/spec/fixtures/broken_files/broken_file.rb"
+  - "**/*.provisionprofile"
+Style/MultipleComparison:
+  Enabled: false
+Style/RedundantFetchBlock:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Enabled: false
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/SafeNavigation:
+  Enabled: false
+Performance/RegexpMatch:
+  Enabled: false
+Performance/StringReplacement:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Naming/VariableNumber:
+  Enabled: false
+Style/MissingRespondToMissing:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/NumericLiteralPrefix:
+  Enabled: false
+Style/TernaryParentheses:
+  Enabled: false
+Style/EmptyMethod:
+  Enabled: false
+Lint/UselessAssignment:
+  Exclude:
+  - "**/spec/**/*"
+Require/MissingRequireStatement:
+  Enabled: false
+Layout/FirstHashElementIndentation:
+  Enabled: false
+Layout/IndentationWidth:
+  Enabled: false
+Layout/IndentationStyle:
+  Enabled: false
+Layout/IndentationConsistency:
+  Enabled: false
+Layout/HashAlignment:
+  Enabled: false
+Layout/DotPosition:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/SymbolArray:
+  Enabled: false
+Layout/HeredocIndentation:
+  Enabled: false
+Style/MixinGrouping:
+  Exclude:
+  - "**/spec/**/*"
+Lint/SuppressedException:
+  Enabled: false
+Lint/SymbolConversion:
+  Enabled: false
+Lint/UnusedBlockArgument:
+  Enabled: false
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+Style/GlobalVars:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Style/WordArray:
+  MinSize: 19
+Style/SignalException:
+  Enabled: false
+Style/RedundantReturn:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/AndOr:
+  Enabled: true
+  EnforcedStyle: conditionals
+Metrics/ClassLength:
+  Max: 320
+Layout/LineLength:
+  Max: 370
+Metrics/ParameterLists:
+  Max: 17
+Metrics/PerceivedComplexity:
+  Max: 20
+Style/GuardClause:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
+Style/RedundantSelf:
+  Enabled: false
+Lint/UnusedMethodArgument:
+  Enabled: false
+Lint/ParenthesesAsGroupedExpression:
+  Exclude:
+  - "**/spec/**/*"
+Naming/PredicateName:
+  Enabled: false
+Naming/MethodParameterName:
+  Enabled: false
+Style/PerlBackrefs:
+  Enabled: false
+Layout/SpaceAroundOperators:
+  Exclude:
+  - "**/spec/actions_specs/xcodebuild_spec.rb"
+Naming/FileName:
+  Exclude:
+  - "**/Dangerfile"
+  - "**/Brewfile"
+  - "**/Gemfile"
+  - "**/Podfile"
+  - "**/Rakefile"
+  - "**/Fastfile"
+  - "**/Deliverfile"
+  - "**/Snapfile"
+  - "**/Pluginfile"
+  - "**/*.gemspec"
+Style/Documentation:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false
+Style/ZeroLengthPredicate:
+  Enabled: false
+Style/IfInsideElse:
+  Enabled: false
+Style/CollectionMethods:
+  Enabled: false
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  AllowedMethods:
+  - require
+  - require_relative
+  - fastlane_require
+  - gem
+  - program
+  - command
+  - raise
+  - attr_accessor
+  - attr_reader
+  - desc
+  - lane
+  - private_lane
+  - platform
+  - to
+  - not_to
+  - describe
+  - it
+  - be
+  - context
+  - before
+  - after
+  - and
+RSpec/ExampleLength:
+  Max: 20
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at a.alterpesotskiy@corp.mail.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in xcmonkey.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Alexey Alter-Pesotskiy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# XCMonkey
+
+A tool for doing randomised UI testing of iOS apps 🙈
+
+## Requirements
+
+```bash
+brew tap facebook/fb
+brew install idb-companion
+```
+
+## Installation
+
+```bash
+brew install xcmonkey
+```
+
+or
+
+```bash
+gem install xcmonkey
+```
+
+## Usage
+
+### Test
+
+```bash
+xcmonkey test --udid "30694803-2018-460F-BBA6-97D7911A1AC0" --bundle-id "com.example.app"
+```
+
+### Describe point
+
+```bash
+xcmonkey describe -x 10 -y 10 --udid "20694801-2018-460F-BBA6-97D7911A1AC0"
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new(:rubocop)
+
+desc 'Run Fasterer'
+task :fasterer do
+  sh('bundle exec fasterer')
+end
+
+task(default: [:spec, :rubocop, :fasterer])

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xcmonkey"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/xcmonkey

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+require_relative '../lib/xcmonkey'
+require_relative '../lib/xcmonkey/describer'
+require_relative '../lib/xcmonkey/logger'
+require_relative '../lib/xcmonkey/driver'
+require_relative '../lib/xcmonkey/version'
+
+module Xcmonkey
+  program :version, VERSION
+  program :description, 'A tool for doing randomised UI testing of iOS apps'
+
+  command :test do |c|
+    c.syntax = 'xcmonkey test [options]'
+    c.description = 'Runs monkey test'
+    c.option('-u', '--udid STRING', String, 'Set device UDID')
+    c.option('-b', '--bundle-id STRING', String, 'Set target bundle identifier')
+    c.option('-d', '--duration SECONDS', Integer, 'Test duration in seconds')
+    c.action do |args, options|
+      options.default(duration: 60)
+      params = {
+        udid: options.udid,
+        bundle_id: options.bundle_id,
+        duration: options.duration
+      }
+      Xcmonkey.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|
+      params = {
+        udid: options.udid,
+        x: options.x,
+        y: options.y
+      }
+      Describer.new(params).run
+    end
+  end
+end

data/fastlane/Fastfile

@@ -0,0 +1,26 @@
+skip_docs
+
+lane :release do
+  code_review
+  sh('bundle exec rake build')
+  gem_path = "pkg/xcmonkey-#{version}.gem"
+  sh("gem push ../#{gem_path}")
+  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}",
+    commitish: git_branch,
+    upload_assets: [gem_path]
+  )
+end
+
+lane :code_review do
+  sh('bundle exec rake')
+end
+
+def version
+  version_path = '../lib/xcmonkey/version.rb'
+  File.read(version_path).scan(/\d+/).join('.')
+end

data/lib/xcmonkey/describer.rb

@@ -0,0 +1,22 @@
+class Describer
+	attr_accessor :udid, :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)
+	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
+end

data/lib/xcmonkey/driver.rb

@@ -0,0 +1,125 @@
+class Driver
+  attr_accessor :udid, :bundle_id, :duration
+
+  def initialize(params)
+    self.udid = params[:udid]
+    self.bundle_id = params[:bundle_id]
+    self.duration = params[:duration]
+    ensure_driver_installed
+  end
+
+  def monkey_test(gestures)
+    app_elements = describe_ui.shuffle
+    current_time = Time.now
+    while Time.now < current_time + duration
+      el1_coordinates = central_coordinates(app_elements.first)
+      el2_coordinates = central_coordinates(app_elements.last)
+      case gestures.sample
+      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)
+      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)
+    `idb ui button --udid #{udid} HOME`
+    detect_home_unique_element if return_tracker
+  end
+
+  def describe_ui
+    JSON.parse(`idb ui describe-all --udid #{udid}`)
+  end
+
+  def describe_point(x, y)
+    point_info = JSON.parse(`idb ui describe-point --udid #{udid} #{x} #{y}`)
+    Logger.info("x:#{x} y:#{y} point info:", payload: JSON.pretty_generate(point_info))
+    point_info
+  end
+
+  def launch_app
+    `idb launch --udid #{udid} #{bundle_id}`
+  end
+
+  def terminate_app
+    `idb terminate --udid #{udid} #{bundle_id} 2>/dev/null`
+  end
+
+  def boot_simulator
+    `idb boot #{udid}`
+    ensure_simulator_was_booted
+  end
+
+  def shutdown_simulator
+    `idb shutdown #{udid}`
+  end
+
+  def list_targets
+    @list_targets ||= `idb list-targets`.split("\n")
+    @list_targets
+  end
+
+  def list_booted_simulators
+    `idb list-targets`.split("\n").grep(/Booted/)
+  end
+
+  def ensure_app_installed
+    Logger.error("App #{bundle_id} is not installed on device #{udid}") unless list_apps.include?(bundle_id)
+  end
+
+  def ensure_device_exists
+    device = list_targets.detect { |target| target.include?(udid) }
+    Logger.error("Can't find device #{udid}") if device.nil?
+    Logger.info('Device info:', payload: device)
+    boot_simulator if device.include?('simulator')
+  end
+
+  def ensure_simulator_was_booted
+    sim = list_booted_simulators.detect { |target| target.include?(udid) }
+    Logger.error("Failed to boot #{udid}") if sim.nil?
+  end
+
+  def list_apps
+    `idb list-apps --udid #{udid}`
+  end
+
+  def tap(coordinates:)
+    Logger.info('Tap:', payload: JSON.pretty_generate(coordinates))
+    `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)}")
+    coordinates = "#{start_coordinates[:x]} #{start_coordinates[:y]} #{end_coordinates[:x]} #{end_coordinates[:y]}"
+    `idb ui swipe --udid #{udid} --duration 0.5 #{coordinates}`
+  end
+
+  def central_coordinates(element)
+    frame = element['frame']
+    {
+      x: (frame['x'] + (frame['width'] / 2)).to_i,
+      y: (frame['y'] + (frame['height'] / 2)).to_i
+    }
+  end
+
+  private
+
+  def ensure_driver_installed
+    Logger.error("'idb' doesn't seem to be installed") if `which idb`.strip.empty?
+  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'
+    end
+    @home_tracker
+  end
+end

data/lib/xcmonkey/logger.rb

@@ -0,0 +1,23 @@
+class Logger
+  def self.info(message, payload: nil)
+    log(message, color: :light_cyan, payload: payload)
+  end
+
+  def self.warn(message, payload: nil)
+    log(message, color: :light_yellow, payload: payload)
+  end
+
+  def self.error(message, payload: nil)
+    log(message, color: :light_red, payload: payload)
+    Process.exit(1)
+  end
+
+  def self.log(message, color:, payload:)
+    message = "#{Time.now.strftime('%k:%M:%S.%L')}: #{message}".colorize(color)
+    if payload
+      print(message, ' ', payload.colorize(:light_green), "\n\n")
+    else
+      puts("#{message}\n\n")
+    end
+  end
+end

data/lib/xcmonkey/version.rb

@@ -0,0 +1,4 @@
+module Xcmonkey
+  VERSION = '0.1.0'
+  GEM_NAME = 'xcmonkey'
+end

data/lib/xcmonkey.rb

@@ -0,0 +1,41 @@
+require 'json'
+require 'colorize'
+require_relative 'xcmonkey/describer'
+require_relative 'xcmonkey/version'
+require_relative 'xcmonkey/logger'
+require_relative 'xcmonkey/driver'
+
+module Xcmonkey
+	class Xcmonkey
+	  attr_accessor :udid, :bundle_id, :duration, :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(return_tracker: true)
+			driver.launch_app
+			driver.monkey_test(gestures)
+    end
+
+		def gestures
+			[:precise_tap, :blind_tap, :swipe]
+		end
+
+		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?
+			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
+end

data/spec/describer_spec.rb

@@ -0,0 +1,43 @@
+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
+    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
+  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
+  end
+
+  it 'verifies `udid` param is required' do
+    expect(Logger).to receive(:error).with('UDID should be provided')
+    described_class.new(x: 10, y: 10)
+  end
+
+  it 'verifies `x` param is required' do
+    expect(Logger).to receive(:error).with('`x` point coordinate should be provided')
+    described_class.new(udid: udid, y: '10')
+  end
+
+  it 'verifies `y` param is required' do
+    expect(Logger).to receive(:error).with('`y` point coordinate should be provided')
+    described_class.new(udid: udid, x: '10')
+  end
+
+  it 'verifies `x` param is integer' do
+    expect(Logger).to receive(:error).with('`x` point coordinate should be provided')
+    described_class.new(udid: udid, x: 'test', y: '10')
+  end
+
+  it 'verifies `y` param is integer' do
+    expect(Logger).to receive(:error).with('`y` point coordinate should be provided')
+    described_class.new(udid: udid, x: '10', y: 'test')
+  end
+end

data/spec/driver_spec.rb

@@ -0,0 +1,94 @@
+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) }
+
+  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
+  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(return_tracker: true)
+    expect(home_tracker).not_to be_empty
+  end
+
+  it 'verifies that list of targets can be showed' do
+    list_targets = driver.list_targets
+    expect(list_targets).not_to be_empty
+  end
+
+  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)
+  end
+
+  it 'verifies that app installed' do
+    driver.boot_simulator
+    error_message = "App #{bundle_id} is not installed on device #{udid}"
+    expect(Logger).not_to receive(:error).with(error_message, payload: nil)
+    expect { driver.ensure_app_installed }.not_to raise_error
+  end
+
+  it 'verifies that app is not installed' do
+    driver.boot_simulator
+    bundle_id = 'fake.app.bundle.id'
+    error_message = "App #{bundle_id} is not installed on device #{udid}"
+    driver = described_class.new(udid: udid, bundle_id: bundle_id)
+    expect(Logger).to receive(:log).with(error_message, color: :light_red, payload: nil)
+    expect { driver.ensure_app_installed }.to raise_error(SystemExit) { |e| expect(e.status).to eq(1) }
+  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(driver).to receive(:boot_simulator)
+    expect { driver.ensure_device_exists }.not_to raise_error
+  end
+
+  it 'verifies that device does not exist' do
+    udid = '1234-5678'
+    error_message = "Can't find device #{udid}"
+    driver = described_class.new(udid: udid, bundle_id: bundle_id)
+    expect(Logger).to receive(:log).with(error_message, color: :light_red, payload: nil)
+    expect { driver.ensure_device_exists }.to raise_error(SystemExit) { |e| expect(e.status).to eq(1) }
+  end
+
+  it 'verifies that idb installed' do
+    error_message = "'idb' doesn't seem to be installed"
+    expect(Logger).not_to receive(:error).with(error_message, payload: nil)
+    expect { driver.send(:ensure_driver_installed) }.not_to raise_error
+  end
+
+  it 'verifies that element central coordinates can be found' do
+    element = JSON.parse('{ "frame": { "x": 0, "y": 0, "width": 100, "height": 100 } }')
+    expected_coordinates = { 'x': 50, 'y': 50 }
+    actual_coordinates = driver.central_coordinates(element)
+    expect(actual_coordinates).to eq(expected_coordinates)
+  end
+
+  it 'verifies that simulator was not booted' do
+    driver.shutdown_simulator
+    error_message = "Failed to boot #{udid}"
+    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) }
+  end
+end

data/spec/logger_spec.rb

@@ -0,0 +1,36 @@
+describe Logger do
+  let(:message) { 'test' }
+  let(:payload) { '{"test": true}' }
+
+  it 'verifies info log without payload' do
+    expect(described_class).to receive(:log).with(message, color: :light_cyan, payload: nil)
+    described_class.info(message)
+  end
+
+  it 'verifies info log with payload' do
+    expect(described_class).to receive(:log).with(message, color: :light_cyan, payload: payload)
+    described_class.info(message, payload: payload)
+  end
+
+  it 'verifies warning log without payload' do
+    expect(described_class).to receive(:log).with(message, color: :light_yellow, payload: nil)
+    described_class.warn(message)
+  end
+
+  it 'verifies warning log with payload' do
+    expect(described_class).to receive(:log).with(message, color: :light_yellow, payload: payload)
+    described_class.warn(message, payload: payload)
+  end
+
+  it 'verifies error log without payload' do
+    expect(described_class).to receive(:log).with(message, color: :light_red, payload: nil)
+    expect { described_class.error(message) }
+      .to raise_error(SystemExit) { |e| expect(e.status).to eq(1) }
+  end
+
+  it 'verifies error log with payload' do
+    expect(described_class).to receive(:log).with(message, color: :light_red, payload: payload)
+    expect { described_class.error(message, payload: payload) }
+      .to raise_error(SystemExit) { |e| expect(e.status).to eq(1) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+require 'simplecov'
+
+# SimpleCov.minimum_coverage(80)
+SimpleCov.start
+
+# This module is only used to check the environment is currently a testing env
+module SpecHelper
+end
+
+require 'xcmonkey'

data/spec/xcmonkey_spec.rb

@@ -0,0 +1,46 @@
+describe Xcmonkey do
+  describe Xcmonkey::Xcmonkey do
+    let(:params) { { udid: '123', bundle_id: 'example.com.app', duration: 10 } }
+    let(:duration_error_msg) { 'Duration must be Integer and not less than 1 second' }
+
+    it 'verifies gestures' do
+      gestures = described_class.new(params).gestures
+      expect(gestures) =~ [:swipe, :precise_tap, :blind_tap]
+    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
+  end
+end

data/xcmonkey.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xcmonkey/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = Xcmonkey::GEM_NAME
+  spec.version       = Xcmonkey::VERSION
+  spec.authors       = ["alteral"]
+  spec.email         = ["a.alterpesotskiy@mail.ru"]
+
+  spec.summary       = "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"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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'
+end

metadata

@@ -0,0 +1,270 @@
+--- !ruby/object:Gem::Specification
+name: xcmonkey
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alteral
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-27 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- a.alterpesotskiy@mail.ru
+executables:
+- xcmonkey
+extensions: []
+extra_rdoc_files: []
+files:
+- ".fasterer.yml"
+- ".github/FUNDING.yml"
+- ".github/dependabot.yml"
+- ".github/pull_request_template.md"
+- ".github/workflows/Test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/xcmonkey
+- fastlane/Fastfile
+- lib/xcmonkey.rb
+- lib/xcmonkey/describer.rb
+- lib/xcmonkey/driver.rb
+- lib/xcmonkey/logger.rb
+- lib/xcmonkey/version.rb
+- spec/describer_spec.rb
+- spec/driver_spec.rb
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+- spec/xcmonkey_spec.rb
+- xcmonkey.gemspec
+homepage: https://github.com/alteral/xcmonkey
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A tool for doing randomised UI testing of iOS apps
+test_files: []