ruby_raider 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb0a98ec53c2d7632f0b1def441979b6a22db7634c8bb22f880f0602b6f6e4ed
-  data.tar.gz: 0a67358b59c7e53db1710012d66e3a9dc6dd345c86a8d362eab2149b4d3d8a0c
+  metadata.gz: 6187527f5296b729b6b97dfc897beb9d60809db17ab34fece7673c53a247be0f
+  data.tar.gz: 2ac25c14abdc3c038390cf6ca0b1b1a36cab72366adef86c7cdf6d32984aadec
 SHA512:
-  metadata.gz: bd29021c924b36ce9c04a86a13d7fcacb661c3403ca0e51bd3d2dc93c9caa8ff2dff04ec3e5d0ce2e1fa0e8166c06d1c0b7dcebe219a70cd82266ae38c8cc2e9
-  data.tar.gz: 5c83afc6f6a9e194889a9c6315225077c9879680f07538232ffff0cbb6baa09423bb8a3356f3eeb6c6efc45760c125d172328061000f2be3bd0ab7225f4477b2
+  metadata.gz: d999412e75b3f5b595d3615bc4664c0bc2c059385d8d397e970cce48565caa11712223654b6c28ae2892ba1ce03c3e72ddb305f272d9c61228053d93a7b92e8e
+  data.tar.gz: 33f26594ee731b2dfce01861e13ee8423acca5411c583fe4d77784d54edea05f840cf95cdc85b70dcc15407ce041e8e3062dd46d35b9617a42c18e803dc5f276

data/.reek.yml

@@ -7,7 +7,3 @@ detectors:
     exclude:
       - initialize
     max_statements: 10
-
-exclude_paths:
-  - 'lib/desktop/components/*.rb'
-  - 'lib/desktop/screens/*.rb'

data/README.md

@@ -57,6 +57,7 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 * Generating a visual testing framework with Cucumber, Applitools and Selenium
 
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
+***Remember to use the full path of the app that you download in the capabilities file***
 
 ***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read
 more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.)
@@ -97,7 +98,6 @@ Commands :
   raider generate # Provides access to all the generators commands
 raider help [COMMAND] # Describe available commands or one specific command
 raider new [PROJECT_NAME] # Creates a new framework based on settings picked
-raider open # It opens the desktop runner
 raider open_ai # Provides access to all the open ai commands
 raider utility # Provides access to all the utility commands
 raider version # It shows the version of Ruby Raider you are currently using

data/Rakefile

@@ -2,7 +2,6 @@
 
 require_relative 'lib/ruby_raider'
 require_relative 'lib/commands/scaffolding_commands'
-require_relative 'lib/desktop/screens/runner_screen'
 
 desc 'Creates a new test project'
 task :new, [:name] do |_t, args|
