qat-web 6.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e92379991eb1d96103670c226b80c22ed8bc8f10d6eda381be8a0b61bd336b33
+  data.tar.gz: 1bf523ec09958f3b5a43815ef178974b858967a69a306fe8cd3b441c584e581f
+SHA512:
+  metadata.gz: fc9bc0ccb6e9fc2f49778ccb9840927fea4d8040f53867ef2781817628b8ffad45f585762653274cded93d8fad2e1ae577dab9aaa4c51aaf8f8f806269191fd8
+  data.tar.gz: '0268ac6f4b106cc85951e55f5877c67d81e3b1656b9359c70233fd97ae031c5939c07b47d5379f0beb25999aea4d6b6a91cf2090858c86724a6898b3f068839e'

data/lib/capybara/core_ext.rb

@@ -0,0 +1,7 @@
+require 'capybara'
+require_relative 'core_ext/capybara_error'
+require_relative 'core_ext/node/element'
+
+if defined?(Selenium::WebDriver)
+  require_relative 'core_ext/selenium/node'
+end

data/lib/capybara/core_ext/capybara_error.rb

@@ -0,0 +1,14 @@
+require 'capybara'
+require_relative '../../../lib/qat/web/error/enrichment'
+# Capybara extension
+module Capybara
+  # Capybara::CapybaraError extension
+  class CapybaraError
+    include Enrichment
+
+    #@api private
+    def initialize(msg)
+      super(rich_msg(msg))
+    end
+  end
+end

data/lib/capybara/core_ext/node/element.rb

@@ -0,0 +1,35 @@
+require 'capybara/node/element'
+
+# Capybara namespace
+module Capybara
+  # Capybara::Node namespace
+  module Node
+    # Capybara::Node::Element namespace
+    class Element < Base
+      # Scrolls an element into view and return the element to allow method chaining
+      #@return [Capybara::Node::Element]
+      def scroll_into_view!
+        synchronize { base.scroll_into_view! }
+        self
+      end
+
+      # Validates if the element on the displayed part of the page (screen!)
+      #@return [Boolean]
+      def on_screen?(fully: false)
+        synchronize { base.on_screen?(fully) }
+      end
+
+      # Returns the element absolute location on the page
+      #@return [Selenium::WebDriver::Point]
+      def location
+        synchronize { base.location }
+      end
+
+      # Returns the size of this element
+      # @return [Selenium::WebDriver::Dimension]
+      def size
+        synchronize { base.size }
+      end
+    end
+  end
+end

data/lib/capybara/core_ext/selenium/node.rb

@@ -0,0 +1,75 @@
+require 'capybara/selenium/node'
+
+# Selenium specific implementation of the Capybara::Driver::Node API
+class Capybara::Selenium::Node < Capybara::Driver::Node
+  # Scrolls an element into view and return the element to allow method chaining
+  #@return [Nil]
+  def scroll_into_view!
+    script = <<-JS
+        arguments[0].scrollIntoView(false);
+    JS
+
+    driver.execute_script(script, native)
+  end
+
+  # Validates if the element on the displayed part of the page (screen!)
+  #@return [Boolean]
+  def on_screen?(fully)
+    raise ArgumentError, 'on_screen argument should be true or false' unless [true, false].include?(fully)
+
+    screen_position_x = driver.execute_script('return window.scrollX;')
+    screen_position_y = driver.execute_script('return window.scrollY;')
+
+    window_size = driver.browser.manage.window.size
+
+    screen_size_width  = window_size.width
+    screen_size_height = window_size.height
+
+    if fully
+      on_screen_x = (x_origin < (screen_position_x + screen_size_width) and x_end < (screen_position_x + screen_size_width))
+      on_screen_y = (y_origin < (screen_position_y + screen_size_height) and y_end < (screen_position_y + screen_size_height))
+    else #partially
+      on_screen_x = location.x < (screen_position_x + screen_size_width)
+      on_screen_y = location.y < (screen_position_y + screen_size_height)
+    end
+
+    on_screen_x and on_screen_y
+  end
+
+  # Returns the element absolute location on the page
+  #@return [Selenium::WebDriver::Point]
+  def location
+    native.location
+  end
+
+  # Returns the size of this element
+  # @return [Selenium::WebDriver::Dimension]
+  def size
+    native.size
+  end
+
+  # Returns the element X location on the page
+  #@return Integer
+  def x_origin
+    @x_origin ||= (location.x).to_i
+  end
+
+  # Returns the end of the X element location on the page
+  #@return Integer
+  def x_end
+    @x_end ||= (x_origin + size.width).to_i
+  end
+
+  # Returns the element Y location on the page
+  #@return Integer
+  def y_origin
+    @y_origin ||= (location.y).to_i
+  end
+
+  # Returns the end of the Y element location on the page
+  #@return Integer
+  def y_end
+    @y_end ||= (y_origin + size.height).to_i
+  end
+
+end

data/lib/headless/core_ext/random_display.rb

