ruby_raider 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36188ec04973b3250dce20a65362ad77cd87c6f5aa255977f66d024ebdf40d65
-  data.tar.gz: d7c704bf859d9ac8e73fd76260565545a65eb48d483c9766a2b7daa5aa2a1050
+  metadata.gz: f7b2c000c852222f35914766b001264de3988fc1d4c2baa7b28504c885dad43a
+  data.tar.gz: d791271be3eb3118dfde048a732a672f5c5a65b80975ce7ea9f061504ca7b594
 SHA512:
-  metadata.gz: f0d684f51de9dec607f6ce7e53fc95451f56bca9025e278d77e466c0030dfd7544be756260037cd99a80bd5969e941b4e0ec1c19c174cb9d4a841ddd25674ea0
-  data.tar.gz: 2c6edaf85dc0084a817e619c28fc5147d346178a7ab9d9bb359774a3cefc4b6180fabeb5e4eb41f513f07a81379c74270374f5aab3737aac0b488528be12aca9
+  metadata.gz: 162584ae4fed3dacba0ee826fd707243d4150f1cfbabf00a40d1de0dd1433ac52e38157a9d553fef2d192ff31e7c8203b89d77cbfe8ea1bd709a479e4082d51c
+  data.tar.gz: 328caadb18a48ae8f103b79e91cf12b365139d5854e3f4e1a28bd27436de8bf04f5270e51a6aeddc9c4c19df1c55c97251e3bc2f20e5f5fdc8f7f24798502463

data/lib/commands/utility_commands.rb

@@ -80,4 +80,22 @@ class UtilityCommands < Thor
   end
 
   map '-pl' => 'platform'
+
+  desc 'download_builds [build_type]', 'It downloads the example builds for appium projects'
+  def download_builds(build_type)
+    if %w[android, ios, both].include?(build_type)
+      raise 'Please select one of the following build types: android, ios, both'
+    end
+
+    Utilities.new.download_builds build_type
+  end
+
+  map '-d' => 'download_builds'
+
+  desc 'version', 'It shows the version of Ruby Raider you are currently using'
+  def version
+    Utilities.new.version
+  end
+
+  map '-v' => 'version'
 end

data/lib/generators/automation_generator.rb

@@ -27,12 +27,14 @@ class AutomationGenerator < Generator
 
   def generate_header_component
     return unless (@_initializer.first & %w[android ios cross_platform]).empty?
+    return if @_initializer.first.last
 
     template('automation/component.tt', "#{name}/page_objects/components/header_component.rb")
   end
 
   def generate_abstract_component
     return unless (@_initializer.first & %w[android ios cross_platform]).empty?
+    return if @_initializer.first.last
 
     template('automation/abstract_component.tt', "#{name}/page_objects/abstract/abstract_component.rb")
   end
@@ -42,4 +44,16 @@ class AutomationGenerator < Generator
 
     template('automation/appium_caps.tt', "#{name}/config/capabilities.yml")
   end
+
+  def generate_app_page
+    return unless @_initializer.first.last
+
+    template('automation/app_page.tt', "#{name}/page_objects/pages/app_page.rb")
+  end
+
+  def generate_visual_options
+    return unless @_initializer.first.last
+
+    template('automation/visual_options.tt', "#{name}/config/options.yml")
+  end
 end

data/lib/generators/common_generator.rb

@@ -22,10 +22,10 @@ class CommonGenerator < Generator
   end
 
   def create_allure_folder
-    empty_directory "#{name}/allure-results"
+    empty_directory "#{name}/allure-results" unless @_initializer.first.last
   end
 
   def create_screenshots_folder
-    empty_directory "#{name}/allure-results/screenshots"
+    empty_directory "#{name}/allure-results/screenshots" unless @_initializer.first.last
   end
 end

data/lib/generators/generator.rb

@@ -8,6 +8,7 @@ class Generator < Thor::Group
   argument :automation
   argument :framework
   argument :name
+  argument :visual_automation, optional: true
 
   def self.source_root
     "#{File.dirname(__FILE__)}/templates"

data/lib/generators/helper_generator.rb

@@ -8,6 +8,8 @@ class HelpersGenerator < Generator
   end
 
   def generate_allure_helper
+    return if @_initializer.first.last
+
     template('helpers/allure_helper.tt', "#{name}/helpers/allure_helper.rb")
   end
 
@@ -16,6 +18,8 @@ class HelpersGenerator < Generator
   end
 
   def generate_spec_helper
+    return if @_initializer.first.last
+
     template('helpers/spec_helper.tt', "#{name}/helpers/spec_helper.rb") if @_initializer.first.include?('rspec')
   end
 
