qat-web 6.0.3 → 7.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0c42697ea27626ec6e4674fa4bfcb15157690095b7f95f17f70c8e011dac68
-  data.tar.gz: a8e5c7815776b985bab6956db5d3c9050b4cbbf2e2a29bebde266ccd3401cbcf
+  metadata.gz: 0aadd76d0544542a1d7b1ec9a392ddbc5049fb6f137a8f9d65f816ad1a277281
+  data.tar.gz: 1947029c65e7cec67c756e23092b72d5da026bf400996c67f61d1d5c43ee2ca0
 SHA512:
-  metadata.gz: 5b9b51572bca22fe718f253c153af8282674f588250ee7cb549e9c625c0ed20fc60752f239668e31c9981a1d13f0ed53987c59840f19e0668660af810ef9c60a
-  data.tar.gz: ea161b61cc1e98e8daeeafdff7b0620d791e505886c26cd3384d18c26bd19ccb5376bf8a7b999102ac5c82b104f9f261a3ff41ca5bb5a2aa52590191c47a1d6b
+  metadata.gz: f23e24e6e48a67fb47cb9cbf9ece4f9ff2c6da5ee0e0cc5474a2c3a590908dfd740c3369500741798013a0f73fec4ea612ce1aead9d76c654ba0bca9b9dda867
+  data.tar.gz: af97afa92c26af6a3153099b4698373865659aa5155a6e82c1a92ed3b6d9bfcab49a78324bc955db1f92f625600e764cf3b0fc310897a1271be01fa7a532ed46

data/lib/qat/cli.rb

@@ -0,0 +1,52 @@
+require 'little-plugger'
+
+module QAT
+  #Module for CLI functions
+  #@since 6.1.0
+  module CLI
+    #Module as namespace for plugin definition
+    #@since 6.1.0
+    module Plugins
+      #Placeholder
+    end
+    # @!parse extend LittlePlugger
+    send :extend, LittlePlugger( :path => 'qat/cli/plugins', :module => ::QAT::CLI::Plugins )
+
+    #Lists all registered extentions/plugins
+    #@since 6.1.0
+    def self.list_extentions
+      plugins.keys.map(&:to_s).sort
+    end
+
+    #Call add_module in a given plugin.
+    #@param mod [String,Symbol] name of the plugin to call
+    #@param stdout [IO] stdout stream
+    #@param opts [Hash] options hash
+    #@raise ArgumentError When module does not exist
+    #@since 6.1.0
+    def self.add_module mod, stdout, opts
+      raise ArgumentError.new "Module #{mod} is not a plugin!" unless has_module? mod
+
+      loaded_mod = plugins[mod.to_sym]
+
+      if loaded_mod.respond_to? :add_module
+        meth = loaded_mod.method :add_module
+        unless meth.arity == 2 || meth.arity < 0
+          raise ArgumentError.new "Invalid implementation of add_module in #{mod}: should have 2 parameters: stdout, opts"
+        end
+        meth.call stdout, opts
+      else
+        stdout.puts "Nothing to add in #{mod}"
+      end
+    end
+
+
+    #Check if a plugin exists
+    #@param mod [String,Symbol] name of the plugin to call
+    #@return [true,false] true if the plugin exists
+    #@since 6.1.0
+    def self.has_module? mod
+      return plugins.has_key? mod.to_sym
+    end
+  end
+end

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

@@ -1,7 +1,26 @@
-require_relative '../../web/version'
+require_relative '../../web/generator'
 
 #Plugin for CLI functions
-#@since 1.0.0
-module QAT::CLI::Plugins::Web
+#@since 6.1.0
+module QAT
+  #CLI module from QAT::Web.
+  #@since 6.1.0
+  module CLI
+    #Plugin namespace for CLI module from QAT::Web.
+    #@since 6.1.0
+    module Plugins
+      #Plugin for CLI functions
+      #@since 6.1.0
+      module Web
 
+        #Function for adding the Logger module to a project. Just used for testing, does nothing.
+        #@param stdout [IO] Stdout stream
+        #@param opts [Hash] Options hash
+        #@since 6.1.0
+        def self.add_module stdout, opts
+          QAT::Web::Generator.add_module(stdout, opts)
+        end
+      end
+    end
+  end
 end

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

@@ -17,23 +17,36 @@ module QAT::Web
       #@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 { "Saving HTML dump to #{path}" }
+        path = read_html_dump page ,path
         log.info { "HTML dump available" }
