ruby_raider 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 717ea9978a9909bc5d4d78f717b8da94ebc7e76945ec638ceeb35bb9aa5a9281
-  data.tar.gz: f6f390ee74bc484a763e4e0daf8f4cd08a5e8ed630d5284656a18efc0bffe91d
+  metadata.gz: 1179dcf5f2664b6adea02db8af1b33883f18d095f9c9b57acf3fa2bb56d68c49
+  data.tar.gz: ad8dc4b695f154191047406e882029b063c4147987adf369c018063d38b414c9
 SHA512:
-  metadata.gz: 61718cc0edcd9dd89d65d25e0aa80032351921495bdcb3b4f69808e93ba448c1c859f2289e8008a94d7efd5987524fc510c8e17bc3e6a19ffa7b0dfa7828aa2c
-  data.tar.gz: ce72aba02cf4813232ba7c3e4b0f5ec8d7688b56194ab066d32c8cd6a95c76f5395b16c5fece33150408191d4c95e15e66dd929d1eab497beb0bd28ed895c87f
+  metadata.gz: d052c0513c67e27313cdcff208ab5ed54a6606722480ab3534b2c84976b0fffd0a8675367b278575ec1181b7a48f695ed08643cee5bf5229c317c136359fc171
+  data.tar.gz: 1130758fd998eecfb68f320968c3993ea5d026c362ebcc22068ae28c4b0301084e0fb9b6d116a8e2f06e14cecba91b25d37d0e4d81595a1e565cc3917c3de512

data/.rubocop.yml

@@ -1,8 +1,5 @@
-require: rubocop-rspec
-
-AllCops:
-  Exclude:
-    - './spec/*'
+require:
+  - rubocop-rspec
 
 # Layout
 Layout/CaseIndentation:
@@ -86,7 +83,7 @@ Style/HashTransformValues:
 
 Style/SafeNavigation:
   Description: "Use &. instead of checking if an object exists"
-  Enabled: false
+  Enabled: true
 
 Style/SingleLineBlockParams:
   Description: 'Enforces the names of some block params.'

data/README.md

@@ -47,6 +47,10 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 * Generating a framework with Cucumber and Appium for Android
 
+* Generating a framework with Rspec and Appium cross platform
+
+* Generating a framework with Cucumber and Appium cross platform
+
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
 
 This works in all the platforms (Tested on Mac OS, Linux and Windows).
@@ -92,6 +96,8 @@ Commands:
   raider page [PAGE_NAME]           # Creates a new page object
   
   raider path [PATH]                # Sets the default path for scaffolding
+
+  raider platform [PLATFORM]        # Sets the default platform for a cross-platform project
   
   raider raid                       # Runs all the tests in a project
   

data/lib/commands/scaffolding_commands.rb

@@ -86,7 +86,7 @@ class ScaffoldingCommands < UtilityCommands
   def scaffold(name)
     if Pathname.new('spec').exist? && !Pathname.new('features').exist?
       Scaffolding.new([name, load_config_path('spec')]).generate_spec
-    elsif Pathname.new('features').exist?
+    else
       Scaffolding.new([name, load_config_path('feature')]).generate_feature
     end
     Scaffolding.new([name, load_config_path('page')]).generate_class
@@ -110,7 +110,7 @@ class ScaffoldingCommands < UtilityCommands
 
   no_commands do
     def load_config_path(type)
-      YAML.load_file('config/config.yml')["#{type}_path"] if YAML.load_file('config/config.yml')
+      YAML.load_file('config/config.yml')["#{type}_path"] if Pathname.new('config/config.yml').exist?
     end
   end
 end

data/lib/commands/utility_commands.rb

@@ -72,4 +72,12 @@ class UtilityCommands < Thor
          type: :string, required: false, desc: 'The path where your config file will be created', aliases: '-p'
   option :delete,
          type: :boolean, required: false, desc: 'This will delete the selected config file', aliases: '-d'
+
+  desc 'platform [platform]', 'Sets the default platform for a cross-platform project'
+
+  def platform(platform)
+    Utilities.new.platform = platform
+  end
+
+  map '-pl' => 'platform'
 end

data/lib/generators/automation_generator.rb

@@ -4,7 +4,7 @@ require_relative 'generator'
 
 class AutomationGenerator < Generator
   def generate_login_page
-    return unless (@_initializer.first & %w[android ios]).empty?
+    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
 
     template('automation/login_page.tt', "#{name}/page_objects/pages/login_page.rb")
   end
