ruby_raider 0.1.7 → 0.2.0

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

@@ -1,16 +0,0 @@
-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

@@ -1,104 +0,0 @@
-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

@@ -1,38 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,21 +0,0 @@
-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

@@ -1,47 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

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

@@ -1,42 +0,0 @@
-require_relative '../template'
-
-class SeleniumHelperTemplate < Template
-  def body
-    <<~EOF
-      require 'selenium-webdriver'
-      require_relative 'driver_helper'
-
-      module Raider
-        module SeleniumHelper
-          def click_when_present
-            # This is an example of an implicit wait in selenium
-            wait = Selenium::WebDriver::Wait.new(timeout: 15)
-            wait.until { present? }
-            click
-          end
-
-          def select_by(key, value)
-            # Creates new Select object to use the select by method
-            dropdown = Selenium::WebDriver::Support::Select.new self
-            dropdown.select_by(key, value)
-          end
-
-          def hover
-            # Using actions to move the mouse over an element
-            DriverHelper.driver.action.move_to(self).perform
-          end
-
-          # How to perform right click through the context click method
-          def right_click
-            DriverHelper.driver.action.context_click(self).perform
-          end
-        end
-
-        # Here we are opening the selenium class and adding our custom method
-        class Selenium::WebDriver::Element
-          include SeleniumHelper
-        end
-      end
-    EOF
-  end
-end

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

@@ -1,35 +0,0 @@
-require_relative '../template'
-
-class SpecHelperTemplate < Template
-  def body
-    <<~EOF
-      require 'active_support/all'
-      require 'rspec'
-      require_relative 'allure_helper'
-      require_relative '#{@automation == 'watir' ? 'browser_helper' : 'driver_helper'}'
-
-      module Raider
-        module SpecHelper
-
-          AllureHelper.configure
-
-          RSpec.configure do |config|
-            config.formatter = AllureHelper.formatter
-            config.before(:each) do
-              #{@automation == 'watir' ? 'BrowserHelper.new_browser' : 'DriverHelper.new_driver'}
-            end
-
-            config.after(:each) do
-              #{@automation == 'watir' ? 'browser = BrowserHelper.browser' : 'driver = DriverHelper.driver'}
-              example_name = self.class.descendant_filtered_examples.first.description
-              status = self.class.descendant_filtered_examples.first.execution_result.status
-              #{@automation == 'watir' ? 'browser' : 'driver'}.save_screenshot("allure-results/screenshots/#\{example_name}.png") if status == :failed
-              AllureHelper.add_screenshot example_name if status == :failed
-              #{@automation == 'watir' ? 'browser.quit' : 'driver.quit'}
-            end
-          end
-        end
-      end
-    EOF
-  end
-end

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

@@ -1,24 +0,0 @@
-require_relative '../template'
-
-class WatirHelperTemplate < Template
-  def body
-    <<~EOF
-      require 'watir'
-
-      module Raider
-        module WatirHelper
-          refine Watir::Element do
-            def click_when_present
-              wait_until_present
-              self.click
-            end
-
-            def wait_until_present
-              self.wait_until(&:present?)
-            end
-          end
-        end
-      end
-    EOF
-  end
-end

data/lib/generators/templates/rspec/base_spec_template.rb

@@ -1,13 +0,0 @@
-require_relative '../template'
-
-class BaseSpecTemplate < Template
-  def body
-    <<~EOF
-       require_relative '../helpers/raider'
-
-      class BaseSpec
-        include Raider::SpecHelper
-      end
-    EOF
-  end
-end

data/lib/generators/templates/rspec/example_spec_template.rb

@@ -1,33 +0,0 @@
-require_relative '../template'
-
-class ExampleSpecTemplate < Template
-  def body
-    <<~EOF
-      require_relative 'base_spec'
-      require_relative '../page_objects/pages/login_page'
-
-      class LoginSpec < BaseSpec
-        context 'On the Login Page' do
-
-          before(:each) do
-            LoginPage.visit
-          end
-
-          describe 'A user can' do
-            it 'login with the right credentials', :JIRA_123 do
-              LoginPage.login('aguspe', '12341234')
-              expect(LoginPage.header.customer_name).to eq 'Welcome back Agustin'
-            end
-          end
-
-          describe 'A user cannot' do
-            it 'login with the wrong credentials', :JIRA_123 do
-              LoginPage.login('aguspe', 'wrongPassword')
-              expect(LoginPage.header.customer_name).to be_empty
-            end
-          end
-        end
-      end
-    EOF
-  end
-end

data/lib/generators/templates/template.rb

@@ -1,14 +0,0 @@
-require 'erb'
-
-class Template
-  def initialize(args = {})
-    @automation = args[:automation]
-    @name = args[:name]
-    @framework = args[:framework]
-  end
-
-  def parsed_body
-    parsed_body = ERB.new body
-    parsed_body.result(binding)
-  end
-end

data/spec/automation_file_generator_spec.rb

