ruby_raider 3.13.0 → 4.0.0

data/lib/generators/generator.rb

@@ -13,7 +13,7 @@ class Generator < Thor::Group
 
   def self.source_paths
     base_path = File.dirname(__FILE__)
-    %W[#{base_path}/automation/templates #{base_path}/cucumber/templates
+    %W[#{base_path}/automation/templates
        #{base_path}/rspec/templates
        #{base_path}/templates #{base_path}/infrastructure/templates ]
   end
@@ -22,10 +22,6 @@ class Generator < Thor::Group
     initializer.first
   end
 
-  def cucumber?
-    framework == 'cucumber'
-  end
-
   # The framework is cross platform when it supports Android and iOS
   def cross_platform?
     automation == 'cross_platform'
@@ -47,10 +43,6 @@ class Generator < Thor::Group
     automation == 'android'
   end
 
-  def rspec?
-    framework == 'rspec'
-  end
-
   def azure?
     options_after_name.include?('azure')
   end
@@ -59,23 +51,24 @@ class Generator < Thor::Group
     !azure?
   end
 
-  # The automation arg only, so a project named "watir" or "selenium" keeps its own automation
+  # The automation arg only, so a project named "selenium" keeps its own automation
   def selenium?
     automation == 'selenium'
   end
 
-  def watir?
-    automation == 'watir'
+  # Selenium web projects record a trace per test; mobile has none yet
+  def trace_helper?
+    !mobile?
   end
 
-  # Selenium and Appium projects get the auto-waiting WaitHelper; Watir keeps its own waits
-  def wait_helper?
-    !watir?
+  # Network mocking needs the same Selenium web projects (WebDriver BiDi, no mobile)
+  def network_helper?
+    trace_helper?
   end
 
-  # Selenium web projects record a trace per test; it needs WaitHelper's actions, and mobile has none yet
-  def trace_helper?
-    wait_helper? && !mobile?
+  # Screenshot comparison needs the same Selenium web projects
+  def screenshot_helper?
+    trace_helper?
   end
 
   # False for `raider new -p examples:false`: an empty skeleton without the example pages, tests and wiring
@@ -84,7 +77,7 @@ class Generator < Thor::Group
   end
 
   def web?
-    selenium? || watir?
+    selenium?
   end
 
   def axe_addon?

data/lib/generators/helper_generator.rb

@@ -4,33 +4,24 @@ require_relative 'generator'
 
 class HelpersGenerator < Generator
   def generate_helpers
-    generate_browser_helper
     generate_driver_helper
     generate_appium_helper
+    generate_gesture_helper
     generate_spec_helper
     generate_video_helper
     generate_session_state
-    generate_wait_helper
     generate_trace_helper
+    generate_network_helper
+    generate_screenshot_helper
   end
 
   private
 
-  def generate_browser_helper
-    return if selenium_based? || mobile?
-
-    template('helpers/browser_helper.tt', "#{name}/helpers/browser_helper.rb")
-  end
-
   def generate_spec_helper
-    return if cucumber?
-
     template('helpers/spec_helper.tt', "#{name}/helpers/spec_helper.rb")
   end
 
   def generate_driver_helper
-    return if watir?
-
     template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
   end
 
@@ -44,19 +35,30 @@ class HelpersGenerator < Generator
     template('helpers/session_state.tt', "#{name}/helpers/session_state.rb")
   end
 
-  def generate_wait_helper
-    return unless wait_helper?
-
-    template('helpers/wait_helper.tt', "#{name}/helpers/wait_helper.rb")
-    template('helpers/raider_element.tt', "#{name}/helpers/raider_element.rb")
-  end
-
   def generate_trace_helper
     return unless trace_helper?
 
     template('helpers/trace_helper.tt', "#{name}/helpers/trace_helper.rb")
   end
 
+  def generate_network_helper
+    return unless network_helper?
+
+    template('helpers/network_helper.tt', "#{name}/helpers/network_helper.rb")
+  end
+
+  def generate_screenshot_helper
+    return unless screenshot_helper?
+
+    template('helpers/screenshot_helper.tt', "#{name}/helpers/screenshot_helper.rb")
+  end
+
+  def generate_gesture_helper
+    return unless mobile?
+
+    template('helpers/gesture_helper.tt', "#{name}/helpers/gesture_helper.rb")
+  end
+
   def generate_appium_helper
     return unless cross_platform?
 

data/lib/generators/infrastructure/templates/azure_pipelines.tt

@@ -32,7 +32,7 @@ jobs:
       - script: bundle exec raider u video install
         displayName: Install ffmpeg for failure videos
         continueOnError: true
-      - script: <%- if cucumber? -%>bundle exec raider-reporter exec -- bundle exec cucumber features/ --format pretty<%- else -%>bundle exec raider-reporter exec -- bundle exec rspec spec/ --format documentation<%- end %>
+      - script: bundle exec raider-reporter exec -- bundle exec rspec spec/ --format documentation
         displayName: Run tests
         env:
           RAIDER_TOKEN: $(RAIDER_TOKEN)

data/lib/generators/infrastructure/templates/github.tt

@@ -1,5 +1,4 @@
-name: <%- if framework == 'cucumber' -%>Cucumber Tests<%- else -%>Rspec Tests<%- end -%>
-
+name: Rspec Tests
 on:
   push:
     branches: [ main, master ]
@@ -45,7 +44,7 @@ jobs:
         continue-on-error: true
 
       - name: Run tests
-        run: <%- if framework == 'cucumber' -%>bundle exec raider-reporter exec -- bundle exec cucumber features --format pretty<%- else -%>bundle exec raider-reporter exec -- bundle exec rspec spec --format documentation<%- end %>
+        run: bundle exec raider-reporter exec -- bundle exec rspec spec --format documentation
         # RAIDER_ENDPOINT: your Raider Hideout URL (repository variable); RAIDER_TOKEN: a project token (secret).
         env:
           HEADLESS: true

data/lib/generators/infrastructure/templates/github_appium.tt

@@ -56,11 +56,7 @@ jobs:
         continue-on-error: true
 
       - name: Run tests
-<%- if cucumber? -%>
-        run: bundle exec raider-reporter exec -- bundle exec cucumber features/ --format pretty
-<%- else -%>
         run: bundle exec raider-reporter exec -- bundle exec rspec spec/ --format documentation
-<%- end -%>
         # RAIDER_ENDPOINT: your Raider Hideout URL (repository variable); RAIDER_TOKEN: a project token (secret).
         env:
           APP_PATH: ${{ github.workspace }}/apps/RaiderTestApp.app
@@ -132,11 +128,7 @@ jobs:
           arch: x86_64
           profile: pixel_8
           script: |
-<%- if cucumber? -%>
-            bundle exec raider-reporter exec -- bundle exec cucumber features/ --format pretty
-<%- else -%>
             bundle exec raider-reporter exec -- bundle exec rspec spec/ --format documentation
-<%- end -%>
         env:
           APP_PATH: ${{ github.workspace }}/apps/app-release.apk
           RAIDER_TOKEN: ${{ secrets.RAIDER_TOKEN }}

data/lib/generators/invoke_generators.rb

@@ -3,16 +3,12 @@ require_relative 'infrastructure/github_generator'
 require_relative 'infrastructure/azure_generator'
 require_relative 'automation/automation_generator'
 require_relative 'common_generator'
-require_relative 'cucumber/cucumber_generator'
 require_relative 'helper_generator'
 require_relative 'rspec/rspec_generator'
 
 module InvokeGenerators
-  FRAMEWORKS = %w[rspec cucumber].freeze
-  AUTOMATIONS = %w[selenium watir ios android cross_platform].freeze
-
-  WATIR_NOTICE = 'Watir is deprecated and will be removed in the next major version of ruby_raider; ' \
-                 'new projects should use Selenium.'.freeze
+  FRAMEWORKS = %w[rspec].freeze
+  AUTOMATIONS = %w[selenium ios android cross_platform].freeze
 
   module_function
 
@@ -36,13 +32,11 @@ module InvokeGenerators
                        })
     end
     print_mobile_azure_notice(structure)
