ruby_raider 0.1.2 → 0.1.7

data/lib/generators/menu_generator.rb

@@ -1,4 +1,5 @@
 require 'highline'
+require_relative '../generators/projects/cucumber_project_generator'
 require_relative '../generators/projects/rspec_project_generator'
 
 module RubyRaider
@@ -20,16 +21,25 @@ module RubyRaider
       framework = ''
       cli.choose do |menu|
         menu.prompt = 'Please select your test framework'
-        menu.choice(:Rspec) { framework = 'Rspec'; set_rspec_framework(automation, project_name)}
-        menu.choice(:Cucumber) { framework = 'cucumber'; 'We are still working on supporting this' }
+        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 program.') { exit }
       end
       cli.say("You have chosen to use #{framework} with #{automation}")
     end
 
-    def self.set_rspec_framework(automation, project_name)
-      RspecProjectGenerator.generate_rspec_project(project_name, automation: automation)
-      ProjectGenerator.install_gems(project_name)
+    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)
+      end
     end
   end
 end

data/lib/generators/projects/cucumber_project_generator.rb

@@ -1,14 +1,26 @@
+require_relative '../files/cucumber_file_generator'
 require_relative 'project_generator'
 
 module RubyRaider
-  class CucumberProjectGenerator
-    def cucumber_folder_structure(name)
-      Dir.mkdir name.to_s
-      Dir.mkdir "#{name}/features"
-      folders = %w[steps_definitions support]
-      create_children_folders("#{name}/features", folders)
-      Dir.mkdir "#{name}/features/support/helpers"
-      Dir.mkdir "#{name}/page_objects"
+  class CucumberProjectGenerator < ProjectGenerator
+    class << self
+      def generate_cucumber_project(name, automation: 'watir')
+        cucumber_folder_structure(name)
+        CucumberFileGenerator.generate_cucumber_files(name, automation)
+        ProjectGenerator.install_gems(name)
+      end
+
+      def cucumber_folder_structure(name)
+        Dir.mkdir name.to_s
+        folders = %w[features config page_objects allure-results]
+        create_children_folders("#{name}", folders)
+        folders = %w[step_definitions support]
+        create_children_folders("#{name}/features", folders)
+        Dir.mkdir "#{name}/features/support/helpers"
+        folders = %w[abstract pages components]
+        create_children_folders("#{name}/page_objects", folders)
+        Dir.mkdir "#{name}/allure-results/screenshots"
+      end
     end
   end
 end

data/lib/generators/projects/project_generator.rb

@@ -1,11 +1,13 @@
 module RubyRaider
   class ProjectGenerator
-    def self.create_children_folders(parent, folders)
-      folders.each { |folder| Dir.mkdir "#{parent}/#{folder}" }
-    end
+    class << self
+      def create_children_folders(parent, folders)
+        folders.each { |folder| Dir.mkdir "#{parent}/#{folder}" }
+      end
 
-    def self.install_gems(name)
-      system "cd #{name} && gem install bundler && bundle install"
+      def install_gems(name)
+        system "cd #{name} && gem install bundler && bundle install"
+      end
     end
   end
 end

data/lib/generators/projects/rspec_project_generator.rb

@@ -3,21 +3,20 @@ require_relative '../files/rspec_file_generator'
 
 module RubyRaider
   class RspecProjectGenerator < ProjectGenerator
-    def self.generate_rspec_project(name, automation: 'watir')
-      rspec_folder_structure(name)
-      rspec_files(name, automation)
-    end
-
-    def self.rspec_folder_structure(name)
-      Dir.mkdir name.to_s
-      folders = %w[config data page_objects helpers spec]
-      create_children_folders(name, folders)
-      pages = %w[pages components abstract]
-      create_children_folders("#{name}/page_objects", pages)
-    end
+    class << self
+      def generate_rspec_project(name, automation: 'watir')
+        rspec_folder_structure(name)
+        RspecFileGenerator.generate_rspec_files(name, automation)
+        ProjectGenerator.install_gems(name)
+      end
 