@@ -28,8 +27,3 @@ desc 'Download mobile builds'
 task :builds, [:type] do |_t, args|
   ScaffoldingCommands.new.invoke(:download_builds, nil, %W[#{args.type}])
 end
-
-desc 'Open the run screen'
-task :runner do
-  RunnerScreen.new.launch
-end

data/lib/generators/automation/automation_generator.rb

@@ -6,9 +6,13 @@ class AutomationGenerator < Generator
   def generate_automation_files
     if mobile?
       generate_appium_settings
+      generate_home_page
+      generate_pdp_page
     else
-      generate_abstract_component
       generate_visual_options
+      generate_components
+      generate_model_files
+      generate_pages
     end
 
     generate_abstract_page
@@ -16,6 +20,21 @@ class AutomationGenerator < Generator
 
   private
 
+  def generate_pages
+    generate_login_page
+    generate_account_page
+  end
+
+  def generate_components
+    generate_abstract_component
+    generate_header_component
+  end
+
+  def generate_model_files
+    generate_model_factory
+    generate_model_data
+  end
+
   def generate_abstract_page
     template('abstract_page.tt', "#{name}/page_objects/abstract/abstract_page.rb")
   end
@@ -33,4 +52,32 @@ class AutomationGenerator < Generator
 
     template('visual_options.tt', "#{name}/config/options.yml")
   end
+
+  def generate_login_page
+    template('login_page.tt', "#{name}/page_objects/pages/login_page.rb")
+  end
+
+  def generate_account_page
+    template('account_page.tt', "#{name}/page_objects/pages/account_page.rb")
+  end
+
+  def generate_home_page
+    template('home_page.tt', "#{name}/page_objects/pages/home_page.rb")
+  end
+
+  def generate_pdp_page
+    template('pdp_page.tt', "#{name}/page_objects/pages/pdp_page.rb")
+  end
+
+  def generate_header_component
+    template('component.tt', "#{name}/page_objects/components/header_component.rb")
+  end
+
+  def generate_model_factory
+    template('factory.tt', "#{name}/models/model_factory.rb")
+  end
+
+  def generate_model_data
+    template('data.tt', "#{name}/models/data/users.yml")
+  end
 end

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

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

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

@@ -1,5 +1,7 @@
-automationName: UiAutomator2
 platformName: Android
-deviceName: Nexus_7_API_33
-app: "Android-MyDemoAppRN.1.3.0.build-244.apk"
-autoGrantPermissions: true
+appium:options:
+  url: http://localhost:4723/wd/hub
+  platformVersion: '12'
+  automationName: UiAutomator2
+  deviceName: Pixel 3 API 32
+  app: "Android-MyDemoAppRN.1.3.0.build-244.apk"

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

@@ -1,14 +1,15 @@
 android:
-  automationName: UiAutomator2
   platformName: Android
-  deviceName: Nexus_7_API_33
-  app: "Android-MyDemoAppRN.1.3.0.build-244.apk"
-  autoGrantPermissions: true
-
+  appium:options:
+    platformVersion: '12'
+    automationName: UiAutomator2
+    deviceName: Pixel 3 API 32
+    app: "Android-MyDemoAppRN.1.3.0.build-244.apk"
 ios:
-  automationName: XCUITest
   platformName: iOS
-  platformVersion: "15.5"
-  deviceName: iPhone 11
-  app: "MyRNDemoApp.app"
-  autoDismissAlerts: true
+  appium:options:
+    platformVersion: "14.0"
+    deviceName: iPhone 11
+    automationName: XCUITest
+    app: "MyRNDemoApp.app"
+    autoDismissAlerts: true

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

@@ -1,6 +1,8 @@
-automationName: XCUITest
 platformName: iOS
-platformVersion: "15.5"
-deviceName: iPhone 11
-app: "MyRNDemoApp.app"
-autoDismissAlerts: true
+appium:options:
+  url: http://localhost:4723/wd/hub
+  platformVersion: "14.0"
+  deviceName: iPhone 11
+  automationName: XCUITest
+  app: "MyRNDemoApp.app"
+  autoDismissAlerts: true

data/lib/generators/common_generator.rb

@@ -8,7 +8,7 @@ class CommonGenerator < Generator
   end
 
   def generate_config_file
-    return if mobile?
+    return if single_platform?
 
     template('common/config.tt', "#{name}/config/config.yml")
   end

data/lib/generators/cucumber/cucumber_generator.rb

@@ -3,6 +3,18 @@
 require_relative '../generator'
 
 class CucumberGenerator < Generator
+  def generate_feature
+    template('feature.tt', "#{name}/features/#{template_name}.feature")
+  end
+
+  def generate_steps
+    template('steps.tt', "#{name}/features/step_definitions/#{template_name}_steps.rb")
+  end
+
+  def generate_user_factory
+    template('user_factory.tt', "#{name}/models/user_factory.rb")
+  end
+
   def generate_env_file
     template('env.tt', "#{name}/features/support/env.rb")
   end
@@ -14,4 +26,8 @@ class CucumberGenerator < Generator
   def generate_cucumber_file
     template('cucumber.tt', "#{name}/cucumber.yml")
   end
+
+  def template_name
+    @template_name ||= (@_initializer.first & %w[android ios cross_platform]).empty? ? 'login' : 'home'
+  end
 end

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

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

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

@@ -5,7 +5,7 @@ require_relative '../../helpers/visual_helper'
 <%- if automation == 'selenium' -%>
 require_relative '../../models/user_factory'
 
-World(Raider::DriverHelper<%- if visual_automation -%>, Raider::VisualHelper<%- end -%>)
+World(DriverHelper<%- if visual_automation -%>, VisualHelper<%- end -%>)
 <%- else -%>
-World(Raider::DriverHelper)
+World(DriverHelper)
 <%- end -%>

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

@@ -1,23 +1,24 @@
 <%- if visual_automation -%>
 # frozen_string_literal: true
 
+require_relative '../../helpers/allure_helper'
 require_relative '../../helpers/driver_helper'
 require_relative '../../helpers/visual_helper'
 
-include Raider::DriverHelper
-include Raider::VisualHelper
+include DriverHelper
+include VisualHelper
 
 Before 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)
+  @grid_runner = VisualHelper.create_grid_runner
+  @eyes = VisualHelper.create_eyes(@grid_runner)
+  VisualHelper.configure_eyes @eyes
+  @driver = @eyes.open(driver: driver)
 end
 
 After do |scenario|
   driver.save_screenshot("allure-results/screenshots/#{scenario.name}.png")
-  Raider::AllureHelper.add_screenshot(scenario.name)
+  AllureHelper.add_screenshot(scenario.name)
   @eyes.close
   @driver.quit
   @eyes.abort_async
@@ -29,16 +30,17 @@ end
 # frozen_string_literal: true
 
 require_relative '../../helpers/driver_helper'
+require_relative '../../helpers/allure_helper'
 
-include Raider::DriverHelper
+include DriverHelper
 
 Before do
-  new_driver
+  driver
 end
 
 After do |scenario|
   driver.save_screenshot("allure-results/screenshots/#{scenario.name}.png")
-  Raider::AllureHelper.add_screenshot(scenario.name)
+  AllureHelper.add_screenshot(scenario.name)
   driver.quit
 end
 <%- end -%>

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

@@ -1,44 +1,16 @@
-<%- if visual_automation -%>
 # frozen_string_literal: true
 
+require_relative '../../helpers/allure_helper'
 require_relative '../../helpers/browser_helper'
-require_relative '../../helpers/visual_helper'
 
-include Raider::BrowserHelper
-include Raider::VisualHelper
+include BrowserHelper
 
 Before do
-  OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
-  @grid_runner = create_grid_runner
-  @eyes = create_eyes(@grid_runner)
-  configure_eyes @eyes
-  @browser = @eyes.open(driver: new_browser.driver)
+  browser
 end
 
 After do |scenario|
   browser.screenshot.save("allure-results/screenshots/#{scenario.name}.png")
-  Raider::AllureHelper.add_screenshot(scenario.name)
-  @eyes.close
-  @browser.quit
-  @eyes.abort_async
-  results = @grid_runner.get_all_test_results
-  puts results
-end
-
-<%- else -%>
-# frozen_string_literal: true
-
-require_relative '../../helpers/browser_helper'
-
-include Raider::BrowserHelper
-
-Before do
-  new_browser
-end
-
-After do |scenario|
-  browser.screenshot.save("allure-results/screenshots/#{scenario.name}.png")
-  Raider::AllureHelper.add_screenshot(scenario.name)
+  AllureHelper.add_screenshot(scenario.name)
   browser.quit
 end
-<%- end -%>

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

@@ -1,4 +1,4 @@
 require_relative '../../helpers/browser_helper'
 require_relative '../../models/user_factory'
 
-World(Raider::BrowserHelper)
+World(BrowserHelper)

data/lib/generators/generator.rb

@@ -32,6 +32,10 @@ class Generator < Thor::Group
     (args & %w[android ios cross_platform]).count.positive?
   end
 
+  def single_platform?
+    (args & %w[android ios]).count.positive?
+  end
+
   def rspec?
     args.include?('rspec')
   end

data/lib/generators/helper_generator.rb

@@ -4,7 +4,6 @@ require_relative 'generator'
 
 class HelpersGenerator < Generator
   def generate_helpers
-    generate_raider_helper
     generate_browser_helper
     generate_driver_helper
     generate_appium_helper
@@ -20,10 +19,6 @@ class HelpersGenerator < Generator
 
   private
 
-  def generate_raider_helper
-    template('helpers/raider_helper.tt', "#{name}/helpers/raider.rb")
-  end
-
   def generate_allure_helper
     template('helpers/allure_helper.tt', "#{name}/helpers/allure_helper.rb")
   end

data/lib/generators/invoke_generators.rb

@@ -1,11 +1,8 @@
 require_relative 'automation/automation_generator'
-require_relative 'automation/automation_examples_generator'
 require_relative 'common_generator'
 require_relative 'cucumber/cucumber_generator'
-require_relative 'cucumber/cucumber_examples_generator'
 require_relative 'helper_generator'
 require_relative 'rspec/rspec_generator'
-require_relative 'rspec/rspec_examples_generator'
 
 # :reek:FeatureEnvy { enabled: false }
 # :reek:UtilityFunction { enabled: false }
@@ -14,7 +11,6 @@ module InvokeGenerators
     generators = %w[Automation Common Helpers]
     framework = structure[:framework]
     add_generator(generators, framework.capitalize)
-    generators = add_examples(generators) if structure[:examples]
     generators.each do |generator|
       invoke_generator({
                          automation: structure[:automation],
@@ -30,16 +26,6 @@ module InvokeGenerators
     gens.each { |generator| generators.push generator }
   end
 
-  def add_examples(generators)
-    if generators.include?('Cucumber')
-      generators.push('CucumberExamples')
-    else
-      generators.push('RspecExamples')
-    end
-
-    generators.push('AutomationExamples')
-  end
-
   def invoke_generator(structure = {})
     Object.const_get("#{structure[:generator]}Generator")
           .new([structure[:automation],

data/lib/generators/menu_generator.rb

@@ -39,8 +39,7 @@ class MenuGenerator
       automation: options[:automation],
       framework: options[:framework],
       name: @name,
-      visual: options[:visual_automation],
-      examples: options[:with_examples]
+      visual: options[:visual_automation]
     }
     generate_framework(structure)
     system "cd #{name} && gem install bundler && bundle install"
@@ -59,36 +58,23 @@ class MenuGenerator
 
   def select_test_framework(automation)
     prompt.select('Please select your test framework') do |menu|
-      menu.choice :Cucumber, -> { select_example_files('Cucumber', automation) }
-      menu.choice :Rspec, -> { select_example_files('Rspec', automation) }
+      menu.choice :Cucumber, -> { create_framework('Cucumber', automation) }
+      menu.choice :Rspec, -> { create_framework('Rspec', automation) }
       menu.choice :Quit, -> { exit }
     end
   end
 
-  def select_example_files(framework, automation)
-    prompt.select('Would you like to create example files?') do |menu|
-      menu.choice :Yes, -> { framework_with_examples(framework, automation) }
-      menu.choice :No, -> { framework_without_examples(framework, automation) }
-      menu.choice :Quit, -> { exit }
-    end
-  end
-
-  FrameworkOptions = Struct.new(:automation, :framework, :visual_automation, :with_examples)
+  FrameworkOptions = Struct.new(:automation, :framework, :visual_automation)
 
   def create_framework_options(params)
-    FrameworkOptions.new(params[:automation], params[:framework], params[:visual_automation], params[:with_examples])
-  end
-
-  def framework_with_examples(framework, automation_type)
-    visual_automation = choose_visual_automation if %w[selenium].include?(automation_type)
-    options = create_framework_options(automation: automation_type, framework: framework.downcase, visual_automation: visual_automation, with_examples: true)
-    set_up_framework(options)
-    prompt.say("You have chosen to use #{framework} with #{automation_type}")
+    FrameworkOptions.new(params[:automation], params[:framework], params[:visual_automation])
   end
 
-  def framework_without_examples(framework, automation_type)
+  def create_framework(framework, automation_type)
     visual_automation = choose_visual_automation if %w[selenium].include?(automation_type)
-    options = create_framework_options(automation: automation_type, framework: framework.downcase, visual_automation: visual_automation, with_examples: false)
+    options = create_framework_options(automation: automation_type,
+                                       framework: framework.downcase,
+                                       visual_automation: visual_automation)
     set_up_framework(options)
     prompt.say("You have chosen to use #{framework} with #{automation_type}")
   end

data/lib/generators/rspec/rspec_generator.rb

@@ -3,7 +3,15 @@
 require_relative '../generator'
 
 class RspecGenerator < Generator
-  def generate_base_spec
-    template('base_spec.tt', "#{name}/spec/base_spec.rb")
+  def generate_login_spec
+    return if mobile?
+
+    template('spec.tt', "#{name}/spec/login_page_spec.rb")
+  end
+
+  def generate_pdp_spec
+    return unless mobile?
+
+    template('spec.tt', "#{name}/spec/pdp_page_spec.rb")
   end
 end

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

@@ -1,7 +1,7 @@
 <%- if %w[selenium watir].include? automation -%>
 # frozen_string_literal: true
 
-require_relative 'base_spec'
+require_relative '../helpers/spec_helper'
 require_relative '../models/model_factory'
 require_relative '../page_objects/pages/account_page'
 require_relative '../page_objects/pages/login_page'
@@ -43,11 +43,11 @@ describe 'Login' do
   end
 end
 <%- else -%>
+require_relative '../helpers/spec_helper'
 require_relative '../page_objects/pages/home_page'
-require_relative 'base_spec'
 require_relative '../page_objects/pages/pdp_page'
 
-class PdpSpec < BaseSpec
+class PdpSpec
   describe 'PDP page' do
 
     let(:home_page) { HomePage.new(driver) }

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

@@ -53,6 +53,7 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 * Generating a visual testing framework with Cucumber, Applitools and Selenium
 
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
+***Remember to use the full path of the app that you download in the capabilities file***
 
 ***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read
 more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.)
@@ -93,7 +94,6 @@ Commands :
   raider generate # Provides access to all the generators commands
 raider help [COMMAND] # Describe available commands or one specific command
 raider new [PROJECT_NAME] # Creates a new framework based on settings picked
-raider open # It opens the desktop runner
 raider open_ai # Provides access to all the open ai commands
 raider utility # Provides access to all the utility commands
 raider version # It shows the version of Ruby Raider you are currently using

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

@@ -4,30 +4,28 @@
 <%- allure = ERB.new(File.read(File.expand_path('./partials/allure_imports.tt', __dir__))).result(binding).strip! -%>
 
 
-module Raider
-  module AllureHelper
-    class << self
-      def configure
-        <%= allure %>.configure do |config|
-          config.results_directory = 'allure-results'
-          config.clean_results_directory = true
-        end
+module AllureHelper
+  class << self
+    def configure
+      <%= allure %>.configure do |config|
+        config.results_directory = 'allure-results'
+        config.clean_results_directory = true
       end
+    end
 
-      def add_screenshot(screenshot_name)
-        Allure.add_attachment(
-          name: name,
-          source: File.open("allure-results/screenshots/#{screenshot_name}.png"),
-          type: Allure::ContentType::PNG,
-          test_case: true
-        )
-      end
+    def add_screenshot(screenshot_name)
+      Allure.add_attachment(
+        name: name,
+        source: File.open("allure-results/screenshots/#{screenshot_name}.png"),
+        type: Allure::ContentType::PNG,
+        test_case: true
+       )
+     end
 
-    <%- if framework == 'rspec' -%>
-      def formatter
-        AllureRspecFormatter
-      end
-      <%- end -%>
+  <%- if framework == 'rspec' -%>
+    def formatter
+      AllureRspecFormatter
     end
+      <%- end -%>
   end
 end

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

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