percy-appium-app 0.0.3 → 0.0.5.pre.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9d215b1a1e9daf04d5672a65a909db34bf2f9118e7551a72a83ba742e3dcbf
-  data.tar.gz: d5bd4454dbb19e0f649025ebb21692a847b1e6f14a4bf85f67c16749ff462349
+  metadata.gz: f293168326d6bddeb11b1b5bdc1bb7beb7ec9c72d0fdd71b4a4122ca508ca7d0
+  data.tar.gz: 7145c22d760541bb741a251e58024e0f1027efc8b16fe25c760cd62c05ae6b6f
 SHA512:
-  metadata.gz: 10f4a8d07bdc08deb1068025032f05cedacd3959244a1fbd5465ce9ed2eac0a502ab629abeb3087849ad62d9edf874dc298b49a8e14c9c2e36b2b4da71d9f1f6
-  data.tar.gz: ef3897862dacf57e5b64b8026a0272415b7ea47a09cdd80e83bc8bcc51d7be02dc4243b4b3e99f268a841934b0131112d37610abef8c5801b21e0e208eb17c8d
+  metadata.gz: bd51272ede73d35decf0b7f143aa6345a5631401923981b5bd1b270fc51172c1779c5004b870f87a255a38e2bac0be434d11454eae3ebb7bcfc11131c65c7d3a
+  data.tar.gz: 8415678acd851a743154daaafb0b944c7c1dbf256764182637c51c8d47ea396665ff7a4a92d7ca930308e9b35bcb5aaf275ad6813bece2aa8311e566a6531909

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -3,7 +3,7 @@
 source 'https://rubygems.org'
 
 gem 'appium_console'
-gem 'appium_lib'
+gem 'appium_lib', '>= 11.2.0'
 gem 'dotenv'
 gem 'minitest'
 gem 'rubocop', require: false

data/README.md

@@ -93,6 +93,7 @@ $ percy app:exec -- [ruby test command]
     - `top_scrollview_offset`: (**optional**) - [Alpha] Offset from top of scrollview; int
     - `bottom_scrollview_offset` (**optional**) - [Alpha] Offset from bottom of scrollview; int
 - `full_screen` (**optional**) - Indicate whether app is full screen; boolean [ needs @percy/cli 1.20.2+ ];
+- `sync` (**optional**) - Waits for screenshot to be processed and gives the processed result of screenshot [needs @percy/cli v1.28.0-beta.0+]; boolean
 - `scrollable_xpath` (**optional**) - [Alpha] Scrollable element xpath for fullpage [ needs @percy/cli 1.20.2+ ]; string
 - `scrollable_id` (**optional**) - [Alpha] Scrollable element accessibility id for fullpage [ needs @percy/cli 1.20.2+ ]; string
 - `ignore_regions_xpaths` (**optional**) - Elements xpaths that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of string
@@ -139,6 +140,7 @@ percy_screenshot_flutter(driver, name, **kwargs)
 - `driver` (**required**) - A appium driver instance
 - `name` (**required**) - The screenshot name; must be unique to each screenshot
 - `options` (**optional**) - There are various options supported by percy_screenshot to server further functionality.
+    - `sync` - Boolean value by default it falls back to `false`, Gives the processed result around screenshot [From CLI v1.28.0-beta.0+].
     - `freeze_animated_image` - Boolean value by default it falls back to `false`, you can pass `true` and percy will freeze image based animations.
     - `freeze_image_by_selectors` -List of selectors. Images will be freezed which are passed using selectors. For this to work `freeze_animated_image` must be set to true.
     - `freeze_image_by_xpaths` - List of xpaths. Images will be freezed which are passed using xpaths. For this to work `freeze_animated_image` must be set to true.

data/percy/lib/app_percy.rb

@@ -49,7 +49,6 @@ module Percy
       end
 
       @provider.screenshot(name, **kwargs)
-      nil
     end
 
     attr_reader :percy_options

data/percy/lib/cache.rb

