ruby_raider 2.0.0 → 3.0.0

data/spec/integration/content/ci_content_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative 'content_helper'
+
+describe 'CI pipeline content' do
+  # --- GitHub Actions ---
+
+  shared_examples 'valid github pipeline' do |project_name|
+    subject(:pipeline) { read_generated("#{project_name}_github", '.github/workflows/test_pipeline.yml') }
+
+    it 'is valid YAML' do
+      expect { YAML.safe_load(pipeline) }.not_to raise_error
+    end
+
+    it 'has name' do
+      expect(pipeline).to match(/^name:/)
+    end
+
+    it 'has jobs section' do
+      expect(pipeline).to include('jobs:')
+    end
+
+    it 'sets up Ruby' do
+      expect(pipeline).to include('ruby')
+    end
+
+    it 'installs dependencies' do
+      expect(pipeline).to include('bundler-cache: true').or include('bundle install')
+    end
+  end
+
+  shared_examples 'github rspec pipeline' do |project_name|
+    subject(:pipeline) { read_generated("#{project_name}_github", '.github/workflows/test_pipeline.yml') }
+
+    it 'runs rspec' do
+      expect(pipeline).to include('rspec')
+    end
+  end
+
+  shared_examples 'github cucumber pipeline' do |project_name|
+    subject(:pipeline) { read_generated("#{project_name}_github", '.github/workflows/test_pipeline.yml') }
+
+    it 'runs cucumber' do
+      expect(pipeline).to include('cucumber')
+    end
+  end
+
+  shared_examples 'github minitest pipeline' do |project_name|
+    subject(:pipeline) { read_generated("#{project_name}_github", '.github/workflows/test_pipeline.yml') }
+
+    it 'runs minitest' do
+      expect(pipeline).to match(/minitest|ruby.*test/)
+    end
+  end
+
+  context 'with rspec and selenium on github' do
+    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::SELENIUM}"
+    include_examples 'valid github pipeline', name
+    include_examples 'github rspec pipeline', name
+  end
+
+  context 'with cucumber and selenium on github' do
+    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::SELENIUM}"
+    include_examples 'valid github pipeline', name
+    include_examples 'github cucumber pipeline', name
+  end
+
+  context 'with minitest and selenium on github' do
+    name = "#{FrameworkIndex::MINITEST}_#{AutomationIndex::SELENIUM}"
+    include_examples 'valid github pipeline', name
+    include_examples 'github minitest pipeline', name
+  end
+
+  context 'with rspec and capybara on github' do
+    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::CAPYBARA}"
+    include_examples 'valid github pipeline', name
+    include_examples 'github rspec pipeline', name
+  end
+
+  context 'with rspec and watir on github' do
+    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::WATIR}"
+    include_examples 'valid github pipeline', name
+    include_examples 'github rspec pipeline', name
+  end
+
+  # --- GitLab CI ---
+
+  shared_examples 'valid gitlab pipeline' do |project_name|
+    subject(:pipeline) { read_generated("#{project_name}_gitlab", 'gitlab-ci.yml') }
+
+    it 'is valid YAML' do
+      expect { YAML.safe_load(pipeline) }.not_to raise_error
+    end
+
+    it 'has stages' do
+      expect(pipeline).to include('stages:')
+    end
+
+    it 'has script section' do
+      expect(pipeline).to include('script:')
+    end
+  end
+
+  context 'with rspec and selenium on gitlab' do
+    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::SELENIUM}"
+    include_examples 'valid gitlab pipeline', name
+  end
+
+  context 'with cucumber and selenium on gitlab' do
+    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::SELENIUM}"
+    include_examples 'valid gitlab pipeline', name
+  end
+
+  context 'with minitest and selenium on gitlab' do
+    name = "#{FrameworkIndex::MINITEST}_#{AutomationIndex::SELENIUM}"
+    include_examples 'valid gitlab pipeline', name
+  end
+end

data/spec/integration/content/common_content_spec.rb

