qat-web 6.0.0

data/lib/qat/web/page/validators.rb

@@ -0,0 +1,37 @@
+module QAT::Web
+  class Page
+    # Module with helper methods to validate Page return types
+    # @since 2.0.1
+    module Validators
+      private
+      # Validates the return value for the action based on the return options
+      # @param return_opts [Hash] return options
+      # @return [Array|Class]
+      def validate_return_value(return_opts)
+        raise TypeError.new "Did not find return information, the ':returns' option must be defined!" unless return_opts
+
+        case return_opts
+        when Array
+          return_opts = validate_return_type_array(return_opts)
+        when Class
+          raise TypeError.new "Invalid return value, #{return_opts} be subclasses of QAT::Web::Page." unless return_opts.ancestors.include? QAT::Web::Page
+        else
+          raise TypeError.new "Invalid return value, must be either an Array or a subclass of QAT::Web::Page, but was #{return_opts}"
+        end
+
+        return_opts
+      end
+
+      # Validate an array of return options
+      # @param return_opts [Array] return options
+      # @return [Array|Class]
+      def validate_return_type_array(return_opts)
+        raise TypeError.new "Invalid return value, must be either an Array or a subclass of QAT::Web::Page, but was an empty array" if return_opts.empty?
+        invalid = return_opts.reject { |klass| klass.is_a? Class and klass.ancestors.include? QAT::Web::Page }
+        raise TypeError.new "Invalid return values, must all be subclasses of QAT::Web::Page. Invalid options: #{invalid.join ', '}" unless invalid.empty?
+
+        return_opts
+      end
+    end
+  end
+end

data/lib/qat/web/page_manager.rb

@@ -0,0 +1,71 @@
+require_relative 'version'
+
+require_relative 'page'
+
+module QAT::Web
+
+  #Class to represent a Web Site as a collection of {QAT::Web::Page}. These webpages should be all subclasses of a common
+  #{QAT::Web::Page} abstract subclass, representing a website's generic webpage. This abstract class should be used in the
+  ##manages class definition. Also the initial website's page should be declared and should be a subclass of the managed
+  #domain.
+  #To navigate in the website, just call the methods of the current page of the website.
+  # @example Sample Website implementation.
+  #   class ExampleWebsite < QAT::Web::PageManager
+  #
+  #     manages ExampleWebsitePage #Inherits from QAT::Web::Page
+  #
+  #     initial_page ExampleLoginPage #Inherits from ExampleWebsitePage
+  #
+  #   end
+  #
+  #   site_controller = ExampleWebsite.new
+  #   site_controller.current_page # ExampleLoginPage instance
+  #   site_controller.login
+  #   site_controller.current_page # ExampleAuthenticatedPage instance
+  #
+  #@abstract
+  #@since 1.0.0
+  class PageManager
+
+    #Define the initial page of the chosen managed domain.
+    #@param page [Class] Initial page class. Must be subclass of the class defined in #manages
+    #@raise [TypeError] Invalid class type defined
+    def self.initial_page page
+      raise TypeError.new "Initial page class #{page} is not a QAT::Web::Page subclass" unless page.is_a? Class and page.ancestors.include? QAT::Web::Page
+      raise TypeError.new "Initial page class #{page} is not a #{@@manages} subclass" if @@manages and not page.ancestors.include? @@manages
+
+      @@initial_page = page
+    end
+
+
+    #Define the domain's main class to manage.
+    #@param page_type [Class] Domain's abstract page class. Must be subclass of QAT::Web::Page
+    #@raise [TypeError] Invalid class type defined
+    def self.manages page_type
+      raise TypeError.new "Manage domain class #{page_type} is not an QAT::Web::Page subclass" unless page_type.is_a? Class and page_type.ancestors.include? QAT::Web::Page
+
+      @@manages = page_type
+    end
+
+    #Initialize the page manager. Will start at the defined initial page.
+    #@raise [TypeError] Invalid definition of #manages or #initial_page
+    def initialize
+      raise TypeError.new "No page type defined, use class definition 'manages' to define a QAT:Web::Page type to manage" unless @@manages
+      raise TypeError.new "No initial page type defined, use class definition 'initial_page' to define a #{@@manages} type page as initial" unless @@initial_page
+
+      @current_page = @@initial_page.new
+    end
+
+    #@return [QAT::Web::Page] current page object instance.
+    attr_reader :current_page
+
+
+    #Forwards all methods to current page.
+    def method_missing method, *args, &block
+      result = @current_page.send method, *args, &block
+      @current_page = result if @current_page.class.actions.include? method
+      return result
+    end
+
+  end
+end

data/lib/qat/web/screen.rb

@@ -0,0 +1,2 @@
+require_relative 'screen/loader'
+require_relative 'screen/factory'

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

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

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