-    def self.rspec_files(name, automation)
-      RspecFileGenerator.generate_rspec_files(name, automation)
+      def rspec_folder_structure(name)
+        Dir.mkdir name.to_s
+        folders = %w[config data page_objects helpers spec]
+        create_children_folders(name, folders)
+        pages = %w[pages components abstract]
+        create_children_folders("#{name}/page_objects", pages)
+      end
     end
   end
 end

data/lib/generators/templates/automation/abstract_component_template.rb

@@ -0,0 +1,22 @@
+require_relative '../template'
+
+class AbstractComponentTemplate < Template
+  def body
+    raider = if @framework == 'rspec'
+               "require_relative '../../helpers/raider'"
+             else
+               "require_relative '../../features/support/helpers/raider'"
+             end
+
+    <<~EOF
+      #{raider}
+
+      class AbstractComponent
+
+          def initialize(component)
+            @component = component
+          end
+      end
+    EOF
+  end
+end

data/lib/generators/templates/automation/abstract_page_template.rb

@@ -0,0 +1,48 @@
+require_relative '../template'
+
+class AbstractPageTemplate < Template
+  def body
+    browser = "def browser
+    Raider::BrowserHelper.browser
+  end"
+    driver = "def driver
+    Raider::DriverHelper.driver
+  end"
+
+    visit = @automation == 'watir' ? 'browser.goto full_url(page.first)' : 'driver.navigate.to full_url(page.first)'
+    raider = if @framework == 'rspec'
+               "require_relative '../../helpers/raider'"
+             else
+               "require_relative '../../features/support/helpers/raider'"
+             end
+
+    <<~EOF
+        require 'rspec'
+        #{raider}
+
+        class AbstractPage
+
+          include RSpec::Matchers
+          extend Raider::PomHelper
+
+          #{@automation == 'watir' ? browser : driver}
+
+          def visit(*page)
+            #{visit}
+          end
+
+          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
+    EOF
+  end
+end

data/lib/generators/templates/automation/component_template.rb

@@ -0,0 +1,16 @@
+require_relative '../template'
+
+class ComponentTemplate < Template
+  def body
+    <<~EOF
+          require_relative '../abstract/abstract_component'
+
+          class HeaderComponent < AbstractComponent
+
+            def customer_name
+              @component.text
+            end
+          end
+    EOF
+  end
+end

data/lib/generators/templates/automation/page_template.rb

