ruby_raider 3.13.0 → 4.0.0

data/spec/integration/content/gemfile_content_spec.rb

@@ -42,53 +42,17 @@ describe 'Gemfile content' do
       expect(gemfile).to include("gem 'rubocop-rspec'")
     end
 
-    it 'does not include cucumber' do
-      expect(gemfile).not_to include("gem 'cucumber'")
-    end
-
     it 'does not include minitest' do
       expect(gemfile).not_to include("gem 'minitest'\n")
     end
   end
 
-  shared_examples 'contains cucumber gems' do |project_name|
-    subject(:gemfile) { read_generated(project_name, 'Gemfile') }
-
-    it 'includes cucumber' do
-      expect(gemfile).to include("gem 'cucumber'")
-    end
-
-    it 'does not include allure-cucumber' do
-      expect(gemfile).not_to include('allure')
-    end
-
-    it 'includes rspec as cucumber dependency' do
-      expect(gemfile).to include("gem 'rspec'")
-    end
-  end
-
   shared_examples 'contains selenium gems' do |project_name|
     subject(:gemfile) { read_generated(project_name, 'Gemfile') }
 
     it 'includes selenium-webdriver' do
       expect(gemfile).to include("gem 'selenium-webdriver'")
     end
-
-    it 'does not include watir' do
-      expect(gemfile).not_to include("gem 'watir'")
-    end
-  end
-
-  shared_examples 'contains watir gems' do |project_name|
-    subject(:gemfile) { read_generated(project_name, 'Gemfile') }
-
-    it 'includes watir' do
-      expect(gemfile).to include("gem 'watir'")
-    end
-
-    it 'does not include selenium-webdriver' do
-      expect(gemfile).not_to include("gem 'selenium-webdriver'")
-    end
   end
 
   context 'with rspec and selenium' do
@@ -98,27 +62,6 @@ describe 'Gemfile content' do
     include_examples 'contains selenium gems', name
   end
 
-  context 'with rspec and watir' do
-    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::WATIR}"
-    include_examples 'contains common gems', name
-    include_examples 'contains rspec gems', name
-    include_examples 'contains watir gems', name
-  end
-
-  context 'with cucumber and selenium' do
-    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::SELENIUM}"
-    include_examples 'contains common gems', name
-    include_examples 'contains cucumber gems', name
-    include_examples 'contains selenium gems', name
-  end
-
-  context 'with cucumber and watir' do
-    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::WATIR}"
-    include_examples 'contains common gems', name
-    include_examples 'contains cucumber gems', name
-    include_examples 'contains watir gems', name
-  end
-
   describe 'raider_reporter and ruby_raider pin' do
     major_minor = File.read('lib/version').strip.split('.').first(2).join('.')
 
@@ -127,7 +70,11 @@ describe 'Gemfile content' do
         let(:gemfile) { read_generated("#{FrameworkIndex::RSPEC}_#{automation}", 'Gemfile') }
 
         it 'includes raider_reporter' do
-          expect(gemfile).to include("gem 'raider_reporter', '~> 0.12'")
+          expect(gemfile).to include("gem 'raider_reporter', '~> 1.0'")
+        end
+
+        it "#{automation == 'selenium' ? 'includes' : 'leaves out'} chunky_png" do
+          expect(gemfile.include?("gem 'chunky_png'")).to eq(automation == 'selenium')
         end
 
         it 'has no allure gems' do
@@ -137,21 +84,9 @@ describe 'Gemfile content' do
         it 'pins ruby_raider to the generator major.minor' do
           expect(gemfile).to include("gem 'ruby_raider', '~> #{major_minor}'")
         end
-      end
-
-      context "with cucumber and #{automation}" do
-        let(:gemfile) { read_generated("#{FrameworkIndex::CUCUMBER}_#{automation}", 'Gemfile') }
-
-        it 'includes raider_reporter' do
-          expect(gemfile).to include("gem 'raider_reporter', '~> 0.12'")
-        end
-
-        it 'drops allure-cucumber' do
-          expect(gemfile).not_to include('allure')
-        end
 
-        it 'pins ruby_raider to the generator major.minor' do
-          expect(gemfile).to include("gem 'ruby_raider', '~> #{major_minor}'")
+        it 'pins ruby_raider to the 4.0 release line' do
+          expect(gemfile).to include("gem 'ruby_raider', '~> 4.0'")
         end
       end
     end

