module Browsery::Utils::PageObjectHelper

Page object-related helper methods.

Public Instance Methods

connector_is_saucelabs?() click to toggle source
# File lib/browsery/utils/page_object_helper.rb, line 137
def connector_is_saucelabs?
  Browsery.settings.connector.include? 'saucelabs'
end
current_page(calling_page) click to toggle source
# File lib/browsery/utils/page_object_helper.rb, line 219
def current_page(calling_page)
  calling_page.class.to_s.split('::').last.downcase
end
is_element_present?(how, what, driver = nil) click to toggle source

Check if a web element exists on page or not, without wait

# File lib/browsery/utils/page_object_helper.rb, line 192
def is_element_present?(how, what, driver = nil)
  element_appeared?(how, what, driver)
end
is_element_present_and_displayed?(how, what, driver = nil) click to toggle source

Check if a web element exists and displayed on page or not, without wait

# File lib/browsery/utils/page_object_helper.rb, line 197
def is_element_present_and_displayed?(how, what, driver = nil)
  element_appeared?(how, what, driver, check_display = true)
end
json_save_to_ever_failed() click to toggle source

Create new/override same file ever_failed_tests.json with fail count

# File lib/browsery/utils/page_object_helper.rb, line 87
def json_save_to_ever_failed
  ever_failed_tests = 'logs/tap_results/ever_failed_tests.json'
  data_hash = {}
  if File.file?(ever_failed_tests) && !File.zero?(ever_failed_tests)
    data_hash = JSON.parse(File.read(ever_failed_tests))
  end

  if data_hash[name]
    data_hash[name]["fail_count"] += 1
  else
    data_hash[name] = { "fail_count" => 1 }
  end
  begin
    data_hash[name]["last_fail_on_sauce"] = "saucelabs.com/tests/#{@driver.session_id}"
  rescue
    self.logger.debug "Failed setting last_fail_on_sauce, driver may not be available"
  end

  File.open(ever_failed_tests, 'w+') do |file|
    file.write JSON.pretty_generate(data_hash)
  end
end
page(name, override_driver=nil) { |instance| ... } click to toggle source

Helper method to instantiate a new page object. This method should only be used when first loading; subsequent page objects are automatically instantiated by calling cast on the page object.

Pass optional parameter Driver, which can be initialized in test and will override the global driver here.

@param name [String, Driver] @return [PageObject::Base]

# File lib/browsery/utils/page_object_helper.rb, line 15
def page(name, override_driver=nil)
  # Get the fully-qualified class name
  klass_name = "browsery/page_objects/#{name}".camelize
  klass = begin
    klass_name.constantize
  rescue => exc
    msg = ""
    msg << "Cannot find page object '#{name}', "
    msg << "because could not load class '#{klass_name}' "
    msg << "with underlying error:\n  #{exc.class}: #{exc.message}\n"
    msg << exc.backtrace.map { |str| "    #{str}" }.join("\n")
    raise NameError, msg
  end

  # Get a default connector
  @driver = Browsery::Connector.get_default if override_driver.nil?
  @driver = override_driver if !override_driver.nil?
  instance = klass.new(@driver)

  # Set SauceLabs session(job) name to test's name if running on Saucelabs
  begin
    update_sauce_session_name if connector_is_saucelabs? && !@driver.nil?
  rescue
    self.logger.debug "Failed setting saucelabs session name for #{name()}"
  end

  # Before visiting the page, do any pre-processing necessary, if any,
  # but only visit the page if the pre-processing succeeds
  if block_given?
    retval = yield instance
    instance.go! if retval
  else
    instance.go! if override_driver.nil?
  end

  # similar like casting a page, necessary to validate some element on a page
  begin
    instance.validate!
  rescue Minitest::Assertion => exc
    raise Browsery::PageObjects::InvalidePageState, "#{klass}: #{exc.message}"
  end

  # Return the instance as-is
  instance
end
put_value(web_element, value) click to toggle source

Generic page object helper method to clear and send keys to a web element found by driver @param [Element, String]

# File lib/browsery/utils/page_object_helper.rb, line 143
def put_value(web_element, value)
  web_element.clear
  web_element.send_keys(value)
end
read_yml(file_name, keys) click to toggle source

Helper method for retrieving value from yml file todo should be moved to FileHelper.rb once we created this file in utils @param [String, String] keys, eg. “timeouts:implicit_wait”

# File lib/browsery/utils/page_object_helper.rb, line 152
def read_yml(file_name, keys)
  data = Hash.new
  begin
    data = YAML.load_file "#{file_name}"
  rescue
    raise Exception, "File #{file_name} doesn't exist" unless File.exist?(file_name)
  rescue
    raise YAMLErrors, "Failed to load #{file_name}"
  end
  keys_array = keys.split(/:/)
  value = data
  keys_array.each do |key|
    value = value[key]
  end
  value
end
retry_with_count(count, &block) click to toggle source

Retry a block of code for a number of times

# File lib/browsery/utils/page_object_helper.rb, line 170
def retry_with_count(count, &block)
  try = 0
  count.times do
    try += 1
    begin
      block.call
      return true
    rescue Exception => e
      Browsery.logger.warn "Exception: #{e}\nfrom\n#{block.source_location.join(':')}"
      Browsery.logger.warn "Retrying" if try < count
    end
  end
end
take_screenshot() click to toggle source

Take screenshot and save as png with test name as file name

# File lib/browsery/utils/page_object_helper.rb, line 82
def take_screenshot
  @driver.save_screenshot("logs/#{name}.png")
end
teardown() click to toggle source

Local teardown for page objects. Any page objects that are loaded will be finalized upon teardown.

@return [void]

