percy-appium-app 0.0.1 → 0.0.3

data/percy/metadata/metadata.rb

@@ -7,102 +7,104 @@ require_relative '../common/common'
 DEVICE_INFO_FILE_PATH = File.join(File.dirname(__FILE__), '..', 'configs', 'devices.json')
 DEVICE_INFO = JSON.parse(File.read(DEVICE_INFO_FILE_PATH))
 
-class Metadata
-  attr_reader :driver, :device_info
-  attr_accessor :device_name, :os_version, :device_info
-
-  def initialize(driver)
-    @driver = driver
-    @device_name = nil
-    @os_version = nil
-    @device_info = {}
-  end
-
-  def capabilities
-    caps = driver.capabilities
-    caps = caps.as_json unless caps.is_a?(Hash)
-    caps
-  end
+module Percy
+  class Metadata
+    attr_reader :driver, :device_info
+    attr_accessor :device_name, :os_version, :device_info
+
+    def initialize(driver)
+      @driver = driver
+      @device_name = nil
+      @os_version = nil
+      @device_info = {}
+    end
 
-  def session_id
-    driver.session_id
-  end
+    def capabilities
+      caps = driver.capabilities
+      caps = caps.as_json unless caps.is_a?(Hash)
+      caps
+    end
 
-  def os_name
-    capabilities['platformName']
-  end
+    def session_id
+      driver.session_id
+    end
 
-  def os_version
-    caps = capabilities
-    caps = caps.as_json unless caps.is_a?(Hash)
+    def os_name
+      capabilities['platformName']
+    end
 
-    os_version = caps['os_version'] || caps['platformVersion'] || ''
-    os_version = @os_version || os_version
-    begin
-      os_version.to_f.to_i.to_s
-    rescue StandardError
-      ''
+    def os_version
+      caps = capabilities
+      caps = caps.as_json unless caps.is_a?(Hash)
+
+      os_version = caps['os_version'] || caps['platformVersion'] || ''
+      os_version = @os_version || os_version
+      begin
+        os_version.to_f.to_i.to_s
+      rescue StandardError
+        ''
+      end
     end
-  end
 
-  def remote_url
-    driver.instance_variable_get(:@bridge).instance_variable_get(:@http).instance_variable_get(:@server_url).to_s
-  end
+    def remote_url
+      driver.instance_variable_get(:@bridge).instance_variable_get(:@http).instance_variable_get(:@server_url).to_s
+    end
 
-  def get_orientation(**kwargs)
-    orientation = kwargs[:orientation] || capabilities['orientation'] || 'PORTRAIT'
-    orientation = orientation.downcase
-    orientation = orientation == 'auto' ? _orientation : orientation
-    orientation.upcase
-  end
+    def get_orientation(**kwargs)
+      orientation = kwargs[:orientation] || capabilities['orientation'] || 'PORTRAIT'
+      orientation = orientation.downcase
+      orientation = orientation == 'auto' ? _orientation : orientation
+      orientation.upcase
+    end
 
-  def _orientation
-    driver.orientation.downcase
-  end
+    def _orientation
+      driver.orientation.downcase
+    end
 
-  def device_screen_size
-    raise NotImplementedError
-  end
+    def device_screen_size
+      raise NotImplementedError
+    end
 
-  def _device_name
-    raise NotImplementedError
-  end
+    def _device_name
+      raise NotImplementedError
+    end
 
-  def status_bar
-    raise NotImplementedError
-  end
+    def status_bar
+      raise NotImplementedError
+    end
 
-  def status_bar_height
-    status_bar['height']
-  end
+    def status_bar_height
+      status_bar['height']
+    end
 
-  def navigation_bar
-    raise NotImplementedError
-  end
+    def navigation_bar
+      raise NotImplementedError
+    end
 
-  def navigation_bar_height
-    navigation_bar['height']
-  end
+    def navigation_bar_height
+      navigation_bar['height']
+    end
 
-  def viewport
-    raise NotImplementedError
-  end
+    def viewport
+      raise NotImplementedError
+    end
 
-  def execute_script(command)
-    driver.execute_script(command)
-  end
+    def execute_script(command)
+      driver.execute_script(command)
+    end
 
-  def value_from_devices_info(key, device_name, os_version = nil)
-    device_info = get_device_info(device_name)
-    device_info = device_info[os_version] || {} if os_version
-    device_info[key].to_i || 0
-  end
+    def value_from_devices_info(key, device_name, os_version = nil)
+      device_info = get_device_info(device_name)
+      device_info = device_info[os_version] || {} if os_version
+      device_info[key].to_i || 0
+    end
 
