onlyoffice_webdriver_wrapper 0.6.0

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_screenshot_helper.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'onlyoffice_s3_wrapper'
+module OnlyofficeWebdriverWrapper
+  # Working with screenshots
+  module WebdriverScreenshotHelper
+    # @return [OnlyofficeS3Wrapper::AmazonS3Wrapper] s3 wrapper
+    def amazon_s3_wrapper
+      @amazon_s3_wrapper ||= OnlyofficeS3Wrapper::AmazonS3Wrapper.new(bucket_name: 'webdriver-wrapper-screenshots',
+                                                                      region: 'us-east-1')
+    end
+
+    # @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 = amazon_s3_wrapper.upload_file_and_make_public(path_to_screenshot)
+        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 = amazon_s3_wrapper.upload_file_and_make_public("/tmp/#{screenshot_name}.png")
+          rescue Exception => e
+            OnlyofficeLoggerHelper.log("Error in get screenshot: #{e}. System screenshot #{link}")
+          end
+        else
+          @headless.take_screenshot("/tmp/#{screenshot_name}.png")
+          begin
+            link = amazon_s3_wrapper.upload_file_and_make_public("/tmp/#{screenshot_name}.png")
+          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,32 @@
+# frozen_string_literal: true
+
+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
+      nil
+    end
+
+    # Set style attribute value of element
+    # @param xpath [String] xpath to set
+    # @param attribute [String] style param to set
+    # @param attribute_value [String] attribute value to set
+    # @return [String] result of execution
+    def set_style_attribute(xpath, attribute, attribute_value)
+      execute_javascript("#{dom_element_by_xpath(xpath)}.style.#{attribute}=\"#{attribute_value}\"")
+    end
+
+    alias set_style_parameter set_style_attribute
+
+    def set_style_show_by_xpath(xpath, move_to_center = false)
+      execute_javascript("#{dom_element_by_xpath(xpath)}.style.display = 'block';")
+      return unless move_to_center
+
+      execute_javascript("#{dom_element_by_xpath(xpath)}.style.left = '410px';")
+      execute_javascript("#{dom_element_by_xpath(xpath)}.style.top = '260px';")
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_tab_helper.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module OnlyofficeWebdriverWrapper
+  # Module for work with tabs
+  module WebdriverTabHelper
+    TIMEOUT_WAIT_ELEMENT = 15
+
+    def new_tab
+      execute_javascript('window.open()')
+    end
+
+    def resize_tab(width, height)
+      @driver.manage.window.resize_to(width, height)
+      OnlyofficeLoggerHelper.log("Resize current window to #{width}x#{height}")
+    end
+
+    # @param after_switch_timeout [Integer] wait after switch to window
+    # non-zero to workaround bug with page load hanging up after switch
+    def switch_to_popup(after_switch_timeout: 3)
+      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)
+      sleep(after_switch_timeout) # Do not remove until problem with page loading stop resolved
+    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_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,121 @@
+# frozen_string_literal: true
+
+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(e.class, "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
+          webdriver_bug_8179_workaround(text_to_send)
+        end
+      end
+    end
+
+    def type_to_input(xpath_name, text_to_send, clear_content = false, click_on_it = true)
+      element = get_element(xpath_name)
+      if element.nil?
+        webdriver_error(Selenium::WebDriver::Error::NoSuchElementError,
+                        "type_to_input(#{xpath_name}, #{text_to_send}, "\
+                        "#{clear_content}, #{click_on_it}): element not found")
+      end
+      element.clear if clear_content
+      sleep 0.2
+      if click_on_it
+        begin
+          element.click
+        rescue Exception => e
+          webdriver_error(e.class, "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 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
+      sleep(1) # for some reason quick key_down select text in control
+    end
+
+    def key_up(xpath, key)
+      @driver.action.key_up(get_element(xpath), key).perform
+    end
+
+    private
+
+    # Workaround for bug with typing with :control
+    # See https://github.com/SeleniumHQ/selenium/issues/8179
+    # for more details
+    def webdriver_bug_8179_workaround(text_to_send)
+      text_to_send = [text_to_send].flatten
+
+      key_modifiers = text_to_send.select { |i| i.is_a?(Symbol) }
+      letters = text_to_send - key_modifiers
+
+      key_modifiers.each do |modifier|
+        @driver.action.key_down(modifier).perform
+      end
+
+      letters.each do |letter|
+        @driver.action.send_keys(letter.to_s).perform
+      end
+
+      key_modifiers.each do |modifier|
+        @driver.action.key_up(modifier).perform
+      end
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_user_agent_helper.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OnlyofficeWebdriverWrapper
+  # Module for wokring with webdriver useragent
+  module WebdriverUserAgentHelper
+    USERAGENT_ANDROID_PHONE = 'Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MDB08M) '\
+                              'AppleWebKit/537.36 (KHTML, like Gecko) '\
+                              'Chrome/51.0.2704.81 Mobile Safari/537.36'
+    USERAGENT_IPHONE = 'Mozilla/5.0 (iPhone; CPU iPhone OS 9_3_2 like Mac OS X) '\
+                       'AppleWebKit/601.1.46 (KHTML, like Gecko) '\
+                       'Version/9.0 Mobile/13F69 Safari/601.1'
+    USERAGENT_IPAD_AIR_2_SAFARI = 'Mozilla/5.0 (iPad; CPU OS 10_0 like Mac OS X) '\
+                                  'AppleWebKit/602.1.50 (KHTML, like Gecko) '\
+                                  'Version/10.0 Mobile/14A5346a Safari/602.1'
+    USERAGENT_NEXUS_10_CHROME = 'Mozilla/5.0 (Linux; Android 4.3; Nexus 10 Build/JSS15Q) '\
+                                'AppleWebKit/537.36 (KHTML, like Gecko) '\
+                                'Chrome/48.0.2564.23 Safari/537.36'
+
+    # @return [String] user agent string for current device
+    def user_agent_for_device
+      case @device
+      when :desktop_linux
+        nil
+      when :android_phone
+        USERAGENT_ANDROID_PHONE
+      when :iphone
+        USERAGENT_IPHONE
+      when :ipad_air_2_safari
+        USERAGENT_IPAD_AIR_2_SAFARI
+      when :nexus_10_chrome
+        USERAGENT_NEXUS_10_CHROME
+      else
+        webdriver_error("Unknown user device for starting browser: #{@device}")
+      end
+    end
+
+    # @param switches [Array, String] current switches of browser
+    # @return [String] user agent switch for browser
+    def add_useragent_to_switches(switches)
+      user_agent = user_agent_for_device
+      return switches.dup if user_agent.nil?
+
+      switches.dup << "--user-agent=#{user_agent}"
+    end
+
+    # @return [String] current user agent
+    def current_user_agent
+      execute_javascript('return navigator.userAgent;')
+    end
+  end
+end

metadata

@@ -0,0 +1,278 @@
+--- !ruby/object:Gem::Specification
+name: onlyoffice_webdriver_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- ONLYOFFICE
+- Pavel Lobashov
+- Oleg Nazarov
+- Dmitry Rotaty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: headless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: onlyoffice_file_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: onlyoffice_logger_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: onlyoffice_s3_wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: page-object
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.6
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.142.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.142.7
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.17.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.9
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.90.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.90.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.43.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.43.2
+description: ONLYOFFICE Webdriver Wrapper Gem. Used in QA
+email:
+- shockwavenn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/onlyoffice_webdriver_wrapper.rb
+- lib/onlyoffice_webdriver_wrapper/dimensions.rb
+- lib/onlyoffice_webdriver_wrapper/helpers/bin/chromedriver
+- lib/onlyoffice_webdriver_wrapper/helpers/bin/chromedriver_mac
+- lib/onlyoffice_webdriver_wrapper/helpers/bin/geckodriver
+- lib/onlyoffice_webdriver_wrapper/helpers/chrome_helper.rb
+- lib/onlyoffice_webdriver_wrapper/helpers/firefox_helper.rb
+- lib/onlyoffice_webdriver_wrapper/helpers/firefox_helper/save_to_disk_files.list
+- lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb
+- lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/headless_screenshot_patch.rb
+- lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/headless_video_recorder.rb
+- lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/real_display_tools.rb
+- lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/ruby_helper.rb
+- lib/onlyoffice_webdriver_wrapper/helpers/os_helper.rb
+- lib/onlyoffice_webdriver_wrapper/name.rb
+- lib/onlyoffice_webdriver_wrapper/version.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/click_methods.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/wait_until_methods.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_alert_helper.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_attributes_helper.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_browser_info_helper.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_browser_log_helper.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_exceptions.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_helper.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_js_methods.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_screenshot_helper.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_style_helper.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_tab_helper.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_type_helper.rb
+- lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_user_agent_helper.rb
+homepage: https://github.com/onlyoffice-testing-robot/onlyoffice_webdriver_wrapper
+licenses:
+- AGPL-3.0
+metadata:
+  bug_tracker_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_webdriver_wrapper/issues
+  changelog_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_webdriver_wrapper/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/onlyoffice_webdriver_wrapper
+  homepage_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_webdriver_wrapper
+  source_code_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_webdriver_wrapper
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: ONLYOFFICE Webdriver Wrapper Gem
+test_files: []