qat-web-video 9.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf3c89384b93f390fcc340679384a1d7cf3a4a52eb10f813681906814eb18af7
+  data.tar.gz: ff05043001d9e372d8063c85d78a30f8edb1e9ebde30ae6e223ab16c3a378847
+SHA512:
+  metadata.gz: '06494ab76abb855a8aed9d6535a0754174ad94779739f96da2a490ef687e65e0270f904a09132f7c63d3d7cb21c1b3ccc9c139d92ad9d5bb88f44210cac4ab2f'
+  data.tar.gz: 8e1e92a71affbb2d8bc54b3de5d1531ce88c8614bdfb29a0a45ebe3e5e375ee2e3c348c911882b889ec8e2d4824f61a94f8c45b00e34f3467d602dd8248110b3

data/lib/headless/video/video_recorder_ext.rb

@@ -0,0 +1,35 @@
+# Monkey Patch Description:
+#
+# This monkey patch modifies the behavior of the `stop_and_save` within the `VideoRecorder`
+# from the 'headless' gem. It is applied to address a specific issue or add custom
+# functionality required for our project.
+#
+# Original method behavior:
+# - File.exists? was removed in Ruby 3.2.0 (deprecated in 2.2)
+# https://bugs.ruby-lang.org/issues/17391
+# https://github.com/ruby/ruby/commit/bf97415c02b11a8949f715431aca9eeb6311add2
+# Sadly the gem Headless is currently outdated thus this patch
+#
+# Changes Made:
+# - Change `File.exists?` to `File.exist?`
+#
+# Note: This patch should be reviewed and updated as needed with future gem updates.
+#
+# Author: Bruno Penedo
+
+require 'headless'
+
+class Headless
+  class VideoRecorder
+    def stop_and_save(path)
+      CliUtil.kill_process(@pid_file_path, :wait => true)
+      if File.exist? @tmp_file_path
+        begin
+          FileUtils.mv(@tmp_file_path, path)
+        rescue Errno::EINVAL
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/headless_ext.rb

@@ -0,0 +1 @@
+require_relative 'headless/video/video_recorder_ext'

data/lib/qat/web/core_ext/browser/firefox/loader/helper.rb

@@ -0,0 +1,18 @@
+module QAT::Web
+  module Browser
+    module Loader
+
+      private
+
+      def maximize_browser_window(driver, screen)
+        if screen.xvfb
+          driver.resize_window_to(driver.current_window_handle, screen.width, screen.height)
+
+          screen.start_video_capture if %w(always success failure).include? ENV['QAT_WEB_VIDEO_MODE']
+        else
+          driver.maximize_window(driver.current_window_handle) if driver.respond_to? :maximize_window
+        end
+      end
+    end
+  end
+end

data/lib/qat/web/core_ext/screen/wrapper.rb

@@ -0,0 +1,80 @@
+require 'qat/web/screen/loader'
+require 'headless/core_ext/random_display'
+require 'qat/logger'
+require 'headless_ext'
+
+module QAT::Web
+  module Screen
+
+    #Screen wrapper to represent an abstract display. Can have a Headless instance associated.
+    class Wrapper
+      include QAT::Logger
+
+      # Video recording configurations exception
+      #@since 6.0.0
+      class VideoRecordingConfigError < StandardError
+      end
+
+      #Start a new Xvfb instance
+      #@return [Headless] Xvfb instance
+      #@since 6.0.0
+      def start
+        if %w(always success failure).include?(ENV['QAT_WEB_VIDEO_MODE']) and (@options[:video].nil? or @options[:video].empty?)
+          raise(VideoRecordingConfigError, "Video recording configuration is missing!")
+        end
+
+        @xvfb = Headless.new @options
+        @xvfb.start
+        log.info "Xvfb #{name} screen started"
+        @xvfb
+      end
+
+      #Start Xvfb web capture
+      #@since 6.0.0
+      def start_video_capture
+        @xvfb.video.start_capture
+        log.debug "Started video capture"
+      end
+
+      #Stop Xvfb web capture and discard the recorded web
+      #@since 6.0.0
+      def stop_and_discard_video_capture
+        return unless video_capture_running?
+        @xvfb.video.stop_and_discard
+        log.debug "Stopped and discarded video capture"
+      end
+
+      #Stop Xvfb web capture and save the recorded web
+      #@since 6.0.0
+      def stop_and_save_video_capture(path = nil)
+        return unless video_capture_running?
+        path ||= self.class.default_video_name
+        @xvfb.video.stop_and_save path
+        log.info "Saving video capture to #{path}"
+        path
+      end
+
+      #Check if Xvfb web capture is running
+      #@since 6.0.0
+      def video_capture_running?
+        return false unless @xvfb
+        return false if ENV['QAT_WEB_VIDEO_MODE'] == 'never'
+        @xvfb.video.capture_running?.tap { |value| log.debug "Video capture#{value ? '' : ' not'} running" }
+      rescue Headless::Exception => e
+        log.debug { "An error occurred while checking web recording:" }
+        log.debug { e }
+        log.debug { "Assuming video capture is not running" }
+        false
+      end
+
+      def self.default_video_name
+        return @@default_video_name ||= "video.mkv"
+      end
+
+      def self.default_video_name=(path)
+        @@default_video_name = path
+      end
+
+    end
+  end
+end