-  def get_device_info(device_name)
-    return @device_info unless @device_info.empty?
+    def get_device_info(device_name)
+      return @device_info unless @device_info.empty?
 
-    @device_info = DEVICE_INFO[device_name.downcase] || {}
-    log("#{device_name.downcase} does not exist in config.") if @device_info.empty?
-    @device_info
+      @device_info = DEVICE_INFO[device_name.downcase] || {}
+      log("#{device_name.downcase} does not exist in config.") if @device_info.empty?
+      @device_info
+    end
   end
 end

data/percy/metadata/metadata_resolver.rb

@@ -4,18 +4,20 @@ require_relative '../exceptions/exceptions'
 require_relative 'android_metadata'
 require_relative 'ios_metadata'
 
-class MetadataResolver
-  def self.resolve(driver)
-    capabilities = driver.capabilities
-    capabilities = capabilities.as_json unless capabilities.is_a?(Hash)
-    platform_name = capabilities.fetch('platformName', '').downcase
-    case platform_name
-    when 'android'
-      AndroidMetadata.new(driver)
-    when 'ios'
-      IOSMetadata.new(driver)
-    else
-      raise PlatformNotSupported
+module Percy
+  class MetadataResolver
+    def self.resolve(driver)
+      capabilities = driver.capabilities
+      capabilities = capabilities.as_json unless capabilities.is_a?(Hash)
+      platform_name = capabilities.fetch('platformName', '').downcase
+      case platform_name
+      when 'android'
+        Percy::AndroidMetadata.new(driver)
+      when 'ios'
+        Percy::IOSMetadata.new(driver)
+      else
+        raise PlatformNotSupported
+      end
     end
   end
 end

data/percy/{screenshot.rb → percy-appium-app.rb}

@@ -7,14 +7,14 @@ require_relative 'lib/cli_wrapper'
 require_relative 'environment'
 
 def percy_screenshot(driver, name, **kwargs)
-  return nil unless CLIWrapper.percy_enabled?
+  return nil unless Percy::CLIWrapper.percy_enabled?
 
   app_percy = nil
-  provider_class = Environment.session_type == 'automate' ? PercyOnAutomate : AppPercy
+  provider_class = Percy::Environment.session_type == 'automate' ? Percy::PercyOnAutomate : Percy::AppPercy
   app_percy = provider_class.new(driver)
   app_percy.screenshot(name, **kwargs)
 rescue StandardError => e
-  CLIWrapper.post_failed_event(e.to_s)
+  Percy::CLIWrapper.post_failed_event(e.to_s)
   log("Could not take screenshot \"#{name}\"")
   raise e if app_percy && !app_percy.percy_options.ignore_errors
 

data/percy/providers/app_automate.rb

@@ -6,154 +6,156 @@ require_relative '../lib/tile'
 require_relative 'generic_provider'
 require_relative '../environment'
 
-class AppAutomate < GenericProvider
-  def self.supports(remote_url)
-    r_index = remote_url.rindex(ENV['AA_DOMAIN'].nil? ? 'browserstack' : ENV['AA_DOMAIN'])
-    if r_index
-      r_index > -1
-    else
-      false
+module Percy
+  class AppAutomate < Percy::GenericProvider
+    def self.supports(remote_url)
+      r_index = remote_url.rindex(ENV['AA_DOMAIN'].nil? ? 'browserstack' : ENV['AA_DOMAIN'])
+      if r_index
+        r_index > -1
+      else
+        false
+      end
     end
-  end
 
-  def screenshot(name, **kwargs)
-    session_details = execute_percy_screenshot_begin(name)
+    def screenshot(name, **kwargs)
+      session_details = execute_percy_screenshot_begin(name)
 
-    if session_details
-      metadata.device_name = session_details['deviceName']
-      metadata.os_version = session_details['osVersion']
-      set_debug_url(session_details)
-    end
+      if session_details
+        metadata.device_name = session_details['deviceName']
+        metadata.os_version = session_details['osVersion']
+        set_debug_url(session_details)
+      end
 
-    begin
-      response = super(name, **kwargs)
-      percy_screenshot_url = response.fetch('link', '')
-      execute_percy_screenshot_end(name, percy_screenshot_url, 'success')
-    rescue StandardError => e
-      execute_percy_screenshot_end(name, percy_screenshot_url, 'failure', e.message)
-      raise e
+      begin
+        response = super(name, **kwargs)
+        percy_screenshot_url = response.fetch('link', '')
+        execute_percy_screenshot_end(name, percy_screenshot_url, 'success')
+      rescue StandardError => e
+        execute_percy_screenshot_end(name, percy_screenshot_url, 'failure', e.message)
+        raise e
+      end
     end
