onlyoffice_webdriver_wrapper 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2132850b7105fa563d909e4c82575b19f525603fba19e23a241e743ab2ebf3ef
-  data.tar.gz: b9f5a3a4414ac4b4dc56567593f99c6c4f39ecc494cde8820c09c04e06e3fa1e
+  metadata.gz: a21d9eaf5674c09425184631dd79d31f8d36cb2977e3d7dd309fe938d54603b9
+  data.tar.gz: a807c1805c6cfb6197692efdc4947081b02589ba923f30a058eeec80759e75a6
 SHA512:
-  metadata.gz: 48cb93139b5f22b4b1993240c6ba7297f886936844eced9f587547d4527083876d1d2065a4eafb34e4a05848fae1d1455e6f3cb3af204fb1c35b02e356b0f5b0
-  data.tar.gz: bb5e042cda619d6ce3714094ed6b50d4369cb8fabe229fdaf33132fc21dc0a094e36d5df49c57a52a8a74301e379f3e90940c9a12ac012098afa12be2cec6c57
+  metadata.gz: 25a0dac52bc614e8f5ee863825e105879b3c6db71451c59c8f8b05dadaecbbf121928083793cf1d2af24ab870882a9f351731637627bbc076b8d5f1f3dd31ae0
+  data.tar.gz: d5037066d18d20f9b82a86ed42de5b60ab2202bddf93304e211e5d6fcb9f2679c9a815391c3b6526a122196060cbf7a23d572e2b434b7c9ce8905afdefb58ea2

data/lib/onlyoffice_webdriver_wrapper/helpers/headless_helper.rb

@@ -4,10 +4,12 @@ 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
@@ -16,10 +18,15 @@ module OnlyofficeWebdriverWrapper
     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
@@ -43,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.5.0'
+    STRING = '0.7.0'
   end
 end

data/lib/onlyoffice_webdriver_wrapper/webdriver.rb

@@ -56,20 +56,20 @@ module OnlyofficeWebdriverWrapper
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_webdriver_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: headless
@@ -47,28 +47,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: onlyoffice_s3_wrapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: page-object
   requirement: !ruby/object:Gem::Requirement
@@ -103,112 +103,112 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.16.5
+        version: 6.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.16.5
+        version: 6.17.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.8
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.8
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.1
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.1
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: '2'
 description: ONLYOFFICE Webdriver Wrapper Gem. Used in QA
 email:
 - shockwavenn@gmail.com
@@ -226,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