data/spec/integration/content/helper_content_spec.rb

@@ -36,20 +36,34 @@ describe 'Helper file content' do
       expect(helper).to include("require 'selenium-webdriver'")
     end
 
-    it 'does not require watir' do
-      expect(helper).not_to include("require 'watir'")
+    it 'requires the runtime right after selenium-webdriver' do
+      lines = helper.lines.map(&:chomp)
+      expect(lines[lines.index("require 'selenium-webdriver'") + 1]).to eq("require 'ruby_raider/runtime'")
     end
 
     it 'does not reference Capybara' do
       expect(helper).not_to include('Capybara')
     end
 
+    it 'requires network_helper before trace_helper' do
+      expect(helper).to include("require_relative 'network_helper'")
+      expect(helper.index("require_relative 'network_helper'")).to be < helper.index("require_relative 'trace_helper'")
+    end
+
+    it 'requires screenshot_helper next to network_helper' do
+      expect(helper).to include("require_relative 'screenshot_helper'")
+      expect(helper.index("require_relative 'screenshot_helper'")).to be > helper.index("require_relative 'network_helper'")
+      expect(helper.index("require_relative 'screenshot_helper'")).to be < helper.index("require_relative 'trace_helper'")
+    end
+
     it 'requires trace_helper' do
       expect(helper).to include("require_relative 'trace_helper'")
     end
 
     it 'sets web_socket_url only for chrome, edge and firefox and not with TRACE=off' do
-      expect(helper).to include('options.web_socket_url = true if defined?(TraceHelper) && TraceHelper.bidi?(load_browser)')
+      expect(helper).to include('bidi = (defined?(TraceHelper) && TraceHelper.bidi?(load_browser)) ||',
+                                '(defined?(NetworkHelper) && NetworkHelper.bidi?(load_browser))')
+      expect(helper).to include('options.web_socket_url = true if bidi')
     end
 
     it 'fans the video and trace listeners out through one listener, each guarded by defined?' do
@@ -77,18 +91,10 @@ describe 'Helper file content' do
       expect(helper).to match(/module BrowserHelper/)
     end
 
-    it 'requires watir' do
-      expect(helper).to include("require 'watir'")
-    end
-
     it 'defines browser method' do
       expect(helper).to match(/def browser/)
     end
 
-    it 'creates Watir::Browser' do
-      expect(helper).to include('Watir::Browser.new')
-    end
-
     it 'does not require selenium-webdriver' do
       expect(helper).not_to include("require 'selenium-webdriver'")
     end
@@ -118,6 +124,11 @@ describe 'Helper file content' do
     it 'configures RSpec' do
       expect(helper).to include('RSpec.configure')
     end
+
+    it 'requires the rspec runtime and includes the Raider matchers and helpers' do
+      expect(helper).to include("require 'ruby_raider/runtime/rspec'", 'config.include(Raider::Matchers)',
+                                'config.include(Raider::Helpers)')
+    end
   end
 
   shared_examples 'raider reporter spec helper' do |project_name, screenshot_call|
@@ -137,7 +148,7 @@ describe 'Helper file content' do
 
     it 'screenshots only on failure' do
       lines = helper.lines
-      start = lines.index { |line| line.include?('if example.exception') }
+      start = lines.index { |line| line.match?(/if (example\.exception|failure)$/) }
       expect(start).not_to be_nil
       indent = lines[start][/\A */].size
       body = lines[(start + 1)..].take_while { |line| line.strip.empty? || line[/\A */].size > indent }
@@ -173,7 +184,7 @@ describe 'Helper file content' do
     end
 
     it 'attaches "video" only when example.exception && VideoHelper.final_attempt?(example)' do
-      expect(after_hook).to match(/example\.exception\s*(\?|&&)\s*VideoHelper\.final_attempt\?\(example\)/)
+      expect(after_hook).to match(/(example\.exception|failure)\s*(\?|&&)\s*VideoHelper\.final_attempt\?\(example\)/)
       expect(after_hook).to include("RaiderReporter.attach('video', video_path, type: #{video_type}) if video_path")
     end
 
@@ -183,7 +194,7 @@ describe 'Helper file content' do
                after_hook.index(/driver\.quit|browser\.quit/)]
       expect(order).to all(be_an(Integer)).and eq(order.compact.sort)
       expect(after_hook.scan(/driver\.quit|browser\.quit/).size).to eq(1)
