onlyoffice_webdriver_wrapper 0.0.1

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_alert_helper.rb

@@ -0,0 +1,25 @@
+module OnlyofficeWebdriverWrapper
+  # Methods for working with alerts
+  module WebdriverAlertHelper
+    def alert_confirm
+      @driver.switch_to.alert.accept
+    rescue StandardError
+      Selenium::WebDriver::Error::NoAlertOpenError
+    end
+
+    # Check if alert exists
+    # @return [True, false]
+    def alert_exists?
+      @driver.switch_to.alert.text
+      true
+    rescue Selenium::WebDriver::Error::NoAlertOpenError, Selenium::WebDriver::Error::NoSuchAlertError
+      false
+    end
+
+    # Get alert text
+    # @return [String] text inside alert
+    def alert_text
+      @driver.switch_to.alert.text
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_attributes_helper.rb

@@ -0,0 +1,53 @@
+module OnlyofficeWebdriverWrapper
+  # Module with methods to work with attributes
+  module WebdriverAttributesHelper
+    def attribute_exist?(xpath_name, attribute)
+      exist = false
+
+      element = xpath_name.is_a?(String) ? get_element(xpath_name) : xpath_name
+      begin
+        attribute_value = element.attribute(attribute)
+        exist = attribute_value.empty? || attribute_value.nil? ? false : true
+      rescue Exception
+        exist = false
+      end
+      exist
+    end
+
+    def get_attribute(xpath_name, attribute)
+      element = xpath_name.is_a?(Selenium::WebDriver::Element) ? xpath_name : get_element(xpath_name)
+
+      if element.nil?
+        webdriver_error("Webdriver.get_attribute(#{xpath_name}, #{attribute}) failed because element not found")
+      else
+        element.attribute(attribute)
+      end
+    end
+
+    def get_element_by_parameter(elements, parameter_name, value)
+      elements.find { |current_element| value == get_attribute(current_element, parameter_name) }
+    end
+
+    def get_attribute_from_displayed_element(xpath_name, attribute)
+      @driver.find_elements(:xpath, xpath_name).each do |current_element|
+        return current_element.attribute(attribute) if current_element.displayed?
+      end
+      false
+    end
+
+    def get_attributes_of_several_elements(xpath_several_elements, attribute)
+      elements = @driver.find_elements(:xpath, xpath_several_elements)
+
+      elements.map do |element|
+        element.attribute(attribute)
+      end
+    end
+
+    def get_index_of_elements_with_attribute(xpath, attribute, value, only_visible = true)
+      get_elements(xpath, only_visible).each_with_index do |element, index|
+        return (index + 1) if get_attribute(element, attribute).include?(value)
+      end
+      0
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_browser_info_helper.rb

@@ -0,0 +1,20 @@
+module OnlyofficeWebdriverWrapper
+  # Module for working with browser metadata
+  module WebdriverBrowserInfo
+    # @return [Dimensions] Size of browser window
+    def browser_size
+      size_struct = @driver.manage.window.size
+      size = Dimensions.new(size_struct.width, size_struct.height)
+      OnlyofficeLoggerHelper.log("browser_size: #{size}")
+      size
+    end
+
+    # @return [String] info about platform
+    def browser_metadata
+      caps = @driver.capabilities
+      platform = caps[:platform_name] || caps[:platform]
+      version = caps[:browser_version] || caps[:version]
+      "Platform: #{platform}, Browser: #{caps[:browser_name]}, Version: #{version}"
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_browser_log_helper.rb

@@ -0,0 +1,9 @@
+module OnlyofficeWebdriverWrapper
+  # Methods for working with browser console logs
+  module WebdriverBrowserLogHelper
+    def browser_logs
+      return [] if browser == :firefox # not implemented, see https://github.com/mozilla/geckodriver/issues/284
+      @driver.manage.logs.get(:browser)
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_exceptions.rb

@@ -0,0 +1,3 @@
+module OnlyofficeWebdriverWrapper
+  class WebdriverSystemNotSupported < StandardError; end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_extension.rb

@@ -0,0 +1,2 @@
+Selenium::WebDriver::Service::START_TIMEOUT = 120
+Selenium::WebDriver::Service::STOP_TIMEOUT = 120

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_helper.rb

@@ -0,0 +1,22 @@
+require 'open-uri'
+require 'tempfile'
+
+module OnlyofficeWebdriverWrapper
+  # Some additional methods for webdriver
+  module WebdriverHelper
+    def system_screenshot(file_name)
+      `import -window root #{file_name}`
+    end
+
+    # Download temp file and return it location
+    # @param file [String] url
+    # @return [String] path to file
+    def download(file_url)
+      data = Kernel.open(file_url, &:read)
+      file = Tempfile.new('onlyoffice-downloaded-file')
+      file.write(data)
+      file.close
+      file.path
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_js_methods.rb