@@ -0,0 +1,288 @@
+# frozen_string_literal: true
+
+require_relative 'content_helper'
+
+describe 'Common file content' do
+  # --- Rakefile ---
+
+  shared_examples 'valid rakefile' do |project_name|
+    subject(:rakefile) { read_generated(project_name, 'Rakefile') }
+
+    it 'has raider version task' do
+      expect(rakefile).to include('task :raider')
+    end
+  end
+
+  shared_examples 'rspec rakefile with tag tasks' do |project_name|
+    subject(:rakefile) { read_generated(project_name, 'Rakefile') }
+
+    it 'requires rspec/core/rake_task' do
+      expect(rakefile).to include("require 'rspec/core/rake_task'")
+    end
+
+    it 'defines spec task' do
+      expect(rakefile).to include('RakeTask.new(:spec)')
+    end
+
+    it 'defines smoke task' do
+      expect(rakefile).to include('RakeTask.new(:smoke)')
+      expect(rakefile).to include("'--tag smoke'")
+    end
+
+    it 'defines regression task' do
+      expect(rakefile).to include('RakeTask.new(:regression)')
+      expect(rakefile).to include("'--tag regression'")
+    end
+
+    it 'sets default task to spec' do
+      expect(rakefile).to include('task default: :spec')
+    end
+
+    it 'does not include cucumber tasks' do
+      expect(rakefile).not_to include('Cucumber::Rake::Task')
+    end
+  end
+
+  shared_examples 'cucumber rakefile with tag tasks' do |project_name|
+    subject(:rakefile) { read_generated(project_name, 'Rakefile') }
+
+    it 'requires cucumber/rake/task' do
+      expect(rakefile).to include("require 'cucumber/rake/task'")
+    end
+
+    it 'defines features task' do
+      expect(rakefile).to include('Rake::Task.new(:features)')
+    end
+
+    it 'defines smoke task' do
+      expect(rakefile).to include('Rake::Task.new(:smoke)')
+      expect(rakefile).to include("'--tags @smoke'")
+    end
+
+    it 'defines regression task' do
+      expect(rakefile).to include('Rake::Task.new(:regression)')
+      expect(rakefile).to include("'--tags @regression'")
+    end
+
+    it 'sets default task to features' do
+      expect(rakefile).to include('task default: :features')
+    end
+
+    it 'does not include rspec tasks' do
+      expect(rakefile).not_to include('RSpec::Core::RakeTask')
+    end
+  end
+
+  shared_examples 'minitest rakefile with default task' do |project_name|
+    subject(:rakefile) { read_generated(project_name, 'Rakefile') }
+
+    it 'requires rake/testtask' do
+      expect(rakefile).to include("require 'rake/testtask'")
+    end
+
+    it 'defines test task' do
+      expect(rakefile).to include('Rake::TestTask.new(:test)')
+    end
+
+    it 'sets default task to test' do
+      expect(rakefile).to include('task default: :test')
+    end
+  end
+
+  # --- .rspec file ---
+
+  shared_examples 'has rspec dotfile' do |project_name|
+    subject(:rspec_file) { read_generated(project_name, '.rspec') }
+
+    it 'exists' do
+      expect(File).to exist(File.join(project_name, '.rspec'))
+    end
+
+    it 'requires spec_helper' do
+      expect(rspec_file).to include('--require helpers/spec_helper')
+    end
+
+    it 'uses documentation format' do
+      expect(rspec_file).to include('--format documentation')
+    end
+  end
+
+  shared_examples 'no rspec dotfile' do |project_name|
+    it 'does not have .rspec file' do
+      expect(File).not_to exist(File.join(project_name, '.rspec'))
+    end
+  end
+
+  # --- .gitignore ---
+
+  shared_examples 'rspec gitignore' do |project_name|
+    subject(:gitignore) { read_generated(project_name, '.gitignore') }
+
+    it 'includes allure-results' do
+      expect(gitignore).to include('allure-results')
+    end
+
+    it 'includes spec/examples.txt' do
+      expect(gitignore).to include('spec/examples.txt')
+    end
+  end
+
+  shared_examples 'non-rspec gitignore' do |project_name|
+    subject(:gitignore) { read_generated(project_name, '.gitignore') }
+
+    it 'includes allure-results' do
+      expect(gitignore).to include('allure-results')
+    end
+
+    it 'does not include spec/examples.txt' do
+      expect(gitignore).not_to include('spec/examples.txt')
+    end
+  end
+
+  # --- Spec helper retry config (C4) ---
+
+  shared_examples 'spec helper with retry config' do |project_name|
+    subject(:helper) { read_generated(project_name, 'helpers/spec_helper.rb') }
+
+    it 'requires rspec/retry' do
+      expect(helper).to include("require 'rspec/retry'")
+    end
+
+    it 'enables verbose retry' do
+      expect(helper).to include('config.verbose_retry = true')
+    end
+
+    it 'enables failure messages display' do
+      expect(helper).to include('config.display_try_failure_messages = true')
+    end
+
+    it 'sets retry count from env' do
+      expect(helper).to include("config.default_retry_count = ENV.fetch('RETRY_COUNT', 0).to_i")
+    end
+
+    it 'has example_status_persistence_file_path' do
+      expect(helper).to include("config.example_status_persistence_file_path = 'spec/examples.txt'")
+    end
+  end
+
+  # --- Gemfile retry gem (C4) ---
+
+  shared_examples 'gemfile with rspec-retry' do |project_name|
+    subject(:gemfile) { read_generated(project_name, 'Gemfile') }
+
+    it 'includes rspec-retry gem' do
+      expect(gemfile).to include("gem 'rspec-retry'")
+    end
+  end
+
+  shared_examples 'gemfile without rspec-retry' do |project_name|
+    subject(:gemfile) { read_generated(project_name, 'Gemfile') }
+
+    it 'does not include rspec-retry gem' do
+      expect(gemfile).not_to include("gem 'rspec-retry'")
+    end
+  end
+
+  # --- Cucumber retry config (C4) ---
+
+  shared_examples 'cucumber config with retry' do |project_name|
+    subject(:cucumber_yml) { read_generated(project_name, 'cucumber.yml') }
+
+    it 'includes --retry flag' do
+      expect(cucumber_yml).to include('--retry')
+    end
+  end
+
+  # --- RSpec contexts ---
+
+  context 'with rspec and selenium' do
+    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::SELENIUM}"
+    it_behaves_like 'valid rakefile', name
+    it_behaves_like 'rspec rakefile with tag tasks', name
+    it_behaves_like 'has rspec dotfile', name
+    it_behaves_like 'rspec gitignore', name
+    it_behaves_like 'spec helper with retry config', name
+    it_behaves_like 'gemfile with rspec-retry', name
+  end
+
+  context 'with rspec and watir' do
+    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::WATIR}"
+    it_behaves_like 'valid rakefile', name
+    it_behaves_like 'rspec rakefile with tag tasks', name
+    it_behaves_like 'has rspec dotfile', name
+    it_behaves_like 'rspec gitignore', name
+    it_behaves_like 'spec helper with retry config', name
+    it_behaves_like 'gemfile with rspec-retry', name
+  end
+
+  context 'with rspec and capybara' do
+    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::CAPYBARA}"
+    it_behaves_like 'valid rakefile', name
+    it_behaves_like 'rspec rakefile with tag tasks', name
+    it_behaves_like 'has rspec dotfile', name
+    it_behaves_like 'rspec gitignore', name
+    it_behaves_like 'spec helper with retry config', name
+    it_behaves_like 'gemfile with rspec-retry', name
+  end
+
+  # --- Cucumber contexts ---
+
+  context 'with cucumber and selenium' do
+    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::SELENIUM}"
+    it_behaves_like 'valid rakefile', name
+    it_behaves_like 'cucumber rakefile with tag tasks', name
+    it_behaves_like 'no rspec dotfile', name
+    it_behaves_like 'non-rspec gitignore', name
+    it_behaves_like 'gemfile without rspec-retry', name
+    it_behaves_like 'cucumber config with retry', name
+  end
+
+  context 'with cucumber and watir' do
+    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::WATIR}"
+    it_behaves_like 'valid rakefile', name
+    it_behaves_like 'cucumber rakefile with tag tasks', name
+    it_behaves_like 'no rspec dotfile', name
+    it_behaves_like 'non-rspec gitignore', name
+    it_behaves_like 'gemfile without rspec-retry', name
+    it_behaves_like 'cucumber config with retry', name
+  end
+
+  context 'with cucumber and capybara' do
+    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::CAPYBARA}"
+    it_behaves_like 'valid rakefile', name
+    it_behaves_like 'cucumber rakefile with tag tasks', name
+    it_behaves_like 'no rspec dotfile', name
+    it_behaves_like 'non-rspec gitignore', name
+    it_behaves_like 'gemfile without rspec-retry', name
+    it_behaves_like 'cucumber config with retry', name
+  end
+
+  # --- Minitest contexts ---
+
+  context 'with minitest and selenium' do
+    name = "#{FrameworkIndex::MINITEST}_#{AutomationIndex::SELENIUM}"
+    it_behaves_like 'valid rakefile', name
+    it_behaves_like 'minitest rakefile with default task', name
+    it_behaves_like 'no rspec dotfile', name
+    it_behaves_like 'non-rspec gitignore', name
+    it_behaves_like 'gemfile without rspec-retry', name
+  end
+
+  context 'with minitest and watir' do
+    name = "#{FrameworkIndex::MINITEST}_#{AutomationIndex::WATIR}"
+    it_behaves_like 'valid rakefile', name
+    it_behaves_like 'minitest rakefile with default task', name
+    it_behaves_like 'no rspec dotfile', name
+    it_behaves_like 'non-rspec gitignore', name
+    it_behaves_like 'gemfile without rspec-retry', name
+  end
+
+  context 'with minitest and capybara' do
+    name = "#{FrameworkIndex::MINITEST}_#{AutomationIndex::CAPYBARA}"
+    it_behaves_like 'valid rakefile', name
+    it_behaves_like 'minitest rakefile with default task', name
+    it_behaves_like 'no rspec dotfile', name
+    it_behaves_like 'non-rspec gitignore', name
+    it_behaves_like 'gemfile without rspec-retry', name
+  end
+end