-      expect(after_hook[order[2]..]).to match(/\n      (@trace_recorder&\.cleanup\n      )?@video_recorder&\.cleanup\n      (driver|browser)\.quit(_driver)?\n    end\n/)
+      expect(after_hook[order[2]..]).to match(/\n      (@trace_recorder&\.cleanup\n      )?@video_recorder&\.cleanup\n      (driver|browser)\.quit(_driver)?\n(      raise mock_error if mock_error\n)?    end\n/)
     end
 
     it 'keeps the screenshot attachment' do
@@ -203,11 +214,12 @@ describe 'Helper file content' do
     end
 
     it 'keeps the trace for TRACE=on or a final-attempt failure, falling back to keeping failures without a video helper' do
-      expect(after_hook).to include('TraceHelper.keep_all? || (example.exception && (defined?(VideoHelper) ? VideoHelper.final_attempt?(example) : true))')
+      expect(after_hook).to match(/TraceHelper\.keep_all\? \|\| \((example\.exception|failure) && \(defined\?\(VideoHelper\) \? VideoHelper\.final_attempt\?\(example\) : true\)\)/)
     end
 
     it 'counts the attempt from the rspec-retry metadata and hands the recorder the test' do
-      expect(after_hook).to include('example.metadata[:retry_attempts].to_i + 1', 'error: example.exception')
+      expect(after_hook).to include('example.metadata[:retry_attempts].to_i + 1')
+      expect(after_hook).to match(/error: (example\.exception|failure) \}/)
       expect(after_hook).to include('@trace_recorder&.stop(keep: keep_trace, test: trace_test)')
     end
 
@@ -220,6 +232,32 @@ describe 'Helper file content' do
     end
   end
 
+  shared_examples 'network mock after hook' do |project_name|
+    subject(:helper) { read_generated(project_name, 'helpers/spec_helper.rb') }
+
+    let(:after_hook) { helper[/config\.after\(:each\).*\z/m] }
+
+    it 'finishes the router first and counts a mock error as a failure' do
+      expect(after_hook).to include('mock_error = NetworkHelper.finish(driver) if defined?(NetworkHelper)', 'failure = example.exception || mock_error')
+      expect(after_hook.index('mock_error = NetworkHelper.finish')).to be < after_hook.index('TraceHelper.keep_all?')
+      expect(after_hook).not_to include('example.exception ?', 'error: example.exception')
+    end
+
+    it 'raises the mock error after the driver has quit' do
+      expect(after_hook.index('raise mock_error if mock_error')).to be > after_hook.index('driver.quit')
+    end
+
+    it 'is valid Ruby' do
+      expect(helper).to have_valid_ruby_syntax
+    end
+  end
+
+  shared_examples 'no network mock wiring' do |project_name|
+    it 'leaves spec_helper.rb without NetworkHelper' do
+      expect(read_generated(project_name, 'helpers/spec_helper.rb')).not_to include('NetworkHelper', 'mock_error')
+    end
+  end
+
   shared_examples 'no trace wiring' do |project_name, file|
     it "leaves #{file} without trace code" do
       expect(read_generated(project_name, file)).not_to match(/trace/i)
@@ -242,22 +280,6 @@ describe 'Helper file content' do
     end
   end
 
-  shared_examples 'watir spec helper' do |project_name|
-    subject(:helper) { read_generated(project_name, 'helpers/spec_helper.rb') }
-
-    it 'includes BrowserHelper' do
-      expect(helper).to include('include(BrowserHelper)')
-    end
-
-    it 'requires browser_helper' do
-      expect(helper).to include("require_relative 'browser_helper'")
-    end
-
-    it 'maximizes window via browser' do
-      expect(helper).to include('browser.window.maximize')
-    end
-  end
-
   # --- Video helper ---
 
   shared_examples 'valid video helper' do |project_name|
@@ -348,13 +370,6 @@ describe 'Helper file content' do
     it_behaves_like 'video listener wiring', name, 'driver_helper.rb'
   end
 
-  context 'with cucumber and watir video' do
-    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::WATIR}"
-    it_behaves_like 'valid video helper', name
-    it_behaves_like 'web video helper', name
-    it_behaves_like 'video listener wiring', name, 'browser_helper.rb'
-  end
-
   context 'with rspec and ios video' do
     name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::IOS}"
     it_behaves_like 'valid video helper', name
@@ -379,55 +394,29 @@ describe 'Helper file content' do
     it_behaves_like 'selenium spec helper', name
   end
 