@@ -0,0 +1,51 @@
+require_relative '../template'
+
+class PageTemplate < Template
+  def body
+    element = @automation == 'watir' ? 'browser.element' : 'driver.find_element'
+    helper = @automation == 'watir' ? 'Raider::WatirHelper' : 'Raider::SeleniumHelper'
+
+    <<~EOF
+      require_relative '../abstract/abstract_page'
+      require_relative '../components/header_component'
+
+      class LoginPage < AbstractPage
+        using #{helper}
+
+        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(#{element}(class: 'menu_text'))
+        end
+
+        private
+
+        # Elements
+
+        def username_field
+          #{element}(id: 'loginFrm_loginname')
+        end
+
+        def password_field
+          #{element}(id: 'loginFrm_password')
+        end
+
+        def login_button
+          #{element}(xpath: "//button[@title='Login']")
+        end
+      end
+    EOF
+  end
+end

data/lib/generators/templates/common/config_template.rb

@@ -0,0 +1,9 @@
+require_relative '../template'
+
+class ConfigTemplate < Template
+  def body
+    <<~EOF
+      browser: :chrome
+    EOF
+  end
+end

data/lib/generators/templates/common/gemfile_template.rb

@@ -0,0 +1,29 @@
+require_relative '../template'
+
+class GemfileTemplate < Template
+  def body
+    if @framework == 'cucumber'
+      allure_cucumber = "gem 'allure-cucumber'"
+      rspec = "gem 'rspec'"
+    end
+
+    <<~EOF
+          # frozen_string_literal: true
+
+          source 'https://rubygems.org'
+
+          gem 'activesupport'
+          gem 'allure-rspec'
+          gem 'allure-ruby-commons'
+          #{allure_cucumber}
+          gem 'parallel_split_test'
+          gem 'parallel_tests'
+          gem 'rake'
+          gem '#{@framework}'
+          #{rspec}
+          gem 'selenium-webdriver'
+          gem 'watir'
+          gem 'webdrivers'
+    EOF
+  end
+end

data/lib/generators/templates/common/rake_file_template.rb

@@ -0,0 +1,16 @@
+require_relative '../template'
+
+class RakeFileTemplate < Template
+  def body
+    <<~EOF
+          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
+    EOF
+  end
+end

data/lib/generators/templates/common/read_me_template.rb

@@ -0,0 +1,104 @@
+require_relative '../template'
+
+class ReadMeTemplate < Template
+  def body
+    <<~EOF
+          What is Raider?
+          ===========
+
+          Raider is a tool to make the setup and start of automation projects in ruby easier, with one command you are
+          ready to go
+
+          # Pre-requisites:
+
+          Install RVM:
+          https://rvm.io/rvm/install
+
+          # How to use the framework:
+
+          If you want to run all the tests from your terminal do:
+          *rspec spec/*
+
+          If you want to run all the tests in parallel do:
+          *parallel_rspec spec/*
+
+          # How are specs organized:
+
+          We use 'context' as the highest grouping level to indicate in which part of the application we are as an example:
+
+          *context 'On the login page'/*
+
+          We use 'describe' from the user perspective to describe an action that the user can or cannot take:
+
+          *describe 'A user can'/*
+
+          or
+
+          *describe 'A user cannot'/*
+
+          This saves us repetition and forces us into an structure
+
+          At last we use 'it' for the specific action the user can or cannot perform:
+
+          it 'login with right credentials'
+
+          If we group all of this together it will look like
+
+          ```ruby
+          context 'On the login page' do
+            describe 'A user can' do
+              it 'login with the right credentials' do
+              end
+          #{'   '}
+            end
+          #{'  '}
+            describe 'A user cannot' do
+              it 'login with the wrong credentials' do
+              end
+            end
+          end
+          ```
+          #{'    '}
+          This is readed as 'On the login page a user can login with the right credentials' and 'On the login page a user cannot login with the wrong credentials'
+
+          # How pages are organized:
+
+          ```ruby#{' '}
+          require_relative '../abstract/base_page'
+
+          class MainPage < BasePage
+
+            using Raider::WatirHelper
+
+            def url(_page)
+              '/'
+            end
+
+            # Actions
+
+            def change_currency(currency)
+              currency_dropdown.select currency
+            end
+
+            # Validations
+
+            def validate_currency(currency)
+              expect(currency_dropdown.include?(currency)).to be true
+            end
+
+            private
+
+            # Elements
+
+            def currency_dropdown
+              browser.select(class: %w[dropdown-menu currency])
+            end
+          end
+          ```
+
+          Pages are organized in Actions (things a user can perform on the page), Validations (assertions), and Elements.
+          Each page has to have a url define, and each page is using the module WatirHelper to add methods on runtime to the Watir elements
+
+    EOF
+  end
+end

data/lib/generators/templates/cucumber/env_template.rb

@@ -0,0 +1,38 @@
+require_relative '../template'
+
+class EnvTemplate < Template
+  def body
+
+    if @automation == 'watir'
+      helper = 'helpers/browser_helper'
+      browser = 'Raider::BrowserHelper.new_browser'
+      get_browser = 'browser = Raider::BrowserHelper.new_browser'
+      screenshot = 'browser.screenshot.save("allure-results/screenshots/#{scenario.name}.png")'
+      quit = 'browser.quit'
+    else
+      helper = 'helpers/driver_helper'
+      browser = 'Raider::DriverHelper.new_driver'
+      get_browser = 'driver = Raider::DriverHelper.driver'
+      screenshot = 'driver.save_screenshot("allure-results/screenshots/#{scenario.name}.png")'
+      quit = 'driver.quit'
+    end
+
+    <<~EOF
+      require 'active_support/all'
+      require_relative 'helpers/allure_helper'
+      require_relative '#{helper}'
+
+      Before do
+          Raider::AllureHelper.configure
+          #{browser}
+      end
+
+      After do |scenario|
+       #{get_browser}
+        #{screenshot}
+        Raider::AllureHelper.add_screenshot(scenario.name)
+        #{quit}
+      end
+    EOF
+  end
+end

data/lib/generators/templates/cucumber/example_feature_template.rb

@@ -0,0 +1,15 @@
+require_relative '../template'
+
+class ExampleFeatureTemplate < Template
+  def body
+    <<~EOF
+      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
+
+    EOF
+  end
+end

data/lib/generators/templates/cucumber/example_steps_template.rb

@@ -0,0 +1,21 @@
+require_relative '../template'
+
+class ExampleStepsTemplate < Template
+  def body
+    <<~EOF
+          require_relative '../../page_objects/pages/login_page'
+
+          Given("I'm a registered user on the login page") do
+            LoginPage.visit
+          end
+
+          When('I login with my credentials') do
+            LoginPage.login('aguspe', '12341234')
+          end
+
+          When('I can see the main page') do
+            expect(LoginPage.header.customer_name).to eq 'Welcome back Agustin'
+          end
+    EOF
+  end
+end

data/lib/generators/templates/helpers/allure_helper_template.rb

@@ -0,0 +1,47 @@
+require_relative '../template'
+
+class AllureHelperTemplate < Template
+  def body
+    if @framework == 'cucumber'
+      gems = "require 'allure-cucumber'"
+      allure = 'AllureCucumber'
+    else
+      gems = "require 'allure-ruby-commons'
+require 'allure-rspec'"
+      allure = 'AllureRspec'
+    end
+    <<~EOF
+            #{gems}
+
+            module Raider
+              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
+
+                  #{
+      if @framework == 'rspec'
+        'def formatter
+            AllureRspecFormatter
+          end'
+      end }
+                end
+              end
+            end
+    EOF
+  end
+end

data/lib/generators/templates/helpers/browser_helper_template.rb

@@ -0,0 +1,26 @@
+require_relative '../template'
+
+class BrowserHelperTemplate < Template
+  def body
+    <<~EOF
+      require 'yaml'
+      require 'selenium-webdriver'
+      require 'watir'
+      require 'webdrivers'
+
+      module Raider
+        module BrowserHelper
+          class << self
+            attr_reader :browser
+
+            def new_browser
+              config = YAML.load_file('config/config.yml')
+              @browser = Watir::Browser.new config['browser']
+            end
+          end
+        end
+      end
+
+    EOF
+  end
+end

data/lib/generators/templates/helpers/driver_helper_template.rb

@@ -0,0 +1,24 @@
+require_relative '../template'
+
+class DriverHelperTemplate < Template
+  def body
+    <<~EOF
+      require 'selenium-webdriver'
+      require 'watir'
+      require 'webdrivers'
+      require 'yaml'
+
+      module Raider
+        module DriverHelper
+          class << self
+            attr_reader :driver
+
+            def new_driver
+              @driver = Selenium::WebDriver.for :chrome
+            end
+          end
+        end
+      end
+    EOF
+  end
+end

data/lib/generators/templates/helpers/pom_helper_template.rb

@@ -0,0 +1,25 @@
+require_relative '../template'
+
+class PomHelperTemplate < Template
+  def body
+    <<~EOF
+      module Raider
+        module PomHelper
+          def instance
+            @instance ||= new
+          end
+
+          def method_missing(message, *args, &block)
+            return super unless instance.respond_to?(message)
+
+            instance.public_send(message, *args, &block)
+          end
+
+          def respond_to_missing?(method, *_args, &block)
+            instance.respond_to?(method) || super
+          end
+        end
+      end
+    EOF
+  end
+end

data/lib/generators/templates/helpers/raider_helper_template.rb

@@ -0,0 +1,15 @@
+require_relative '../template'
+
+class RaiderHelperTemplate < Template
+  def body
+    <<~EOF
+      module Raider
+        #{"require_relative 'spec_helper'" if @framework == 'rspec'}
+        require_relative '#{@automation}_helper'
+        require_relative 'pom_helper'
+        require_relative '#{@automation == 'watir' ? 'browser_helper' : 'driver_helper'}'
+        require_relative 'allure_helper'
+      end
+    EOF
+  end
+end