percy-appium-app 0.0.1 → 0.0.2.pre.beta.0

data/specs/percy_options.rb

@@ -4,110 +4,110 @@ require 'minitest/autorun'
 require 'minitest/mock'
 require_relative '../percy/lib/percy_options'
 
-# Test suite for the PercyOptions class
+# Test suite for the Percy::PercyOptions class
 class TestPercyOptions < Minitest::Test
   # Defaults
   def test_percy_options_not_provided
     capabilities = {}
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal true, percy_options.enabled
     assert_equal true, percy_options.ignore_errors
   end
 
   def test_percy_options_w3c_enabled
     capabilities = { 'percy:options' => { 'enabled' => true } }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal true, percy_options.enabled
     assert_equal true, percy_options.ignore_errors
   end
 
   def test_percy_options_json_wire_enabled
     capabilities = { 'percy.enabled' => true }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal true, percy_options.enabled
     assert_equal true, percy_options.ignore_errors
   end
 
   def test_percy_options_w3c_not_enabled
     capabilities = { 'percy:options' => { 'enabled' => false } }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal false, percy_options.enabled
     assert_equal true, percy_options.ignore_errors
   end
 
   def test_percy_options_json_wire_not_enabled
     capabilities = { 'percy.enabled' => false }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal false, percy_options.enabled
     assert_equal true, percy_options.ignore_errors
   end
 
   def test_percy_options_w3c_ignore_errors
     capabilities = { 'percy:options' => { 'ignoreErrors' => true } }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal true, percy_options.ignore_errors
     assert_equal true, percy_options.enabled
   end
 
   def test_percy_options_json_wire_ignore_errors
     capabilities = { 'percy.ignoreErrors' => true }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal true, percy_options.ignore_errors
     assert_equal true, percy_options.enabled
   end
 
   def test_percy_options_w3c_not_ignore_errors
     capabilities = { 'percy:options' => { 'ignoreErrors' => false } }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal false, percy_options.ignore_errors
     assert_equal true, percy_options.enabled
   end
 
   def test_percy_options_json_wire_not_ignore_errors
     capabilities = { 'percy.ignoreErrors' => false }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal false, percy_options.ignore_errors
     assert_equal true, percy_options.enabled
   end
 
   def test_percy_options_w3c_all_options_false
     capabilities = { 'percy:options' => { 'ignoreErrors' => false, 'enabled' => false } }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal false, percy_options.ignore_errors
     assert_equal false, percy_options.enabled
   end
 
   def test_percy_options_json_wire_all_options_false
     capabilities = { 'percy.ignoreErrors' => false, 'percy.enabled' => false }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal false, percy_options.ignore_errors
     # assert_equal false, percy_options.enabled
   end
 
   def test_percy_options_w3c_all_options_true
     capabilities = { 'percy:options' => { 'ignoreErrors' => true, 'enabled' => true } }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal true, percy_options.ignore_errors
     assert_equal true, percy_options.enabled
   end
 
   def test_percy_options_json_wire_all_options_true
     capabilities = { 'percy.ignoreErrors' => true, 'percy.enabled' => true }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal true, percy_options.ignore_errors
     assert_equal true, percy_options.enabled
   end
 
   def test_percy_options_json_wire_and_w3c_case_1
     capabilities = { 'percy.ignoreErrors' => false, 'percy:options' => { 'enabled' => false } }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal false, percy_options.ignore_errors
     assert_equal false, percy_options.enabled
   end
 
   def test_percy_options_json_wire_and_w3c_case_2
     capabilities = { 'percy.enabled' => false, 'percy:options' => { 'ignoreErrors' => false } }
-    percy_options = PercyOptions.new(capabilities)
+    percy_options = Percy::PercyOptions.new(capabilities)
     assert_equal false, percy_options.ignore_errors
     assert_equal false, percy_options.enabled
   end

data/specs/screenshot.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/MethodLength
-# rubocop:disable Metrics/AbcSize
-
 require 'minitest/autorun'
 require 'json'
 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'
 