@@ -31,9 +35,21 @@ class HelpersGenerator < Generator
     template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
   end
 
-  def generate_pdp_page
+  def generate_appium_helper
     return unless @_initializer.first.include?('cross_platform')
 
     template('helpers/appium_helper.tt', "#{name}/helpers/appium_helper.rb")
   end
+
+  def generate_visual_helper
+    return unless @_initializer.first.last
+
+    template('helpers/visual_helper.tt', "#{name}/helpers/visual_helper.rb")
+  end
+
+  def generate_visual_spec_helper
+    return unless @_initializer.first.last
+
+    template('helpers/visual_spec_helper.tt', "#{name}/helpers/spec_helper.rb")
+  end
 end

data/lib/generators/menu_generator.rb

@@ -25,14 +25,22 @@ class MenuGenerator
     end
   end
 
+  def choose_visual_automation
+    prompt.select('Do you want to add visual automation with applitools?') do |menu|
+      menu.choice :Yes, -> { true  }
+      menu.choice :No, -> { false }
+      menu.choice :Quit, -> { exit }
+    end
+  end
+
   def choose_test_framework(automation)
     return choose_mobile_platform if automation == 'appium'
 
     select_test_framework(automation)
   end
 
-  def set_up_framework(automation, framework)
-    generate_framework(automation, framework)
+  def set_up_framework(automation, framework, visual_automation)
+    generate_framework(automation, framework, visual_automation)
     system "cd #{name} && gem install bundler && bundle install"
   end
 
@@ -45,9 +53,9 @@ class MenuGenerator
     end
   end
 
-  def generate_framework(automation, framework)
+  def generate_framework(automation, framework, visual_automation)
     add_generator framework.capitalize
-    generators.each { |generator| invoke_generator(automation, framework, generator) }
+    generators.each { |generator| invoke_generator(automation, framework, generator, visual_automation) }
   end
 
   protected
@@ -59,7 +67,11 @@ class MenuGenerator
   private
 
   def framework_choice(framework, automation_type)
-    set_up_framework(automation_type, framework.downcase)
+    visual_automation = if automation_type == 'selenium' && framework == 'Rspec'
+                          choose_visual_automation
+                        end
+
+    set_up_framework(automation_type, framework.downcase, visual_automation)
     prompt.say("You have chosen to use #{framework} with #{automation_type}")
   end
 
@@ -75,7 +87,7 @@ class MenuGenerator
     end
   end
 
-  def invoke_generator(automation, framework, generator)
-    Object.const_get("#{generator}Generator").new([automation, framework, name]).invoke_all
+  def invoke_generator(automation, framework, generator, visual_automation)
+    Object.const_get("#{generator}Generator").new([automation, framework, name, visual_automation]).invoke_all
   end
 end

data/lib/generators/templates/automation/abstract_page.tt

@@ -7,4 +7,8 @@ class AbstractPage
 <%= ERB.new(File.read(File.expand_path('./partials/initialize_selector.tt', __dir__))).result(binding) -%>
 <%= ERB.new(File.read(File.expand_path('./partials/visit_method.tt', __dir__))).result(binding) -%>
 <%= ERB.new(File.read(File.expand_path('./partials/url_methods.tt', __dir__))).result(binding) -%>
+
+  def to_s
+    self.class.to_s.sub('Page', ' Page')
+  end
 end

data/lib/generators/templates/automation/app_page.tt

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/abstract_page'
+
+class AppPage < AbstractPage
+  using Raider::SeleniumHelper
+
+  def url(_page)
+    'app.html#'
+  end
+end

data/lib/generators/templates/automation/login_page.tt

@@ -1,6 +1,7 @@
-<% case automation
- when 'selenium' -%>
+<% if automation == 'selenium' && visual_automation == true %>
+<%= ERB.new(File.read(File.expand_path('./partials/visual_login.tt', __dir__))).result(binding) %>
+<% elsif automation == 'selenium' %>
 <%= ERB.new(File.read(File.expand_path('./partials/selenium_login.tt', __dir__))).result(binding) %>
-<% when 'watir' -%>
+<% elsif automation == 'watir' %>
 <%= ERB.new(File.read(File.expand_path('./partials/watir_login.tt', __dir__))).result(binding) %>
-<% end -%>
+<% end %>

data/lib/generators/templates/automation/partials/visual_login.tt

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/abstract_page'
+
+class LoginPage < AbstractPage
+  using Raider::SeleniumHelper
+
+  def url(_page)
+    'index.html'
+  end
+
+  # Actions
+
+  def login
+    login_button.click_when_present
+  end
+
+  private
+
+  # Elements
+
+  def login_button
+    driver.find_element(:id, 'log-in')
+  end
+end