@@ -0,0 +1,56 @@
+module OnlyofficeWebdriverWrapper
+  # Methods for webdriver for calling Javascript
+  module WebdriverJsMethods
+    def execute_javascript(script)
+      result = @driver.execute_script(script)
+      OnlyofficeLoggerHelper.log("Executed js: `#{script}` with result: `#{result}`")
+      result
+    rescue Exception => e
+      webdriver_error("Exception #{e} in execute_javascript: #{script}")
+    end
+
+    def type_to_locator_by_javascript(xpath_name, text)
+      escaped_text = text.gsub('\\', '\\\\\\\\').gsub('"', '\\"').gsub("\n", '\\n')
+      execute_javascript("document.evaluate('#{xpath_name}', document, null, XPathResult.ANY_TYPE, null).iterateNext().value=\"#{escaped_text}\";")
+    end
+
+    def get_text_by_js(xpath)
+      execute_javascript("return document.evaluate(\"#{xpath.tr('"', "'")}\",document, null, XPathResult.ANY_TYPE, null ).iterateNext().textContent")
+    end
+
+    # Calculate object size using Javascript
+    # @param xpath [Sting] xpath of object
+    # @return [Dimensions] size of element
+    def element_size_by_js(xpath)
+      width = execute_javascript("return document.evaluate(\"#{xpath.tr('"', "'")}\",document, null, XPathResult.ANY_TYPE, null ).iterateNext().offsetWidth")
+      height = execute_javascript("return document.evaluate(\"#{xpath.tr('"', "'")}\",document, null, XPathResult.ANY_TYPE, null ).iterateNext().offsetHeight")
+      Dimensions.new(width, height)
+    end
+
+    # Get object absolute postion from top left edge of screen
+    # @param xpath [Sting] xpath of object
+    # @return [CursorPoint] position of element
+    def object_absolute_position(xpath)
+      left = execute_javascript("return document.evaluate(\"#{xpath.tr('"', "'")}\",document, null, XPathResult.ANY_TYPE, null ).iterateNext().getBoundingClientRect().left")
+      top = execute_javascript("return document.evaluate(\"#{xpath.tr('"', "'")}\",document, null, XPathResult.ANY_TYPE, null ).iterateNext().getBoundingClientRect().top")
+      Dimensions.new(left, top)
+    end
+
+    # @return [True, False] is page have jquery loaded
+    def jquery_loaded?
+      loaded = execute_javascript('return !!window.jQuery')
+      OnlyofficeLoggerHelper.log("jquery_loaded? # #{loaded}")
+      loaded
+    end
+
+    # Checks for jQuery finished its job or not present
+    def jquery_finished?
+      return true unless jquery_loaded?
+      execute_javascript('return window.jQuery.active;').zero?
+    end
+
+    def document_ready?
+      execute_javascript('return document.readyState;') == 'complete'
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_screenshot_helper.rb

@@ -0,0 +1,60 @@
+require 'onlyoffice_s3_wrapper'
+module OnlyofficeWebdriverWrapper
+  # Working with screenshots
+  module WebdriverScreenshotHelper
+    # @return [String] location of screenshot to take
+    def screenshot_folder
+      '/tmp/screenshot/WebdriverError'
+    end
+
+    def get_screenshot_and_upload(path_to_screenshot = "#{screenshot_folder}/#{StringHelper.generate_random_string}.png")
+      begin
+        get_screenshot(path_to_screenshot)
+        cloud_screenshot = OnlyofficeS3Wrapper::AmazonS3Wrapper.new.upload_file_and_make_public(path_to_screenshot, 'screenshots')
+        File.delete(path_to_screenshot) if File.exist?(path_to_screenshot)
+        OnlyofficeLoggerHelper.log("upload screenshot: #{cloud_screenshot}")
+        return cloud_screenshot
+      rescue Errno::ENOENT => e
+        begin
+          @driver.save_screenshot(path_to_screenshot)
+          OnlyofficeLoggerHelper.log("Cant upload screenshot #{path_to_screenshot}. Error: #{e}")
+        rescue Errno::ENOENT => e
+          @driver.save_screenshot("tmp/#{File.basename(path_to_screenshot)}")
+          OnlyofficeLoggerHelper.log("Upload screenshot to tmp/#{File.basename(path_to_screenshot)}. Error: #{e}")
+        end
+      end
+      path_to_screenshot
+    end
+
+    def get_screenshot(path_to_screenshot = "#{screenshot_folder}/#{StringHelper.generate_random_string}.png")
+      screenshot_folder = File.dirname(path_to_screenshot)
+      FileUtils.mkdir_p(screenshot_folder) unless File.directory?(screenshot_folder)
+      @driver.save_screenshot(path_to_screenshot)
+      OnlyofficeLoggerHelper.log("get_screenshot(#{path_to_screenshot})")
+    end
+
+    def webdriver_screenshot(screenshot_name = SecureRandom.uuid)
+      begin
+        link = get_screenshot_and_upload("#{screenshot_folder}/#{screenshot_name}.png")
+      rescue Exception => e
+        OnlyofficeLoggerHelper.log("Error in get screenshot: #{e}. Trying to get headless screenshot")
+        if @headless.headless_instance.nil?
+          system_screenshot("/tmp/#{screenshot_name}.png")
+          begin
+            link = OnlyofficeS3Wrapper::AmazonS3Wrapper.new.upload_file_and_make_public("/tmp/#{screenshot_name}.png", 'screenshots')
+          rescue Exception => e
+            OnlyofficeLoggerHelper.log("Error in get screenshot: #{e}. System screenshot #{link}")
+          end
+        else
+          @headless.take_screenshot("/tmp/#{screenshot_name}.png")
+          begin
+            link = OnlyofficeS3Wrapper::AmazonS3Wrapper.new.upload_file_and_make_public("/tmp/#{screenshot_name}.png", 'screenshots')
+          rescue Exception => e
+            OnlyofficeLoggerHelper.log("Error in get screenshot: #{e}. Headless screenshot #{link}")
+          end
+        end
+      end
+      "screenshot: #{link}"
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_style_helper.rb