-  context 'with rspec and watir' do
-    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::WATIR}"
-    it_behaves_like 'valid browser helper', name
-    it_behaves_like 'valid spec helper', name
-    it_behaves_like 'watir spec helper', name
-  end
-
-  # --- Cucumber + automation contexts (no spec_helper/test_helper) ---
-
-  context 'with cucumber and selenium' do
-    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::SELENIUM}"
-    it_behaves_like 'valid driver helper', name
-    it_behaves_like 'selenium driver helper', name
-  end
-
-  context 'with cucumber and watir' do
-    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::WATIR}"
-    it_behaves_like 'valid browser helper', name
-  end
-
   # --- Raider reporter wiring (every rspec automation) ---
 
   AUTOMATION_TYPES.each do |automation|
     context "with rspec and #{automation} raider reporter wiring" do
       name = "#{FrameworkIndex::RSPEC}_#{automation}"
       screenshot_call = {
-        'selenium' => 'driver.save_screenshot(screenshot_path)',
-        'watir' => 'browser.screenshot.save(screenshot_path)'
+        'selenium' => 'driver.save_screenshot(screenshot_path)'
       }.fetch(automation, 'driver.screenshot(screenshot_path)')
       it_behaves_like 'raider reporter spec helper', name, screenshot_call
-      it_behaves_like 'video spec helper wiring', name, automation == 'watir' ? 'browser' : 'driver',
-                      %w[selenium watir].include?(automation) ? ':webm' : ':mp4'
+      it_behaves_like 'video spec helper wiring', name, 'driver', automation == 'selenium' ? ':webm' : ':mp4'
       if automation == 'selenium'
         it_behaves_like 'trace spec helper wiring', name
+        it_behaves_like 'network mock after hook', name
       else
         it_behaves_like 'no trace wiring', name, 'helpers/spec_helper.rb'
-      end
-    end
-
-    context "with cucumber and #{automation}" do
-      it 'does not generate the allure helper' do
-        expect(File).not_to exist("#{FrameworkIndex::CUCUMBER}_#{automation}/helpers/allure_helper.rb")
+        it_behaves_like 'no network mock wiring', name
       end
     end
   end
 
   # --- Opt-in login reuse ---
 
-  { 'selenium' => 'driver', 'watir' => 'browser.driver' }.each do |automation, target|
+  { 'selenium' => 'driver' }.each do |automation, target|
     context "with rspec and #{automation} login reuse" do
       subject(:helper) { read_generated("#{FrameworkIndex::RSPEC}_#{automation}", 'helpers/spec_helper.rb') }
 
@@ -438,7 +427,7 @@ describe 'Helper file content' do
       it 'reuses the saved login for the driver, falling back to the real login' do
         expect(helper).to include("SessionState.new(#{target}).reuse(")
         expect(helper).to include("user = ModelFactory.for('users')['registered user']", ".login(user['username'], user['password'])")
-        expect(helper).to include("header.customer_name == \"Welcome back \#{user['name']}\"")
+        expect(helper).to include("welcome_message.text == \"Welcome back \#{user['name']}\"")
       end
 
       it 'requires the models and pages the login needs' do
@@ -461,15 +450,26 @@ end
 describe 'Auto-waiting helper wiring' do
   %w[selenium ios android cross_platform].each do |automation|
     context "with rspec and #{automation}" do
-      it 'includes WaitHelper in the spec helper' do
+      it 'leaves the wait helper out of the spec helper' do
+        helper = read_generated("#{FrameworkIndex::RSPEC}_#{automation}", 'helpers/spec_helper.rb')
+        expect(helper).not_to include('wait_helper', 'WaitHelper')
+      end
+
+      it "#{automation == 'selenium' ? 'includes' : 'leaves out'} NetworkHelper in the spec helper" do
         helper = read_generated("#{FrameworkIndex::RSPEC}_#{automation}", 'helpers/spec_helper.rb')
-        expect(helper).to include("require_relative 'wait_helper'", 'config.include(WaitHelper)')
+        expect(helper.include?('config.include(NetworkHelper)')).to eq(automation == 'selenium')
+      end
+
+      it "#{automation == 'selenium' ? 'includes' : 'leaves out'} ScreenshotHelper in the spec helper" do
+        helper = read_generated("#{FrameworkIndex::RSPEC}_#{automation}", 'helpers/spec_helper.rb')
+        expect(helper.include?('config.include(ScreenshotHelper)')).to eq(automation == 'selenium')
+        expect(helper.include?("require_relative 'screenshot_helper'")).to eq(automation == 'selenium')
       end
     end
   end
 
   %w[ios android cross_platform].each do |automation|
