ruby_raider 0.1.8 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aed816df5e1abdc73f27322835a3ca84a2f5238a0a7d6c0a9905fe766fe8a78f
-  data.tar.gz: 041d4cac7ed5dbffa13369b65fa59b275ceaddbdae7b75149e2780eb2befc6e4
+  metadata.gz: 0b04a44917cee86583a600c29b50bba9214fe5b9a34681d067fb55aa93ae13bd
+  data.tar.gz: ad70c90273a5325f1802aea66fc86341482b1f150085d995477c4f509632eecf
 SHA512:
-  metadata.gz: 15f03089c0d4b633e647c802baaa93777eb9bfcc259023b63adb81ab6415b89e5488a5d043aa1234957e9570d22f3f82870d5e4d563ade1577d5a82b12eba2b5
-  data.tar.gz: 2a133387a4d7533f9b654aded174b64c56feb19a6ee2e860953d5c8dbac4c781ff0f86d798db03e31add9ab6eb9abc97a95e3c2c436197d1f6fdcbbf078737e4
+  metadata.gz: 27bf3532138c0968c054168bb6ae882d2bdb83d8e9e1f532e8812d976f4d374eeba3c922c417b7a22ce7d2e3ba7e07669752dc70a5a6abeafc8e0fa49ed8ab3e
+  data.tar.gz: 5b5d47f815aac25972ee74389c295eaa8033ff972a1d829ce4be3e7f54c7bdbd531e1dd6a0e7a9d02a9c69a119d3d8b4af148e6a39231f51e9fc3c7a3b6e399d

data/.reek.yml

@@ -0,0 +1,3 @@
+detectors:
+  IrresponsibleModule:
+    enabled: false

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - './spec/*'
+
+Style/Documentation:
+  Enabled: false

data/README.md

@@ -13,11 +13,10 @@ and you will have a new project in the folder you are in
 
 Currently we only support:
 
-* Gerating a Selenium with Rspec framework
-* Gerating a Watir with Rspec framework
+* 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
 
-We have only tested this in mac and linux, so it works in both platforms.
+In order to run the appium tests, download the example [app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0)
 
-If you wanna follow the development progress 
-
-https://trello.com/b/Nj7UPy0w/ruby-raider
+This works in all the platforms (Tested on Mac OS, Linux and Windows)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/ruby_raider'
 
 desc 'Create a new test projects'

data/bin/raider

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative '../lib/ruby_raider'
 

data/lib/generators/automation_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'generator'
+
+module RubyRaider
+  class AutomationGenerator < Generator
+    def generate_login_page
+      template('automation/login_page.tt', "#{name}/page_objects/pages/login_page.rb")
+    end
+
+    def generate_abstract_page
+      template('automation/abstract_page.tt', "#{name}/page_objects/abstract/abstract_page.rb")
+    end
+
+    def generate_home_page
+      template('automation/home_page.tt', "#{name}/page_objects/pages/home_page.rb")
+    end
+
+    def generate_header_component
+      unless @_initializer.first.include?('appium_ios')
+        template('automation/component.tt', "#{name}/page_objects/components/header_component.rb")
+      end
+    end
+
+    def generate_abstract_component
+      unless @_initializer.first.include?('appium_ios')
+        template('automation/abstract_component.tt', "#{name}/page_objects/abstract/abstract_component.rb")
+      end
+    end
+
+    def generate_confirmation_page
+      if @_initializer.first.include?('appium_ios')
+        template('automation/confirmation_page.tt', "#{name}/page_objects/pages/confirmation_page.rb")
+      end
+    end
+
+    def generate_appium_settings
+      if @_initializer.first.include?('appium_ios')
+        template('automation/appium_settings.tt', "#{name}/appium.txt")
+      end
+    end
+  end
+end

data/lib/generators/common_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'generator'
+
+module RubyRaider
+  class CommonGenerator < Generator
+      def generate_readme_file
+        template('common/read_me.tt', "#{name}/Readme.md")
+      end
+
+      def generate_config_file
+        template('common/config.tt', "#{name}/config/config.yml")
+      end
+
+      def generate_rake_file
+        template('common/rakefile.tt', "#{name}/Rakefile")
+      end
+
+      def generate_gemfile
+        template('common/gemfile.tt', "#{name}/Gemfile")
+      end
+
+      def create_allure_folder
+        empty_directory "#{name}/allure-results"
+      end
+
+      def create_screenshots_folder
+        empty_directory "#{name}/allure-results/screenshots"
+      end
+    end
+end

