percy-appium-app 0.0.1 → 0.0.2

data/percy/providers/generic_provider.rb

@@ -9,197 +9,199 @@ require_relative '../lib/cli_wrapper'
 require_relative '../lib/tile'
 require_relative '../common/common'
 
-class GenericProvider
-  attr_accessor :driver, :metadata, :debug_url
+module Percy
+  class GenericProvider
+    attr_accessor :driver, :metadata, :debug_url
+
+    def initialize(driver, metadata)
+      @driver = driver
+      @metadata = metadata
+      @debug_url = ''
+    end
 
-  def initialize(driver, metadata)
-    @driver = driver
-    @metadata = metadata
-    @debug_url = ''
-  end
+    def self.supports(_remote_url)
+      true
+    end
 
-  def self.supports(_remote_url)
-    true
-  end
+    def screenshot(name, **kwargs)
+      tiles = _get_tiles(**kwargs)
+      tag = _get_tag(**kwargs)
+      ignore_regions = {
+        'ignoreElementsData' => _find_regions(
+          xpaths: kwargs.fetch(:ignore_regions_xpaths, []),
+          accessibility_ids: kwargs.fetch(:ignore_region_accessibility_ids, []),
+          appium_elements: kwargs.fetch(:ignore_region_appium_elements, []),
+          custom_locations: kwargs.fetch(:custom_ignore_regions, [])
+        )
+      }
+      consider_regions = {
+        'considerElementsData' => _find_regions(
+          xpaths: kwargs.fetch(:consider_regions_xpaths, []),
+          accessibility_ids: kwargs.fetch(:consider_region_accessibility_ids, []),
+          appium_elements: kwargs.fetch(:consider_region_appium_elements, []),
+          custom_locations: kwargs.fetch(:custom_consider_regions, [])
+        )
+      }
+
+      _post_screenshots(name, tag, tiles, get_debug_url, ignore_regions, consider_regions)
+    end
 
-  def screenshot(name, **kwargs)
-    tiles = _get_tiles(**kwargs)
-    tag = _get_tag(**kwargs)
-    ignore_regions = {
-      'ignoreElementsData' => _find_regions(
-        xpaths: kwargs.fetch(:ignore_regions_xpaths, []),
-        accessibility_ids: kwargs.fetch(:ignore_region_accessibility_ids, []),
-        appium_elements: kwargs.fetch(:ignore_region_appium_elements, []),
-        custom_locations: kwargs.fetch(:custom_ignore_regions, [])
-      )
-    }
-    consider_regions = {
-      'considerElementsData' => _find_regions(
-        xpaths: kwargs.fetch(:consider_regions_xpaths, []),
-        accessibility_ids: kwargs.fetch(:consider_region_accessibility_ids, []),
-        appium_elements: kwargs.fetch(:consider_region_appium_elements, []),
-        custom_locations: kwargs.fetch(:custom_consider_regions, [])
-      )
-    }
-
-    _post_screenshots(name, tag, tiles, get_debug_url, ignore_regions, consider_regions)
-  end
+    def _get_tag(**kwargs)
+      name = kwargs[:device_name] || metadata.device_name
+      os_name = metadata.os_name
+      os_version = metadata.os_version
+      width = metadata.device_screen_size['width'] || 1
+      height = metadata.device_screen_size['height'] || 1
+      orientation = metadata.get_orientation(**kwargs).downcase
+
+      {
+        'name' => name,
+        'os_name' => os_name,
+        'os_version' => os_version,
+        'width' => width,
+        'height' => height,
+        'orientation' => orientation
+      }
+    end
 
-  def _get_tag(**kwargs)
-    name = kwargs[:device_name] || metadata.device_name
-    os_name = metadata.os_name
-    os_version = metadata.os_version
-    width = metadata.device_screen_size['width'] || 1
-    height = metadata.device_screen_size['height'] || 1
-    orientation = metadata.get_orientation(**kwargs).downcase
-
-    {
-      'name' => name,
-      'os_name' => os_name,
-      'os_version' => os_version,
-      'width' => width,
-      'height' => height,
-      'orientation' => orientation
-    }
-  end
+    def _get_tiles(**kwargs)
+      fullpage_ss = kwargs[:fullpage] || false
+      if fullpage_ss
+        log('Full page screenshot is only supported on App Automate. Falling back to single page screenshot.')
+      end
 