-    print_watir_notice(structure)
-    print_watir_examples_notice(structure)
   end
 
   def normalise_options(structure)
     structure.merge(
-      framework: structure[:framework].to_s.downcase,
+      framework: structure[:framework].to_s.downcase.then { |f| f.empty? ? 'rspec' : f },
       automation: structure[:automation].to_s.downcase
     )
   end
@@ -65,12 +59,6 @@ module InvokeGenerators
     puts 'Azure Pipelines template for mobile projects is not available yet; see the README.'
   end
 
-  def print_watir_notice(structure)
-    return unless structure[:automation] == 'watir'
-
-    puts WATIR_NOTICE
-  end
-
   def add_generator(generators, *gens)
     gens.each { |generator| generators.push generator }
   end
@@ -96,15 +84,8 @@ module InvokeGenerators
     flags
   end
 
-  # Watir templates are frozen, so a Watir project always gets the example tests
   def skeleton?(structure)
-    structure[:examples] == false && structure[:automation] != 'watir'
-  end
-
-  def print_watir_examples_notice(structure)
-    return unless structure[:examples] == false && structure[:automation] == 'watir'
-
-    puts 'Watir projects always include the example tests; examples:false applies to Selenium and Appium projects.'
+    structure[:examples] == false
   end
 
   def mobile_automation?(automation)