-  end
 
-  def set_debug_url(session_details)
-    build_hash = session_details['buildHash'].to_s
-    session_hash = session_details['sessionHash'].to_s
-    @debug_url = "https://app-automate.browserstack.com/dashboard/v2/builds/#{build_hash}/sessions/#{session_hash}"
-  end
-
-  def _get_tiles(**kwargs)
-    fullpage_ss = kwargs[:fullpage] || false
-    if ENV['PERCY_DISABLE_REMOTE_UPLOADS'] == 'true'
-      puts("Full page screenshots are only supported when 'PERCY_DISABLE_REMOTE_UPLOADS' is not set") if fullpage_ss
-      return super(**kwargs) unless fullpage_ss
+    def set_debug_url(session_details)
+      build_hash = session_details['buildHash'].to_s
+      session_hash = session_details['sessionHash'].to_s
+      @debug_url = "https://app-automate.browserstack.com/dashboard/v2/builds/#{build_hash}/sessions/#{session_hash}"
     end
-    screenshot_type = fullpage_ss ? 'fullpage' : 'singlepage'
-    screen_lengths = kwargs[:screen_lengths] || 4
-    scrollable_xpath = kwargs[:scollable_xpath]
-    scrollable_id = kwargs[:scrollable_id]
-    top_scrollview_offset = kwargs[:top_scrollview_offset]
-    bottom_scrollview_offset = kwargs[:top_scrollview_offset]
 
-    data = execute_percy_screenshot(
-      metadata.device_screen_size.fetch('height', 1),
-      screenshot_type,
-      screen_lengths,
-      scrollable_xpath,
-      scrollable_id,
-      metadata.scale_factor,
-      top_scrollview_offset,
-      bottom_scrollview_offset
-    )
-    tiles = []
-    status_bar_height = metadata.status_bar_height
-    nav_bar_height = metadata.navigation_bar_height
+    def _get_tiles(**kwargs)
+      fullpage_ss = kwargs[:fullpage] || false
+      if ENV['PERCY_DISABLE_REMOTE_UPLOADS'] == 'true'
+        puts("Full page screenshots are only supported when 'PERCY_DISABLE_REMOTE_UPLOADS' is not set") if fullpage_ss
+        return super(**kwargs) unless fullpage_ss
+      end
+      screenshot_type = fullpage_ss ? 'fullpage' : 'singlepage'
+      screen_lengths = kwargs[:screen_lengths] || 4
+      scrollable_xpath = kwargs[:scollable_xpath]
+      scrollable_id = kwargs[:scrollable_id]
+      top_scrollview_offset = kwargs[:top_scrollview_offset]
+      bottom_scrollview_offset = kwargs[:top_scrollview_offset]
 