@@ -0,0 +1,68 @@
+require_relative '../version'
+require_relative 'loader'
+require_relative 'wrapper'
+require 'headless/core_ext/random_display'
+require 'qat/logger'
+
+module QAT::Web
+  module Screen
+    #Module to provide virtual screens for web control.
+    #@since 1.0.0
+    module Factory
+      include QAT::Logger
+
+      class << self
+        #Method to ask for a virtual screen. It will be provided if {QAT::Web::Screen::Loader} knows the screen definition.
+        #Will do nothing if +ENV ['QAT_DISPLAY'] + is set to +'none'+
+        #@param name [String/Symbol] Name of the virtual screen to use
+        #@return [QAT::Screen::Wrapper] current screen
+        #@raise [ArgumentError] When a given screen definition does not exist.
+        #@since 1.0.0
+        def for name=:default, load=true
+
+          name ||= :default
+
+          name = name.to_sym
+
+          unless QAT::Web::Screen::Loader.screens.has_key? name
+            log.error { "No screen with name #{name} available" }
+            log.debug { 'Available screens are:' }
+            log.debug { QAT::Web::Screen::Loader.screens.keys }
+            raise ArgumentError.new "No screen with name #{name} available"
+          end
+
+          current_screen.destroy if current_screen
+          screen_definitions = QAT::Web::Screen::Loader.screens[name]
+          if screen_definitions.empty?
+            log.debug {'Using the default configuration definitions'}
+            screen_definitions[:reuse] = false
+          end
+          self.current_screen =  QAT::Web::Screen::Wrapper.new name, screen_definitions
+
+          if ENV['QAT_DISPLAY'] == 'none'
+            log.info 'Virtual screens disabled'
+          elsif not load
+            log.info 'Virtual screen will not be loaded'
+          else
+            current_screen.start
+          end
+
+          current_screen
+        end
+
+        #Current screen in use
+        #@return [QAT::Screen::Wrapper] current screen
+        #@since 1.0.0
+        def current_screen
+          @current_screen ||= nil
+        end
+
+        private
+        def current_screen= screen
+          @current_screen = screen
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,93 @@
+require_relative '../version'
+require 'qat/logger'
+require 'active_support'
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module QAT::Web
+  #Namespace for virtual screen management
+  #@since 1.0.0
+  module Screen
+    #Utility methods to load screen definitions from configuration files
+    #@since 1.0.0
+    module Loader
+      include QAT::Logger
+
+      class << self
+        # include QAT::Logger
+        # Registers screen definitions from a YAML file
+        #@param filepath [String] file containing screen definitions
+        #@raise [QAT::Web::Screen::Loader::InvalidConfigurationError] When an incorrect configuration is found
+        #@since 1.0.0
+        def load(filepath)
+          log.info { "Opening #{filepath}" }
+
+          screens = HashWithIndifferentAccess.new(YAML::load(ERB.new(File.read(filepath)).result)) || {}
+
+          load_config(screens)
+
+          log.info { "File #{filepath} parsed" }
+        end
+
+        # include QAT::Logger
+        # Registers screen definitions from a configuration hash
+        #@param config [Hash] configuration hash containing screen definitions
+        #@raise [QAT::Web::Screen::Loader::InvalidConfigurationError] When an incorrect configuration is found
+        #@since 2.1.0
+        def load_config(config)
+          config.each(&method(:load_screen))
+        end
+
+        # include QAT::Logger
+        # Registers a screen definition
+        #@param name [String] screen name
+        #@param options [String] screen definitions
+        #@raise [QAT::Web::Screen::Loader::InvalidConfigurationError] When an incorrect configuration is found
+        #@since 2.1.0
+        def load_screen(name, options)
+          log.debug { "Parsing #{name}" }
+          parsed_opts = options.dup rescue {}
+
+          raise InvalidConfigurationError.new "Configuration for screen #{name} is empty!" unless parsed_opts&.any?
+
+          parse_resolution name, parsed_opts
+
+          self.screens[name.to_sym] = parsed_opts
+          log.debug { "Parsed #{name}" }
+        end
+
+        #List of known virtual screen definitions
+        #@return [Hash] list of screen definitions
+        #@since 1.0.0
+        def screens
+          @screens ||= { default: {} }
+        end
+
+        private
+
+        def parse_resolution(name, options)
+          raise InvalidConfigurationError.new "No resolution defined for screen #{name}" unless options['resolution']
+
+          res = options.delete 'resolution'
+
+          mandatory_param_check = proc { |key| raise InvalidConfigurationError.new "No mandatory key #{key} in resolution of screen #{name}" }
+
+          height = res.fetch 'height', &mandatory_param_check
+          width  = res.fetch 'width', &mandatory_param_check
+          depth  = res.fetch 'depth', 24
+
+          dim = [width, height, depth].join('x')
+
+          log.debug { "Using #{dim} resolution for screen #{name}" }
+
+          options[:dimensions] = dim
+        end
+
+      end
+      #Configuration load error class.
+      class InvalidConfigurationError < StandardError
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+require_relative '../version'
+require_relative 'loader'
+require 'headless/core_ext/random_display'
+require 'qat/logger'
+
+module QAT::Web
+  module Screen
+
+    #Screen wrapper to represent an abstract display. Can have a Headless instance associated.
+    #@since 1.0.0
+    class Wrapper
+      include QAT::Logger
+
+      #@return [String] Screen name
+      #@since 1.0.0
+      attr_reader :name
+
+      #@return [Hash] Initialization options
+      #@since 1.0.0
+      attr_reader :options
+
+      #@return [String] Screen width
+      #@since 1.0.0
+      attr_reader :width
+
+      #@return [String] Screen height
+      #@since 1.0.0
+      attr_reader :height
+
+      #@return [String] Screen depth
+      #@since 1.0.0
+      attr_reader :depth
+
+      #@return [Headless] Xvfb instance representing the screen
+      #@since 1.0.0
+      attr_reader :xvfb
+
+      # Video recording configurations exception
+      # @since 2.0.1
+      class VideoRecordingConfigError < StandardError
+      end
+
+      #Create a new screen.
+      #@param name [String] screen name
+      #@param options [Hash] start options
+      #@option options [String] :dimensions Screen dimensions ('800x600x24')
+      #@since 1.0.0
+      def initialize name, options
+        @name    = name
+        @options = options
+        parse_resolution options
+        log.info "Created screen with #{width}x#{height}x#{depth}"
+        @xvfb = nil
+      end
+
+      #Start a new Xvfb instance
+      #@return [Headless] Xvfb instance
+      #@since 1.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
+
+      #Destroy the Xvfb instance
+      #@since 1.0.0
+      def destroy
+        return unless @xvfb
+        @xvfb.destroy
+        log.info "Xvfb #{name} screen destroyed"
+        @xvfb = nil
+      end
+
+      #Redirect all unknown methods to the Xvfb instance
+      #@since 1.0.0
+      def method_missing method, *args, &block
+        @xvfb.method(method).call *args, &block
+      end
+
+      private
+
+      def parse_resolution options
+        options[:dimensions] ||= '800x600x24'
+
+        @width, @height, @depth = options[:dimensions].split 'x'
+        @depth                  ||= 24
+      end
+    end
+
+  end
+end