-  def _get_tiles(**kwargs)
-    fullpage_ss = kwargs[:fullpage] || false
-    if fullpage_ss
-      log('Full page screenshot is only supported on App Automate. Falling back to single page screenshot.')
+      png_bytes = driver.screenshot_as(:png)
+      directory = _get_dir
+      path = _write_screenshot(png_bytes, directory)
+
+      fullscreen = kwargs[:full_screen] || false
+      status_bar_height = kwargs[:status_bar_height] || metadata.status_bar_height
+      nav_bar_height = kwargs[:nav_bar_height] || metadata.navigation_bar_height
+      header_height = 0
+      footer_height = 0
+      [
+        Percy::Tile.new(status_bar_height, nav_bar_height, header_height, footer_height, filepath: path, fullscreen: fullscreen)
+      ]
     end
 
-    png_bytes = driver.screenshot_as(:png)
-    directory = _get_dir
-    path = _write_screenshot(png_bytes, directory)
-
-    fullscreen = kwargs[:full_screen] || false
-    status_bar_height = kwargs[:status_bar_height] || metadata.status_bar_height
-    nav_bar_height = kwargs[:nav_bar_height] || metadata.navigation_bar_height
-    header_height = 0
-    footer_height = 0
-    [
-      Tile.new(status_bar_height, nav_bar_height, header_height, footer_height, filepath: path, fullscreen: fullscreen)
-    ]
-  end
+    def _find_regions(xpaths:, accessibility_ids:, appium_elements:, custom_locations:)
+      elements_array = []
+      get_regions_by_xpath(elements_array, xpaths)
+      get_regions_by_ids(elements_array, accessibility_ids)
+      get_regions_by_elements(elements_array, appium_elements)
+      get_regions_by_location(elements_array, custom_locations)
+      elements_array
+    end
 
-  def _find_regions(xpaths:, accessibility_ids:, appium_elements:, custom_locations:)
-    elements_array = []
-    get_regions_by_xpath(elements_array, xpaths)
-    get_regions_by_ids(elements_array, accessibility_ids)
-    get_regions_by_elements(elements_array, appium_elements)
-    get_regions_by_location(elements_array, custom_locations)
-    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)
+    end
 
-  def _post_screenshots(name, tag, tiles, debug_url, ignored_regions, considered_regions)
-    CLIWrapper.new.post_screenshots(name, tag, tiles, debug_url, ignored_regions, considered_regions)
-  end
+    def _write_screenshot(png_bytes, directory)
+      filepath = _get_path(directory)
+      File.open(filepath, 'wb') { |f| f.write(png_bytes) }
+      filepath
+    end
 
-  def _write_screenshot(png_bytes, directory)
-    filepath = _get_path(directory)
-    File.open(filepath, 'wb') { |f| f.write(png_bytes) }
-    filepath
-  end
+    def get_region_object(selector, element)
+      scale_factor = metadata.scale_factor
+      location = hashed(element.location)
+      size = hashed(element.size)
+      coordinates = {
+        'top' => location['y'] * scale_factor,
+        'bottom' => (location['y'] + size['height']) * scale_factor,
+        'left' => location['x'] * scale_factor,
+        'right' => (location['x'] + size['width']) * scale_factor
+      }
+      { 'selector' => selector, 'coOrdinates' => coordinates }
+    end
 