@@ -14,32 +14,32 @@ class AutomationGenerator < Generator
   end
 
   def generate_home_page
-    return if (@_initializer.first & %w[android ios]).empty?
+    return if (@_initializer.first & %w[android ios cross_platform]).empty?
 
     template('automation/home_page.tt', "#{name}/page_objects/pages/home_page.rb")
   end
 
   def generate_pdp_page
-    return if (@_initializer.first & %w[android ios]).empty?
+    return if (@_initializer.first & %w[android ios cross_platform]).empty?
 
     template('automation/pdp_page.tt', "#{name}/page_objects/pages/pdp_page.rb")
   end
 
   def generate_header_component
-    return unless (@_initializer.first & %w[android ios]).empty?
+    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
 
     template('automation/component.tt', "#{name}/page_objects/components/header_component.rb")
   end
 
   def generate_abstract_component
-    return unless (@_initializer.first & %w[android ios]).empty?
+    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
 
     template('automation/abstract_component.tt', "#{name}/page_objects/abstract/abstract_component.rb")
   end
 
   def generate_appium_settings
-    return if (@_initializer.first & %w[android ios]).empty?
+    return if (@_initializer.first & %w[android ios cross_platform]).empty?
 
-    template('automation/appium_settings.tt', "#{name}/appium.txt")
+    template('automation/appium_caps.tt', "#{name}/config/capabilities.yml")
   end
 end

data/lib/generators/common_generator.rb

@@ -8,6 +8,8 @@ class CommonGenerator < Generator
   end
 
   def generate_config_file
+    return unless (@_initializer.first & %w[android ios]).empty?
+
     template('common/config.tt', "#{name}/config/config.yml")
   end
 

data/lib/generators/cucumber_generator.rb

@@ -20,6 +20,6 @@ class CucumberGenerator < Generator
   end
 
   def template_name
-    @template_name ||= (@_initializer.first & %w[android ios]).empty? ? 'login' : 'home'
+    @template_name ||= (@_initializer.first & %w[android ios cross_platform]).empty? ? 'login' : 'home'
   end
 end

data/lib/generators/helper_generator.rb

@@ -30,4 +30,10 @@ class HelpersGenerator < Generator
 
     template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
   end
+
+  def generate_pdp_page
+    return unless (@_initializer.first.include?('cross_platform'))
+
+    template('helpers/appium_helper.tt', "#{name}/helpers/appium_helper.rb")
+  end
 end

data/lib/generators/menu_generator.rb

@@ -31,9 +31,8 @@ class MenuGenerator
     select_test_framework(automation)
   end
 
-  def set_framework(automation, framework)
-    add_generator framework.capitalize
-    generators.each { |generator| invoke_generator(automation, framework, generator) }
+  def set_up_framework(automation, framework)
+    generate_framework(automation, framework)
     system "cd #{name} && gem install bundler && bundle install"
   end
 
@@ -41,11 +40,16 @@ class MenuGenerator
     prompt.select('Please select your mobile platform') do |menu|
       menu.choice :iOS, -> { choose_test_framework 'ios' }
       menu.choice :Android, -> { choose_test_framework 'android' }
-      menu.choice :Cross_Platform, -> { error_handling('Cross Platform') }
+      menu.choice :Cross_Platform, -> { choose_test_framework 'cross_platform' }
       menu.choice :Quit, -> { exit }
     end
   end
 
+  def generate_framework(automation, framework)
+    add_generator framework.capitalize
+    generators.each { |generator| invoke_generator(automation, framework, generator) }
+  end
+
   protected
 
   def add_generator(*opts)
@@ -55,7 +59,7 @@ class MenuGenerator
   private
 
   def framework_choice(framework, automation_type)
-    set_framework(automation_type, framework.downcase)
+    set_up_framework(automation_type, framework.downcase)
     prompt.say("You have chosen to use #{framework} with #{automation_type}")
   end
 

data/lib/generators/rspec_generator.rb

@@ -4,13 +4,13 @@ require_relative 'generator'
 
 class RspecGenerator < Generator
   def generate_login_spec
-    return unless (@_initializer.first & %w[android ios]).empty?
+    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
 
     template('rspec/spec.tt', "#{name}/spec/login_page_spec.rb")
   end
 
   def generate_pdp_spec