data/spec/integration/content/config_content_spec.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative 'content_helper'
+
+describe 'Config file content' do
+  shared_examples 'valid web config' do |project_name|
+    subject(:config_content) { read_generated(project_name, 'config/config.yml') }
+
+    let(:config) { YAML.safe_load(config_content, permitted_classes: [Symbol]) }
+
+    it 'has browser key' do
+      expect(config).to have_key('browser')
+      expect(config['browser']).to eq('chrome')
+    end
+
+    it 'has url key' do
+      expect(config).to have_key('url')
+      expect(config['url']).to include('http')
+    end
+
+    it 'has browser_arguments section' do
+      expect(config_content).to include('browser_arguments:')
+      expect(config_content).to include('chrome:')
+      expect(config_content).to include('firefox:')
+    end
+  end
+
+  shared_examples 'selenium config with timeout' do |project_name|
+    subject(:config_content) { read_generated(project_name, 'config/config.yml') }
+
+    let(:config) { YAML.safe_load(config_content, permitted_classes: [Symbol]) }
+
+    it 'has timeout key' do
+      expect(config).to have_key('timeout')
+      expect(config['timeout']).to eq(10)
+    end
+
+    it 'has viewport section' do
+      expect(config).to have_key('viewport')
+      expect(config['viewport']['width']).to eq(1920)
+      expect(config['viewport']['height']).to eq(1080)
+    end
+  end
+
+  shared_examples 'config without driver_options' do |project_name|
+    subject(:config_content) { read_generated(project_name, 'config/config.yml') }
+
+    it 'does not have driver_options section' do
+      expect(config_content).not_to include('driver_options:')
+    end
+  end
+
+  shared_examples 'config with video section' do |project_name|
+    subject(:config_content) { read_generated(project_name, 'config/config.yml') }
+
+    let(:config) { YAML.safe_load(config_content, permitted_classes: [Symbol]) }
+
+    it 'has video section' do
+      expect(config).to have_key('video')
+    end
+
+    it 'has video enabled key defaulting to false' do
+      expect(config['video']['enabled']).to be false
+    end
+
+    it 'has video strategy key' do
+      expect(config['video']['strategy']).to eq('auto')
+    end
+  end
+
+  shared_examples 'config with debug section' do |project_name|
+    subject(:config_content) { read_generated(project_name, 'config/config.yml') }
+
+    let(:config) { YAML.safe_load(config_content, permitted_classes: [Symbol]) }
+
+    it 'has debug section' do
+      expect(config).to have_key('debug')
+    end
+
+    it 'has debug enabled key defaulting to false' do
+      expect(config['debug']['enabled']).to be false
+    end
+
+    it 'has debug console_logs key' do
+      expect(config['debug']['console_logs']).to be true
+    end
+
+    it 'has debug action_logging key' do
+      expect(config['debug']['action_logging']).to be true
+    end
+
+    it 'has debug network_logging key' do
+      expect(config['debug']['network_logging']).to be true
+    end
+
+    it 'has debug log_dir key' do
+      expect(config['debug']['log_dir']).to eq('debug_logs')
+    end
+  end
+
+  # --- Web config per automation ---
+
+  context 'with rspec and selenium' do
+    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::SELENIUM}"
+    include_examples 'valid web config', name
+    include_examples 'selenium config with timeout', name
+    include_examples 'config with video section', name
+    include_examples 'config with debug section', name
+  end
+
+  context 'with rspec and watir' do
+    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::WATIR}"
+    include_examples 'valid web config', name
+    include_examples 'config without driver_options', name
+    include_examples 'config with video section', name
+    include_examples 'config with debug section', name
+  end
+
+  context 'with rspec and capybara' do
+    name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::CAPYBARA}"
+    include_examples 'valid web config', name
+    include_examples 'config without driver_options', name
+    include_examples 'config with video section', name
+    include_examples 'config with debug section', name
+  end
+
+  context 'with cucumber and selenium' do
+    name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::SELENIUM}"
+    include_examples 'valid web config', name
+    include_examples 'selenium config with timeout', name
+    include_examples 'config with video section', name
+    include_examples 'config with debug section', name
+  end
+
+  context 'with minitest and selenium' do
+    name = "#{FrameworkIndex::MINITEST}_#{AutomationIndex::SELENIUM}"
+    include_examples 'valid web config', name
+    include_examples 'selenium config with timeout', name
+    include_examples 'config with video section', name
+    include_examples 'config with debug section', name
+  end
+
+  context 'with minitest and watir' do
+    name = "#{FrameworkIndex::MINITEST}_#{AutomationIndex::WATIR}"
+    include_examples 'valid web config', name
+    include_examples 'config without driver_options', name
+    include_examples 'config with video section', name
+    include_examples 'config with debug section', name
+  end
+
+  context 'with minitest and capybara' do
+    name = "#{FrameworkIndex::MINITEST}_#{AutomationIndex::CAPYBARA}"
+    include_examples 'valid web config', name
+    include_examples 'config without driver_options', name
+    include_examples 'config with video section', name
+    include_examples 'config with debug section', name
+  end
+
+  # --- Mobile config ---
+
+  context 'with rspec and appium android' do
+    subject(:caps) { read_generated("#{FrameworkIndex::RSPEC}_#{AutomationIndex::ANDROID}", 'config/capabilities.yml') }
+
+    it 'contains expected configuration keys' do
+      expect(caps).to include('platformName')
+      expect(caps).to include('automationName')
+      expect(caps).to include('deviceName')
+    end
+
+    it 'has platform capabilities' do
+      expect(caps).to match(/platformName/i)
+    end
+  end
+end

data/spec/integration/content/content_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+
+module ContentHelper
+  def read_generated(project, relative_path)
+    File.read(File.join(project, relative_path))
+  end
+
+  def project(framework, automation, ci_platform = nil)
+    ci_platform ? "#{framework}_#{automation}_#{ci_platform}" : "#{framework}_#{automation}"
+  end
+end
+
+RSpec::Matchers.define :have_frozen_string_literal do
+  match { |content| content.include?('# frozen_string_literal: true') }
+  failure_message { 'expected file to contain frozen_string_literal magic comment' }
+end
+
+RSpec::Matchers.define :have_valid_ruby_syntax do
+  match do |content|
+    RubyVM::InstructionSequence.compile(content)
+    true
+  rescue SyntaxError
+    false
+  end
+  failure_message { |_content| "expected valid Ruby syntax but got SyntaxError: #{$ERROR_INFO&.message}" }
+end
+
+RSpec.configure do |config|
+  config.include(ContentHelper)
+end