data/lib/generators/cucumber_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'generator'
+
+module RubyRaider
+  class CucumberGenerator < Generator
+    def generate_feature
+      template('cucumber/feature.tt', "#{name}/features/login.feature")
+    end
+
+    def generate_steps
+      template('cucumber/steps.tt', "#{name}/features/step_definitions/login_steps.rb")
+    end
+
+    def generate_env_file
+      template('cucumber/env.tt', "#{name}/features/support/env.rb")
+    end
+  end
+end

data/lib/generators/generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'thor'
+
+module RubyRaider
+  class Generator < Thor::Group
+    include Thor::Actions
+
+    argument :automation
+    argument :framework
+    argument :name
+
+    def self.source_root
+      File.dirname(__FILE__) + '/templates'
+    end
+  end
+end

data/lib/generators/helper_generator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'generator'
+
+module RubyRaider
+  class HelpersGenerator < Generator
+
+    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
+
+    def generate_browser_helper
+      if @_initializer.first.include?('watir')
+        template('helpers/browser_helper.tt', "#{name}/helpers/browser_helper.rb")
+      end
+    end
+
+    def generate_pom_helper
+      template('helpers/pom_helper.tt', "#{name}/helpers/pom_helper.rb")
+    end
+
+    def generate_spec_helper
+      template('helpers/spec_helper.tt', "#{name}/helpers/spec_helper.rb")
+    end
+
+    def generate_watir_helper
+      if @_initializer.first.include?('watir')
+        template('helpers/watir_helper.tt', "#{name}/helpers/watir_helper.rb")
+      end
+    end
+
+    def generate_selenium_helper
+      if @_initializer.first.include?('selenium')
+        template('helpers/selenium_helper.tt', "#{name}/helpers/selenium_helper.rb")
+      end
+    end
+
+    def generate_driver_helper
+      unless @_initializer.first.include?('watir')
+        template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
+      end
+    end
+  end
+end

data/lib/generators/menu_generator.rb

@@ -1,44 +1,72 @@
+# frozen_string_literal: true
+
 require 'highline'
-require_relative '../generators/projects/cucumber_project_generator'
-require_relative '../generators/projects/rspec_project_generator'
+require_relative 'automation_generator'
+require_relative 'common_generator'
+require_relative 'cucumber_generator'
+require_relative 'helper_generator'
+require_relative 'rspec_generator'
 
 module RubyRaider
   class MenuGenerator
-    def self.generate_choice_menu(project_name)
-      cli = HighLine.new
-      cli.choose do |menu|
-        menu.prompt = 'Please select your automation framework'
-        menu.choice(:Selenium) { choose_test_framework('selenium', project_name) }
-        menu.choice(:Watir) { choose_test_framework('watir', project_name) }
-        menu.choice(:Quit, 'Exit program.') { exit }
+    class << self
+      def generate_choice_menu(project_name)
+        @cli = HighLine.new
+        @cli.choose do |menu|
+          menu.prompt = 'Please select your automation framework'
+          menu.choice('Selenium') { choose_test_framework('selenium', project_name) }
+          menu.choice('Watir') { choose_test_framework('watir', project_name) }
+          menu.choice('Appium') { choose_test_framework('appium', project_name) }
+          menu.choice('Quit') { exit }
+        end
       end
-    end
 
-    def self.choose_test_framework(automation, project_name)
-      system('clear') || system('cls')
-      sleep 0.3
-      cli = HighLine.new
-      framework = ''
-      cli.choose do |menu|
-        menu.prompt = 'Please select your test framework'
-        menu.choice(:Rspec) do
-          framework = 'rspec'
-          set_framework(automation, framework, project_name)
+      def choose_test_framework(automation, project_name)
+        system('clear') || system('cls')
+        sleep 0.3
+        automation = automation == 'appium' ? choose_mobile_platform : automation
+        framework = ''
+        @cli.choose do |menu|
+          menu.prompt = 'Please select your test framework'
+          menu.choice('Rspec') do
+            framework = 'rspec'
+            set_framework(automation, framework, project_name)
+          end
+          menu.choice('Cucumber') do
+            framework = 'cucumber'
+            set_framework(automation, framework, project_name)
+          end
+          menu.choice('Quit') { exit }
         end