data/lib/generators/templates/automation/visual_options.tt

@@ -0,0 +1,16 @@
+:batch_name: test_batch
+:app_name: test_app
+:test_name: app_test
+
+:viewport_size:
+  :height: 800
+  :width: 600
+
+:browsers:
+  - :name: chrome
+    :height: 800
+    :width: 600
+
+:devices:
+  - :name: IPhoneX
+    :orientation: PORTRAIT

data/lib/generators/templates/common/gemfile.tt

@@ -1,13 +1,20 @@
 source 'https://rubygems.org'
 
 gem 'activesupport'
+<% unless visual_automation -%>
 gem 'allure-rspec'
 gem 'allure-ruby-commons'
+<% end -%>
 <% if framework == 'cucumber' -%>
 gem 'allure-cucumber'
 <% end -%>
+<% if visual_automation -%>
+gem 'eyes_selenium'
+<% end -%>
+<% unless visual_automation -%>
 gem 'parallel_split_test'
 gem 'parallel_tests'
+<% end -%>
 gem 'rake'
 gem '<%= framework %>'
 <% if framework == 'cucumber' -%>

data/lib/generators/templates/common/partials/web_config.tt

@@ -1,2 +1,6 @@
 browser: :chrome
-url: 'https://automationteststore.com/'
+<% if visual_automation == true %>
+url: 'https://demo.applitools.com/'
+<% else %>
+url: 'https://automationteststore.com/'
+<% end %>

data/lib/generators/templates/helpers/raider_helper.tt

@@ -10,8 +10,13 @@ module Raider
 <% else -%>
   require_relative 'driver_helper'
 <% end -%>
+<% unless visual_automation -%>
   require_relative 'allure_helper'
+<% end -%>
 <% if automation == 'cross_platform' -%>
   require_relative 'appium_helper'
 <% end -%>
+<% if visual_automation -%>
+  require_relative 'visual_helper'
+<% end -%>
 end

data/lib/generators/templates/helpers/visual_helper.tt

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'eyes_selenium'
+require 'yaml'
+
+module Raider
+  module VisualHelper
+    attr_reader :eyes
+
+    SELENIUM = Applitools::Selenium
+    VISUAL_GRID = SELENIUM::VisualGridRunner
+    EYES = SELENIUM::Eyes
+    TARGET = SELENIUM::Target
+    BATCHINFO = Applitools::BatchInfo
+    REGTANGLE_SIZE = Applitools::RectangleSize
+
+    def create_grid_runner(concurrency = 1)
+      VISUAL_GRID.new(concurrency)
+    end
+
+    def create_eyes(grid_runner)
+      EYES.new(runner: grid_runner)
+    end
+
+    def check_page(page)
+      page = format_page(page)
+      @eyes.check(page, TARGET.window.fully)
+    end
+
+    def configure_eyes(eyes, options = nil)
+      options ||= YAML.load_file('config/options.yml')
+
+      eyes.configure do |conf|
+        #  You can get your api key from the Applitools dashboard
+        general_config(options, conf)
+        add_browsers(options[:browsers], conf)
+        add_devices(options[:devices], conf)
+      end
+    end
+
+    def format_page(page)
+      page.instance_of?(String) ? page : page.to_s
+    end
+
+    def add_browsers(browsers, conf)
+      browsers.each do |browser|
+        conf.add_browser(browser[:height], browser[:width], "BrowserType::#{browser[:name].upcase}".constantize)
+      end
+    end
+
+    def add_devices(devices, conf)
+      devices.each do |device|
+        conf.add_device_emulation("Devices::#{device[:name]}".constantize,
+                                  "Orientation::#{device[:orientation]}".constantize)
+      end
+    end
+
+    def general_config(options, conf)
+      conf.api_key = ENV['APPLITOOLS_API_KEY']
+      conf.batch = BATCHINFO.new(options[:batch_name])
+      conf.app_name = options[:app_name]
+      conf.test_name = options[:test_name]
+      conf.viewport_size = REGTANGLE_SIZE.new(options[:viewport_size][:height], options[:viewport_size][:width])
+    end
+  end
+end

data/lib/generators/templates/helpers/visual_spec_helper.tt

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'eyes_selenium'
+require_relative 'driver_helper'
+require_relative 'visual_helper'
+
+module Raider
+  module SpecHelper
+    RSpec.configure do |config|
+      config.include(DriverHelper)
+      config.include(VisualHelper)
+      config.before(:each) do
+        OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+        @grid_runner = create_grid_runner
+        @eyes = create_eyes(@grid_runner)
+        configure_eyes @eyes
+        @driver = @eyes.open(driver: new_driver)
+      end
+
+      config.after(:each) do
+        @eyes.close
+        @driver.quit
+        @eyes.abort_async
+        results = @grid_runner.get_all_test_results
+        puts results
+      end
+    end
+  end
+end