-        ::File.basename(path)
+        path
       rescue Capybara::NotSupportedByDriverError
         log.warn { "Driver #{page.mode} does not support HTML dumps!" }
         return nil
       end
 
+
+      ##Helper for reading file, in cucumber 6 this could be reverted to path directly
+      def read_html_dump page, dump_path
+        file = page.save_page dump_path
+        dump_path_read = File.open file
+        dump_path_read.read
+      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
 
+      def html_dump_filename
+        File.basename(@html_dump_path)
+      end
+
       #Set new default HTML dump path.
       #@param path [String] HTML dump path
       #@since 1.0.0

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

@@ -16,17 +16,29 @@ module QAT::Web
       #@param path [String] File path to save screenshot file
       #@return [String/NilClass]File path to where the screenshot file was saved or nil if the browser doesn't support screenshots
       #@since 1.0.0
-      def take_screenshot page=Capybara.current_session, path=screenshot_path
-        log.info {"Saving screenshot to #{path}"}
+      def take_screenshot page = Capybara.current_session ,  path = screenshot_path
+        log.info { "Saving screenshot to #{path}" }
         raise ArgumentError.new "File #{path} already exists! Choose another filename" if ::File.exists? path
-        path = page.save_screenshot path
-        log.info {"Screenshot available"}
+        path = read_screenshot_file page, path
+        log.info { "Screenshot available" }
         path
       rescue Capybara::NotSupportedByDriverError
         log.warn {"Driver #{page.mode} does not support screenshots!"}
         return nil
       end
 
+      ##Helper for reading file, in cucumber 6 this could be reverted to path directly
+      def read_screenshot_file page, image_path
+        file            = page.save_page image_path
+        image_path_read = File.open file
+        image_path_read.read
+      end
+
+
+      def screenshot_filename
+        File.basename(@screenshot_path)
+      end
+
       #Default screenshot path. Can be set with {#screenshot_path=}.
       #@return [String] Screenshot path
       #@since 1.0.0

data/lib/qat/web/generator.rb

@@ -0,0 +1,57 @@
+require_relative '../../../lib/qat/web/version'
+require 'fileutils'
+require 'gemnasium/parser'
+
+module QAT::Web
+  #Module for the various generators used in the CLI utility
+  #@since 6.1.0
+  module Generator
+    include FileUtils
+    extend FileUtils
+    # Adds a files QAT Web module to the current project
+    def add_module(stdout, opts)
+      stdout.puts "Adding files to project" if opts[:verbose]
+
+      # Read GemFile of new project
+      path = File.join(Dir.pwd, 'Gemfile')
+      has_qatweb = verify_gems path, 'qat-web', verbose: opts[:verbose]
+      if has_qatweb
+        puts "Module already integrated"
+      else
+        add_gem_dependency path, 'qat-web', verbose: opts[:verbose], version: QAT::Web::VERSION
+        add_gem_dependency path, 'headless', verbose: opts[:verbose]
+        add_gem_dependency path, 'selenium-webdriver', verbose: opts[:verbose]
+        cp_r ::File.join(::File.dirname(__FILE__), 'generator', 'project', '.'), Dir.pwd, opts
+      end
+    end
+
+    def verify_gems (gemfile_path, gem, opts = {})
+      file = File.read(gemfile_path)
+      gemfile = Gemnasium::Parser.gemfile(file)
+      dependencies = gemfile.dependencies
+      found_gem = dependencies.find {|i| i.name == gem}
+      puts "Found gem: #{found_gem}"
+      puts "gem #{gem} found? #{!found_gem.nil?}" if opts[:verbose]
+
+      if found_gem
+        return true
+      else
+        return false
+      end
+    end
+
+    def add_gem_dependency (gemfile_path, gem, opts = {})
+      version = opts[:version]
+      line = "\n\ngem '#{gem}'#{version ? ", '>= #{version}'" : ''}"
+      puts "adding dependencies #{gem} to Gemfile" if opts[:verbose]
+      write_to_gemfile gemfile_path, line
+    end
+
+
+    def write_to_gemfile filename, line
+      ::File.write(filename, line, mode: 'a')
+    end
+
+    module_function :add_module, :write_to_gemfile, :add_gem_dependency, :verify_gems
+  end
+end

data/lib/qat/web/generator/project/config/common/browsers.yml

@@ -0,0 +1,5 @@
+firefox:
+  browser: firefox
+  screen: screen_1080p
+  properties:
+    geo.enabled: false

data/lib/qat/web/generator/project/config/common/qat/web/home.yml

@@ -0,0 +1,4 @@
+locators:
+  locator_name_example:
+    xpath: .//*[@name='q']
+    wait: timeouts.browser.medium