@@ -0,0 +1,41 @@
+module OnlyofficeWebdriverWrapper
+  # Webdriver style helper
+  module WebdriverStyleHelper
+    def get_style_parameter(xpath, parameter_name)
+      get_attribute(xpath, 'style').split(';').each do |current_param|
+        return /:\s(.*);?$/.match(current_param)[1] if current_param.include?(parameter_name)
+      end
+    end
+
+    def get_style_attributes_of_several_elements(xpath_several_elements, style)
+      @driver.find_elements(:xpath, xpath_several_elements).map do |element|
+        el_style = element.attribute('style')
+        unless el_style.empty?
+          found_style = el_style.split(';').find { |curr_param| curr_param.include?(style) }
+          found_style.gsub(/\s?#{ style }:/, '') unless found_style.nil?
+        end
+      end.compact
+    end
+
+    def set_style_parameter(xpath, attribute, attribute_value)
+      execute_javascript("document.evaluate(\"#{xpath.tr('"', "'")}\",document, null, XPathResult.ANY_TYPE, null ).iterateNext()." \
+                             "style.#{attribute}=\"#{attribute_value}\"")
+    end
+
+    def set_style_attribute(xpath, attribute, attribute_value)
+      execute_javascript("document.evaluate('#{xpath}',document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null)." \
+                             "singleNodeValue.style.#{attribute}=\"#{attribute_value}\"")
+    end
+
+    def set_style_show_by_xpath(xpath, move_to_center = false)
+      xpath.tr!("'", '"')
+      execute_javascript('document.evaluate( \'' + xpath.to_s +
+                             '\' ,document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null ).singleNodeValue.style.display = "block";')
+      return unless move_to_center
+      execute_javascript('document.evaluate( \'' + xpath.to_s +
+                             '\' ,document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null ).singleNodeValue.style.left = "410px";')
+      execute_javascript('document.evaluate( \'' + xpath.to_s +
+                             '\' ,document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null ).singleNodeValue.style.top = "260px";')
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_tab_helper.rb

@@ -0,0 +1,74 @@
+module OnlyofficeWebdriverWrapper
+  # Module for work with tabs
+  module WebdriverTabHelper
+    TIMEOUT_WAIT_ELEMENT = 15
+
+    def new_tab
+      execute_javascript('window.open()')
+    end
+
+    def maximize
+      @driver.manage.window.maximize
+      OnlyofficeLoggerHelper.log('Maximized current window')
+    end
+
+    def resize_tab(width, height)
+      @driver.manage.window.resize_to(width, height)
+      OnlyofficeLoggerHelper.log("Resize current window to #{width}x#{height}")
+    end
+
+    def switch_to_popup
+      counter = 0
+      while tab_count < 2 && counter < 30
+        sleep 1
+        counter += 1
+      end
+      webdriver_error('switch_to_popup: Popup window not found') if counter >= 30
+      list_of_handlers = @driver.window_handles
+      last_window_handler = list_of_handlers.last
+      @driver.switch_to.window(last_window_handler)
+    end
+
+    # Get tab count
+    # @return [Integer] count of tabs in opened session
+    def tab_count
+      tab_count = @driver.window_handles.length
+      OnlyofficeLoggerHelper.log("tab_count: #{tab_count}")
+      tab_count
+    end
+
+    def choose_tab(tab_number)
+      counter = 0
+      while tab_count < 2 && counter < TIMEOUT_WAIT_ELEMENT
+        sleep 1
+        counter += 1
+      end
+      webdriver_error("choose_tab: Tab number = #{tab_number} not found") if counter >= TIMEOUT_WAIT_ELEMENT
+      @driver.switch_to.window(@driver.window_handles[tab_number - 1])
+    end
+
+    def switch_to_main_tab
+      @driver.switch_to.window(@driver.window_handles.first)
+    end
+
+    def close_tab
+      @driver.close
+      sleep 1
+      switch_to_main_tab
+    end
+
+    def close_window
+      @driver.close
+    end
+
+    def close_popup_and_switch_to_main_tab
+      switch_to_popup
+      close_tab
+      switch_to_main_tab
+    end
+
+    def get_title_of_current_tab
+      @driver.title
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_type_helper.rb

@@ -0,0 +1,104 @@
+module OnlyofficeWebdriverWrapper
+  # Class for helping with type stuff
+  module WebdriverTypeHelper
+    def type_text(element, text_to_send, clear_area = false)
+      element = get_element(element)
+      element.clear if clear_area
+      element.send_keys(text_to_send)
+    end
+
+    def type_text_and_select_it(element, text_to_send, clear_area = false)
+      type_text(element, text_to_send, clear_area)
+      text_to_send.length.times { element.send_keys %i[shift left] }
+    end
+
+    def type_to_locator(xpath_name, text_to_send, clear_content = true, click_on_it = false, by_action = false, by_element_send_key = false)
+      element = get_element(xpath_name)
+      if clear_content
+        begin
+          element.clear
+        rescue Exception => e
+          webdriver_error("Error in element.clear #{e} for type_to_locator(#{xpath_name}, #{text_to_send}, #{clear_content}, #{click_on_it}, #{by_action}, #{by_element_send_key})")
+        end
+      end
+
+      if click_on_it
+        click_on_locator(xpath_name)
+        sleep 0.2
+      end
+
+      if (@browser != :chrome && !by_action) || by_element_send_key
+        element.send_keys text_to_send
+      elsif text_to_send != ''
+        if text_to_send.is_a?(String)
+          text_to_send.split(//).each do |symbol|
+            @driver.action.send_keys(symbol).perform
+          end
+        else
+          @driver.action.send_keys(text_to_send).perform
+        end
+      end
+    end
+
+    def type_to_input(xpath_name, text_to_send, clear_content = false, click_on_it = true)
+      element = get_element(xpath_name)
+      webdriver_error(Selenium::WebDriver::Error::NoSuchElementError, "type_to_input(#{xpath_name}, #{text_to_send}, #{clear_content}, #{click_on_it}): element not found") if element.nil?
+      element.clear if clear_content
+      sleep 0.2
+      if click_on_it
+        begin
+          element.click
+        rescue Exception => e
+          webdriver_error("type_to_input(#{xpath_name}, #{text_to_send}, #{clear_content}, #{click_on_it}) error in 'element.click' error: #{e}")
+        end
+        sleep 0.2
+      end
+      element.send_keys text_to_send
+    end
+
+    def type_text_by_symbol(xpath_name, text_to_send, clear_content = true, click_on_it = false, by_action = false, by_element_send_key = false)
+      click_on_locator(xpath_name) if click_on_it
+      element = get_element(xpath_name)
+      if clear_content
+        element.clear
+        click_on_locator(xpath_name) if click_on_it
+      end
+      text_to_send.scan(/./).each do |symbol|
+        sleep(0.3)
+        if (@browser != :chrome && !by_action) || by_element_send_key
+          send_keys(element, symbol, :element_send_key)
+        else
+          send_keys(element, symbol, by_action)
+        end
+      end
+    end
+
+    def send_keys(xpath_name, text_to_send, by_action = true)
+      element = get_element(xpath_name)
+      @driver.action.click(element).perform if @browser == :firefox
+      if by_action
+        @driver.action.send_keys(element, text_to_send).perform
+      else
+        element.send_keys text_to_send
+      end
+    end
+
+    def send_keys_to_focused_elements(keys, count_of_times = 1)
+      command = @driver.action.send_keys(keys)
+      (count_of_times - 1).times { command = command.send_keys(keys) }
+      command.perform
+    end
+
+    def press_key(key)
+      @driver.action.send_keys(key).perform
+    end
+
+    def key_down(xpath, key)
+      @driver.action.key_down(get_element(xpath), key).perform
+    end
+
+    def key_up(xpath, key)
+      @driver.action.key_up(get_element(xpath), key).perform
+    end
+  end
+end