onlyoffice_webdriver_wrapper 0.3.4 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0ca15252e6b9cabf55874698a42ba87bb66e2c320dd4e08b80504a4bd031254
-  data.tar.gz: fdc1eaf3a869680e756d4af74b05d3cc0ef603ef383509930f53e785b1f7b6aa
+  metadata.gz: fd207cfcb5c3d274d1f27c1159f744f0bf6c5c58beaeb5bbb075d168a3082ded
+  data.tar.gz: 1784801d1b15ae594167e1a11902d3308c0683d9fb45d193d3e8033e8f62d807
 SHA512:
-  metadata.gz: de1324381dbd1a68e88679167a42d40252cb741ac5f6f881853d4bda7d98c61d6111f605f7ebb0b124b01ad3507a01697664f10ecf95bcbf4750e9584de66f43
-  data.tar.gz: c0141ead4b9c7ef3e6f71a4e2be8987973e4ae861806bfa074633068703bad0eec447d9833bbc6a7e8c33b45531d64bdb087df2c2a3016ac1cec327ea6be48e2
+  metadata.gz: 424d71030c12a0ab537b5c5c0bbb44daabb7ec7a5db7b318a97a7d2b034c0d59de67d957417add165e8af151b9cc9bf372cfe640b2a6ebdb36d6abeeb9b81537
+  data.tar.gz: 1b179181f58eab37e9f982e9134679e724d2c0a328c51511d137336ff10260fac2ad2b1c3bcba83d0278bc8d1fba30198392af3c817c4d93345bc894b0f206bb

data/lib/onlyoffice_webdriver_wrapper/helpers/chrome_helper.rb

@@ -37,7 +37,6 @@ module OnlyofficeWebdriverWrapper
       caps = Selenium::WebDriver::Remote::Capabilities.chrome
       caps[:logging_prefs] = { browser: 'ALL' }
       caps[:proxy] = Selenium::WebDriver::Proxy.new(ssl: "#{@proxy.proxy_address}:#{@proxy.proxy_port}") if @proxy
-      caps['chromeOptions'] = { w3c: false }
       switches = add_useragent_to_switches(DEFAULT_CHROME_SWITCHES)
       options = Selenium::WebDriver::Chrome::Options.new(args: switches,
                                                          prefs: prefs)

data/lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb

@@ -4,19 +4,29 @@ require_relative 'headless_helper/real_display_tools'
 require_relative 'headless_helper/ruby_helper'
 require 'headless'
 require_relative 'headless_helper/headless_screenshot_patch'
+require_relative 'headless_helper/headless_video_recorder'
 
 module OnlyofficeWebdriverWrapper
   # Class for using headless gem
   class HeadlessHelper
+    include HeadlessVideoRecorder
     include RealDisplayTools
     include RubyHelper
+    # @return [Headless] instance of headless object
     attr_accessor :headless_instance
+    # @return [Integer] x resolution of virtual screen
     attr_accessor :resolution_x
+    # @return [Integer] y resolution of virtual screen
     attr_accessor :resolution_y
+    # @return [True, False] is video should be recorded
+    attr_reader :record_video
 
-    def initialize(resolution_x = 1680, resolution_y = 1050)
+    def initialize(resolution_x: 1680,
+                   resolution_y: 1050,
+                   record_video: true)
       @resolution_x = resolution_x
       @resolution_y = resolution_y
+      @record_video = record_video
     end
 
     # Check if should start headless
@@ -40,21 +50,25 @@ module OnlyofficeWebdriverWrapper
       begin
         @headless_instance = Headless.new(reuse: false,
                                           destroy_at_exit: true,
-                                          dimensions: "#{@resolution_x + 1}x#{@resolution_y + 1}x24")
+                                          dimensions: "#{@resolution_x + 1}x#{@resolution_y + 1}x24",
+                                          video: { provider: :ffmpeg })
       rescue Exception => e
         OnlyofficeLoggerHelper.log("xvfb not started with problem #{e}")
         WebDriver.clean_up(true)
         @headless_instance = Headless.new(reuse: false,
                                           destroy_at_exit: true,
-                                          dimensions: "#{@resolution_x + 1}x#{@resolution_y + 1}x24")
+                                          dimensions: "#{@resolution_x + 1}x#{@resolution_y + 1}x24",
+                                          video: { provider: :ffmpeg })
       end
       headless_instance.start
+      start_capture
     end
 
     def stop
       return unless running?
 
       OnlyofficeLoggerHelper.log('Stopping Headless Session')
+      stop_capture
       headless_instance.destroy
     end
 