data/lib/qat/web/generator/project/config/common/qat/web/page.yml

@@ -0,0 +1,4 @@
+locators:
+  locator_name_example:
+    xpath: .//a[@title='selector_example']
+    wait: timeouts.browser.medium

data/lib/qat/web/generator/project/config/common/screens.yml

@@ -0,0 +1,10 @@
+screen_1080p: &screen_1080p
+  resolution:
+    width: 1920
+    height: 1080
+  video:
+    provider: ffmpeg
+    log_file_path: <%= File.join 'public', 'video.log' %>
+    codec: libx264
+    frame_rate: 12
+    extra: -pix_fmt yuvj420p

data/lib/qat/web/generator/project/config/common/timeouts.yml

@@ -0,0 +1,7 @@
+browser:
+  small: 5
+  medium: 15
+  big: 30
+  huge: 60
+  go_grab_a_coffee: 120
+  bathroom_break: 360

data/lib/qat/web/generator/project/features/step_definitions/steps.rb

@@ -0,0 +1,7 @@
+When(/^I navigate to home page$/) do
+  browser.navigate_home!
+end
+
+Then(/^I can interact with home page$/) do
+  browser.input_search "Test Automation"
+end

data/lib/qat/web/generator/project/features/support/env_qat_web.rb

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+############################################
+# Requires for your code libraries go here #
+############################################
+require 'selenium-webdriver'
+require 'qat/cucumber'
+require 'qat/configuration'
+require 'qat/web'
+require 'qat/web/cucumber'
+require_relative '../../lib/web/world'
+require 'qat/core_ext/integer'
+
+World ProjectName::Web::World
+
+ENV['FIREFOX_PATH']&.tap do |path|
+  Selenium::WebDriver::Firefox::Binary.path = path
+end

data/lib/qat/web/generator/project/features/web_example.feature

@@ -0,0 +1,11 @@
+@epic#1 @feature#2 @user_story#3 @dummy_feature
+Feature: some feature
+  In order to do something
+  As someone
+  I want to specify scenarios
+
+
+  @test#10 @dummy_test
+  Scenario: Navigate to google page
+    When I navigate to home page
+    Then I can interact with home page

data/lib/qat/web/generator/project/lib/web.rb

@@ -0,0 +1,2 @@
+require_relative 'web/pages'
+require_relative 'web/page_manager'

data/lib/qat/web/generator/project/lib/web/page_manager.rb

@@ -0,0 +1,11 @@
+require_relative 'pages'
+require 'qat/web/page_manager'
+
+#Project name Module
+module ProjectName::Web
+  #Class PageManager
+  class PageManager < QAT::Web::PageManager
+    manages ProjectName::Web::Pages::Base
+    initial_page ProjectName::Web::Pages::Blank
+  end
+end

data/lib/qat/web/generator/project/lib/web/pages.rb

@@ -0,0 +1,3 @@
+require_relative 'pages/base'
+require_relative 'pages/blank'
+require_relative 'pages/home'

data/lib/qat/web/generator/project/lib/web/pages/base.rb

@@ -0,0 +1,27 @@
+require 'capybara/dsl'
+require 'qat/logger'
+require 'qat/configuration'
+require 'qat/web/page'
+require 'qat/web/finders'
+
+#Project name Module
+module ProjectName
+  #Web name Module
+  module Web
+    #Page name Module
+    module Pages
+      #Class base
+      class Base < QAT::Web::Page
+        include Capybara::DSL
+        include QAT::Logger
+        include QAT::Web::Finders
+
+        # Action to navigate to your home page
+        action :navigate_home!, returns: [ProjectName::Web::Pages::Base] do
+          visit 'https://www.google.com'
+          ProjectName::Web::Pages::Home.new
+        end
+      end
+    end
+  end
+end

data/lib/qat/web/generator/project/lib/web/pages/blank.rb

@@ -0,0 +1,5 @@
+require_relative 'base'
+
+#Blank class
+class ProjectName::Web::Pages::Blank < ProjectName::Web::Pages::Base
+end

data/lib/qat/web/generator/project/lib/web/pages/home.rb

