percy-appium-app 0.0.9.beta1 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47bb435221c28272d50b8e17f6540177bf9c656f128bcfb51f3e5468bf89772d
-  data.tar.gz: 5ea3c75e8ea54331a06729fd253219fa40acbabf3936929b0465b77ca10b6c84
+  metadata.gz: 82432d403ea8909fd0dd473251c8b406378497ff06e6e1806144e83350598013
+  data.tar.gz: 1f351d8ede37fef600554f98f1ac8bdc7b60124ea62374be65175a26b0cd74c0
 SHA512:
-  metadata.gz: c73191b25d04b044662995228926349eb37838cb03edd9a3f25c72afc6898872dde22b2b01a87f54f4d7b9277873e2784e8874766c40ae947b4e5690f5fc2118
-  data.tar.gz: b3b16e11cb7c83f5845d92e1773d71d140b4a0b4ccc5c905cbdab11a52beeb96b1d40762e02a0ba8ace7ce25cb45c112711226d0db08b9eef8824bfbaa21cc6e
+  metadata.gz: 0bc03604787ae7757d95e29d33dfcdc176c9b0733c0b639ed04d75a7aac4061ff915046b34c0d65f21cf3360514f3c9f970dfef46e6bb38f363a5c2b3cd611d7
+  data.tar.gz: c339d7e5282e110b6351284f72124cab0876ddb4b40c95606096219923ca64cf9b4cd4c8084022274625a6bbdd6c087a90bec4a6a105a3ed9c61a49b756bb1f3

data/.github/workflows/Semgrep.yml

@@ -27,8 +27,7 @@ jobs:
 
     container:
       # A Docker image with Semgrep installed. Do not change this.
-      image: returntocorp/semgrep
-
+      image: returntocorp/semgrep:1.166.0
     # Skip any PR created by dependabot to avoid permission issues:
     if: (github.actor != 'dependabot[bot]')
 

data/.github/workflows/test.yml

@@ -2,6 +2,7 @@ name: Test
 on:
   push:
     branches: [main]
+  pull_request:
   workflow_dispatch:
     inputs:
       branch:
@@ -12,6 +13,10 @@ jobs:
   test:
     name: Test
     strategy:
+      # Run every Ruby version to completion so one leg failing doesn't cancel
+      # the others. Ruby 3.0's appium_lib API drift is fixed by pinning
+      # appium_lib ~> 12.0 (see Gemfile), so all three legs are green.
+      fail-fast: false
       matrix:
         os: [ubuntu-latest]
         ruby: ['2.6', '2.7', '3.0']