data/lib/onlyoffice_webdriver_wrapper/helpers/headless_helper/headless_video_recorder.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OnlyofficeWebdriverWrapper
+  # Methods to record video
+  module HeadlessVideoRecorder
+    # @return [String] uniq file path to recorded file
+    def recorded_video_file
+      return @recorded_video_file if @recorded_video_file
+
+      file_pattern = 'onlyoffice_webdriver_wrapper_video_file'
+      temp_file = Tempfile.new([file_pattern, '.mp4'])
+      @recorded_video_file = temp_file.path
+      temp_file.unlink
+      @recorded_video_file
+    end
+
+    # @return [nil] start capture of file
+    def start_capture
+      headless_instance.video.start_capture if record_video
+    rescue Headless::Exception => e
+      OnlyofficeLoggerHelper.log("Cannot start video capture: #{e}")
+      @record_video = false
+    end
+
+    # @return [nil] stop catpure of file
+    def stop_capture
+      return unless record_video
+
+      headless_instance.video.stop_and_save(recorded_video_file)
+      OnlyofficeLoggerHelper.log("Video is saved to #{recorded_video_file}")
+    rescue Headless::Exception => e
+      OnlyofficeLoggerHelper.log("Saving recorded video failed: #{e}")
+      @record_video = false
+    end
+  end
+end

data/lib/onlyoffice_webdriver_wrapper/version.rb

@@ -2,6 +2,6 @@
 
 module OnlyofficeWebdriverWrapper
   module Version
-    STRING = '0.3.4'
+    STRING = '0.6.1'
   end
 end

data/lib/onlyoffice_webdriver_wrapper/webdriver.rb

@@ -44,51 +44,52 @@ module OnlyofficeWebdriverWrapper
     TIMEOUT_FILE_DOWNLOAD = 100
     # @return [Array, String] default switches for chrome
     attr_accessor :driver
+    # @return [Symbol] browser to use
     attr_accessor :browser
     # @return [True, False] is browser currently running
     attr_reader :browser_running
     # @return [Symbol] device of which we try to simulate, default - :desktop_linux
     attr_accessor :device
+    # @return [String] directory to which file is downloaded
     attr_accessor :download_directory
-    attr_accessor :server_address
+    # @return [HeadlessHelper] headless wrapper
     attr_accessor :headless
     # @return [Net::HTTP::Proxy] connection proxy
     attr_accessor :proxy
+    # @return [True, False] should video be recorded
+    attr_reader :record_video
 
-    def initialize(browser = :firefox,
-                   _remote_server = nil,
-                   device: :desktop_linux,
-                   proxy: nil)
+    def initialize(browser = :firefox, params = {})
       raise WebdriverSystemNotSupported, 'Your OS is not 64 bit. It is not supported' unless os_64_bit?
 
-      @device = device
-      @headless = HeadlessHelper.new
+      @device = params.fetch(:device, :desktop_linux)
+      @record_video = params.fetch(:record_video, true)
+      @headless = HeadlessHelper.new(record_video: record_video)
       @headless.start
 
       @download_directory = Dir.mktmpdir('webdriver-download')
-      @browser = browser
-      @proxy = proxy
+      @browser = params.fetch(:browser, browser)
+      @proxy = params[:proxy]
       case browser
       when :firefox
         @driver = start_firefox_driver
       when :chrome
         @driver = start_chrome_driver
       else
-        raise 'Unknown Browser: ' + browser.to_s
+        raise("Unknown Browser: #{browser}")
       end
       @browser_running = true
     end
 
     def open(url)
-      url = 'http://' + url unless url.include?('http') || url.include?('file://')
+      url = "http://#{url}" unless url.include?('http') || url.include?('file://')
       loop do
-        begin
-          @driver.navigate.to url
-          break
-        rescue Timeout::Error
-          @driver.navigate.refresh
-        end
+        @driver.navigate.to url
+        break
+      rescue Timeout::Error
+        @driver.navigate.refresh
       end
+      sleep(1) # Correct wait for Page to init focus
       OnlyofficeLoggerHelper.log("Opened page: #{url}")
     end
 
@@ -208,10 +209,10 @@ module OnlyofficeWebdriverWrapper
     def open_dropdown_selector(xpath_name, horizontal_shift = 30, vertical_shift = 0)
       element = get_element(xpath_name)
       if @browser == :firefox || @browser == :safari
-        set_style_attribute(xpath_name + '/button', 'display', 'none')
+        set_style_attribute("#{xpath_name}/button", 'display', 'none')
         set_style_attribute(xpath_name, 'display', 'inline')
         element.click
-        set_style_attribute(xpath_name + '/button', 'display', 'inline-block')
+        set_style_attribute("#{xpath_name}/button", 'display', 'inline-block')
         set_style_attribute(xpath_name, 'display', 'block')
       else
         @driver.action.move_to(element, horizontal_shift, vertical_shift).click.perform
@@ -241,9 +242,10 @@ module OnlyofficeWebdriverWrapper
     end
 
     def element_present?(xpath_name)
-      if xpath_name.is_a?(PageObject::Elements::Element)
+      case xpath_name
+      when PageObject::Elements::Element
         xpath_name.present?
-      elsif xpath_name.is_a?(Selenium::WebDriver::Element)
+      when Selenium::WebDriver::Element
         xpath_name.displayed?
       else
         @driver.find_element(:xpath, xpath_name)