-  def get_region_object(selector, element)
-    scale_factor = metadata.scale_factor
-    location = hashed(element.location)
-    size = hashed(element.size)
-    coordinates = {
-      'top' => location['y'] * scale_factor,
-      'bottom' => (location['y'] + size['height']) * scale_factor,
-      'left' => location['x'] * scale_factor,
-      'right' => (location['x'] + size['width']) * scale_factor
-    }
-    { 'selector' => selector, 'coOrdinates' => coordinates }
-  end
+    def get_regions_by_xpath(elements_array, xpaths)
+      xpaths.each do |xpath|
+        element = driver.find_element(Appium::Core::Base::SearchContext::FINDERS[:xpath], xpath)
+        selector = "xpath: #{xpath}"
+        if element
+          region = get_region_object(selector, element)
+          elements_array << region
+        end
+      rescue Appium::Core::Error::NoSuchElementError => e
+        log("Appium Element with xpath: #{xpath} not found. Ignoring this xpath.")
+        log(e, on_debug: true)
+      end
+    end
 
-  def get_regions_by_xpath(elements_array, xpaths)
-    xpaths.each do |xpath|
-      element = driver.find_element(Appium::Core::Base::SearchContext::FINDERS[:xpath], xpath)
-      selector = "xpath: #{xpath}"
-      if element
+    def get_regions_by_ids(elements_array, ids)
+      ids.each do |id|
+        element = driver.find_element(Appium::Core::Base::SearchContext::FINDERS[:accessibility_id], id)
+        selector = "id: #{id}"
         region = get_region_object(selector, element)
         elements_array << region
+      rescue Appium::Core::Error::NoSuchElementError => e
+        log("Appium Element with id: #{id} not found. Ignoring this id.")
+        log(e, on_debug: true)
       end
-    rescue Appium::Core::Error::NoSuchElementError => e
-      log("Appium Element with xpath: #{xpath} not found. Ignoring this xpath.")
-      log(e, on_debug: true)
     end
-  end
-
-  def get_regions_by_ids(elements_array, ids)
-    ids.each do |id|
-      element = driver.find_element(Appium::Core::Base::SearchContext::FINDERS[:accessibility_id], id)
-      selector = "id: #{id}"
-      region = get_region_object(selector, element)
-      elements_array << region
-    rescue Appium::Core::Error::NoSuchElementError => e
-      log("Appium Element with id: #{id} not found. Ignoring this id.")
-      log(e, on_debug: true)
-    end
-  end
 
-  def get_regions_by_elements(elements_array, elements)
-    elements.each_with_index do |element, index|
-      class_name = element.attribute('class')
-      selector = "element: #{index} #{class_name}"
-      region = get_region_object(selector, element)
-      elements_array << region
-    rescue Appium::Core::Error::NoSuchElementError => e
-      log("Correct Element not passed at index #{index}")
-      log(e, on_debug: true)
+    def get_regions_by_elements(elements_array, elements)
+      elements.each_with_index do |element, index|
+        class_name = element.attribute('class')
+        selector = "element: #{index} #{class_name}"
+        region = get_region_object(selector, element)
+        elements_array << region
+      rescue Appium::Core::Error::NoSuchElementError => e
+        log("Correct Element not passed at index #{index}")
+        log(e, on_debug: true)
+      end
     end
-  end
 