@@ -27,7 +24,7 @@ mock_server.mount('/', MockServerRequestHandler)
 mock_server_thread = Thread.new { mock_server.start }
 
 # Mock helpers
-def mock_healthcheck(fail: false, fail_how: 'error', type: 'AppPercy')
+def mock_healthcheck(fail: false, fail_how: 'error', type: 'Percy::AppPercy')
   health_body = JSON.dump(success: true, build: { 'id' => '123', 'url' => 'dummy_url' }, type: type)
   health_headers = { 'X-Percy-Core-Version' => '1.27.0-beta.1' }
   health_status = 200
@@ -57,14 +54,14 @@ def mock_healthcheck(fail: false, fail_how: 'error', type: '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
@@ -104,12 +101,12 @@ class TestPercyScreenshot < Minitest::Test
       @server_url.expect(:to_s, 'https://hub-cloud.browserstack.com/wd/hub')
     end
 
-    assert_raises(TypeError) { AppPercy.new(@mock_webdriver).screenshot(123) }
-    assert_raises(TypeError) { AppPercy.new(@mock_webdriver).screenshot('screenshot 1', device_name: 123) }
-    assert_raises(TypeError) { AppPercy.new(@mock_webdriver).screenshot('screenshot 1', full_screen: 123) }
-    assert_raises(TypeError) { AppPercy.new(@mock_webdriver).screenshot('screenshot 1', orientation: 123) }
-    assert_raises(TypeError) { AppPercy.new(@mock_webdriver).screenshot('screenshot 1', status_bar_height: 'height') }
-    assert_raises(TypeError) { AppPercy.new(@mock_webdriver).screenshot('screenshot 1', nav_bar_height: 'height') }
+    assert_raises(TypeError) { Percy::AppPercy.new(@mock_webdriver).screenshot(123) }
+    assert_raises(TypeError) { Percy::AppPercy.new(@mock_webdriver).screenshot('screenshot 1', device_name: 123) }
+    assert_raises(TypeError) { Percy::AppPercy.new(@mock_webdriver).screenshot('screenshot 1', full_screen: 123) }
+    assert_raises(TypeError) { Percy::AppPercy.new(@mock_webdriver).screenshot('screenshot 1', orientation: 123) }
+    assert_raises(TypeError) { Percy::AppPercy.new(@mock_webdriver).screenshot('screenshot 1', status_bar_height: 'height') }
+    assert_raises(TypeError) { Percy::AppPercy.new(@mock_webdriver).screenshot('screenshot 1', nav_bar_height: 'height') }
   end
 
   def test_throws_error_when_a_driver_is_not_provided
@@ -207,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
@@ -259,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

data/specs/tile.rb

@@ -3,10 +3,10 @@
 require 'minitest/autorun'
 require_relative '../percy/lib/tile'
 
-# Test suite for the Tile class.
+# Test suite for the Percy::Tile class.
 class TileTest < Minitest::Test
   def setup
-    @tile = Tile.new(20, 120, 150, 0, filepath: 'some-file-path', sha: 'some-sha')
+    @tile = Percy::Tile.new(20, 120, 150, 0, filepath: 'some-file-path', sha: 'some-sha')
     @hash_tile = @tile.to_h
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-appium-app
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2.pre.beta.0
 platform: ruby
 authors:
 - BroswerStack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-30 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -146,10 +160,10 @@ files:
 - percy/metadata/ios_metadata.rb
 - percy/metadata/metadata.rb
 - percy/metadata/metadata_resolver.rb
+- percy/percy-appium-app.rb
 - percy/providers/app_automate.rb
 - percy/providers/generic_provider.rb
 - percy/providers/provider_resolver.rb
-- percy/screenshot.rb
 - percy/version.rb
 - specs/android_metadata.rb
 - specs/app_automate.rb
@@ -183,11 +197,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.4.19
 signing_key:
 specification_version: 4
 summary: Percy visual testing for Ruby Appium Mobile Apps