-    return if (@_initializer.first & %w[android ios]).empty?
+    return if (@_initializer.first & %w[android ios cross_platform]).empty?
 
     template('rspec/spec.tt', "#{name}/spec/pdp_page_spec.rb")
   end

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

@@ -1,6 +1,10 @@
 <%= ERB.new(File.read(File.expand_path('./partials/require_raider.tt', __dir__)), nil, '-').result(binding) -%>
 
 class AbstractPage
+<% if automation == 'cross_platform' %>
+  include Raider::AppiumHelper
+<% end %>
+
   <%= 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) -%>

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

@@ -0,0 +1,7 @@
+<% if automation == 'ios' %>
+<%= ERB.new(File.read(File.expand_path('./partials/ios_caps.tt', __dir__))).result(binding) -%>
+<% elsif automation == 'android' %>
+<%= ERB.new(File.read(File.expand_path('./partials/android_caps.tt', __dir__))).result(binding) -%>
+<% else %>
+<%= ERB.new(File.read(File.expand_path('./partials/cross_platform_caps.tt', __dir__))).result(binding) -%>
+<% end %>

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

@@ -15,10 +15,6 @@ class HomePage < AbstractPage
   # Elements
 
   def backpack_image
-  <% if automation == 'ios' %>
-    driver.find_element(predicate: 'label == "Sauce Labs Backpack"')
-  <% else %>
-    driver.find_element(xpath: '(//android.view.ViewGroup[@content-desc="store item"])[1]/android.view.ViewGroup[1]')
-  <% end %>
+    <%= ERB.new(File.read(File.expand_path('./partials/home_page_selector.tt', __dir__))).result(binding) %>
   end
 end

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

@@ -0,0 +1,5 @@
+automationName: UiAutomator2
+platformName: Android
+deviceName: Nexus_7_API_33
+app: "Android-MyDemoAppRN.1.3.0.build-244.apk"
+autoGrantPermissions: true

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

@@ -0,0 +1,14 @@
+android:
+  automationName: UiAutomator2
+  platformName: Android
+  deviceName: Nexus_7_API_33
+  app: "Android-MyDemoAppRN.1.3.0.build-244.apk"
+  autoGrantPermissions: true
+
+ios:
+  automationName: XCUITest
+  platformName: iOS
+  platformVersion: "15.5"
+  deviceName: iPhone 11
+  app: "MyRNDemoApp.app"
+  autoDismissAlerts: true

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

@@ -0,0 +1,8 @@
+<% if automation == 'ios' %>
+  driver.find_element(predicate: 'label == "Sauce Labs Backpack"')
+<% elsif automation == 'android' %>
+  driver.find_element(xpath: '(//android.view.ViewGroup[@content-desc="store item"])[1]/android.view.ViewGroup[1]')
+<% else %>
+  element(ios: { predicate: 'label == "Sauce Labs Backpack"' },
+              android: { xpath: '(//android.view.ViewGroup[@content-desc="store item"])[1]/android.view.ViewGroup[1]' })
+<% end %>

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

@@ -0,0 +1,6 @@
+automationName: XCUITest
+platformName: iOS
+platformVersion: "15.5"
+deviceName: iPhone 11
+app: "MyRNDemoApp.app"
+autoDismissAlerts: true

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

@@ -0,0 +1,8 @@
+<% if automation == 'ios' %>
+  driver.find_element(accessibility_id: 'Add To Cart button')
+<% elsif automation == 'android' %>
+  driver.find_element(xpath: '//android.view.ViewGroup[@content-desc="Add To Cart button"]/android.widget.TextView')
+<% else %>
+  element(ios: { accessibility_id: 'Add To Cart button' },
+          android: { xpath: '//android.view.ViewGroup[@content-desc="Add To Cart button"]/android.widget.TextView' })
+<% end %>

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

@@ -13,10 +13,6 @@ class PdpPage < AbstractPage
   # Elements
 
   def add_to_cart_button
-      <% if automation == 'ios' %>
-      driver.find_element(accessibility_id: 'Add To Cart button')
-      <% else %>
-      driver.find_element(xpath: '//android.view.ViewGroup[@content-desc="Add To Cart button"]/android.widget.TextView')
-      <% end %>
+    <%= ERB.new(File.read(File.expand_path('./partials/pdp_page_selector.tt', __dir__))).result(binding) %>
   end
 end

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