data/lib/qat/web/version.rb

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

metadata

@@ -0,0 +1,278 @@
+--- !ruby/object:Gem::Specification
+name: qat-web
+version: !ruby/object:Gem::Version
+  version: 6.0.0
+platform: ruby
+authors:
+- QAT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: qat-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: qat-devel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: headless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: syntax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: qat-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: little-plugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: retriable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+    QAT-Web is a browser controller for Web testing, with support for various browsers and webdrivers.
+    Includes various classes for easier planning and implementation of web interactions, using the Page Objects Pattern.
+email: qatoolkit@readinessit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/capybara/core_ext.rb
+- lib/capybara/core_ext/capybara_error.rb
+- lib/capybara/core_ext/node/element.rb
+- lib/capybara/core_ext/selenium/node.rb
+- lib/headless/core_ext/random_display.rb
+- lib/qat/cli/plugins/web.rb
+- lib/qat/web.rb
+- lib/qat/web/browser.rb
+- lib/qat/web/browser/autoload.rb
+- lib/qat/web/browser/factory.rb
+- lib/qat/web/browser/firefox/harexporttrigger-0.5.0-beta.10.xpi
+- lib/qat/web/browser/firefox/loader/helper.rb
+- lib/qat/web/browser/html_dump.rb
+- lib/qat/web/browser/loader.rb
+- lib/qat/web/browser/profile.rb
+- lib/qat/web/browser/screenshot.rb
+- lib/qat/web/configuration.rb
+- lib/qat/web/cucumber.rb
+- lib/qat/web/drivers.rb
+- lib/qat/web/drivers/chrome.rb
+- lib/qat/web/drivers/default.rb
+- lib/qat/web/drivers/firefox.rb
+- lib/qat/web/drivers/firefox/har_exporter.rb
+- lib/qat/web/elements.rb
+- lib/qat/web/elements/base.rb
+- lib/qat/web/elements/collection.rb
+- lib/qat/web/elements/config.rb
+- lib/qat/web/elements/element.rb
+- lib/qat/web/elements/selector.rb
+- lib/qat/web/elements/waiters.rb
+- lib/qat/web/error.rb
+- lib/qat/web/error/enrichment.rb
+- lib/qat/web/exceptions.rb
+- lib/qat/web/finders.rb
+- lib/qat/web/hooks/common.rb
+- lib/qat/web/hooks/har_exporter.rb
+- lib/qat/web/hooks/html_dump.rb
+- lib/qat/web/hooks/screenshot.rb
+- lib/qat/web/page.rb
+- lib/qat/web/page/validators.rb
+- lib/qat/web/page_manager.rb
+- lib/qat/web/screen.rb
+- lib/qat/web/screen/autoload.rb
+- lib/qat/web/screen/factory.rb
+- lib/qat/web/screen/loader.rb
+- lib/qat/web/screen/wrapper.rb
+- lib/qat/web/version.rb
+homepage: https://gitlab.readinessit.com/qa-toolkit/qat-web
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: QAT-Web is a browser controller for Web testing
+test_files: []