-    JSON.parse(data['result']).each do |tile_data|
-      tiles << Tile.new(
-        status_bar_height,
-        nav_bar_height,
-        tile_data['header_height'],
-        tile_data['footer_height'],
-        sha: tile_data['sha'].split('-')[0]
+      data = execute_percy_screenshot(
+        metadata.device_screen_size.fetch('height', 1),
+        screenshot_type,
+        screen_lengths,
+        scrollable_xpath,
+        scrollable_id,
+        metadata.scale_factor,
+        top_scrollview_offset,
+        bottom_scrollview_offset
       )
-    end
+      tiles = []
+      status_bar_height = metadata.status_bar_height
+      nav_bar_height = metadata.navigation_bar_height
 
-    tiles
-  end
+      JSON.parse(data['result']).each do |tile_data|
+        tiles << Percy::Tile.new(
+          status_bar_height,
+          nav_bar_height,
+          tile_data['header_height'],
+          tile_data['footer_height'],
+          sha: tile_data['sha'].split('-')[0]
+        )
+      end
 
-  def execute_percy_screenshot_begin(name)
-    request_body = {
-      action: 'percyScreenshot',
-      arguments: {
-        state: 'begin',
-        percyBuildId: Environment.percy_build_id,
-        percyBuildUrl: Environment.percy_build_url,
-        name: name
+      tiles
+    end
+
+    def execute_percy_screenshot_begin(name)
+      request_body = {
+        action: 'percyScreenshot',
+        arguments: {
+          state: 'begin',
+          percyBuildId: Percy::Environment.percy_build_id,
+          percyBuildUrl: Percy::Environment.percy_build_url,
+          name: name
+        }
       }
-    }
-    command = "browserstack_executor: #{request_body.to_json}"
-    begin
-      response = metadata.execute_script(command)
-      JSON.parse(response)
-    rescue StandardError => e
-      log('Could not set session as Percy session')
-      log('Error occurred during begin call', on_debug: true)
-      log(e, on_debug: true)
-      nil
+      command = "browserstack_executor: #{request_body.to_json}"
+      begin
+        response = metadata.execute_script(command)
+        JSON.parse(response)
+      rescue StandardError => e
+        log('Could not set session as Percy session')
+        log('Error occurred during begin call', on_debug: true)
+        log(e, on_debug: true)
+        nil
+      end
     end
-  end
 
-  def execute_percy_screenshot_end(name, percy_screenshot_url, status, status_message = nil)
-    request_body = {
-      action: 'percyScreenshot',
-      arguments: {
-        state: 'end',
-        percyScreenshotUrl: percy_screenshot_url,
-        name: name,
-        status: status
+    def execute_percy_screenshot_end(name, percy_screenshot_url, status, status_message = nil)
+      request_body = {
+        action: 'percyScreenshot',
+        arguments: {
+          state: 'end',
+          percyScreenshotUrl: percy_screenshot_url,
+          name: name,
+          status: status
+        }
       }
-    }
-    request_body[:arguments][:statusMessage] = status_message if status_message
-    command = "browserstack_executor: #{request_body.to_json}"
-    begin
-      metadata.execute_script(command)
-    rescue StandardError => e
-      log('Error occurred during end call', on_debug: true)
-      log(e, on_debug: true)
+      request_body[:arguments][:statusMessage] = status_message if status_message
+      command = "browserstack_executor: #{request_body.to_json}"
+      begin
+        metadata.execute_script(command)
+      rescue StandardError => e
+        log('Error occurred during end call', on_debug: true)
+        log(e, on_debug: true)
+      end
     end
-  end
 
-  def execute_percy_screenshot(device_height, screenshotType, screen_lengths, scrollable_xpath = nil,
-                               scrollable_id = nil, scale_factor = 1, top_scrollview_offset = 0,
-                               bottom_scrollview_offset = 0)
-    project_id = ENV['PERCY_ENABLE_DEV'] == 'true' ? 'percy-dev' : 'percy-prod'
-    request_body = {
-      action: 'percyScreenshot',
-      arguments: {
-        state: 'screenshot',
-        percyBuildId: Environment.percy_build_id,
-        screenshotType: screenshotType,
-        projectId: project_id,
-        scaleFactor: scale_factor,
-        options: {
-          numOfTiles: screen_lengths,
-          deviceHeight: device_height,
-          scrollableXpath: scrollable_xpath,
-          scrollableId: scrollable_id,
-          topScrollviewOffset: top_scrollview_offset,
-          bottomScrollviewOffset: bottom_scrollview_offset,
-          'FORCE_FULL_PAGE' => ENV['FORCE_FULL_PAGE'] == 'true'
+    def execute_percy_screenshot(device_height, screenshotType, screen_lengths, scrollable_xpath = nil,
+                                scrollable_id = nil, scale_factor = 1, top_scrollview_offset = 0,
+                                bottom_scrollview_offset = 0)
+      project_id = ENV['PERCY_ENABLE_DEV'] == 'true' ? 'percy-dev' : 'percy-prod'
+      request_body = {
+        action: 'percyScreenshot',
+        arguments: {
+          state: 'screenshot',
+          percyBuildId: Percy::Environment.percy_build_id,
+          screenshotType: screenshotType,
+          projectId: project_id,
+          scaleFactor: scale_factor,
+          options: {
+            numOfTiles: screen_lengths,
+            deviceHeight: device_height,
+            scrollableXpath: scrollable_xpath,
+            scrollableId: scrollable_id,
+            topScrollviewOffset: top_scrollview_offset,
+            bottomScrollviewOffset: bottom_scrollview_offset,
+            'FORCE_FULL_PAGE' => ENV['FORCE_FULL_PAGE'] == 'true'
+          }
         }
       }
-    }
-    command = "browserstack_executor: #{request_body.to_json}"
-    begin
-      response = metadata.execute_script(command)
-      JSON.parse(response)
-    rescue StandardError => e
-      log('Error occurred during screenshot call', on_debug: true)
-      log(e, on_debug: true)
-      raise e
+      command = "browserstack_executor: #{request_body.to_json}"
+      begin
+        response = metadata.execute_script(command)
+        JSON.parse(response)
+      rescue StandardError => e
+        log('Error occurred during screenshot call', on_debug: true)
+        log(e, on_debug: true)
+        raise e
+      end
     end
   end
-end
+end