@@ -1,2 +1,5 @@
-browser: :chrome
-url: 'https://automationteststore.com/'
+<% if %w[ios android cross_platform].include?(automation) -%>
+<%= ERB.new(File.read(File.expand_path('./partials/mobile_config.tt', __dir__))).result(binding) %>
+<% else -%>
+<%= ERB.new(File.read(File.expand_path('./partials/web_config.tt', __dir__))).result(binding) %>
+<% end -%>

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

@@ -0,0 +1 @@
+platform: :ios

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

@@ -0,0 +1,2 @@
+browser: :chrome
+url: 'https://automationteststore.com/'

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

@@ -18,6 +18,8 @@ Currently we only support:
 * Gerating a Selenium with both Cucumber and Rspec framework
 * Gerating a Watir with both Cucumber and Rspec framework
 * Generating an Appium project with Rspec and Cucumber on IOS
+* Generating an Appium project with Rspec and Cucumber on Android
+* Generating an Appium project with Rspec and Cucumber cross platform
 
 In order to run the appium tests, download the example [app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0)
 
@@ -40,6 +42,8 @@ Commands:
 
   raider path [PATH]               # Sets the default path for scaffolding
 
+  raider platform [PLATFORM]       # Sets the default platform for a cross-platform project
+
   raider raid                      # It runs all the tests in a project
 
   raider scaffold [SCAFFOLD_NAME]  # It generates everything needed to start automating

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

@@ -0,0 +1,29 @@
+module Raider
+  module AppiumHelper
+    def element(opts = {})
+      return driver.find_element(strategy(opts) => selector(opts)) if opts[os]
+
+      driver.find_element(opts)
+    end
+
+    def elements(opts = {})
+      return driver.find_elements(strategy(opts) => selector(opts)) if opts[os]
+
+      driver.find_elements(opts)
+    end
+
+    def os
+      driver.appium_device
+    end
+
+    private
+
+    def strategy(opts)
+      opts[os].keys.first
+    end
+
+    def selector(opts)
+      opts[os][strategy(opts)]
+    end
+  end
+end

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

@@ -9,8 +9,21 @@ require 'appium_lib'
 
 module Raider
   module DriverHelper
-      attr_reader :driver
+    attr_reader :driver
 
-      <%= ERB.new(File.read(File.expand_path('./partials/driver_and_options.tt', __dir__))).result(binding).strip! %>
+    <%= ERB.new(File.read(File.expand_path('./partials/driver_and_options.tt', __dir__))).result(binding).strip! %>
+
+  <% if automation == 'cross_platform' -%>
+  private
+
+    def config
+      YAML.load_file('config/config.yml')
+    end
+<% end -%>
+<% if automation != 'selenium'  -%>
+    def caps
+      YAML.load_file('config/capabilities.yml')
+    end
+    <% end -%>
   end
 end

data/lib/generators/templates/helpers/partials/driver_and_options.tt

@@ -16,10 +16,13 @@
         opts.each {|option| caps.add_argument(option) }
         caps
       end
+<% elsif automation == 'cross_platform' %>
+   def new_driver
+     platform = config['platform'].to_s
+     @driver = Appium::Driver.new({ caps: caps[platform] })
+   end
 <% else %>
-      def new_driver
-        appium_file = File.join(Dir.pwd, 'appium.txt')
-        caps = Appium.load_appium_txt(file: appium_file)
-        @driver = Appium::Driver.new(caps)
-      end
+   def new_driver
+     @driver = Appium::Driver.new({ caps: caps })
+   end
 <% end %>

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

@@ -11,4 +11,7 @@ module Raider
   require_relative 'driver_helper'
 <% end -%>
   require_relative 'allure_helper'
+<% if automation == 'cross_platform' -%>
+  require_relative 'appium_helper'
+<% end -%>
 end

data/lib/utilities/utilities.rb

@@ -38,6 +38,11 @@ class Utilities
     overwrite_yaml
   end
 
+  def platform=(platform)
+    @config['platform'] = platform
+    overwrite_yaml
+  end
+
   def browser_options=(*opts)
     @config['browser_options'] = opts.flatten
     overwrite_yaml

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.4.1'
+  s.version     = '0.4.3'
   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']
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'reek', '~> 6.1.0'
   s.add_development_dependency 'rspec', '~> 3.11.0'
   s.add_development_dependency 'rubocop', '~> 1.27'
+  s.add_development_dependency 'rubocop-performance', '~> 1.15.0'
   s.add_development_dependency 'rubocop-rspec', '~> 2.9.0'
 
   s.add_runtime_dependency 'thor', '~> 1.2.1'