qat-web 6.0.3 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0c42697ea27626ec6e4674fa4bfcb15157690095b7f95f17f70c8e011dac68
-  data.tar.gz: a8e5c7815776b985bab6956db5d3c9050b4cbbf2e2a29bebde266ccd3401cbcf
+  metadata.gz: d8d68e9065fad78da0faeae6edd261f76f9c2afca7a4b6a9c9032603edffea21
+  data.tar.gz: 5530cb9a8c37d1d930297c270a780c4e1a89516d370e3e25e142c2c50a3c3f70
 SHA512:
-  metadata.gz: 5b9b51572bca22fe718f253c153af8282674f588250ee7cb549e9c625c0ed20fc60752f239668e31c9981a1d13f0ed53987c59840f19e0668660af810ef9c60a
-  data.tar.gz: ea161b61cc1e98e8daeeafdff7b0620d791e505886c26cd3384d18c26bd19ccb5376bf8a7b999102ac5c82b104f9f261a3ff41ca5bb5a2aa52590191c47a1d6b
+  metadata.gz: 7174abc47b1c79a9bed227ba151d9769bd4b660194137b21e820ce7ab0970616b265eab2924a8a2742831823719ea39f628bbc2925dd757e66c98fd1a0faba23
+  data.tar.gz: 78d04f134561aceb6a00c0ed197d6cf56afcb9002a9bc8018a6951e56533d1e0bd46f332a88c496939c03b103283743f3fed8f6a633e2cb302ba3d1abbbdc4f4

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/generator.rb

@@ -0,0 +1,32 @@
+require_relative '../../../lib/qat/web/version'
+require 'fileutils'
+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]
+      cp_r ::File.join(::File.dirname(__FILE__), 'generator', 'project', '.'), Dir.pwd, opts
+      ::File.write('Gemfile', <<-GEMFILE, mode: 'a')
+      
+
+
+# QAT-Web is a browser controller for Web testing (https://github.com/readiness-it/qat-web)
+gem 'qat-web', '~> 6.1'
+
+# Ruby headless display interface (http://leonid.shevtsov.me/en/headless)
+gem 'headless' #optional
+
+# The next generation developer focused tool for automated testing of webapps (https://github.com/seleniumhq/selenium)
+gem 'selenium-webdriver' #optional
+      GEMFILE
+    end
+
+    module_function :add_module
+  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#4 @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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qat-web
 version: !ruby/object:Gem::Version
-  version: 6.0.3
+  version: 6.1.0
 platform: ruby
 authors:
 - QAT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2019-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: qat-cucumber
@@ -209,6 +209,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 +239,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