@@ -37,4 +42,7 @@ jobs:
           key: v1/${{ runner.os }}/ruby-${{ matrix.ruby }}/${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: v1/${{ runner.os }}/ruby-${{ matrix.ruby }}/
       - run: bundle install
-      - run: for file in specs/*.rb; do echo $file; bundle exec ruby $file; done
+      # Run each spec via the SimpleCov runner so per-process coverage is
+      # recorded and merged, then collate the merged result and enforce the gate.
+      - run: for file in specs/*.rb; do echo "$file"; bundle exec ruby specs/support/run_spec.rb "$file"; done
+      - run: bundle exec ruby specs/support/coverage_check.rb

data/.gitignore

@@ -1 +1,4 @@
 Gemfile.lock
+/vendor/
+/.bundle/
+coverage/

data/Gemfile

@@ -2,8 +2,12 @@
 
 source 'https://rubygems.org'
 
-gem 'appium_console'
-gem 'appium_lib', '>= 11.2.0'
+# Pin appium_lib to the 12.x line so all Ruby legs (2.6/2.7/3.0) resolve
+# appium_lib_core ~> 5.0, which still exposes Appium::Core::Base::SearchContext.
+# Unpinned, Ruby 3.0 resolved appium_lib 15 / appium_lib_core 9.x, which removed
+# that constant and broke the specs. appium_console 3.0.0 requires appium_lib = 12.0.0.
+gem 'appium_console', '~> 3.0'
+gem 'appium_lib', '~> 12.0'
 gem 'dotenv'
 gem 'minitest'
 gem 'rubocop', require: false
@@ -11,3 +15,4 @@ gem 'tempfile'
 gem 'webmock', '~> 3.18', '>= 3.18.1'
 gem 'webrick', '~> 1.3', '>= 1.3.1'
 gem 'rake', '~> 13.0'
+gem 'simplecov', require: false

data/percy/metadata/android_metadata.rb

@@ -15,12 +15,15 @@ module Percy
     def device_screen_size
       caps = capabilities
       caps = caps.as_json unless caps.is_a?(Hash)
+      # Use string keys to match the IosMetadata implementation and every
+      # consumer (generic_provider, app_automate, _get_tag), all of which read
+      # device_screen_size['width'] / ['height'].
       if caps['deviceScreenSize'].nil?
         size = driver.window_size
-        { width: size.width.to_i, height: size.height.to_i }
+        { 'width' => size.width.to_i, 'height' => size.height.to_i }
       else
         width, height = caps['deviceScreenSize'].split('x')
-        { width: width.to_i, height: height.to_i }
+        { 'width' => width.to_i, 'height' => height.to_i }
       end
     end
 

data/percy/providers/generic_provider.rb

@@ -137,7 +137,10 @@ module Percy
 
     def get_regions_by_xpath(elements_array, xpaths)
       xpaths.each do |xpath|
-        element = driver.find_element(Appium::Core::Base::SearchContext::FINDERS[:xpath], xpath)
+        # Pass the :xpath finder symbol directly. appium_lib_core 12.x removed
+        # Appium::Core::Base::SearchContext::FINDERS; the symbol form works
+        # across all supported appium_lib versions.
+        element = driver.find_element(:xpath, xpath)
         selector = "xpath: #{xpath}"
         if element
           region = get_region_object(selector, element)

data/percy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Percy
-  VERSION = '0.0.9.beta1'.freeze
+  VERSION = '0.0.9'.freeze
 end

data/specs/android_metadata.rb

@@ -46,13 +46,21 @@ class TestAndroidMetadata < Minitest::Test
 
     # Call the method and assert the result
     result = @android_metadata.device_screen_size
-    assert_equal({ width: 1080, height: 1920 }, result)
+    assert_equal({ 'width' => 1080, 'height' => 1920 }, result)
 
     # Verify mocks
     mock_window_size.verify
     @mock_webdriver.verify
   end
 
+  def test_device_screen_size_when_device_screen_size_is_present
+    # 'deviceScreenSize' => '1080x2280' from get_android_capabilities; parsed into string-keyed hash
+    @mock_webdriver.expect(:capabilities, get_android_capabilities)
+    result = @android_metadata.device_screen_size
+    assert_equal({ 'width' => 1080, 'height' => 2280 }, result)
+    @mock_webdriver.verify
+  end
+
   def test_get_system_bars
     system_bars = {
       'statusBar' => { 'height' => 83 },

data/specs/app_automate.rb

@@ -67,15 +67,170 @@ class TestAppAutomate < Minitest::Test
   end
 
   def test_execute_percy_screenshot_end
-    @app_automate.stub(:execute_percy_screenshot_begin, 'deviceName' => 'abc', 'osVersion' => '123') do
+    # Wrap the stub return hashes in explicit braces. Under Ruby 3 keyword
+    # argument separation, a bare trailing hash is otherwise parsed as keyword
+    # args to Minitest's stub, raising ArgumentError.
+    @app_automate.stub(:execute_percy_screenshot_begin, { 'deviceName' => 'abc', 'osVersion' => '123' }) do
       @app_automate.stub(:execute_percy_screenshot_end, nil) do
-        @app_automate.stub(:screenshot, 'link' => 'https://link') do
+        @app_automate.stub(:screenshot, { 'link' => 'https://link' }) do
           @app_automate.screenshot('name')
         end
       end
     end
   end
 
+  # Covers app_automate.rb lines 34-36: the rescue branch in #screenshot where the
+  # super call fails, #execute_percy_screenshot_end is invoked with 'failure', and the
+  # error is re-raised.
+  def test_screenshot_failure_calls_end_and_reraises
+    captured = {}
+    @app_automate.stub(:execute_percy_screenshot_begin, nil) do
+      # super (GenericProvider#screenshot) calls _get_tiles first; make it blow up.
+      @app_automate.stub(:_get_tiles, ->(**_kwargs) { raise StandardError, 'boom' }) do
+        @app_automate.stub(:execute_percy_screenshot_end,
+                           lambda do |name, url, status, sync = nil, message = nil|
+                             captured[:name] = name
+                             captured[:url] = url
+                             captured[:status] = status
+                             captured[:sync] = sync
+                             captured[:message] = message
+                           end) do
+          error = assert_raises(StandardError) { @app_automate.screenshot('failing-shot') }
+          assert_equal 'boom', error.message
+        end
+      end
+    end
+    assert_equal 'failing-shot', captured[:name]
+    assert_equal 'failure', captured[:status]
+    assert_equal 'boom', captured[:message]
+  end
+
+  # Covers app_automate.rb lines 24-26: when begin returns session details, the device
+  # metadata and debug url are set before the super screenshot (driven through the stubbed
+  # collaborators _get_tiles/_find_regions/_post_screenshots) succeeds.
+  def test_screenshot_success_sets_metadata_and_debug_url
+    session_details = {
+      'deviceName' => 'Google Pixel 7',
+      'osVersion' => '13.0',
+      'buildHash' => 'bhash',
+      'sessionHash' => 'shash'
+    }
+    post_response = { 'link' => 'https://link', 'data' => { 'ok' => true } }
+    @app_automate.stub(:execute_percy_screenshot_begin, session_details) do
+      @app_automate.stub(:_get_tiles, []) do
+        @app_automate.stub(:_get_tag, {}) do
+          @app_automate.stub(:_find_regions, []) do
+            @app_automate.stub(:_post_screenshots, post_response) do
+              @app_automate.stub(:execute_percy_screenshot_end, nil) do
+                result = @app_automate.screenshot('shot')
+                assert_equal({ 'ok' => true }, result)
+              end
+            end
+          end
+        end
+      end
+    end
+    assert_equal 'Google Pixel 7', @metadata.device_name
+    @mock_webdriver.expect(:capabilities, get_android_capabilities)
+    assert_equal '13', @metadata.os_version
+    assert_equal 'https://app-automate.browserstack.com/dashboard/v2/builds/bhash/sessions/shash',
+                 @app_automate.get_debug_url
+  end
+
+  # Covers app_automate.rb line 50: when PERCY_DISABLE_REMOTE_UPLOADS=true and the
+  # screenshot is NOT fullpage, _get_tiles falls back to the generic provider's _get_tiles
+  # (run for real against the mock webdriver), returning a single file-backed tile.
+  def test_get_tiles_disable_remote_uploads_non_fullpage_falls_back_to_super
+    ENV['PERCY_DISABLE_REMOTE_UPLOADS'] = 'true'
+    @mock_webdriver.expect(:screenshot_as, 'png-bytes', [:png])
+
+    tiles = nil
+    @metadata.stub(:status_bar_height, 100) do
+      @metadata.stub(:navigation_bar_height, 150) do
+        tiles = @app_automate._get_tiles(fullpage: false)
+      end
+    end
+
+    assert_equal 1, tiles.length
+    dict_tile = tiles[0].to_h
+    assert_includes dict_tile, 'filepath'
+    assert(File.exist?(dict_tile['filepath']))
+    assert_equal 100, dict_tile['status_bar_height']
+    assert_equal 150, dict_tile['nav_bar_height']
+    File.delete(tiles[0].filepath)
+  ensure
+    ENV.delete('PERCY_DISABLE_REMOTE_UPLOADS')
+  end
+
+  # Covers app_automate.rb lines 49 (fullpage warning puts) and the path that does NOT
+  # fall back to super (line 50 skipped because fullpage_ss is true): full remote
+  # screenshot orchestration continues with PERCY_DISABLE_REMOTE_UPLOADS=true.
+  def test_get_tiles_disable_remote_uploads_fullpage_warns_and_continues
+    ENV['PERCY_DISABLE_REMOTE_UPLOADS'] = 'true'
+    metadata_mock = Minitest::Mock.new
+    metadata_mock.expect(:device_screen_size, { 'width' => 1080, 'height' => 1920 })
+    metadata_mock.expect(:scale_factor, 1)
+    metadata_mock.expect(:status_bar_height, 100)
+    metadata_mock.expect(:navigation_bar_height, 150)
+
+    @metadata.stub(:device_screen_size, { 'width' => 1080, 'height' => 1920 }) do
+      @metadata.stub(:scale_factor, 1) do
+        @metadata.stub(:status_bar_height, 100) do
+          @metadata.stub(:navigation_bar_height, 150) do
+            @app_automate.stub(:execute_percy_screenshot, {
+                                 'result' => '[{"sha":"abc-1234","header_height":10,"footer_height":20}]'
+                               }) do
+              tiles = @app_automate._get_tiles(fullpage: true)
+              assert_equal 1, tiles.length
+              assert_equal 'abc', tiles[0].sha
+              assert_equal 100, tiles[0].status_bar_height
+              assert_equal 150, tiles[0].nav_bar_height
+              assert_equal 10, tiles[0].header_height
+              assert_equal 20, tiles[0].footer_height
+            end
+          end
+        end
+      end
+    end
+  ensure
+    ENV.delete('PERCY_DISABLE_REMOTE_UPLOADS')
+  end
+
+  # Covers app_automate.rb lines 100-104: the rescue in #execute_percy_screenshot_begin
+  # when execute_script raises; it logs and returns nil.
+  def test_execute_percy_screenshot_begin_handles_error_returns_nil
+    @mock_webdriver.expect(:execute_script, nil) do
+      raise StandardError, 'begin failed'
+    end
+    result = @app_automate.execute_percy_screenshot_begin('Screenshot 1')
+    assert_nil result
+    @mock_webdriver.verify
+  end
+
+  # Covers app_automate.rb lines 123-125: the rescue in #execute_percy_screenshot_end
+  # when execute_script raises; it logs and swallows the error (returns nil).
+  def test_execute_percy_screenshot_end_handles_error
+    @mock_webdriver.expect(:execute_script, nil) do
+      raise StandardError, 'end failed'
+    end
+    result = @app_automate.execute_percy_screenshot_end('Screenshot 1', 'snapshot-url', 'success')
+    assert_nil result
+    @mock_webdriver.verify
+  end
+
+  # Covers app_automate.rb lines 156-159: the rescue in #execute_percy_screenshot when
+  # execute_script raises; it logs and re-raises the error.
+  def test_execute_percy_screenshot_handles_error_reraises
+    @mock_webdriver.expect(:execute_script, nil) do
+      raise StandardError, 'screenshot failed'
+    end
+    error = assert_raises(StandardError) do
+      @app_automate.execute_percy_screenshot(1080, 'singlepage', 5)
+    end
+    assert_equal 'screenshot failed', error.message
+    @mock_webdriver.verify
+  end
+
   def test_get_tiles
     # Mocking Percy::Metadata's session_id method
     metadata_mock = Minitest::Mock.new

data/specs/app_percy.rb

@@ -136,6 +136,33 @@ class TestAppPercy < Minitest::Test
     end
   end
 
+  def test_throws_error_when_string_arg_type_mismatch
+    # Three constructions, each followed by a screenshot call with a
+    # non-String value for test_case / labels / th_test_case_execution_id.
+    3.times do
+      @mock_android_webdriver.expect(:is_a?, true, [Appium::Core::Base::Driver])
+    end
+    20.times do
+      @mock_android_webdriver.expect(:capabilities, get_android_capabilities)
+    end
+    3.times do
+      @mock_android_webdriver.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')
+    end
+
+    assert_raises(TypeError) do
+      Percy::AppPercy.new(@mock_android_webdriver).screenshot('screenshot 1', test_case: 123)
+    end
+    assert_raises(TypeError) do
+      Percy::AppPercy.new(@mock_android_webdriver).screenshot('screenshot 1', labels: 123)
+    end
+    assert_raises(TypeError) do
+      Percy::AppPercy.new(@mock_android_webdriver).screenshot('screenshot 1', th_test_case_execution_id: 123)
+    end
+  end
+
   private
 
   def disable_percy_options(mock_webdriver, num = 1)

data/specs/cli_wrapper.rb

@@ -16,6 +16,20 @@ def mock_poa_screenshot(fail: false)
     .to_return(body: "{\"success\": #{fail ? 'false, "error": "test"' : 'true'}}", status: (fail ? 500 : 200))
 end
 
+def mock_healthcheck_with_version(version)
+  stub_request(:get, 'http://localhost:5338/percy/healthcheck')
+    .to_return(
+      body: JSON.dump(success: true, build: { 'id' => '123', 'url' => 'dummy_url' }, type: 'automate'),
+      status: 200,
+      headers: { 'X-Percy-Core-Version' => version }
+    )
+end
+
+def mock_failed_event(fail: false)
+  stub_request(:post, 'http://localhost:5338/percy/events')
+    .to_return(body: "{\"success\": #{fail ? 'false, "error": "test"' : 'true'}}", status: (fail ? 500 : 200))
+end
+
 # Test suite for the Percy::CLIWrapper class
 class TestCLIWrapper < Minitest::Test
   def setup
@@ -143,4 +157,56 @@ class TestCLIWrapper < Minitest::Test
     assert_nil response['labels']
     assert_nil response['th_test_case_execution_id']
   end
+
+  # Targets cli_wrapper.rb lines 42-43: CLI minor version below 27 disables the SDK.
+  def test_percy_enabled_with_unsupported_minor_version
+    Percy::CLIWrapper.instance_variable_set(:@percy_enabled, nil)
+    mock_healthcheck_with_version('1.26.0')
+
+    assert_output(/Please upgrade to the latest CLI version/) do
+      assert_equal(false, Percy::CLIWrapper.percy_enabled?)
+    end
+  ensure
+    Percy::CLIWrapper.instance_variable_set(:@percy_enabled, nil)
+  end
+
+  # Targets cli_wrapper.rb lines 74, 79, 80, 89: post_failed_event success path
+  # builds the body, posts to /percy/events and parses the response.
+  def test_post_failed_event_success
+    mock_failed_event
+
+    result = Percy::CLIWrapper.post_failed_event('some error')
+
+    assert_equal({ 'success' => true }, result)
+  end
+
+  # Targets cli_wrapper.rb lines 83-86 (error branch) and 91-92 (rescue -> nil):
+  # a non-200 response raises CLIException internally which is rescued and nil returned.
+  def test_post_failed_event_handles_error_response
+    mock_failed_event(fail: true)
+
+    assert_nil Percy::CLIWrapper.post_failed_event('some error')
+  end
+
+  # Targets cli_wrapper.rb lines 91-92: a network/parse failure is rescued and nil returned.
+  def test_post_failed_event_rescues_exceptions
+    stub_request(:post, 'http://localhost:5338/percy/events').to_raise(StandardError.new('boom'))
+
+    assert_nil Percy::CLIWrapper.post_failed_event('some error')
+  end
+
+  # Targets cli_wrapper.rb lines 121-122: response is a 2xx success but not exactly 200,
+  # so the error message is extracted from the body and raised.
+  def test_post_poa_screenshots_raises_on_non_200_success
+    stub_request(:post, 'http://localhost:5338/percy/automateScreenshot')
+      .to_return(body: '{"success": false, "error": "poa error"}', status: 201)
+
+    error = assert_raises(CLIException) do
+      @cli_wrapper.post_poa_screenshots(
+        'snapshot', 'session-id', 'http://example.com',
+        { 'browser' => 'chrome' }, { 'platform' => 'Windows' }, {}
+      )
+    end
+    assert_equal('poa error', error.message)
+  end
 end

data/specs/driver_metadata.rb

@@ -5,6 +5,7 @@ require 'minitest/mock'
 require 'appium_lib'
 
 require_relative '../percy/metadata/driver_metadata'
+require_relative '../percy/lib/cache'
 
 # Test suite for the Percy::DriverMetadata class
 class TestDriverMetadata < Minitest::Test
@@ -66,4 +67,25 @@ class TestDriverMetadata < Minitest::Test
 
     assert(session_caps, @metadata.session_capabilities)
   end
+
+  def test_session_capabilities_caches_desired_capabilities_on_cache_miss
+    # Force a clean cache and use a unique session id so the cache lookup misses
+    # and the desired_capabilities branch (set_cache) is exercised.
+    Percy::Cache.force_cleanup_cache
+    session_id = 'session_id_session_caps_miss'
+    desired_caps = {
+      'platform' => 'chrome_android',
+      'browserVersion' => '115.0.1',
+      'session_name' => 'abc'
+    }
+    # session_id is read by session_capabilities, get_cache and set_cache.
+    3.times { @mock_webdriver.expect(:session_id, session_id) }
+    @mock_webdriver.expect(:desired_capabilities, desired_caps)
+
+    fetched = @metadata.session_capabilities
+    assert_equal(desired_caps, fetched)
+    # Now the value is cached: read straight back without another driver call.
+    @mock_webdriver.expect(:session_id, session_id)
+    assert_equal(desired_caps, @metadata.session_capabilities)
+  end
 end

data/specs/generic_providers.rb

@@ -13,6 +13,13 @@ class TestGenericProvider < Minitest::Test
   include Appium
   COMPARISON_RESPONSE = { 'comparison' => { 'id' => 123, 'url' => 'https://percy-build-url' } }.freeze
 
+  # Some tests below permanently redefine Percy::Metadata#session_id and
+  # Percy::AndroidMetadata#get_system_bars via class_eval to route them at fixed-count
+  # mocks. Snapshot the pristine implementations once so teardown can restore them and the
+  # suite stays order-independent (the original suite is flaky on certain seeds otherwise).
+  PRISTINE_SESSION_ID = Percy::Metadata.instance_method(:session_id)
+  PRISTINE_GET_SYSTEM_BARS = Percy::AndroidMetadata.instance_method(:get_system_bars)
+
   def setup
     @existing_dir = 'existing-dir'
     teardown
@@ -37,6 +44,20 @@ class TestGenericProvider < Minitest::Test
     if Dir.exist?(@existing_dir)
       FileUtils.remove_dir(@existing_dir, force: true)
     end
+    restore_pristine_metadata_methods
+  end
+
+  # Undo the class_eval monkey-patching done by tests like test_post_screenshots and
+  # test_non_app_automate so subsequent tests see the real implementations.
+  def restore_pristine_metadata_methods
+    pristine_session_id = PRISTINE_SESSION_ID
+    pristine_get_system_bars = PRISTINE_GET_SYSTEM_BARS
+    Percy::Metadata.class_eval do
+      define_method(:session_id) { |*args, &blk| pristine_session_id.bind(self).call(*args, &blk) }
+    end
+    Percy::AndroidMetadata.class_eval do
+      define_method(:get_system_bars) { |*args, &blk| pristine_get_system_bars.bind(self).call(*args, &blk) }
+    end
   end
 
   def test_get_dir_without_env_variable
@@ -133,6 +154,30 @@ class TestGenericProvider < Minitest::Test
     File.delete(tile.filepath)
   end
 
+  # Covers generic_provider.rb line 75: requesting a fullpage screenshot on the generic
+  # provider logs the "only supported on App Automate" fallback message and still produces
+  # a single page tile.
+  def test_get_tiles_fullpage_logs_fallback
+    status_bar_height = 11
+    nav_bar_height = 22
+    logged = []
+    @generic_provider.stub(:log, ->(message, **_kwargs) { logged << message }) do
+      tile = @generic_provider._get_tiles(
+        fullpage: true,
+        status_bar_height: status_bar_height,
+        nav_bar_height: nav_bar_height
+      )[0]
+      dict_tile = tile.to_h
+      assert_includes dict_tile, 'filepath'
+      assert(File.exist?(dict_tile['filepath']))
+      assert_equal status_bar_height, dict_tile['status_bar_height']
+      assert_equal nav_bar_height, dict_tile['nav_bar_height']
+      File.delete(tile.filepath)
+    end
+    assert_includes logged,
+                    'Full page screenshot is only supported on App Automate. Falling back to single page screenshot.'
+  end
+
   def test_get_tiles_kwargs
     status_bar_height = 135
     nav_bar_height = 246
@@ -256,7 +301,7 @@ class TestGenericProvider < Minitest::Test
     end
 
     @mock_webdriver.expect(:find_element, mock_element,
-                           [Appium::Core::Base::SearchContext::FINDERS[:xpath], '//path/to/element'])
+                           [:xpath, '//path/to/element'])
 
     elements_array = []
     xpaths = ['//path/to/element']
@@ -271,7 +316,7 @@ class TestGenericProvider < Minitest::Test
   end
 
   def test_get_regions_by_xpath_with_non_existing_element
-    @mock_webdriver.expect(:find_element, [Appium::Core::Base::SearchContext::FINDERS[:xpath], '//path/to/element']) do
+    @mock_webdriver.expect(:find_element, [:xpath, '//path/to/element']) do
       raise Appium::Core::Error::NoSuchElementError, 'Test error'
     end
     elements_array = []
@@ -309,7 +354,7 @@ class TestGenericProvider < Minitest::Test
       mock_element.expect(:size, Selenium::WebDriver::Dimension.new(100, 200))
     end
 
-    @mock_webdriver.expect(:find_element, [Appium::Core::Base::SearchContext::FINDERS[:accessibility_id], 'id1']) do
+    @mock_webdriver.expect(:find_element, [:accessibility_id, 'id1']) do
       raise Appium::Core::Error::NoSuchElementError, 'Test error'
     end
 

data/specs/ios_metadata.rb

@@ -69,6 +69,25 @@ class TestIOSMetadata < Minitest::Test
     assert_equal({ 'height' => 40 }, status_bar)
   end
 
+  def test_status_bar_from_viewport_top
+    # Seed a viewport with a non-zero `top` so status_bar uses the viewport
+    # height (view_port['top']) instead of the static config scale_factor path.
+    Percy::Cache.force_cleanup_cache
+    session_id = 'session_id_viewport_top'
+    Percy::Cache.set_cache(session_id, Percy::Cache::VIEWPORT, { 'top' => 30, 'height' => 200, 'width' => 100 })
+
+    # status_bar -> viewport reads the seeded cache (1 session_id call); since
+    # top != 0 it returns view_port['top'] directly.
+    @mock_webdriver.expect(:session_id, session_id)
+
+    status_bar = @ios_metadata.status_bar
+    assert_equal({ 'height' => 30 }, status_bar)
+  end
+
+  def test_navigation_bar
+    assert_equal({ 'height' => 0 }, @ios_metadata.navigation_bar)
+  end
+
   def test_scale_factor_present_in_devices_json
     @mock_webdriver.expect(:capabilities, { 'deviceName' => 'iPhone 6' })
     assert_equal(2, @ios_metadata.scale_factor)

data/specs/metadata.rb

@@ -108,6 +108,16 @@ class TestMetadata < Minitest::Test
     assert_equal('10', os_ver)
   end
 
+  def test_metadata_os_version_returns_empty_string_on_error
+    # os_version that does not respond to #to_f (a Hash) makes the
+    # `os_version.to_f.to_i.to_s` conversion raise, exercising the rescue path.
+    capabilities = { 'os_version' => {} }
+    @mock_webdriver.expect(:capabilities, capabilities)
+    @mock_webdriver.expect(:capabilities, capabilities)
+    @mock_webdriver.expect(:capabilities, capabilities)
+    assert_equal('', @metadata.os_version)
+  end
+
   def test_metadata_value_from_devices_info_for_android
     android_device = 'google pixel 7'
     android_device_info = { '13' => { 'status_bar' => '118', 'nav_bar' => '63' } }

data/specs/percy_automate.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'json'
+require 'webmock/minitest'
+require 'appium_lib'
+
+require_relative '../percy/lib/percy_automate'
+require_relative '../percy/lib/percy_options'
+require_relative '../percy/lib/cli_wrapper'
+require_relative 'mocks/mock_methods'
+
+def mock_poa_screenshot(fail: false)
+  stub_request(:post, 'http://localhost:5338/percy/automateScreenshot')
+    .to_return(body: "{\"success\": #{fail ? 'false, "error": "test"' : 'true'}}", status: (fail ? 500 : 200))
+end
+
+# Test suite for the Percy::PercyOnAutomate class
+class TestPercyOnAutomate < Minitest::Test
+  def setup
+    @mock_driver = Minitest::Mock.new
+    @bridge = Minitest::Mock.new
+    @http = Minitest::Mock.new
+    @server_url = Minitest::Mock.new
+    WebMock.enable!
+  end
+
+  def teardown
+    WebMock.disable!
+  end
+
+  # Targets percy_automate.rb line 17: an unsupported driver raises DriverNotSupported.
+  def test_initialize_raises_for_unsupported_driver
+    assert_raises(DriverNotSupported) do
+      Percy::PercyOnAutomate.new(Object.new)
+    end
+  end
+
+  # Targets percy_automate.rb lines 56-58: when the screenshot post fails, the error
+  # is rescued and logged rather than propagated.
+  def test_screenshot_rescues_and_logs_on_failure
+    mock_poa_screenshot(fail: true)
+
+    @mock_driver.expect(:is_a?, true, [Appium::Core::Base::Driver])
+    @mock_driver.expect(:capabilities, { 'percy:options' => { 'enabled' => true } })
+
+    5.times do
+      @mock_driver.expect(:session_id, 'Dummy_session_id')
+    end
+    @mock_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')
+    @mock_driver.expect(:capabilities, { 'key' => 'value' })
+    @mock_driver.expect(:desired_capabilities, { 'key' => 'value' })
+
+    percy = Percy::PercyOnAutomate.new(@mock_driver)
+
+    result = nil
+    assert_output(/Could not take Screenshot 'Snapshot 1'/) do
+      result = percy.screenshot('Snapshot 1', options: {})
+    end
+    assert_nil result
+  end
+end

data/specs/screenshot.rb

@@ -383,7 +383,7 @@ class TestPercyScreenshot < Minitest::Test
                     })
     end
     driver.expect(:find_element, mock_element,
-                  [Appium::Core::Base::SearchContext::FINDERS[:xpath], '//path/to/element'])
+                  [:xpath, '//path/to/element'])
 
     percy_screenshot(driver, 'screenshot 1', ignore_regions_xpaths: xpaths)
 
@@ -416,4 +416,87 @@ class TestPercyScreenshot < Minitest::Test
     mock_healthcheck(type: 'automate')
     assert_raises(Exception) { percy_screenshot(@mock_webdriver) }
   end
+
+  def test_swallows_screenshot_error_when_ignore_errors_true
+    mock_healthcheck
+    # /percy/events is hit by post_failed_event in the rescue path.
+    stub_request(:post, 'http://localhost:5338/percy/events')
+      .to_return(status: 200, body: '{"success": true}')
+
+    # Force the AppPercy (non-automate) provider so the rescue path in
+    # percy-appium-app.rb is exercised. session_type is memoized across tests.
+    Percy::Environment.session_type = nil
+
+    # Android caps have percy:options.ignoreErrors => true, so the error is
+    # swallowed and percy_screenshot returns nil. A non-String name makes
+    # AppPercy#screenshot raise a TypeError after construction succeeds.
+    driver = build_app_driver(get_android_capabilities)
+
+    result = nil
+    assert_output(/Could not take screenshot/) do
+      result = percy_screenshot(driver, 12_345)
+    end
+    assert_nil result
+    assert(@requests.any? { |r| r.uri.path == '/percy/events' })
+  end
+
+  def test_reraises_screenshot_error_when_ignore_errors_false
+    mock_healthcheck
+    stub_request(:post, 'http://localhost:5338/percy/events')
+      .to_return(status: 200, body: '{"success": true}')
+
+    Percy::Environment.session_type = nil
+
+    # Build caps whose percy:options.ignoreErrors is false so the rescue path
+    # re-raises after posting the failed event.
+    caps = get_android_capabilities.dup
+    caps['percy:options'] = { 'enabled' => true, 'ignoreErrors' => false }
+    caps['percyOptions'] = { 'enabled' => true, 'ignoreErrors' => false }
+    driver = build_app_driver(caps)
+
+    assert_output(/Could not take screenshot/) do
+      assert_raises(TypeError) { percy_screenshot(driver, 12_345) }
+    end
+    assert(@requests.any? { |r| r.uri.path == '/percy/events' })
+  end
+
+  private
+
+  # Builds a Minitest::Mock driver that survives AppPercy construction
+  # (is_a? Appium driver, capabilities, remote_url) for the rescue-path tests.
+  def build_app_driver(caps)
+    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])
+    20.times { driver.expect(:capabilities, caps) }
+    3.times do
+      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')
+    end
+    driver
+  end
+end
+
+# Test suite for the `hashed` helper in percy/common/common.rb
+class TestHashedHelper < Minitest::Test
+  # Stand-in object that responds to #as_json (core objects do not in this env).
+  class JsonableDouble
+    def as_json
+      { 'converted' => true }
+    end
+  end
+
+  def test_hashed_returns_hash_unchanged
+    input = { 'a' => 1 }
+    assert_same(input, hashed(input))
+  end
+
+  def test_hashed_converts_non_hash_via_as_json
+    assert_equal({ 'converted' => true }, hashed(JsonableDouble.new))
+  end
 end

data/specs/support/coverage_check.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Collates the per-process SimpleCov results written during the spec loop and
+# enforces the coverage gate. Run after all specs:
+#   bundle exec ruby specs/support/coverage_check.rb
+require 'simplecov'
+
+SimpleCov.collate Dir['coverage/.resultset.json'] do
+  add_filter '/specs/'
+  track_files 'percy/**/*.rb'
+  minimum_coverage line: 100
+end

data/specs/support/run_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Per-spec runner used by CI: `bundle exec ruby specs/support/run_spec.rb specs/<file>.rb`.
+# Requires spec_helper first (starting SimpleCov within the bundler context, which
+# a command-line `-r` flag cannot do reliably) and then loads the target spec.
+require_relative 'spec_helper'
+
+spec_file = ARGV[0] or abort('usage: run_spec.rb <spec_file>')
+load File.expand_path(spec_file)

data/specs/support/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Loaded (via `ruby -r ./specs/support/spec_helper`) before each spec so
+# SimpleCov can instrument the percy source. The suite runs one spec per
+# process, so each process records its own result under a unique command_name;
+# SimpleCov merges them into coverage/.resultset.json, and
+# specs/support/coverage_check.rb collates the merged result and enforces the gate.
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/specs/'
+  track_files 'percy/**/*.rb'
+  command_name "specs:#{File.basename(ARGV.first || $PROGRAM_NAME)}"
+  merge_timeout 3600
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: percy-appium-app
 version: !ruby/object:Gem::Version
-  version: 0.0.9.beta1
+  version: 0.0.9
 platform: ruby
 authors:
 - BroswerStack
@@ -177,8 +177,12 @@ files:
 - specs/metadata.rb
 - specs/metadata_resolver.rb
 - specs/mocks/mock_methods.rb
+- specs/percy_automate.rb
 - specs/percy_options.rb
 - specs/screenshot.rb
+- specs/support/coverage_check.rb
+- specs/support/run_spec.rb
+- specs/support/spec_helper.rb
 - specs/tile.rb
 homepage: ''
 licenses:
@@ -200,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Percy visual testing for Ruby Appium Mobile Apps
 test_files: []