data/lib/generators/menu_generator.rb

@@ -22,7 +22,7 @@ class MenuGenerator
   def choose_test_framework(automation)
     return choose_mobile_platform if automation == 'appium'
 
-    select_test_framework(automation)
+    select_examples('Rspec', automation)
   end
 
   def set_up_framework(options)
@@ -69,14 +69,6 @@ class MenuGenerator
     end
   end
 
-  def select_test_framework(automation)
-    prompt.select('Please select your test framework') do |menu|
-      menu.choice :Cucumber, -> { select_examples('Cucumber', automation) }
-      menu.choice :Rspec, -> { select_examples('Rspec', automation) }
-      menu.choice :Quit, -> { exit }
-    end
-  end
-
   def select_examples(framework, automation_type)
     prompt.select('Do you want example tests?') do |menu|
       menu.choice :Yes, -> { select_accessibility(framework, automation_type, examples: true) }

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

@@ -4,18 +4,10 @@ require_relative '../helpers/spec_helper'
 
 describe 'Accessibility' do
   before do
-<%- if watir? -%>
-    browser.goto 'https://raider-test-site.onrender.com/'
-<%- else -%>
     driver.get 'https://raider-test-site.onrender.com/'
-<%- end -%>
   end
 
   it 'has no accessibility violations on the page' do
-<%- if watir? -%>
-    expect(browser.driver).to be_axe_clean
-<%- else -%>
-    expect(driver).to be_axe_clean
-<%- end -%>
+    Raider::Wait.immediately { expect(driver).to be_axe_clean }
   end
 end

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

@@ -1,4 +1,4 @@
-<%- if selenium_based? || watir? -%>
+<%- if selenium_based? -%>
 # frozen_string_literal: true
 
 require_relative '../helpers/spec_helper'
@@ -8,13 +8,9 @@ require_relative '../page_objects/pages/login'
 
 # rubocop:disable RSpec/MultipleDescribes
 describe 'Login' do
-<%- if watir? -%>
-  subject(:header) { account_page.header.customer_name }
-
-<%- end -%>
   let(:user) { ModelFactory.for('users')['registered user'] }
-  let(:login_page) { <% if watir? -%>Login.new(browser)<% else -%>Login.new(driver)<% end -%> }
-  let(:account_page) { <% if watir? -%>Account.new(browser)<% else -%>Account.new(driver)<% end -%> }
+  let(:login_page) { Login.new(driver) }
+  let(:account_page) { Account.new(driver) }
 
   before do
     login_page.visit
@@ -26,11 +22,7 @@ describe 'Login' do
 
     it 'can successfully log in' do
       account_page.visit
-<%- if watir? -%>
-      expect(header).to eq "Welcome back #{user['name']}"
-<%- else -%>
-      eventually { expect(account_page.header.customer_name).to eq "Welcome back #{user['name']}" }
-<%- end -%>
+      expect { account_page.welcome_message }.to have_text("Welcome back #{user['name']}")
     end
   end
 
@@ -39,26 +31,18 @@ describe 'Login' do
 
     it 'cannot log in' do
       login_page.visit
-<%- if watir? -%>
-      expect(header).to eq 'Login or register'
-<%- else -%>
-      eventually { expect(account_page.header.customer_name).to eq 'Login or register' }
-<%- end -%>
+      expect { login_page.welcome_message }.to have_text('Login or register')
     end
   end
 end
 
 describe 'Account', :logged_in do
   let(:user) { ModelFactory.for('users')['registered user'] }
-  let(:account_page) { <% if watir? -%>Account.new(browser)<% else -%>Account.new(driver)<% end -%> }
+  let(:account_page) { Account.new(driver) }
 
   it 'opens the account page with the saved login' do
     account_page.visit
-<%- if watir? -%>
-    expect(account_page.header.customer_name).to eq "Welcome back #{user['name']}"
-<%- else -%>
-    eventually { expect(account_page.header.customer_name).to eq "Welcome back #{user['name']}" }
-<%- end -%>
+    expect { account_page.welcome_message }.to have_text("Welcome back #{user['name']}")
   end
 end
 # rubocop:enable RSpec/MultipleDescribes
@@ -79,7 +63,7 @@ class PdpSpec
 
     it 'shows add to cart button' do
       home_page.go_to_product_detail
-      eventually { expect(pdp_page.add_to_cart_text).to eq 'Add to Cart' }
+      expect { pdp_page.add_to_cart_button }.to have_text('Add to Cart')
     end
   end
 end

data/lib/generators/template_renderer/partial_cache.rb