-    %w[rspec cucumber].each do |framework|
+    FRAMEWORKS.each do |framework|
       it "does not pass a wait to appium_lib in #{framework} #{automation}" do
         driver = read_generated("#{framework}_#{automation}", 'helpers/driver_helper.rb')
         expect(driver).not_to match(/\bwait:/)
@@ -477,7 +477,7 @@ describe 'Auto-waiting helper wiring' do
     end
   end
 
-  %w[rspec cucumber].each do |framework|
+  FRAMEWORKS.each do |framework|
     it "returns the new driver without a redundant assignment in #{framework} selenium" do
       driver = read_generated("#{framework}_selenium", 'helpers/driver_helper.rb')
       expect(driver).to include("    Selenium::WebDriver.for(browser.to_sym, **arguments)\n  end")
@@ -488,14 +488,6 @@ describe 'Auto-waiting helper wiring' do
       driver = read_generated("#{framework}_selenium", 'helpers/driver_helper.rb')
       expect(driver).not_to include('implicit_wait')
     end
-
-    it "keeps Watir untouched in #{framework} watir" do
-      project = "#{framework}_watir"
-      expect(File.exist?(File.join(project, 'helpers/wait_helper.rb'))).to be(false)
-      expect(read_generated(project, 'helpers/browser_helper.rb')).to include('Watir.default_timeout')
-      files = Dir.glob(File.join(project, '**/*.rb')).map { |f| File.read(f) }
-      expect(files.grep(/WaitHelper/)).to be_empty
-    end
   end
 
   describe 'without example tests' do
@@ -511,22 +503,6 @@ describe 'Auto-waiting helper wiring' do
           expect(helper).to have_valid_ruby_syntax
         end
       end
-
-      context "with cucumber and #{automation}" do
-        let(:name) { ensure_project(framework: 'cucumber', automation:, examples: false) }
-
-        it 'names no example class or hook in the env and the World' do
-          %w[env.rb world.rb].each do |file|
-            expect(read_generated(name, "features/support/#{file}")).not_to match(/Login|Account|logged_in|factory/)
-          end
-        end
-
-        it 'has a valid env and World' do
-          %w[env.rb world.rb].each do |file|
-            expect(read_generated(name, "features/support/#{file}")).to have_valid_ruby_syntax
-          end
-        end
-      end
     end
 
     it 'keeps the session state require in the selenium rspec spec helper' do
@@ -536,3 +512,33 @@ describe 'Auto-waiting helper wiring' do
     end
   end
 end
+
+describe 'ScreenshotHelper reset between tests' do
+  it 'resets in the RSpec before(:each) of Selenium web projects only' do
+    selenium = read_generated('rspec_selenium', 'helpers/spec_helper.rb')
+    expect(selenium[/config\.before\(:each\) do.*?^    end$/m]).to include('ScreenshotHelper.reset')
+    %w[rspec_ios rspec_android].each do |project|
+      expect(read_generated(project, 'helpers/spec_helper.rb')).not_to include('ScreenshotHelper')
+    end
+  end
+end
+
+describe 'Runtime wiring in generated helpers' do
+  { 'selenium' => "require 'selenium-webdriver'", 'ios' => "require 'appium_lib'",
+    'android' => "require 'appium_lib'", 'cross_platform' => "require 'appium_lib'" }.each do |automation, anchor|
+    context "with rspec and #{automation}" do
+      let(:name) { "#{FrameworkIndex::RSPEC}_#{automation}" }
+
+      it "requires the runtime right after #{anchor}" do
+        lines = read_generated(name, 'helpers/driver_helper.rb').lines.map(&:chomp)
+        expect(lines[lines.index(anchor) + 1]).to eq("require 'ruby_raider/runtime'")
+      end
+
+      it 'requires the rspec runtime and includes the matchers and helpers in spec_helper' do
+        expect(read_generated(name, 'helpers/spec_helper.rb'))
+          .to include("require 'ruby_raider/runtime/rspec'", 'config.include(Raider::Matchers)',
+                      'config.include(Raider::Helpers)')
+      end
+    end
+  end
+end