@@ -50,5 +50,10 @@ module Percy
 
       session_ids.each { |session_id| @@cache.delete(session_id) }
     end
+
+    # Added only for tests
+    def self.force_cleanup_cache
+      @@cache = {}
+    end
   end
 end

data/percy/lib/cli_wrapper.rb

@@ -49,13 +49,14 @@ module Percy
     end
 
     def post_screenshots(name, tag, tiles, external_debug_url = nil, ignored_elements_data = nil,
-                        considered_elements_data = nil)
-      body = request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data)
+                        considered_elements_data = nil, sync = nil)
+      body = request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data, sync)
       body['client_info'] = Percy::Environment.get_client_info
       body['environment_info'] = Percy::Environment.get_env_info
 
       uri = URI("#{PERCY_CLI_API}/percy/comparison")
       http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = 600 # seconds
       request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
       request.body = body.to_json
 
@@ -104,7 +105,11 @@ module Percy
       body['environment_info'] = Percy::Environment.get_env_info
 
       uri = URI("#{PERCY_CLI_API}/percy/automateScreenshot")
-      response = Net::HTTP.post(uri, body.to_json, 'Content-Type' => 'application/json')
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = 600 # seconds
+      request = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
+      request.body = body.to_json
+      response = http.request(request)
 
       # Handle errors
       raise CLIException, "Error: #{response.message}" unless response.is_a?(Net::HTTPSuccess)
@@ -119,7 +124,7 @@ module Percy
       data
     end
 
-    def request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data)
+    def request_body(name, tag, tiles, external_debug_url, ignored_elements_data, considered_elements_data, sync)
       tiles = tiles.map(&:to_h)
       {
         'name' => name,
@@ -127,7 +132,8 @@ module Percy
         'tiles' => tiles,
         'ignored_elements_data' => ignored_elements_data,
         'external_debug_url' => external_debug_url,
-        'considered_elements_data' => considered_elements_data
+        'considered_elements_data' => considered_elements_data,
+        'sync' => sync
       }
     end
   end

data/percy/lib/percy_automate.rb

@@ -43,7 +43,7 @@ module Percy
           'consider_region_elements' => consider_region_elements
         }
 
-        Percy::CLIWrapper.new.post_poa_screenshots(
+        response = Percy::CLIWrapper.new.post_poa_screenshots(
           name,
           metadata.session_id,
           metadata.command_executor_url,
@@ -51,11 +51,12 @@ module Percy
           metadata.session_capabilities,
           options.merge(additional_options)
         )
+
+        response['data']
       rescue StandardError => e
         log("Could not take Screenshot '#{name}'")
         log(e.message, on_debug: true)
       end
-      nil
     end
   end
 end

data/percy/metadata/ios_metadata.rb

@@ -45,7 +45,7 @@ module Percy
     def get_window_size
       @_window_size = Percy::Cache.get_cache(session_id, Percy::Cache::WINDOW_SIZE)
       unless @_window_size
-        @_window_size = driver.get_window_size
+        @_window_size = driver.window_size
         Percy::Cache.set_cache(session_id, Percy::Cache::WINDOW_SIZE, @_window_size)
       end
       @_window_size

data/percy/providers/app_automate.rb

@@ -29,9 +29,10 @@ module Percy
       begin
         response = super(name, **kwargs)
         percy_screenshot_url = response.fetch('link', '')
-        execute_percy_screenshot_end(name, percy_screenshot_url, 'success')
+        execute_percy_screenshot_end(name, percy_screenshot_url, 'success', kwargs.fetch('sync', nil))
+        response['data']
       rescue StandardError => e
-        execute_percy_screenshot_end(name, percy_screenshot_url, 'failure', e.message)
+        execute_percy_screenshot_end(name, percy_screenshot_url, 'failure', kwargs.fetch('sync', nil), e.message)
         raise e
       end
     end
@@ -104,14 +105,15 @@ module Percy
       end
     end
 
-    def execute_percy_screenshot_end(name, percy_screenshot_url, status, status_message = nil)
+    def execute_percy_screenshot_end(name, percy_screenshot_url, status, sync = nil, status_message = nil)
       request_body = {
         action: 'percyScreenshot',
         arguments: {
           state: 'end',
           percyScreenshotUrl: percy_screenshot_url,
           name: name,
-          status: status
+          status: status,
+          sync: sync
         }
       }
       request_body[:arguments][:statusMessage] = status_message if status_message
@@ -158,4 +160,4 @@ module Percy
       end
     end
   end
-end
+end

data/percy/providers/generic_provider.rb

@@ -42,8 +42,9 @@ module Percy
           custom_locations: kwargs.fetch(:custom_consider_regions, [])
         )
       }