@@ -0,0 +1,35 @@
+require_relative 'base'
+
+#Project name Module
+module ProjectName
+  #Web name Module
+  module Web
+    #Page Object Pages
+    module Pages
+      #Home page
+      class Home < ProjectName::Web::Pages::Base
+        include QAT::Logger
+
+        elements_config QAT.configuration.dig(:qat, :web, :home)
+
+        web_elements :locator_name_example
+
+        def initialize
+          raise HomePageNotLoaded.new 'Home page was not loaded!' unless has_selector? *selector_locator_name_example
+          log.info "Loaded home page with URL: #{current_url}"
+        end
+
+        #Introduce text on search box
+        def input_search search_text
+          locator_name_example.set search_text
+        end
+
+        private
+
+        #Exception class error
+        class HomePageNotLoaded < QAT::Web::Error
+        end
+      end
+    end
+  end
+end

data/lib/qat/web/generator/project/lib/web/world.rb

@@ -0,0 +1,23 @@
+require_relative 'page_manager'
+
+QAT::Web::Browser::AutoLoad.load_browsers!
+QAT::Web::Screen::AutoLoad.load_screens!
+
+#Project name Module
+module ProjectName
+  #Web name Module
+  module Web
+    #World name Module
+    module World
+      #Initialise browser
+      def browser
+        unless @browser
+          QAT::Web::Browser::Factory.for :firefox
+          @browser = ProjectName::Web::PageManager.new
+        end
+        @browser
+      end
+
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ After do |scenario|
   if scenario.failed?
     if QAT::Web::Exceptions::HTML_DUMP.any? { |exception| scenario.exception.kind_of?(exception) }
       # Embeds an existing HTML dump to Cucumber's HTML report
-      embed(QAT::Web::Browser::HTMLDump.take_html_dump, 'text/plain', 'HTML dump')
+      attach(QAT::Web::Browser::HTMLDump.take_html_dump, 'text/html')
     end
   end
 end

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

@@ -14,7 +14,7 @@ end
 After do |scenario|
   if scenario.failed?
     if QAT::Web::Exceptions::SCREENSHOT.any? { |exception| scenario.exception.kind_of?(exception) }
-      embed QAT::Web::Browser::Screenshot.take_screenshot, 'image/png', 'Screenshot'
+      attach QAT::Web::Browser::Screenshot.take_screenshot, 'image/png'
     end
   end
 end

data/lib/qat/web/version.rb

@@ -4,6 +4,6 @@ module QAT
 #@since 1.0.0
   module Web
     # Represents QAT-Web's version
-    VERSION = '6.0.3'
+    VERSION = '7.0.0.rc.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qat-web
 version: !ruby/object:Gem::Version
-  version: 6.0.3
+  version: 7.0.0.rc.1
 platform: ruby
 authors:
 - QAT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: qat-cucumber
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 7.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 7.0.3
 - !ruby/object:Gem::Dependency
   name: qat-devel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: headless
   requirement: !ruby/object:Gem::Requirement
@@ -126,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: little-plugger
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +196,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gemnasium-parser
+  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.
@@ -209,6 +223,7 @@ files:
 - lib/capybara/core_ext/node/element.rb
 - lib/capybara/core_ext/selenium/node.rb
 - lib/headless/core_ext/random_display.rb
+- lib/qat/cli.rb
 - lib/qat/cli/plugins/web.rb
 - lib/qat/web.rb
 - lib/qat/web/browser.rb
@@ -238,6 +253,22 @@ files:
 - lib/qat/web/error/enrichment.rb
 - lib/qat/web/exceptions.rb
 - lib/qat/web/finders.rb
+- lib/qat/web/generator.rb
+- lib/qat/web/generator/project/config/common/browsers.yml
+- lib/qat/web/generator/project/config/common/qat/web/home.yml
+- lib/qat/web/generator/project/config/common/qat/web/page.yml
+- lib/qat/web/generator/project/config/common/screens.yml
+- lib/qat/web/generator/project/config/common/timeouts.yml
+- lib/qat/web/generator/project/features/step_definitions/steps.rb
+- lib/qat/web/generator/project/features/support/env_qat_web.rb
+- lib/qat/web/generator/project/features/web_example.feature
+- lib/qat/web/generator/project/lib/web.rb
+- lib/qat/web/generator/project/lib/web/page_manager.rb
+- lib/qat/web/generator/project/lib/web/pages.rb
+- lib/qat/web/generator/project/lib/web/pages/base.rb
+- lib/qat/web/generator/project/lib/web/pages/blank.rb
+- lib/qat/web/generator/project/lib/web/pages/home.rb
+- lib/qat/web/generator/project/lib/web/world.rb
 - lib/qat/web/hooks/common.rb
 - lib/qat/web/hooks/har_exporter.rb
 - lib/qat/web/hooks/html_dump.rb
@@ -264,15 +295,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: QAT-Web is a browser controller for Web testing