-        menu.choice(:Cucumber) do
-          framework = 'cucumber'
-          set_framework(automation, framework, project_name)
+        @cli.say("You have chosen to use #{framework} with #{automation}")
+      end
+
+      def set_framework(automation, framework, project_name)
+        if framework == 'rspec'
+          RspecGenerator.new([automation, framework, project_name]).invoke_all
+        else
+          CucumberGenerator.new([automation, framework, project_name]).invoke_all
         end
-        menu.choice(:Quit, 'Exit program.') { exit }
+        AutomationGenerator.new([automation, framework, project_name]).invoke_all
+        CommonGenerator.new([automation, framework, project_name]).invoke_all
+        HelpersGenerator.new([automation, framework, project_name]).invoke_all
+        system "cd #{project_name} && gem install bundler && bundle install"
       end
-      cli.say("You have chosen to use #{framework} with #{automation}")
-    end
 
-    def self.set_framework(automation, framework, project_name)
-      if framework == 'rspec'
-        RspecProjectGenerator.generate_rspec_project(project_name, automation: automation)
-      else
-        CucumberProjectGenerator.generate_cucumber_project(project_name, automation: automation)
+      def choose_mobile_platform
+        @cli.choose do |menu|
+          menu.prompt = 'Please select your mobile platform'
+          menu.choice('iOS') { 'appium_ios' }
+          menu.choice('Android') do
+            pp 'Android appium is coming soon. Thank you for the interest'
+            exit
+          end
+          menu.choice('Cross Platform') do
+            pp 'Cross platform appium is coming soon. Thank you for the interest'
+            exit
+          end
+          menu.choice('Quit') { exit }
+        end
       end
     end
   end

data/lib/generators/rspec_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'generator'
+
+module RubyRaider
+  class RspecGenerator < Generator
+
+    def generate_spec
+      template('rspec/spec.tt', "#{name}/spec/login_page_spec.rb")
+    end
+
+    def generate_base_spec
+      template('rspec/base_spec.tt', "#{name}/spec/base_spec.rb")
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AbstractComponent
+  def initialize(component)
+    @component = component
+  end
+end

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