Calls superclass method
# File lib/browsery/utils/page_object_helper.rb, line 65
def teardown
  if !passed? && !skipped? && !@driver.nil?
    json_save_to_ever_failed if Browsery.settings.rerun_failure
    print_sauce_link if connector_is_saucelabs?
    take_screenshot
  end
  begin
    update_sauce_session_status if connector_is_saucelabs? && !@driver.nil? && !skipped?
  rescue
    self.logger.debug "Failed setting saucelabs session status for #{name()}"
  end

  Browsery::Connector.finalize!
  super
end
update_sauce_session_name() click to toggle source

Update SauceLabs session(job) name and build number/name

# File lib/browsery/utils/page_object_helper.rb, line 121
def update_sauce_session_name
  http_auth = Browsery.settings.sauce_session_http_auth(@driver)
  body = { 'name' => name() }
  unless (build_number = ENV['JENKINS_BUILD_NUMBER']).nil?
    body['build'] = build_number
  end
  RestClient.put(http_auth, body.to_json, {:content_type => "application/json"})
end
update_sauce_session_status() click to toggle source

Update session(job) status if test is not skipped

# File lib/browsery/utils/page_object_helper.rb, line 131
def update_sauce_session_status
  http_auth = Browsery.settings.sauce_session_http_auth(@driver)
  body = { "passed" => passed? }
  RestClient.put(http_auth, body.to_json, {:content_type => "application/json"})
end
visual_regression(test_step_id) click to toggle source
# File lib/browsery/utils/page_object_helper.rb, line 223
def visual_regression(test_step_id)
  if Browsery.settings.visual_regression
    if File.exist?("visual_regression/#{test_step_id}-base.png")
      base_image_path = "visual_regression/#{test_step_id}-base.png"
      new_image_path = @driver.save_screenshot("visual_regression/#{test_step_id}-new.png")
      diff_image = Browsery::DiffImage.new(base_image_path, new_image_path)
      diff_percentage = diff_image.calculate_changes
      if diff_percentage > Browsery.settings.visual_regression
        diff_image_path = "visual_regression/#{test_step_id}-diff.png"
        diff_image.save_diff(diff_image_path)
        return false
      end
    else
      @driver.save_screenshot("visual_regression/#{test_step_id}-base.png")
    end
  end
  true
end
wait_for_attribute_to_have_value(how, what, attribute, value, friendly_name = "attribute") click to toggle source

Useful when you want to wait for the status of an element attribute to change Example: the class attribute of <body> changes to include 'logged-in' when a user signs in to rent.com Example usage: wait_for_attribute_status_change(:css, 'body', 'class', 'logged-in', 'sign in')

# File lib/browsery/utils/page_object_helper.rb, line 214
def wait_for_attribute_to_have_value(how, what, attribute, value, friendly_name = "attribute")
  wait(timeout: 15, message: "Timeout waiting for #{friendly_name} status to update")
    .until { driver.find_element(how, what).attribute(attribute).include?(value) rescue retry }
end
wait_for_element_to_be_present(how, what, friendly_name = "element") click to toggle source
# File lib/browsery/utils/page_object_helper.rb, line 206
def wait_for_element_to_be_present(how, what, friendly_name = "element")
  wait(timeout: 15, message: "Timeout waiting for #{friendly_name} to be present")
    .until {is_element_present?(how, what)}
end
wait_for_element_to_display(how, what, friendly_name = "element") click to toggle source
# File lib/browsery/utils/page_object_helper.rb, line 201
def wait_for_element_to_display(how, what, friendly_name = "element")
    wait(timeout: 15, message: "Timeout waiting for #{friendly_name} to display")
      .until {is_element_present_and_displayed?(how, what)}
end
with_url_change_wait(&block) click to toggle source
# File lib/browsery/utils/page_object_helper.rb, line 184
def with_url_change_wait(&block)
  starting_url = @driver.current_url
  block.call
  wait(timeout: 15, message: 'Timeout waiting for URL to change')
    .until { @driver.current_url != starting_url }
end

Private Instance Methods

browser_safe_checkbox_click(element) click to toggle source

Method that overrides click to send the space key to the checkbox if the current browser is internet explorer. Used when sending the space key to the checkbox will work

# File lib/browsery/utils/page_object_helper.rb, line 275
def browser_safe_checkbox_click(element)
  (driver.browser == :internet_explorer || driver.browser == :firefox) ? element.send_keys(:space) : element.click
end
browser_safe_click(element) click to toggle source

Method that overrides click to send the enter key to the element if the current browser is internet explorer. Used when sending the enter key to the element will work

# File lib/browsery/utils/page_object_helper.rb, line 269
def browser_safe_click(element)
  driver.browser == :internet_explorer ? element.send_keys(:enter) : element.click
end
element_appeared?(how, what, driver = nil, check_display = false) click to toggle source

@param eg. (:css, 'button.cancel') or (*BUTTON_SUBMIT_SEARCH) @param also has an optional parameter-driver, which can be @element when calling this method in a widget object @return [boolean]

# File lib/browsery/utils/page_object_helper.rb, line 247
def element_appeared?(how, what, driver = nil, check_display = false)
  original_timeout = read_yml("config/browsery/connectors/saucelabs.yml", "timeouts:implicit_wait")
  @driver.manage.timeouts.implicit_wait = 0
  result = false
  parent_element = @driver if driver == nil
  parent_element = driver if driver != nil
  elements = parent_element.find_elements(how, what)
  if check_display
    begin
      result = true if elements.size() > 0 && elements[0].displayed?
    rescue
      result = false
    end
  else
    result = true if elements.size() > 0
  end
  @driver.manage.timeouts.implicit_wait = original_timeout
  result
end