data/lib/generators/templates/rspec/spec.tt

@@ -1,4 +1,26 @@
-<% if %w[selenium watir].include? automation -%>
+<% if automation == 'selenium' && visual_automation == true %>
+# frozen_string_literal: true
+
+require_relative 'base_spec'
+require_relative '../page_objects/pages/login_page'
+require_relative '../page_objects/pages/app_page'
+
+describe 'Login Page' do
+  let(:app_page) { AppPage.new(@driver) }
+  let(:login_page) { LoginPage.new(@driver) }
+
+  before(:example) do
+    login_page.visit
+  end
+
+  it 'looks as expected' do
+    check_page login_page
+    login_page.login
+    check_page app_page
+  end
+end
+
+<% elsif %w[selenium watir].include? automation -%>
 require_relative 'base_spec'
 require_relative '../page_objects/pages/login_page'
 

data/lib/utilities/utilities.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'open-uri'
 
 class Utilities
   def initialize
@@ -66,4 +67,38 @@ class Utilities
   def overwrite_yaml
     File.open(@path, 'w') { |file| YAML.dump(@config, file) }
   end
+
+  def version
+    spec_version = Gem::Specification.load('ruby_raider.gemspec').version
+    puts "The Ruby Raider version is #{spec_version}, Happy testing!"
+  end
+
+  def download_builds(build_type)
+    case build_type
+    when 'android'
+      download_android_build
+    when 'ios'
+      download_ios_build
+    else
+      download_android_build
+      download_ios_build
+    end
+  end
+
+  private
+
+  def download_android_build
+    download_build('Android-MyDemoAppRN.1.3.0.build-244.apk',
+                   'https://github.com/saucelabs/my-demo-app-rn/releases/download/v1.3.0/Android-MyDemoAppRN.1.3.0.build-244.apk')
+  end
+
+  def download_ios_build
+    download_build('iOS-Simulator-MyRNDemoApp.1.3.0-162.zip',
+                   'https://github.com/saucelabs/my-demo-app-rn/releases/download/v1.3.0/iOS-Simulator-MyRNDemoApp.1.3.0-162.zip')
+  end
+  def download_build(name, url)
+    open(name, 'wb') do |file|
+      file << open(url).read
+    end
+  end
 end

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.4.4'
+  s.version     = '0.4.5'
   s.summary     = 'A gem to make setup and start of UI automation projects easier'
   s.description = 'This gem has everything you need to start working with test automation'
   s.authors     = ['Agustin Pequeno']

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ RSpec.configure do |config|
   config.before(:all) do
     FRAMEWORKS.each do |framework|
       AUTOMATION_TYPES.each do |automation|
-        MenuGenerator.new("#{framework}_#{automation}").generate_framework(automation, framework)
+        MenuGenerator.new("#{framework}_#{automation}").generate_framework(automation, framework, false)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-27 00:00:00.000000000 Z
+date: 2022-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -155,6 +155,7 @@ files:
 - lib/generators/rspec_generator.rb
 - lib/generators/templates/automation/abstract_component.tt
 - lib/generators/templates/automation/abstract_page.tt
+- lib/generators/templates/automation/app_page.tt
 - lib/generators/templates/automation/appium_caps.tt
 - lib/generators/templates/automation/component.tt
 - lib/generators/templates/automation/home_page.tt
@@ -170,8 +171,10 @@ files:
 - lib/generators/templates/automation/partials/selenium_login.tt
 - lib/generators/templates/automation/partials/url_methods.tt
 - lib/generators/templates/automation/partials/visit_method.tt
+- lib/generators/templates/automation/partials/visual_login.tt
 - lib/generators/templates/automation/partials/watir_login.tt
 - lib/generators/templates/automation/pdp_page.tt
+- lib/generators/templates/automation/visual_options.tt
 - lib/generators/templates/common/config.tt
 - lib/generators/templates/common/gemfile.tt
 - lib/generators/templates/common/partials/automation_gems.tt
@@ -204,6 +207,8 @@ files:
 - lib/generators/templates/helpers/raider_helper.tt
 - lib/generators/templates/helpers/selenium_helper.tt
 - lib/generators/templates/helpers/spec_helper.tt
+- lib/generators/templates/helpers/visual_helper.tt
+- lib/generators/templates/helpers/visual_spec_helper.tt
 - lib/generators/templates/rspec/base_spec.tt
 - lib/generators/templates/rspec/spec.tt
 - lib/ruby_raider.rb
@@ -240,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A gem to make setup and start of UI automation projects easier