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

data/percy/providers/app_automate.rb

@@ -6,154 +6,158 @@ 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', kwargs.fetch('sync', nil))
+        response['data']
+      rescue StandardError => e
+        execute_percy_screenshot_end(name, percy_screenshot_url, 'failure', kwargs.fetch('sync', nil), 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, sync = nil, status_message = nil)
+      request_body = {
+        action: 'percyScreenshot',
+        arguments: {
+          state: 'end',
+          percyScreenshotUrl: percy_screenshot_url,
+          name: name,
+          status: status,
+          sync: sync
+        }
       }
-    }
-    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

data/percy/providers/generic_provider.rb

@@ -9,197 +9,200 @@ 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, [])
+        )
+      }
+      sync = kwargs.fetch(:sync, nil)
+
+      _post_screenshots(name, tag, tiles, get_debug_url, ignore_regions, consider_regions, sync)
+    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, sync)
+      Percy::CLIWrapper.new.post_screenshots(name, tag, tiles, debug_url, ignored_regions, considered_regions, sync)
+    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