@@ -1,34 +0,0 @@
-require_relative '../lib/generators/files/automation_file_generator'
-require_relative 'spec_helper'
-
-describe RubyRaider::AutomationFileGenerator do
-  before(:all) do
-    @name = 'Rspec-watir-1'
-    RubyRaider::RspecProjectGenerator.generate_rspec_project(@name, automation: 'watir')
-  end
-
-  it 'creates a login page file' do
-    expect(File.exist?("#{@name}/page_objects/pages/login_page.rb")).to be_truthy
-  end
-
-  it 'creates an abstract page file' do
-    expect(File.exist?("#{@name}/page_objects/abstract/abstract_page.rb")).to be_truthy
-  end
-
-  it 'creates an abstract component file' do
-    expect(File.exist?("#{@name}/page_objects/abstract/abstract_component.rb")).to be_truthy
-  end
-
-  it 'creates a component file' do
-    expect(File.exist?("#{@name}/page_objects/components/header_component.rb")).to be_truthy
-  end
-
-  it 'creates a gemfile file' do
-    expect(File.exist?("#{@name}/Gemfile")).to be_truthy
-  end
-
-  after(:all) do
-    FileUtils.rm_rf(@name)
-  end
-end
-

data/spec/common_file_generator_spec.rb

@@ -1,27 +0,0 @@
-require_relative '../lib/generators/files/common_file_generator'
-require_relative 'spec_helper'
-
-describe RubyRaider::CommonFileGenerator do
-  before(:all) do
-    @name = 'Cucumber-watir-1'
-    RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'watir')
-  end
-
-  it 'creates a config file' do
-    expect(File.exist?("#{@name}/config/config.yml")).to be_truthy
-  end
-
-  it 'creates a rake file' do
-    expect(File.exist?("#{@name}/Rakefile")).to be_truthy
-  end
-
-  it 'creates a readMe file' do
-    expect(File.exist?("#{@name}/Readme.md")).to be_truthy
-  end
-
-  after(:all) do
-    FileUtils.rm_rf(@name)
-  end
-end
-
-

data/spec/cucumber_file_generator_spec.rb

@@ -1,26 +0,0 @@
-require_relative '../lib/generators/files/rspec_file_generator'
-require_relative 'spec_helper'
-
-describe RubyRaider::RspecFileGenerator do
-  before(:all) do
-    @name = 'Cucumber-watir-2'
-    RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'watir')
-  end
-
-  it 'creates a feature file' do
-    expect(File.exist?("#{@name}/features/login.feature")).to be_truthy
-  end
-
-  it 'creates a step definitions file' do
-    expect(File.exist?("#{@name}/features/step_definitions/login_steps.rb")).to be_truthy
-  end
-
-  it 'creates an env file' do
-    expect(File.exist?("#{@name}/features/support/env.rb")).to be_truthy
-  end
-
-  after(:all) do
-    FileUtils.rm_rf(@name)
-  end
-end
-

data/spec/cucumber_project_generator_spec.rb

@@ -1,60 +0,0 @@
-require_relative 'spec_helper'
-
-describe RubyRaider::CucumberProjectGenerator do
-  before(:all) do
-    @name = 'Cucumber'
-    RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'selenium')
-  end
-
-  it 'creates a project folder' do
-    expect(Dir.exist?(@name)).to be_truthy
-  end
-
-  it 'creates a features folder' do
-    expect(Dir.exist?("#{@name}/features")).to be_truthy
-  end
-
-  it 'creates a config folder' do
-    expect(Dir.exist?("#{@name}/config")).to be_truthy
-  end
-
-  it 'creates a page_objects object folder' do
-    expect(Dir.exist?("#{@name}/page_objects")).to be_truthy
-  end
-
-  it 'creates an allure results folder' do
-    expect(Dir.exist?("#{@name}/allure-results")).to be_truthy
-  end
-
-  it 'creates a step definitions folder' do
-    expect(Dir.exist?("#{@name}/features/step_definitions")).to be_truthy
-  end
-
-  it 'creates a support folder' do
-    expect(Dir.exist?("#{@name}/features/support")).to be_truthy
-  end
-
-  it 'creates a helpers folder' do
-    expect(Dir.exist?("#{@name}/features/support/helpers")).to be_truthy
-  end
-
-  it 'creates an abstract folder' do
-    expect(Dir.exist?("#{@name}/page_objects/abstract")).to be_truthy
-  end
-
-  it 'creates a pages folder' do
-    expect(Dir.exist?("#{@name}/page_objects/pages")).to be_truthy
-  end
-
-  it 'creates a components folder' do
-    expect(Dir.exist?("#{@name}/page_objects/components")).to be_truthy
-  end
-
-  it 'creates a screenshot folder' do
-    expect(Dir.exist?("#{@name}/allure-results/screenshots")).to be_truthy
-  end
-
-  after(:all) do
-    FileUtils.rm_rf(@name)
-  end
-end