@@ -0,0 +1,10 @@
+require 'rspec'
+<%= ERB.new(File.read(File.expand_path('./partials/require_raider.tt', __dir__))).result(binding) %>
+
+class AbstractPage
+  include RSpec::Matchers
+  extend Raider::PomHelper
+  <%= ERB.new(File.read(File.expand_path('./partials/driver_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) %>
+end

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

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

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/abstract_component'
+
+class HeaderComponent < AbstractComponent
+  def customer_name
+    @component.text
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/abstract_page'
+
+class ConfirmationPage < AbstractPage
+  #Values
+
+  def login_message
+    driver.wait { message_element }.text
+  end
+
+  private
+
+  # Elements
+
+  def message_element
+    driver.find_element(accessibility_id: 'You are logged in as alice')
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/abstract_page'
+
+class HomePage < AbstractPage
+
+  #Actions
+
+  def go_to_login
+    driver.wait { login_button_navigator }.click
+  end
+
+  private
+
+  # Elements
+
+  def login_button_navigator
+    driver.find_element(accessibility_id: 'Login Screen')
+  end
+end

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

@@ -0,0 +1,8 @@
+<% case automation
+ when 'selenium' %>
+<%= 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/appium_login.tt

@@ -0,0 +1,28 @@
+require_relative '../abstract/abstract_page'
+
+class LoginPage < AbstractPage
+
+  # Actions
+
+  def login(username, password)
+    username_field.send_keys username
+    password_field.send_keys password
+    login_button.click
+  end
+
+  private
+
+  # Elements
+
+  def username_field
+    driver.find_element(xpath: "//XCUIElementTypeTextField[@name=\"username\"]")
+  end
+
+  def password_field
+    driver.find_element(xpath: "//XCUIElementTypeSecureTextField[@name=\"password\"]")
+  end
+
+  def login_button
+    driver.find_elements(xpath: "//XCUIElementTypeOther[@name=\"loginBtn\"]").last
+  end
+end

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

@@ -0,0 +1,9 @@
+<% if automation == 'watir' %>
+  def browser
+    Raider::BrowserHelper.browser
+  end
+<% else %>
+  def driver
+    Raider::DriverHelper.driver
+  end
+<% end %>

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

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

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

@@ -0,0 +1,5 @@
+<% if framework == 'rspec' %>
+require_relative '../../helpers/raider'
+<% else %>
+require_relative '../../helpers/raider'
+<% end %>

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

@@ -0,0 +1,40 @@
+require_relative '../abstract/abstract_page'
+require_relative '../components/header_component'
+
+class LoginPage < AbstractPage
+  using Raider::SeleniumHelper
+
+  def url(_page)
+    'index.php?rt=account/login'
+  end
+
+  # Actions
+
+  def login(username, password)
+    username_field.send_keys username
+    password_field.send_keys password
+    login_button.click_when_present
+  end
+
+  # Components
+
+  def header
+    HeaderComponent.new(driver.find_element(class: 'menu_text'))
+  end
+
+  private
+
+  # Elements
+
+  def username_field
+    driver.find_element(id: 'loginFrm_loginname')
+  end
+
+  def password_field
+    driver.find_element(id: 'loginFrm_password')
+  end
+
+  def login_button
+    driver.find_element(xpath: "//button[@title='Login']")
+  end
+end

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

@@ -0,0 +1,13 @@
+<% if %w[selenium watir].include?(automation) %>
+  def full_url(*page)
+    "#{base_url}#{url(*page)}"
+  end
+
+  def base_url
+    'https://automationteststore.com/'
+  end
+
+  def url(_page)
+    raise 'Url must be defined on child pages'
+  end
+<% end %>

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

@@ -0,0 +1,9 @@
+<% if %w[selenium watir].include? automation %>
+  def visit(*page)
+<% if automation == 'selenium' %>
+    driver.navigate.to full_url(page.first)
+<% else %>
+    browser.goto full_url(page.first)
+<% end %>
+  end
+<% end %>

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

@@ -0,0 +1,41 @@
+require_relative '../abstract/abstract_page'
+require_relative '../components/header_component'
+
+class LoginPage < AbstractPage
+  using Raider::WatirHelper
+
+  def url(_page)
+    'index.php?rt=account/login'
+  end
+
+  # Actions
+
+  def login(username, password)
+    username_field.send_keys username
+    password_field.send_keys password
+    login_button.click_when_present
+  end
+
+  # Components
+
+
+  def header
+    HeaderComponent.new(browser.element(class: 'menu_text'))
+  end
+
+  private
+
+  # Elements
+
+  def username_field
+    browser.element(id: 'loginFrm_loginname')
+  end
+
+  def password_field
+    browser.element(id: 'loginFrm_password')
+  end
+
+  def login_button
+    browser.element(xpath: "//button[@title='Login']")
+  end
+end

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

@@ -0,0 +1 @@
+browser: :chrome

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

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gem 'activesupport'
+gem 'allure-rspec'
+gem 'allure-ruby-commons'
+<% if framework == 'cucumber' %>
+gem 'allure-cucumber'
+<% end %>
+gem 'parallel_split_test'
+gem 'parallel_tests'
+gem 'rake'
+gem '<%= framework %>'
+<% if framework == 'cucumber' %>
+gem 'rspec'
+<% end %>
+<%= ERB.new(File.read(File.expand_path('./partials/automation_gems.tt', __dir__))).result(binding).strip! %>
+<% if %w[selenium watir].include? automation %>
+gem 'webdrivers'
+<% end %>

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

@@ -0,0 +1,10 @@
+<% case automation
+ when 'watir' %>
+gem 'selenium-webdriver'
+gem 'watir'
+<% when 'selenium' %>
+gem 'selenium-webdriver'
+<% else %>
+gem 'appium_lib'
+gem 'appium_console'
+<% end %>

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

@@ -0,0 +1,8 @@
+require 'yaml'
+
+desc 'Selects browser for automation run'
+task :select_browser, [:browser] do |_t, args|
+  config = YAML.load_file('config/config.yml')
+  config['browser'] = args.browser
+  File.write('config/config.yml', config.to_yaml)
+end