ruby_raider 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 178109afc0345d78e1ec6fea0a281a55fc461cd4270f4b34117c49f9e4a91fa2
-  data.tar.gz: b6087156268a4f75cf74f436753c36928bf9e01f3705d48a85d456e1828749ec
+  metadata.gz: 6a92cf556575579c0fd4b96bde582b6f19d0715224467dae8276a7b5a367d611
+  data.tar.gz: c4327f646e1f7dc87657da33e7cf2a075103fe605a953cb9e0a2c4f0a8bef24f
 SHA512:
-  metadata.gz: 3ea7e978b7740cc986acf05336acb6e1036bb7f3c501a81d29ef9211a707c783b86c11116b153229dfa3ee709f0f2d38d1728c13591603813f7c1f188bdb9a05
-  data.tar.gz: 7ad15bf0087f8d6d208b46118175d493afeeedd4d6855546d19ad752a596d5d09020c7bae8c58f360df671e10738f9c3814027fbf3d8415d1f80cc435dc058ae
+  metadata.gz: cd2a91f76d5f338b7cd2e79ae0c3af2012a4ff4a46802c3f90b8d1e79724c30fb9127790a89ceac5592ac74e039863993f62c7205e732fa714b3a3ae4309c4e3
+  data.tar.gz: d61169f5255b2f0e12a9cd62cb312c81dabc696ad9285d0863c62d46cdaaa4e9cea152e68985ff063450fc0c9c5d55cf752f5d06ae4cf245647c0ce924906ec9

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

@@ -43,7 +43,11 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 * Generating a framework with Cucumber and Appium for IOS
 
-***In order to run the Appium tests, download the example [app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0).***
+* Generating a framework with Rspec and Appium for Android
+
+* Generating a framework with Cucumber and Appium for Android
+
+***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).
 

data/Rakefile

@@ -4,8 +4,8 @@ require_relative 'lib/ruby_raider'
 require_relative 'lib/commands/scaffolding_commands'
 
 desc 'Creates a new test project'
-task :new do
-  RubyRaider.start
+task :new, [:name] do |_t, args|
+  system "bin/raider -n #{args.name}"
 end
 
 desc 'Creates a page'

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/generators/automation_generator.rb

@@ -4,6 +4,8 @@ require_relative 'generator'
 
 class AutomationGenerator < Generator
   def generate_login_page
+    return unless (@_initializer.first & %w[android ios]).empty?
+
     template('automation/login_page.tt', "#{name}/page_objects/pages/login_page.rb")
   end
 
@@ -12,30 +14,32 @@ class AutomationGenerator < Generator
   end
 
   def generate_home_page
-    return unless @_initializer.first.include?('appium_ios')
+    return if (@_initializer.first & %w[android ios]).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?
+
+    template('automation/pdp_page.tt', "#{name}/page_objects/pages/pdp_page.rb")
+  end
+
   def generate_header_component
-    return if @_initializer.first.include?('appium_ios')
+    return unless (@_initializer.first & %w[android ios]).empty?
 
     template('automation/component.tt', "#{name}/page_objects/components/header_component.rb")
   end
 
   def generate_abstract_component
-    return if @_initializer.first.include?('appium_ios')
+    return unless (@_initializer.first & %w[android ios]).empty?
 
     template('automation/abstract_component.tt', "#{name}/page_objects/abstract/abstract_component.rb")
   end
 
-  def generate_confirmation_page
-    return unless @_initializer.first.include?('appium_ios')
-
-    template('automation/confirmation_page.tt', "#{name}/page_objects/pages/confirmation_page.rb")
-  end
-
   def generate_appium_settings
-    template('automation/appium_settings.tt', "#{name}/appium.txt") if @_initializer.first.include?('appium_ios')
+    return if (@_initializer.first & %w[android ios]).empty?
+
+    template('automation/appium_settings.tt', "#{name}/appium.txt")
   end
 end