data/lib/qat/web/core_ext.rb

@@ -0,0 +1,5 @@
+require 'qat/web/browser/firefox/loader/helper'
+require_relative 'core_ext/browser/firefox/loader/helper'
+
+require 'qat/web/screen/wrapper'
+require_relative 'core_ext/screen/wrapper'

data/lib/qat/web/video/cucumber.rb

@@ -0,0 +1,2 @@
+require 'qat/web/cucumber'
+require_relative 'hooks/video'

data/lib/qat/web/video/hooks/video.rb

@@ -0,0 +1,38 @@
+require 'qat/web/hooks/common'
+require 'qat/web/exceptions'
+require_relative '../../video'
+
+module QAT::Web
+  module Exceptions
+    VIDEO = GLOBAL.dup
+  end
+end
+
+Before do |scenario|
+  QAT::Web::Screen::Wrapper.default_video_name = File.join('public', "#{QAT::Web::Hooks::Common.scenario_tag(scenario)}.mkv")
+
+  if %w(always success failure).include?(ENV['QAT_WEB_VIDEO_MODE']) and QAT::Web::Screen::Factory.current_screen and not QAT::Web::Screen::Factory.current_screen.video_capture_running?
+    QAT::Web::Screen::Factory.current_screen.start_video_capture
+  end
+end
+
+After do |scenario|
+  if ENV['QAT_WEB_VIDEO_MODE'] and QAT::Web::Screen::Factory.current_screen and QAT::Web::Screen::Factory.current_screen.video_capture_running?
+    case ENV['QAT_WEB_VIDEO_MODE']
+      when 'always'
+        attach QAT::Web::Screen::Factory.current_screen.stop_and_save_video_capture, 'video/mp4'
+      when 'success'
+        if scenario.passed?
+          attach QAT::Web::Screen::Factory.current_screen.stop_and_save_video_capture, 'video/mp4'
+        else
+          QAT::Web::Screen::Factory.current_screen.stop_and_discard_video_capture
+        end
+      when 'failure'
+        if scenario.failed? and QAT::Web::Exceptions::VIDEO.any? { |exception| scenario.exception.kind_of?(exception) }
+          attach QAT::Web::Screen::Factory.current_screen.stop_and_save_video_capture, 'video/mp4'
+        else
+          QAT::Web::Screen::Factory.current_screen.stop_and_discard_video_capture
+        end
+    end
+  end
+end

data/lib/qat/web/video/version.rb

@@ -0,0 +1,13 @@
+#QAT global namespace
+module QAT
+  #Web Module namespace for browser interaction API
+  #@since 6.0.0
+  module Web
+    #Video Module namespace for browser recorder interaction API
+    #@since 6.0.0
+    module Video
+      # Represents QAT-Web-Video's version
+      VERSION = '9.0.0'
+    end
+  end
+end

data/lib/qat/web/video.rb

@@ -0,0 +1,3 @@
+require_relative 'core_ext'
+require_relative 'video/version'
+require_relative 'video/cucumber'

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: qat-web-video
+version: !ruby/object:Gem::Version
+  version: 9.0.0
+platform: ruby
+authors:
+- QAT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-16 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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: qat-devel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+- !ruby/object:Gem::Dependency
+  name: qat-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.2
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.12.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: syntax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: qat-web
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.3
+description: "  QAT-Web-Video is a screen recorder for Web testing evidences, with
+  support for various browsers and webdrivers.\n"
+email: qatoolkit@readinessit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/headless/video/video_recorder_ext.rb
+- lib/headless_ext.rb
+- lib/qat/web/core_ext.rb
+- lib/qat/web/core_ext/browser/firefox/loader/helper.rb
+- lib/qat/web/core_ext/screen/wrapper.rb
+- lib/qat/web/video.rb
+- lib/qat/web/video/cucumber.rb
+- lib/qat/web/video/hooks/video.rb
+- lib/qat/web/video/version.rb
+homepage: https://gitlab.readinessit.com/qa-toolkit/qat-web-video
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: QAT-Web-Video is a screen recorder for Web testing evidences
+test_files: []