@@ -330,14 +332,12 @@ module OnlyofficeWebdriverWrapper
     # @param [String] xpath_name name of current xpath
     def select_frame(xpath_name = '//iframe', count_of_frames = 1)
       (0...count_of_frames).each do
-        begin
-          frame = @driver.find_element(:xpath, xpath_name)
-          @driver.switch_to.frame frame
-        rescue Selenium::WebDriver::Error::NoSuchElementError
-          OnlyofficeLoggerHelper.log('Raise NoSuchElementError in the select_frame method')
-        rescue Exception => e
-          webdriver_error("Raise unkwnown exception: #{e}")
-        end
+        frame = @driver.find_element(:xpath, xpath_name)
+        @driver.switch_to.frame frame
+      rescue Selenium::WebDriver::Error::NoSuchElementError
+        OnlyofficeLoggerHelper.log('Raise NoSuchElementError in the select_frame method')
+      rescue Exception => e
+        webdriver_error("Raise unkwnown exception: #{e}")
       end
     end
 
@@ -369,16 +369,6 @@ module OnlyofficeWebdriverWrapper
       @driver.find_elements(:xpath, xpath_several_elements).map { |element| element.text unless element.text == '' }.compact
     end
 
-    def set_parameter(xpath, attribute, attribute_value)
-      execute_javascript("document.evaluate(\"#{xpath.tr('"', "'")}\",document, null, XPathResult.ANY_TYPE, null ).iterateNext()." \
-                             "#{attribute}=\"#{attribute_value}\";")
-    end
-
-    def remove_attribute(xpath, attribute)
-      execute_javascript("document.evaluate(\"#{xpath}\",document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null)." \
-                             "singleNodeValue.removeAttribute('#{attribute}');")
-    end
-
     def select_combo_box(xpath_name, select_value, select_by = :value)
       wait_until_element_visible(xpath_name)
       option = Selenium::WebDriver::Support::Select.new(get_element(xpath_name))

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_attributes_helper.rb

@@ -40,5 +40,24 @@ module OnlyofficeWebdriverWrapper
       end
       0
     end
+
+    # Set element attribute
+    # @param xpath [String] element to select
+    # @param attribute [String] attribute to set
+    # @param attribute_value [String] value of attribute
+    # @return [String] result of execution
+    def set_attribute(xpath, attribute, attribute_value)
+      execute_javascript("#{dom_element_by_xpath(xpath)}.#{attribute}=\"#{attribute_value}\";")
+    end
+
+    alias set_parameter set_attribute
+
+    # Remove attribute of element
+    # @param xpath [String] xpath of element
+    # @param attribute [String] attribute to remove
+    # @return [String] result of execution
+    def remove_attribute(xpath, attribute)
+      execute_javascript("#{dom_element_by_xpath(xpath)}.removeAttribute('#{attribute}');")
+    end
   end
 end

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_js_methods.rb

@@ -28,8 +28,13 @@ module OnlyofficeWebdriverWrapper
       execute_javascript("document.evaluate('#{xpath_name}', document, null, XPathResult.ANY_TYPE, null).iterateNext().value=\"#{escaped_text}\";")
     end
 
+    # Get text in object by xpath
+    # @param xpath [String] xpath to get text
+    # @return [String] text in xpath
     def get_text_by_js(xpath)
-      execute_javascript("return document.evaluate(\"#{xpath.tr('"', "'")}\",document, null, XPathResult.ANY_TYPE, null ).iterateNext().textContent")
+      text = execute_javascript("return #{dom_element_by_xpath(xpath)}.textContent")
+      text = execute_javascript("return #{dom_element_by_xpath(xpath)}.value") if text.empty?
+      text
     end
 
     # Calculate object size using Javascript

data/lib/onlyoffice_webdriver_wrapper/webdriver/webdriver_style_helper.rb

@@ -10,26 +10,23 @@ module OnlyofficeWebdriverWrapper
       nil
     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
-
+    # 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("document.evaluate('#{xpath}',document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null)." \
-                             "singleNodeValue.style.#{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)
-      xpath = xpath.tr("'", '"')
-      execute_javascript('document.evaluate( \'' + xpath.to_s +
-                             '\' ,document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null ).singleNodeValue.style.display = "block";')
+      execute_javascript("#{dom_element_by_xpath(xpath)}.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";')
+      execute_javascript("#{dom_element_by_xpath(xpath)}.style.left = '410px';")
+      execute_javascript("#{dom_element_by_xpath(xpath)}.style.top = '260px';")
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_webdriver_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.6.1
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: headless
@@ -31,58 +31,58 @@ dependencies:
   name: onlyoffice_file_helper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: onlyoffice_logger_helper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1'
+        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'
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: page-object
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.2.6
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -101,30 +101,114 @@ dependencies:
   name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '6'
+        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: '6'
+        version: 0.55.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '13.0'
+        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: '13.0'
+        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
@@ -142,6 +226,7 @@ files:
 - 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
@@ -179,7 +264,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="