@@ -113,7 +113,9 @@ module TemplateRenderer
 
     # Compile an ERB template
     def compile_template(path, trim_mode)
-      content = File.read(path)
+      # Templates are UTF-8 whatever the locale: a plain File.read follows Encoding.default_external, and a
+      # US-ASCII locale (no LANG, as macOS gives GUI apps) then made ERB fail on any non-ASCII byte.
+      content = File.read(path, encoding: 'UTF-8')
       ERB.new(content, trim_mode:)
     end
 

data/lib/generators/template_renderer.rb

@@ -19,7 +19,7 @@ require_relative 'template_renderer/template_error'
 #   <%= partial('driver_config', trim_mode: '<>') %> # Custom trim_mode
 #
 # The partial() method automatically has access to all generator instance
-# variables and methods (cucumber?, mobile?, selenium?, etc.) through binding.
+# variables and methods (mobile?, selenium?, etc.) through binding.
 module TemplateRenderer
   # Render a partial template with caching and smart path resolution
   #

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

@@ -9,26 +9,19 @@ gem 'appium_lib'
 gem 'axe-core-rspec'
 gem 'axe-core-selenium'
 <%- end -%>
-<%- if cucumber? -%>
-gem 'cucumber'
+<%- if screenshot_helper? -%>
+gem 'chunky_png'
 <%- end -%>
 gem 'parallel_split_test'
 gem 'parallel_tests'
-gem 'raider_reporter', '~> 0.12'
+gem 'raider_reporter', '~> 1.0'
 gem 'rake'
 gem 'reek'
 gem 'rspec'
-<%- if rspec? -%>
 gem 'rspec-retry'
-<%- end -%>
 gem 'rubocop'
-<%- if rspec? -%>
 gem 'rubocop-rspec'
-<%- end -%>
 gem 'ruby_raider', '<%= ruby_raider_version_requirement %>'
 <%- if selenium_based? -%>
 gem 'selenium-webdriver'
 <%- end -%>
-<%- if watir? -%>
-gem 'watir'
-<%- end -%>

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

@@ -1,10 +1,5 @@
 raider-results
-<%- if rspec? -%>
 spec/examples.txt
-<%- end -%>
-<%- if cucumber? -%>
-rerun.txt
-<%- end -%>
 <%- if web? -%>
 .raider/auth/
 <%- end -%>

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

@@ -1,5 +1,7 @@
 platform: :ios
-timeout: 10 # seconds that actions and eventually wait before failing
+timeout: 10 # seconds that finds, actions and assertions wait before failing
+strict: true # find_element fails when a locator matches more than one element; find_elements never does
+actionability: true # actions wait until the element is ready (visible, enabled, stable, receives events; on native apps visible and enabled); force: true skips it
 
 video:
   enabled: true

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

@@ -1,6 +1,8 @@
 browser: chrome
 url: 'https://raider-test-site.onrender.com/'
-timeout: 10 # <%= wait_helper? ? 'seconds that actions and eventually wait before failing' : 'seconds — used for implicit waits and max wait time' %>
+timeout: 10 # seconds that finds, actions and assertions wait before failing
+strict: true # find_element fails when a locator matches more than one element; find_elements never does
+actionability: true # actions wait until the element is ready (visible, enabled, stable, receives events; on native apps visible and enabled); force: true skips it
 viewport:
   width: 1920
   height: 1080
@@ -26,6 +28,13 @@ trace:
   max_steps: 200     # newest steps are kept; older ones lose screenshots and snapshots first
   max_mb: 20         # the zip stays under this; see Cost
 <%- end -%>
+<%- if screenshot_helper? -%>
+
+screenshots:
+  threshold: 0.2        # per-pixel colour difference allowed, 0 (exact) to 1
+  max_diff_pixels: 0    # pixels allowed to differ
+  # max_diff_ratio: 0.001  # or a share of all pixels
+<%- end -%>
 
 login_state:
   max_age: 3600 # seconds a saved login is reused before logging in again

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

@@ -2,7 +2,6 @@ desc 'Print Ruby Raider version'
 task :raider do
   system 'raider version'
 end
-<%- if rspec? -%>
 
 require 'rspec/core/rake_task'
 
@@ -15,17 +14,3 @@ RSpec::Core::RakeTask.new(:regression) do |t|
 end
 
 task default: :spec
-<%- elsif cucumber? -%>
-
-require 'cucumber/rake/task'
-
-Cucumber::Rake::Task.new(:features)
-Cucumber::Rake::Task.new(:smoke) do |t|
-  t.cucumber_opts = '--tags @smoke'
-end
-Cucumber::Rake::Task.new(:regression) do |t|
-  t.cucumber_opts = '--tags @regression'
-end
-
-task default: :features
-<%- end -%>