+      sync = kwargs.fetch(:sync, nil)
 
-      _post_screenshots(name, tag, tiles, get_debug_url, ignore_regions, consider_regions)
+      _post_screenshots(name, tag, tiles, get_debug_url, ignore_regions, consider_regions, sync)
     end
 
     def _get_tag(**kwargs)
@@ -93,8 +94,8 @@ module Percy
       elements_array
     end
 
-    def _post_screenshots(name, tag, tiles, debug_url, ignored_regions, considered_regions)
-      Percy::CLIWrapper.new.post_screenshots(name, tag, tiles, debug_url, ignored_regions, considered_regions)
+    def _post_screenshots(name, tag, tiles, debug_url, ignored_regions, considered_regions, sync)
+      Percy::CLIWrapper.new.post_screenshots(name, tag, tiles, debug_url, ignored_regions, considered_regions, sync)
     end
 
     def _write_screenshot(png_bytes, directory)

data/percy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Percy
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.5-beta.0'.freeze
 end

data/percy-appium-app.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['percy']
 
-  spec.add_runtime_dependency 'appium_lib', '~> 12.0'
+  spec.add_runtime_dependency 'appium_lib', '~> 11.2.0'
   spec.add_runtime_dependency 'dotenv', '~> 2.8'
 
   spec.add_development_dependency 'bundler', '~> 2.4'

data/specs/cli_wrapper.rb

@@ -104,14 +104,16 @@ class TestCLIWrapper < Minitest::Test
     tag = { 'name' => 'Tag' }
     name = 'some-name'
     debug_url = 'debug-url'
+    sync = false
     response = @cli_wrapper.request_body(name, tag, [tile], debug_url, @ignored_elements_data,
-                                         @considered_elements_data)
+                                         @considered_elements_data, sync)
     assert_equal response['name'], name
     assert_equal response['external_debug_url'], debug_url
     assert_equal response['tag'], tag
     assert_equal response['tiles'], [tile.to_h]
     assert_equal response['ignored_elements_data'], @ignored_elements_data
     assert_equal response['considered_elements_data'], @considered_elements_data
+    assert_equal response['sync'], sync
   end
 
   def test_request_body_when_optional_values_are_null
@@ -121,13 +123,15 @@ class TestCLIWrapper < Minitest::Test
     debug_url = nil
     ignored_elements_data = nil
     considered_elements_data = nil
+    sync = nil
     response = @cli_wrapper.send(:request_body, name, tag, [tile], debug_url, ignored_elements_data,
-                                 considered_elements_data)
+                                 considered_elements_data, sync)
     assert_equal response['name'], name
     assert_equal response['external_debug_url'], debug_url
     assert_equal response['tag'], tag
     assert_equal response['tiles'], [tile.to_h]
     assert_nil response['ignored_elements_data']
     assert_nil response['considered_elements_data']
+    assert_nil response['sync']
   end
 end

data/specs/generic_providers.rb

@@ -15,6 +15,7 @@ class TestGenericProvider < Minitest::Test
 
   def setup
     @existing_dir = 'existing-dir'
+    teardown
     Dir.mkdir(@existing_dir)
 
     @mock_webdriver = Minitest::Mock.new
@@ -33,7 +34,9 @@ class TestGenericProvider < Minitest::Test
   end
 
   def teardown
