xcmonkey 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd9f0e62a4820d7e9041cf5219b79941fd416829f2943c68a354ed5dd46dd6aa
-  data.tar.gz: 80debe535a05457eb8cce60b1c9f43feae95e00b1849206f1e8c2d0c2194ae44
+  metadata.gz: 7a6aa190c1c4cfa28f97b20524c907da488aad2d78f2c1dda8f827899f6ee53f
+  data.tar.gz: 534245a695ed0f030df459986c326fb356b3593baec3bc6750eb1cc622d32390
 SHA512:
-  metadata.gz: 8ef6ae85c92902d29d04d59b0d2ec4ebed20877054edaa8c00f767db88e3c6d5232f8603159b78478562a53b154a7249ac6721ab20b14524d755367daaf73100
-  data.tar.gz: 57e3829a912bb9d7997f8bfa94e7748cefbe9ea4130efaa3fe8167ae91b70d8e90bbb1d30a5dccf997717ac2c83626cf761947f826239d85883c7f2936791794
+  metadata.gz: 41415c8c576a3b6887ee87d44f4c4e571f1e7abda3a96f23abff52cebe77438be70ee76ab18f83a92b78cca2da429cf0c12305b2d3a8ca59b0b2e7e26405ec23
+  data.tar.gz: 93d86451b2b7b8d2a755744ea47be375d042763ea550ddbdef5faff530bbf775e46ab24ede0f6d9dfe424f02ef4c2a923ccd3f342d1872cd6f4d82dcefae7cef

data/.github/FUNDING.yml

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

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: 15
+    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/.gitignore

@@ -1,15 +1,41 @@
-.DS_Store
-/.idea/
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+fastlane/README.md
+fastlane/report.xml
+coverage
+test-results
+
+# Ruby
+*.gem
+Gemfile.lock
 /pkg/
-/PageObjects/
-/attach/
-/Attachments/
-/XCResults/
-*.lock
-*.xcuserdatad
-*.png
-*.html
-port
 /vendor/
-coverage/
-test-results/
+
+# OSX
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Xcode
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+
+# Sonar
+.scannerwork

data/README.md

@@ -1,22 +1,25 @@
-# XCMonkey
+<p align="center">
+  <img src="/assets/images/xcmonkey.png"/>
+</p>
 
-A tool for doing randomised UI testing of iOS apps 🙈
+<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>
+
+*xcmonkey* is a tool for doing randomised UI testing of iOS apps.
 
 ## 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
-```
-
-or
-
 ```bash
 gem install xcmonkey
 ```
@@ -26,11 +29,67 @@ gem install xcmonkey
 ### 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.mobilesafari"
+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.mobilesafari | MobileSafari | system | x86_64, arm64 | Running | Not Debuggable | pid=43398
+
+12:44:23.203: Tap: {
+  "x": 53,
+  "y": 749
+}
+
+12:44:23.511: Swipe: {
+  "x": 196,
+  "y": 426
+} => {
+  "x": 143,
+  "y": 447
+}
+
+12:44:24.355: Tap: {
+  "x": 143,
+  "y": 323
+}
 ```
 
 ### Describe point
 
 ```bash
-xcmonkey describe -x 10 -y 10 --udid "20694801-2018-460F-BBA6-97D7911A1AC0"
+$ xcmonkey describe -x 125 -y 760 --udid "413EA256-CFFB-4312-94A6-12592BEE4CBA"
+12:41:03.840: 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:41:05.342: x:125 y:760 point info: {
+  "AXFrame": "{{120, 759}, {64, 64}}",
+  "AXUniqueId": "Safari",
+  "frame": {
+    "y": 759,
+    "x": 120,
+    "width": 64,
+    "height": 64
+  },
+  "role_description": "button",
+  "AXLabel": "Safari",
+  "content_required": false,
+  "type": "Button",
+  "title": null,
+  "help": "Double tap to open",
+  "custom_actions": [
+    "Edit mode",
+    "Today",
+    "App Library"
+  ],
+  "AXValue": "",
+  "enabled": true,
+  "role": "AXButton",
+  "subrole": null
+}
 ```
+
+## Code of Conduct
+
+Help us keep *xcmonkey* open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file.

data/bin/xcmonkey

@@ -9,7 +9,7 @@ require_relative '../lib/xcmonkey/version'
 
 module Xcmonkey
   program :version, VERSION
-  program :description, 'A tool for doing randomised UI testing of iOS apps'
+  program :description, 'xcmonkey is a tool for doing randomised UI testing of iOS apps'
 
   command :test do |c|
     c.syntax = 'xcmonkey test [options]'

data/fastlane/Fastfile

@@ -8,7 +8,7 @@ lane :release do
   set_github_release(
     repository_name: 'alteral/xcmonkey',
     api_token: ENV.fetch("GITHUB_TOKEN", nil),
-    name: "XCMonkey v#{version}",
+    name: "xcmonkey v#{version}",
     tag_name: "v#{version}",
     description: "v#{version}",
     commitish: git_branch,
@@ -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

@@ -23,6 +23,8 @@ class Driver
         tap(coordinates: { x: x, y: y })
       when :swipe
         swipe(start_coordinates: el1_coordinates, end_coordinates: el2_coordinates)
+      else
+        next
       end
       app_elements = describe_ui.shuffle
       Logger.error('App lost') if app_elements.include?(@home_tracker)
@@ -46,6 +48,7 @@ class Driver
 
   def launch_app
     `idb launch --udid #{udid} #{bundle_id}`
+    wait_until_app_launched
   end
 
   def terminate_app
@@ -122,4 +125,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.0'
+  VERSION = '0.1.2'
   GEM_NAME = 'xcmonkey'
 end

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

@@ -85,6 +85,14 @@ describe Driver do
     expect(actual_coordinates).to eq(expected_coordinates)
   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 that simulator was not booted' do
     driver.shutdown_simulator
     error_message = "Failed to boot #{udid}"

data/xcmonkey.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["alteral"]
   spec.email         = ["a.alterpesotskiy@mail.ru"]
 
-  spec.summary       = "A tool for doing randomised UI testing of iOS apps"
+  spec.summary       = "xcmonkey is a tool for doing randomised UI testing of iOS apps"
   spec.homepage      = "https://github.com/alteral/xcmonkey"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcmonkey
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - alteral
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-27 00:00:00.000000000 Z
+date: 2022-12-28 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
@@ -266,5 +269,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A tool for doing randomised UI testing of iOS apps
+summary: xcmonkey is a tool for doing randomised UI testing of iOS apps
 test_files: []

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