@@ -0,0 +1,15 @@
+require 'headless'
+
+#Redifinition of the Headless class, which works as a wrapper arround Xvfb.
+#@since 1.1.0
+class Headless
+
+  #Link to original implemenmtarion of Headless#pick_available_display
+  alias_method :old_pick_available_display, :pick_available_display
+
+  #Shuffles the original display set generated by Headless.
+  #This makes the display picking random while still using the original avalability check algorithm.
+  def pick_available_display(display_set, can_reuse)
+    old_pick_available_display display_set.to_a.shuffle, can_reuse
+  end
+end

data/lib/qat/cli/plugins/web.rb

@@ -0,0 +1,7 @@
+require_relative '../../web/version'
+
+#Plugin for CLI functions
+#@since 1.0.0
+module QAT::CLI::Plugins::Web
+
+end

data/lib/qat/web.rb

@@ -0,0 +1,12 @@
+require_relative 'web/version'
+require_relative 'web/drivers'
+require_relative 'web/browser'
+require_relative 'web/browser/autoload'
+require_relative 'web/finders'
+require_relative 'web/screen'
+require_relative 'web/screen/autoload'
+require_relative 'web/error'
+require_relative 'web/exceptions'
+require_relative 'web/page'
+require_relative 'web/page_manager'
+require_relative '../capybara/core_ext'

data/lib/qat/web/browser.rb

@@ -0,0 +1,21 @@
+require_relative 'version'
+require_relative 'drivers'
+require_relative 'browser/factory'
+require_relative 'browser/loader'
+require_relative 'browser/screenshot'
+require_relative 'browser/html_dump'
+require_relative 'browser/profile'
+
+require 'qat/logger'
+
+module QAT::Web::Browser
+  include QAT::Logger
+
+  class << self
+    #Prints the current browser URL
+    #@since 1.2.0
+    def print_url
+      log.info "The current URL is #{Capybara.current_session.current_url}"
+    end
+  end
+end

data/lib/qat/web/browser/autoload.rb

@@ -0,0 +1,22 @@
+require_relative 'loader'
+
+module QAT
+  module Web
+    module Browser
+      # Helper methods for configuration auto-loading
+      module AutoLoad
+        include QAT::Logger
+
+        # Loads all screens from QAT cconfiguration cache
+        def self.load_browsers!
+          if QAT.respond_to?(:configuration) && QAT.configuration[:browsers]
+            QAT::Web::Browser::Loader.load_config(QAT.configuration[:browsers])
+            log.debug { "Browser controllers loaded in cache: [#{Capybara.drivers.keys.join(', ')}]" }
+          else
+            log.debug { "Browser controllers aren't loaded in cache, load screens manually from file using QAT::Web::Browser::Loader#load" }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/qat/web/browser/factory.rb

@@ -0,0 +1,39 @@
+require 'capybara'
+require 'qat/logger'
+
+module QAT::Web
+  # Browser namespace
+  module Browser
+    # Module to provide browsers and drivers for web control.
+    #@since 1.0.0
+    module Factory
+      include QAT::Logger
+
+      #Method to ask for a browser. It will be provided if Capybara has a driver with that name
+      #@param browser [String/Symbol] Name of the Capybara::Driver to use
+      #@raise [ArgumentError] When a given driver does not exist.
+      #@since 1.0.0
+      def self.for browser
+        browser = browser.to_sym
+
+        unless Capybara.drivers.has_key? browser
+          log.error { "No driver with name #{browser} available" }
+          log.debug { 'Available drivers are:' }
+          log.debug { Capybara.drivers.keys }
+          raise ArgumentError.new "No driver with name #{browser} available"
+        end
+
+        if Capybara.current_driver != browser
+          log.info { "Switching from #{Capybara.current_driver} to #{browser}" }
+          Capybara.current_driver    = browser
+          Capybara.default_driver    = browser
+          Capybara.javascript_driver = browser
+        end
+        #Force driver start
+        Capybara.current_session.driver
+        Capybara.current_session
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module QAT::Web
+  module Browser
+    module Loader
+      # Module with helper methods to load browsers and drivers from configuration files.
+      #@since 2.0.1
+      module Helper
+        # Creates a generic Capybara driver
+        # @param browser [String] Expected browser
+        # @param controller [String] Expected controller
+        # @param screen [String] Expected screen properties
+        # @param driver [String] Expected driver
+        # @param properties [String] Expected driver properties
+        # @param addons [String] Expected driver/browser addons
+        # @param hooks [String] Cucumber hooks to use
+        # @return [Capybara::RackTest::Driver||Capybara::Selenium::Driver]
+        def load_generic_driver(browser, controller, screen, driver, properties, addons, hooks)
+          Capybara.register_driver controller do |app|
+            loaded_screen = QAT::Web::Screen::Factory.for screen
+            loaded_driver = nil
+            Retriable.retriable on:            [Net::ReadTimeout, ::Selenium::WebDriver::Error::WebDriverError],
+                                tries:         3,
+                                base_interval: 5,
+                                multiplier:    1.0,
+                                rand_factor:   0.0 do
+
+              options = { browser: browser }
+              if properties
+                customized_profile = create_profile(driver, browser, properties, addons)
+                options.merge!(customized_profile) if customized_profile
+              end
+              loaded_driver = Capybara.const_get(driver.capitalize)::Driver.new(app, options)
+              loaded_driver.browser
+            end
+
+            if loaded_screen.xvfb
+              loaded_driver.resize_window_to(loaded_driver.current_window_handle, loaded_screen.width, loaded_screen.height)
+            else
+              loaded_driver.maximize_window(loaded_driver.current_window_handle) if loaded_driver.respond_to? :maximize_window
+            end
+
+            require_hooks(hooks)
+
+            loaded_driver
+          end
+        end
+      end
+    end
+  end
+end