-    FileUtils.remove_entry_secure(@existing_dir)
+    if Dir.exist?(@existing_dir)
+      FileUtils.remove_dir(@existing_dir, force: true)
+    end
   end
 
   def test_get_dir_without_env_variable

data/specs/ios_metadata.rb

@@ -37,7 +37,7 @@ class TestIOSMetadata < Minitest::Test
     height = 100
     width = 100
     window_size = { 'height' => height, 'width' => width }
-    @mock_webdriver.expect(:get_window_size, window_size)
+    @mock_webdriver.expect(:window_size, window_size)
     session_id = 'session_id_123'
     @mock_webdriver.expect(:session_id, session_id)
     @mock_webdriver.expect(:session_id, session_id)
@@ -48,12 +48,13 @@ class TestIOSMetadata < Minitest::Test
   end
 
   def test_device_screen_size
+    Percy::Cache.force_cleanup_cache
     session_id = 'session_id_123'
     5.times do
       @mock_webdriver.expect(:session_id, session_id)
     end
     @mock_webdriver.expect(:capabilities, { 'deviceName' => 'iPhone 6' })
-    @mock_webdriver.expect(:get_window_size, { 'height' => 100, 'width' => 100 })
+    @mock_webdriver.expect(:window_size, { 'height' => 100, 'width' => 100 })
     device_screen_size = @ios_metadata.device_screen_size
     assert_equal({ 'height' => 200, 'width' => 200 }, device_screen_size)
   end
@@ -80,7 +81,7 @@ class TestIOSMetadata < Minitest::Test
       @mock_webdriver.expect(:session_id, session_id)
     end
     @mock_webdriver.expect(:capabilities, { 'deviceName' => 'iPhone 14' })
-    @mock_webdriver.expect(:get_window_size, window_size)
+    @mock_webdriver.expect(:window_size, window_size)
     @mock_webdriver.expect(:execute_script, { 'height' => 100, 'width' => 200 }, ['mobile: viewportRect'])
 
     assert_equal(2, @ios_metadata.scale_factor)

data/specs/screenshot.rb

@@ -6,7 +6,7 @@ require 'webmock/minitest'
 require 'appium_lib'
 require 'webrick'
 
-require_relative '../percy/screenshot'
+require_relative '../percy/percy-appium-app'
 require_relative '../percy/lib/app_percy'
 require_relative 'mocks/mock_methods'
 
@@ -54,14 +54,14 @@ def mock_healthcheck(fail: false, fail_how: 'error', type: 'Percy::AppPercy')
     .to_return(status: health_status, body: health_body, headers: health_headers)
 end
 
-def mock_screenshot(fail: false)
+def mock_screenshot(fail: false, data: false)
   stub_request(:post, 'http://localhost:5338/percy/comparison')
-    .to_return(body: "{\"success\": #{fail ? 'false, "error": "test"' : 'true'}}", status: (fail ? 500 : 200))
+    .to_return(body: "{\"success\": #{fail ? 'false, "error": "test"' : 'true'} #{data ? ',"data": "sync-data"' : ""}}", status: (fail ? 500 : 200))
 end
 
-def mock_poa_screenshot(fail: false)
+def mock_poa_screenshot(fail: false, data: false)
   stub_request(:post, 'http://localhost:5338/percy/automateScreenshot')
-    .to_return(body: "{\"success\": #{fail ? 'false, "error": "test"' : 'true'}}", status: (fail ? 500 : 200))
+    .to_return(body: "{\"success\": #{fail ? 'false, "error": "test"' : 'true'} #{data ? ',"data": "sync-data"' : ""}}", status: (fail ? 500 : 200))
 end
 
 def mock_session_request
@@ -204,6 +204,37 @@ class TestPercyScreenshot < Minitest::Test
     assert_equal(['Consider_Dummy_id'], s2['options']['consider_region_elements'])
   end
 
