ruby_raider 0.1.9 → 0.2.0

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+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
+
+# Mobile:
+
+For the appium base project to work you need to have [appium](https://appium.io)
+and download [the example app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0)

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

@@ -0,0 +1,8 @@
+<% case automation
+ when 'selenium' %>
+<%= ERB.new(File.read(File.expand_path('./partials/selenium_appium_env.tt', __dir__))).result(binding).strip! -%>
+<% when 'watir' %>
+<%= ERB.new(File.read(File.expand_path('./partials/watir_env.tt', __dir__))).result(binding).strip! -%>
+<% else %>
+<%= ERB.new(File.read(File.expand_path('./partials/appium_env.tt', __dir__))).result(binding).strip! -%>
+<% end %>

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

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

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

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

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

@@ -0,0 +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'
+
+Given("I'm a registered user on the login page") do
+    HomePage.go_to_login
+end
+
+When('I login with my credentials') do
+    LoginPage.login('alice', 'mypassword')
+end
+
+When('I can see the main page') do
+    expect(ConfirmationPage.login_message).to eq 'You are logged in as alice'
+end

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

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

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

@@ -0,0 +1,13 @@
+require_relative '../../helpers/browser_helper'
+
+Before do
+  Raider::AllureHelper.configure
+  Raider::BrowserHelper.new_browser
+end
+
+After do |scenario|
+  browser = Raider::BrowserHelper.browser
+  browser.screenshot.save("allure-results/screenshots/#{scenario.name}.png")
+  Raider::AllureHelper.add_screenshot(scenario.name)
+  browser.quit
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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

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

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

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+<%= ERB.new(File.read(File.expand_path('./partials/allure_requirements.tt', __dir__))).result(binding).strip! %>
+<% 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
+      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

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+<% if automation == 'selenium' %>
+require 'webdrivers'
+<% else %>
+require 'appium_lib'
+<% end %>
+require_relative 'driver_helper'
+
+module Raider
+  module DriverHelper
+    class << self
+      attr_reader :driver
+
+      <%= ERB.new(File.read(File.expand_path('./partials/new_driver.tt', __dir__))).result(binding).strip! %>
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+<% if framework == 'rspec' %>
+AllureRspec
+<% else %>
+AllureCucumber
+<% end %>

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

@@ -0,0 +1,6 @@
+<% if framework == 'cucumber' %>
+require 'allure-cucumber'
+<% else %>
+require 'allure-ruby-commons'
+require 'allure-rspec'
+<% end %>

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

@@ -0,0 +1,14 @@
+  def requirements
+    case automation
+    when 'selenium'
+        require 'selenium-webdriver'
+        require 'webdrivers'
+
+    when 'watir'
+
+        require 'watir'
+        require 'webdrivers'
+    else
+      "require 'appium_lib'"
+    end
+  end

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

@@ -0,0 +1,11 @@
+<% if automation == 'selenium' %>
+      def new_driver
+        @driver = Selenium::WebDriver.for :chrome
+      end
+<% else %>
+      def new_driver
+        appium_file = File.join(Dir.pwd, 'appium.txt')
+        caps = Appium.load_appium_txt(file: appium_file)
+        @driver = Appium::Driver.new(caps)
+      end
+<% end %>

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

@@ -0,0 +1,8 @@
+<% case automation
+ when 'selenium' %>
+DriverHelper.driver.quit
+<% when 'watir' %>
+BrowserHelper.browser.quit
+<% else %>
+DriverHelper.driver.quit_driver
+<% end %>

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

@@ -0,0 +1,5 @@
+<% if automation == 'selenium' %>
+    require_relative 'selenium_helper'
+<% elsif automation == 'watir' %>
+    require_relative 'watir_helper'
+<% end %>

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

@@ -0,0 +1,8 @@
+<% case automation
+ when 'selenium' %>
+driver.save_screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+<% when 'watir' %>
+browser.save_screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+<% else %>
+driver.screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+<% end %>

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Raider
+  <% if framework == 'rspec' %>
+  require_relative 'spec_helper'
+  <% end %>
+  <%= ERB.new(File.read(File.expand_path('./partials/require_automation.tt', __dir__))).result(binding).strip! %>
+  require_relative 'pom_helper'
+  <% if automation == 'watir' %>
+  require_relative 'browser_helper'
+  <% else %>
+  require_relative 'driver_helper'
+  <% end %>
+  require_relative 'allure_helper'
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+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 { displayed? }
+      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

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require_relative 'allure_helper'
+<% if automation == 'watir' %>
+require_relative 'browser_helper'
+<% else %>
+require_relative 'driver_helper'
+<% end %>
+
+module Raider
+  module SpecHelper
+
+    AllureHelper.configure
+    RSpec.configure do |config|
+      config.formatter = AllureHelper.formatter
+      config.before(:each) do
+        <% if automation == 'watir' %>
+        BrowserHelper.new_browser
+        <% else %>
+        DriverHelper.new_driver
+        <% end %>
+        <% if %w[appium_ios].include? automation %>
+        DriverHelper.driver.start_driver
+        <% end %>
+      end
+
+      config.after(:each) do
+        example_name = self.class.descendant_filtered_examples.first.description
+        status = self.class.descendant_filtered_examples.first.execution_result.status
+        <%= ERB.new(File.read(File.expand_path('./partials/screenshot.tt', __dir__))).result(binding).strip! %>
+        AllureHelper.add_screenshot example_name if status == :failed
+        <%= ERB.new(File.read(File.expand_path('./partials/quit_driver.tt', __dir__))).result(binding).strip! %>
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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

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

@@ -0,0 +1,5 @@
+require_relative '../helpers/raider'
+
+class BaseSpec
+  include Raider::SpecHelper
+end

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

@@ -0,0 +1,37 @@
+<% if %w[selenium watir].include? automation %>
+require_relative 'base_spec'
+require_relative '../page_objects/pages/login_page'
+
+class LoginSpec < BaseSpec
+  describe 'Login' do
+    before(:each) do
+      LoginPage.visit
+    end
+
+    it 'can login with valid credentials' do
+      LoginPage.login('aguspe', '12341234')
+      expect(LoginPage.header.customer_name).to eq 'Welcome back Agustin'
+    end
+
+    it 'cannot login with wrong credentials' do
+      LoginPage.login('aguspe', 'wrongPassword')
+      expect(LoginPage.header.customer_name).to be_empty
+    end
+  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'
+
+class LoginSpec < BaseSpec
+  describe 'Login' do
+    it 'Login with valid credentials' do
+      HomePage.go_to_login
+      LoginPage.login('alice', 'mypassword')
+      expect(ConfirmationPage.login_message).to eq 'You are logged in as alice'
+    end
+  end
+end
+<% end %>

data/lib/ruby_raider.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require_relative 'generators/menu_generator'
-require_relative 'generators/projects/cucumber_project_generator'
-require_relative 'generators/projects/project_generator'
-require_relative 'generators/projects/rspec_project_generator'
 
+# Main module to load all the generators
 module RubyRaider
-  extend self
+  module_function
+
   def generate_project(project_name)
     MenuGenerator.generate_choice_menu(project_name)
   end

data/ruby_raider.gemspec

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.1.9'
+  s.version     = '0.2.0'
   s.summary     = 'A gem to make setup and start of UI automation projects easier'
   s.description = 'This gem contents everything you need to start doing web automation in one simple package'
   s.authors     = ['Agustin Pequeno']
@@ -13,7 +15,11 @@ Gem::Specification.new do |s|
   s.bindir = 'bin'
   s.executables << 'raider'
   s.add_development_dependency 'rake', '~> 13.0.6'
+  s.add_development_dependency 'reek', '~> 6.1.0'
+  s.add_development_dependency 'rubocop', '~> 1.27'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.9.0'
   s.add_development_dependency 'rspec', '~> 3.11.0'
 
   s.add_runtime_dependency 'highline', '~> 2.0.3'
+  s.add_runtime_dependency 'thor', '~> 1.2.1'
 end