data/lib/qat/web/browser/html_dump.rb

@@ -0,0 +1,46 @@
+require_relative '../version'
+require 'capybara'
+require 'qat/logger'
+
+module QAT::Web
+  # Browser namespace
+  module Browser
+    # Module to handle browser HTML dumps.
+    #@since 1.0.0
+    module HTMLDump
+      include QAT::Logger
+      extend self
+
+      # Function to take a browser HTML dump. Will handle the usage of driver that don't support HTML dumps.
+      #@param page [Capybara::Session] Browser to take HTML dump from
+      #@param path [String] File path to save HTML dump file
+      #@return [String/NilClass] File path to where the HTML dump file was saved or nil if the browser doesn't support HTML dumps
+      #@since 1.0.0
+      def take_html_dump(page=Capybara.current_session, path=html_dump_path)
+        log.info { "Saving HTML dump to #{path}" }
+        raise ArgumentError.new "File #{path} already exists! Choose another filename" if ::File.exists? path
+        path = page.save_page path
+        log.info { "HTML dump available" }
+        ::File.basename(path)
+      rescue Capybara::NotSupportedByDriverError
+        log.warn { "Driver #{page.mode} does not support HTML dumps!" }
+        return nil
+      end
+
+      #Default HTML dump path. Can be set with {#html_dump_path=}.
+      #@return [String] HTML dump path
+      #@since 1.0.0
+      def html_dump_path
+        @html_dump_path || ::File.join('public', "browser_#{Time.new.strftime("%H%M%S%L")}.html")
+      end
+
+      #Set new default HTML dump path.
+      #@param path [String] HTML dump path
+      #@since 1.0.0
+      def html_dump_path=(path)
+        @html_dump_path = path
+      end
+
+    end
+  end
+end

data/lib/qat/web/browser/loader.rb

@@ -0,0 +1,75 @@
+require 'capybara'
+require_relative '../version'
+require_relative '../drivers/default'
+require_relative 'profile'
+require_relative 'firefox/loader/helper'
+require 'retriable'
+require 'erb'
+require 'active_support'
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module QAT::Web
+  module Browser
+    # Module to load browsers and drivers from configuration files.
+    #@since 1.0.0
+    module Loader
+      include Drivers::Default
+      include QAT::Web::Browser::Profile
+      include Helper
+      extend self
+
+      # Registers browser drivers in Capybara from a YAML file
+      #@param file_path [String] file containing browser drivers
+      #@since 1.0.0
+      def load(file_path)
+        controllers = HashWithIndifferentAccess.new(YAML::load(ERB.new(File.read(file_path)).result)) || {}
+        load_config(controllers)
+      end
+
+      # Registers browser drivers in Capybara from a configuration hash
+      #@param config [String] configuration hash containing browser drivers
+      #@since 2.1.0
+      def load_config(config)
+        config.each do |controller, options|
+          raise InvalidConfigurationError.new "No browser defined for controller #{controller}" unless options['browser']
+          register_controller(controller.to_sym, options)
+        end
+      end
+
+      private
+
+      def register_controller(controller, options)
+        browser    = options['browser'].to_sym
+        driver     = options['driver'] || mapping[browser]
+        screen     = options['screen']
+        properties = options['properties']
+        addons     = options['addons']
+        hooks      = options['hooks']
+
+        if driver.to_sym == :poltergeist
+          load_poltergeist_driver(browser, controller, screen)
+        else
+          load_generic_driver(browser, controller, screen, driver, properties, addons, hooks)
+        end
+      end
+
+      def require_hooks(hooks)
+        if hooks&.any?
+          if defined?(Cucumber)
+            hooks.each do |hook|
+              log.debug "Loading cucumber hook: qat/web/hooks/#{hook}"
+              require "qat/web/hooks/#{hook}"
+            end
+          else
+            log.debug "Running in a non-Cucumber runtime, skipping hooks!"
+          end
+        end
+      end
+
+      #Configuration load error class.
+      class InvalidConfigurationError < StandardError
+      end
+    end
+  end
+end