-  def get_regions_by_location(elements_array, custom_locations)
-    custom_locations.each_with_index do |custom_location, index|
-      screen_width = metadata.device_screen_size['width']
-      screen_height = metadata.device_screen_size['height']
-      if custom_location.valid?(screen_height, screen_width)
-        region = {
-          selector: "custom ignore region: #{index}",
-          coOrdinates: {
-            top: custom_location.top,
-            bottom: custom_location.bottom,
-            left: custom_location.left,
-            right: custom_location.right
+    def get_regions_by_location(elements_array, custom_locations)
+      custom_locations.each_with_index do |custom_location, index|
+        screen_width = metadata.device_screen_size['width']
+        screen_height = metadata.device_screen_size['height']
+        if custom_location.valid?(screen_height, screen_width)
+          region = {
+            selector: "custom ignore region: #{index}",
+            coOrdinates: {
+              top: custom_location.top,
+              bottom: custom_location.bottom,
+              left: custom_location.left,
+              right: custom_location.right
+            }
           }
-        }
-        elements_array << region
-      else
-        log("Values passed in custom ignored region at index: #{index} are not valid")
+          elements_array << region
+        else
+          log("Values passed in custom ignored region at index: #{index} are not valid")
+        end
       end
     end
-  end
 
-  def log(message, on_debug: false)
-    puts message if on_debug
-  end
+    def log(message, on_debug: false)
+      puts message if on_debug
+    end
 
-  def get_debug_url
-    debug_url
-  end
+    def get_debug_url
+      debug_url
+    end
 
-  def get_device_name
-    ''
-  end
+    def get_device_name
+      ''
+    end
 
-  def _get_dir
-    dir_path = ENV['PERCY_TMP_DIR'] || nil
-    if dir_path
-      Pathname.new(dir_path).mkpath
-      return dir_path
+    def _get_dir
+      dir_path = ENV['PERCY_TMP_DIR'] || nil
+      if dir_path
+        Pathname.new(dir_path).mkpath
+        return dir_path
+      end
+      Dir.mktmpdir
     end
-    Dir.mktmpdir
-  end
 
-  def _get_path(directory)
-    suffix = '.png'
-    prefix = 'percy-appium-'
-    file = Tempfile.new([prefix, suffix], directory)
-    file.close
-    file.path
+    def _get_path(directory)
+      suffix = '.png'
+      prefix = 'percy-appium-'
+      file = Tempfile.new([prefix, suffix], directory)
+      file.close
+      file.path
+    end
   end
 end

data/percy/providers/provider_resolver.rb

@@ -5,13 +5,15 @@ require_relative '../metadata/metadata_resolver'
 require_relative 'app_automate'
 require_relative 'generic_provider'
 
-class ProviderResolver
-  def self.resolve(driver)
-    metadata = MetadataResolver.resolve(driver)
-    providers = [AppAutomate, GenericProvider]
-    providers.each do |provider|
-      return provider.new(driver, metadata) if provider.supports(metadata.remote_url)
+module Percy
+  class ProviderResolver
+    def self.resolve(driver)
+      metadata = Percy::MetadataResolver.resolve(driver)
+      providers = [Percy::AppAutomate, Percy::GenericProvider]
+      providers.each do |provider|
+        return provider.new(driver, metadata) if provider.supports(metadata.remote_url)
+      end
+      raise UnknownProvider
     end
-    raise UnknownProvider
   end
 end

data/percy/version.rb

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

data/percy-appium-app.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['percy']
 
   spec.add_runtime_dependency 'appium_lib', '~> 12.0'
+  spec.add_runtime_dependency 'dotenv', '~> 2.8'
 
   spec.add_development_dependency 'bundler', '~> 2.4'
   spec.add_development_dependency 'minitest', '~> 5.20'

data/specs/android_metadata.rb

@@ -1,19 +1,17 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/MethodLength
-
 require 'minitest/autorun'
 require 'minitest/mock'
 require 'appium_lib'
 require_relative 'mocks/mock_methods'
 require_relative '../percy/metadata/android_metadata'
 
-# Test suite for the AndroidMetadata class
+# Test suite for the Percy::AndroidMetadata class
 class TestAndroidMetadata < Minitest::Test
   def setup
     @mock_webdriver = Minitest::Mock.new
     @mock_webdriver.expect(:capabilities, get_android_capabilities)
-    @android_metadata = AndroidMetadata.new(@mock_webdriver)
+    @android_metadata = Percy::AndroidMetadata.new(@mock_webdriver)
   end
 
   def test_android_execute_script

data/specs/app_automate.rb

@@ -1,23 +1,20 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/MethodLength
-# rubocop:disable Metrics/AbcSize
-
 require 'minitest/autorun'
 require 'minitest/mock'
 require_relative '../percy/providers/app_automate'
 require_relative '../percy/metadata/android_metadata'
 require_relative 'mocks/mock_methods'
 
-# Test suite for the AppAutomate class
+# Test suite for the Percy::AppAutomate class
 class TestAppAutomate < Minitest::Test
   COMPARISON_RESPONSE = { 'success' => true, 'link' => 'https://snapshots-url' }.freeze
 
   def setup
     @mock_webdriver = Minitest::Mock.new
     @mock_webdriver.expect(:capabilities, get_android_capabilities)
-    @metadata = AndroidMetadata.new(@mock_webdriver)
-    @app_automate = AppAutomate.new(@mock_webdriver, @metadata)
+    @metadata = Percy::AndroidMetadata.new(@mock_webdriver)
+    @app_automate = Percy::AppAutomate.new(@mock_webdriver, @metadata)
   end
 
   def test_app_automate_get_debug_url
@@ -28,18 +25,18 @@ class TestAppAutomate < Minitest::Test
   end
 
   def test_app_automate_supports_with_correct_url
-    app_automate_session = AppAutomate.supports('https://hub-cloud.browserstack.com/wd/hub')
+    app_automate_session = Percy::AppAutomate.supports('https://hub-cloud.browserstack.com/wd/hub')
     assert_equal true, app_automate_session
   end
 
   def test_app_automate_supports_with_incorrect_url
-    app_automate_session = AppAutomate.supports('https://hub-cloud.generic.com/wd/hub')
+    app_automate_session = Percy::AppAutomate.supports('https://hub-cloud.generic.com/wd/hub')
     assert_equal false, app_automate_session
   end
 
   def test_app_automate_supports_with_AA_DOMAIN
     ENV['AA_DOMAIN'] = 'bsstag'
-    app_automate_session = AppAutomate.supports('bsstag.com')
+    app_automate_session = Percy::AppAutomate.supports('bsstag.com')
     assert_equal true, app_automate_session
     ENV['AA_DOMAIN'] = nil
   end
@@ -80,23 +77,23 @@ class TestAppAutomate < Minitest::Test
   end
 
   def test_get_tiles
-    # Mocking Metadata's session_id method
+    # Mocking Percy::Metadata's session_id method
     metadata_mock = Minitest::Mock.new
     metadata_mock.expect(:session_id, 'session_id_123')
 
-    # Mocking AndroidMetadata's methods
+    # Mocking Percy::AndroidMetadata's methods
     android_metadata_mock = Minitest::Mock.new
     android_metadata_mock.expect(:device_screen_size, { 'width' => 1080, 'height' => 1920 })
     android_metadata_mock.expect(:navigation_bar_height, 150)
     android_metadata_mock.expect(:status_bar_height, 100)
 
-    Metadata.class_eval do
+    Percy::Metadata.class_eval do
       define_method(:session_id) do
         metadata_mock.session_id
       end
     end
 
-    AndroidMetadata.class_eval do
+    Percy::AndroidMetadata.class_eval do
       define_method(:device_screen_size) do
         android_metadata_mock.device_screen_size
       end

data/specs/app_percy.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/MethodLength
-
 require 'minitest/autorun'
 # require 'webmock/minitest'
 require_relative '../percy/lib/app_percy'
@@ -12,7 +10,7 @@ require_relative '../percy/providers/generic_provider'
 require_relative '../percy/lib/cli_wrapper'
 require_relative 'mocks/mock_methods'
 
-# Test suite for the AppPercy class
+# Test suite for the Percy::AppPercy class
 class TestAppPercy < Minitest::Test
   COMPARISON_RESPONSE = { 'link' => 'https://snapshot_url', 'success' => true }.freeze
 
@@ -38,10 +36,10 @@ class TestAppPercy < Minitest::Test
 
     ENV['PERCY_DISABLE_REMOTE_UPLOADS'] = 'true'
 
-    app_percy = AppPercy.new(@mock_android_webdriver)
+    app_percy = Percy::AppPercy.new(@mock_android_webdriver)
 
-    assert_instance_of(AndroidMetadata, app_percy.metadata)
-    assert_instance_of(AppAutomate, app_percy.provider)
+    assert_instance_of(Percy::AndroidMetadata, app_percy.metadata)
+    assert_instance_of(Percy::AppAutomate, app_percy.provider)
   end
 
   def test_android_on_non_app_automate
@@ -57,9 +55,9 @@ class TestAppPercy < Minitest::Test
     5.times do
       @mock_android_webdriver.expect(:capabilities, get_android_capabilities)
     end
-    app_percy = AppPercy.new(@mock_android_webdriver)
-    assert_instance_of(AndroidMetadata, app_percy.metadata)
-    assert_instance_of(GenericProvider, app_percy.provider)
+    app_percy = Percy::AppPercy.new(@mock_android_webdriver)
+    assert_instance_of(Percy::AndroidMetadata, app_percy.metadata)
+    assert_instance_of(Percy::GenericProvider, app_percy.provider)
   end
 
   def test_ios_on_app_automate
@@ -68,9 +66,9 @@ class TestAppPercy < Minitest::Test
     5.times do
       @mock_ios_webdriver.expect(:capabilities, get_ios_capabilities)
     end
-    app_percy = AppPercy.new(@mock_ios_webdriver)
-    assert_instance_of(IOSMetadata, app_percy.metadata)
-    assert_instance_of(AppAutomate, app_percy.provider)
+    app_percy = Percy::AppPercy.new(@mock_ios_webdriver)
+    assert_instance_of(Percy::IOSMetadata, app_percy.metadata)
+    assert_instance_of(Percy::AppAutomate, app_percy.provider)
   end
 
   def test_ios_on_non_app_automate
@@ -84,16 +82,16 @@ class TestAppPercy < Minitest::Test
     3.times do
       @mock_ios_webdriver.expect(:capabilities, get_ios_capabilities)
     end
-    app_percy = AppPercy.new(@mock_ios_webdriver)
-    assert_instance_of(IOSMetadata, app_percy.metadata)
-    assert_instance_of(GenericProvider, app_percy.provider)
+    app_percy = Percy::AppPercy.new(@mock_ios_webdriver)
+    assert_instance_of(Percy::IOSMetadata, app_percy.metadata)
+    assert_instance_of(Percy::GenericProvider, app_percy.provider)
   end
 
   def test_screenshot_with_percy_options_disabled
     disable_percy_options(@mock_android_webdriver, num = 5)
     make_mock_driver_appium(@mock_android_webdriver)
     mock_driver_remote_url(@mock_android_webdriver, 'some-other-url', num = 2)
-    app_percy = AppPercy.new(@mock_android_webdriver)
+    app_percy = Percy::AppPercy.new(@mock_android_webdriver)
     assert_nil app_percy.screenshot('screenshot 1')
   end
 
@@ -101,7 +99,7 @@ class TestAppPercy < Minitest::Test
     disable_percy_options(@mock_android_webdriver, num = 5)
     make_mock_driver_appium(@mock_android_webdriver)
     mock_driver_remote_url(@mock_android_webdriver, 'some-other-url', num = 2)
-    app_percy = AppPercy.new(@mock_android_webdriver)
+    app_percy = Percy::AppPercy.new(@mock_android_webdriver)
     assert_nil app_percy.screenshot('screenshot 1')
   end
 
@@ -112,7 +110,7 @@ class TestAppPercy < Minitest::Test
                                    })
 
     assert_raises(Exception) do
-      AppPercy.screenshot(@mock_android_webdriver, 'screenshot')
+      Percy::AppPercy.screenshot(@mock_android_webdriver, 'screenshot')
     end
   end
 
@@ -125,16 +123,16 @@ class TestAppPercy < Minitest::Test
       @mock_android_webdriver.expect(:capabilities, caps)
     end
 
-    GenericProvider.stub(:supports, false) do
+    Percy::GenericProvider.stub(:supports, false) do
       assert_raises(UnknownProvider) do
-        _provider = AppPercy.new(@mock_android_webdriver).provider
+        _provider = Percy::AppPercy.new(@mock_android_webdriver).provider
       end
     end
   end
 
   def test_invalid_driver
     assert_raises(DriverNotSupported) do
-      AppPercy.new(Object.new)
+      Percy::AppPercy.new(Object.new)
     end
   end
 
@@ -169,7 +167,7 @@ class TestAppPercy < Minitest::Test
                           })
 
     assert_raises(Exception) do
-      AppPercy.screenshot(mock_webdriver, 'screenshot')
+      Percy::AppPercy.screenshot(mock_webdriver, 'screenshot')
     end
   end
 end