data/lib/generators/cucumber_generator.rb

@@ -4,14 +4,22 @@ require_relative 'generator'
 
 class CucumberGenerator < Generator
   def generate_feature
-    template('cucumber/feature.tt', "#{name}/features/login.feature")
+    template('cucumber/feature.tt', "#{name}/features/#{template_name}.feature")
   end
 
   def generate_steps
-    template('cucumber/steps.tt', "#{name}/features/step_definitions/login_steps.rb")
+    template('cucumber/steps.tt', "#{name}/features/step_definitions/#{template_name}_steps.rb")
   end
 
   def generate_env_file
     template('cucumber/env.tt', "#{name}/features/support/env.rb")
   end
+
+  def generate_world
+    template('cucumber/world.tt', "#{name}/world.rb")
+  end
+
+  def template_name
+    @template_name ||= (@_initializer.first & %w[android ios]).empty? ? 'login' : 'home'
+  end
 end

data/lib/generators/menu_generator.rb

@@ -31,21 +31,25 @@ 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
 
   def choose_mobile_platform
     prompt.select('Please select your mobile platform') do |menu|
-      menu.choice :iOS, -> { choose_test_framework 'appium_ios' }
-      menu.choice :Android, -> { error_handling('Android') }
+      menu.choice :iOS, -> { choose_test_framework 'ios' }
+      menu.choice :Android, -> { choose_test_framework 'android' }
       menu.choice :Cross_Platform, -> { error_handling('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

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

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

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class AbstractComponent
+  attr_reader :component
+
   def initialize(component)
     @component = component
   end

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

@@ -1,4 +1,3 @@
-require 'yaml'
 <%= ERB.new(File.read(File.expand_path('./partials/require_raider.tt', __dir__)), nil, '-').result(binding) -%>
 
 class AbstractPage

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

@@ -1,8 +1,5 @@
-[caps]
-platformName = "iOS"
-platformVersion = "15.5"
-deviceName = "iPhone SE (3rd generation)"
-app = "TheApp.app"
-
-[appium_lib]
-server_url = "http://127.0.0.1:4723/wd/hub"
+<% if automation == 'ios' %>
+<%= ERB.new(File.read(File.expand_path('./partials/ios_settings.tt', __dir__))).result(binding) -%>
+<% else %>
+<%= ERB.new(File.read(File.expand_path('./partials/android_settings.tt', __dir__))).result(binding) -%>
+<% end %>

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

@@ -4,6 +4,6 @@ require_relative '../abstract/abstract_component'
 
 class HeaderComponent < AbstractComponent
   def customer_name
-    @component.text
+    component.text
   end
 end

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

@@ -4,17 +4,21 @@ require_relative '../abstract/abstract_page'
 
 class HomePage < AbstractPage
 
-  #Actions
+  # Actions
 
-  def go_to_login
-    @driver.wait { login_button_navigator }.click
+  def go_to_backpack_pdp
+    driver.wait { backpack_image }.click
   end
 
   private
 
   # Elements
 
-  def login_button_navigator
-    @driver.find_element(accessibility_id: 'Login Screen')
+  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 %>
   end
 end

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

@@ -3,6 +3,4 @@
 <%= ERB.new(File.read(File.expand_path('./partials/selenium_login.tt', __dir__))).result(binding) %>
 <% when 'watir' -%>
 <%= ERB.new(File.read(File.expand_path('./partials/watir_login.tt', __dir__))).result(binding) %>
-<% else -%>
-<%= ERB.new(File.read(File.expand_path('./partials/appium_login.tt', __dir__))).result(binding) %>
 <% end -%>

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

@@ -0,0 +1,8 @@
+[caps]
+automationName = "UiAutomator2"
+platformName = "Android"
+deviceName = "Nexus_7_API_33"
+app = "Android-MyDemoAppRN.1.3.0.build-244.apk"
+
+[appium_lib]
+server_url = "http://127.0.0.1:4723/wd/hub"

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

@@ -1,5 +1,5 @@
-<% if %w[selenium appium_ios].include?(automation) -%>
-  @driver.find_element
+<% if %w[selenium appium_ios appium_android].include?(automation) -%>
+  driver.find_element
 <% else -%>
-  @browser.element
+  browser.element
 <% end -%>

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

@@ -1,8 +1,12 @@
 <% if automation == 'watir' %>
+  attr_reader :browser
+
   def initialize(browser)
     @browser = browser
   end
 <% else %>
+  attr_reader :driver
+
   def initialize(driver)
     @driver = driver
   end

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

@@ -0,0 +1,8 @@
+[caps]
+platformName = "iOS"
+platformVersion = "16.0"
+deviceName = "iPhone SE (3rd generation)"
+app = "MyRNDemoApp.app"
+
+[appium_lib]
+server_url = "http://127.0.0.1:4723/wd/hub"

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

@@ -27,14 +27,14 @@ class LoginPage < AbstractPage
   # Elements
 
   def username_field
-    @driver.find_element(id: 'loginFrm_loginname')
+    driver.find_element(id: 'loginFrm_loginname')
   end
 
   def password_field
-    @driver.find_element(id: 'loginFrm_password')
+    driver.find_element(id: 'loginFrm_password')
   end
 
   def login_button
-    @driver.find_element(xpath: "//button[@title='Login']")
+    driver.find_element(xpath: "//button[@title='Login']")
   end
 end

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

@@ -26,14 +26,14 @@ class LoginPage < AbstractPage
   # Elements
 
   def username_field
-    @browser.text_field(id: 'loginFrm_loginname')
+    browser.text_field(id: 'loginFrm_loginname')
   end
 
   def password_field
-    @browser.text_field(id: 'loginFrm_password')
+    browser.text_field(id: 'loginFrm_password')
   end
 
   def login_button
-    @browser.button(xpath: "//button[@title='Login']")
+    browser.button(xpath: "//button[@title='Login']")
   end
 end

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

@@ -0,0 +1,22 @@
+require_relative '../abstract/abstract_page'
+
+class PdpPage < AbstractPage
+
+  # Actions
+
+  def add_to_cart_text
+    driver.wait { add_to_cart_button }.text
+  end
+
+  private
+
+  # 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 %>
+  end
+end

data/lib/generators/templates/cucumber/feature.tt

@@ -1,6 +1,15 @@
+<% if %w[selenium watir].include? automation -%>
 Feature: Login Page
 
 Scenario: A user can login
     Given I'm a registered user on the login page
     When I login with my credentials
     Then I can see the main page
+<% else -%>
+Feature: Home Page
+
+Scenario: A user can go to the product details page
+    Given I'm an anonymous user on the home page
+    When I select one of the products
+    Then I'm redirected to the product details page
+<% end %>

data/lib/generators/templates/cucumber/partials/appium_env.tt

@@ -1,13 +1,15 @@
 require_relative '../../helpers/driver_helper'
 
+include Raider::DriverHelper
+
 Before do
   Raider::AllureHelper.configure
-  @driver = Raider::DriverHelper.new_driver
-  @driver.start_driver
+  new_driver
+  driver.start_driver
 end
 
 After do |scenario|
-  @driver.screenshot("allure-results/screenshots/#{scenario.name}.png")
+  driver.screenshot("allure-results/screenshots/#{scenario.name}.png")
   Raider::AllureHelper.add_screenshot(scenario.name)
-  @driver.quit_driver
-end
+  driver.quit_driver
+end

data/lib/generators/templates/cucumber/partials/driver_world.tt

@@ -0,0 +1 @@
+World(DriverHelper)

data/lib/generators/templates/cucumber/partials/mobile_steps.tt

@@ -1,20 +1,17 @@
 # frozen_string_literal: true
 
-require_relative '../../page_objects/pages/confirmation_page'
 require_relative '../../page_objects/pages/home_page'
-require_relative '../../page_objects/pages/login_page'
+require_relative '../../page_objects/pages/pdp_page'
 
-Given("I'm a registered user on the login page") do
-    home_page = HomePage.new(@driver)
-    home_page.go_to_login
+Given("I'm an anonymous user on the home page") do
+    @home_page = HomePage.new(driver)
 end
 
-When('I login with my credentials') do
-    login_page = LoginPage.new(@driver)
-    login_page.login('alice', 'mypassword')
+When('I select one of the products') do
+    @home_page.go_to_backpack_pdp
 end
 
-When('I can see the main page') do
-    confirmation_page = ConfirmationPage.new(@driver)
-    expect(confirmation_page.login_message).to eq 'You are logged in as alice'
+When("I'm redirected to the product details page") do
+    pdp_page = PdpPage.new(driver)
+    expect(pdp_page.add_to_cart_text).to eq 'Add To Cart'
 end

data/lib/generators/templates/cucumber/partials/watir_world.tt

@@ -0,0 +1 @@
+World(BrowserHelper)

data/lib/generators/templates/cucumber/partials/web_steps.tt

@@ -3,7 +3,7 @@
 require_relative '../../page_objects/pages/login_page'
 
 Given("I'm a registered user on the login page") do
-    @login_page = LoginPage.new(<% if automation == 'watir'%>@browser<% else %>@driver<% end %>)
+    @login_page = LoginPage.new(<% if automation == 'watir'%>browser<% else %>driver<% end %>)
     @login_page.visit
 end
 

data/lib/generators/templates/cucumber/world.tt

@@ -0,0 +1,5 @@
+<% if %w[watir].include? automation -%>
+<%= ERB.new(File.read(File.expand_path('./partials/watir_world.tt', __dir__))).result(binding).strip! -%>
+<% else -%>
+<%= ERB.new(File.read(File.expand_path('./partials/driver_world.tt', __dir__))).result(binding).strip! -%>
+<% end -%>

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

@@ -6,7 +6,6 @@ require 'webdrivers'
 <% else -%>
 require 'appium_lib'
 <% end -%>
-require_relative 'driver_helper'
 
 module Raider
   module DriverHelper

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

@@ -1,8 +1,9 @@
-<% if automation == 'watir' %>
+<% case automation
+ when 'selenium' %>
+new_driver
+<% when 'watir' %>
 new_browser
 <% else %>
 new_driver
-<% end %>
-<% if %w[appium_ios].include? automation %>
-start_driver
+        driver.start_driver
 <% end %>

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

@@ -29,24 +29,19 @@ describe 'Login' do
   end
 end
 <% else -%>
-require_relative '../page_objects/pages/confirmation_page'
 require_relative '../page_objects/pages/home_page'
 require_relative 'base_spec'
-require_relative '../page_objects/pages/login_page'
+require_relative '../page_objects/pages/pdp_page'
 
-class LoginSpec < BaseSpec
-  describe 'Login' do
+class PdpSpec < BaseSpec
+  describe 'PDP page' do
 
-    let(:user_name) { 'alice' }
-    let(:password) { 'mypassword' }
-    let(:login_page) { LoginPage.new(@driver) }
-    let(:home_page) { HomePage.new(@driver) }
-    let(:confirmation_page) { ConfirmationPage.new(@driver) }
+    let(:home_page) { HomePage.new(driver) }
+    let(:pdp_page) { PdpPage.new(driver) }
 
-    it 'can login' do
-      home_page.go_to_login
-      login_page.login(user_name, password)
-      expect(confirmation_page.login_message).to eq 'You are logged in as alice'
+    it 'shows add to cart button' do
+      home_page.go_to_backpack_pdp
+      expect(pdp_page.add_to_cart_text).to eq 'Add To Cart'
     end
   end
 end

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.4.0'
+  s.version     = '0.4.2'
   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'