+  def test_posts_screenshot_poa_with_sync
+    mock_healthcheck(type: 'automate')
+    mock_poa_screenshot(data: true)
+    mock_session_request
+
+    driver = Minitest::Mock.new
+    @bridge = Minitest::Mock.new
+    @http = Minitest::Mock.new
+    @server_url = Minitest::Mock.new
+
+    driver.expect(:is_a?, true, [Appium::Core::Base::Driver])
+    driver.expect(:desired_capabilities, { 'key' => 'value' })
+    driver.expect(:instance_variable_get, @bridge, [:@bridge])
+    @http.expect(:instance_variable_get, @server_url, [:@server_url])
+    @bridge.expect(:instance_variable_get, @http, [:@http])
+    @server_url.expect(:to_s, 'https://hub-cloud.browserstack.com/wd/hub')
+
+    10.times do
+      driver.expect(:session_id, 'Dummy_session_id')
+    end
+    2.times do
+      driver.expect(:capabilities, { 'key' => 'value' })
+    end
+    @mock_webdriver.expect(:capabilities, { 'key' => 'value' })
+
+    res = percy_screenshot(driver, 'Snapshot 1', options: { sync: true })
+
+    assert_equal('sync-data', res)
+    assert_equal('/percy/automateScreenshot', @requests.last.uri.path)
+  end
+
   def test_posts_multiple_screenshots_to_the_local_percy_server
     mock_healthcheck
     mock_screenshot
@@ -256,6 +287,53 @@ class TestPercyScreenshot < Minitest::Test
     assert_match(%r{ruby/\d+\.\d+\.\d+}, body['environment_info'][1])
   end
 
+  def test_post_screenshot_with_sync
+    mock_healthcheck
+    mock_screenshot(data: true)
+
+    driver = Minitest::Mock.new
+
+    driver.expect(:is_a?, true, [Appium::Core::Base::Driver])
+    driver.expect(:instance_variable_get, @bridge, [:@bridge])
+    @http.expect(:instance_variable_get, @server_url, [:@server_url])
+    @bridge.expect(:instance_variable_get, @http, [:@http])
+    @server_url.expect(:to_s, 'https://hub-cloud.browserstack.com/wd/hub')
+
+    5.times do
+      driver.expect(:session_id, 'Dummy_session_id')
+    end
+
+    13.times do
+      driver.expect(:capabilities, get_android_capabilities)
+    end
+
+    3.times do
+      driver.expect(
+        :execute_script,
+        '{"success":true,"result":"[{\"sha\":\"sha-something\",\"status_bar\":null'\
+        ',\"nav_bar\":null,\"header_height\":0,\"footer_height\":0,\"index\":0}]"}',
+        [String]
+      )
+    end
+
+    2.times do
+      driver.expect(:get_system_bars, {
+                      'statusBar' => { 'height' => 10, 'width' => 20 },
+                      'navigationBar' => { 'height' => 10, 'width' => 20 }
+                    })
+    end
+
+    res = percy_screenshot(driver, 'screenshot 2', sync: true)
+
+    assert_equal('sync-data', res)
+    assert_equal('/percy/comparison', @requests.last.uri.path)
+
+    body = JSON.parse(@requests[-1].body)
+    assert_match(%r{percy-appium-app/\d+}, body['client_info'])
+    assert_match(%r{appium/\d+}, body['environment_info'][0])
+    assert_match(%r{ruby/\d+\.\d+\.\d+}, body['environment_info'][1])
+  end
+
   def test_ignore_region_screenshots_to_the_local_percy_server
     mock_healthcheck
     mock_screenshot

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-appium-app
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5.pre.beta.0
 platform: ruby
 authors:
 - BroswerStack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 11.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 11.2.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +137,7 @@ files:
 - ".github/workflows/release.yml"
 - ".github/workflows/stale.yml"
 - ".github/workflows/test.yml"
+- ".gitignore"
 - Gemfile
 - LICENSE
 - Makefile
@@ -197,11 +198,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Percy visual testing for Ruby Appium Mobile Apps