selenium_chrome_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d509320040ae664e9c2565e483f46d08467aa31ec987c450d98edeeb8d2b9df
+  data.tar.gz: f54dfa1bd8b8b1bdfa81d298195468c8437b65522d713a475318c6e5dc3de549
+SHA512:
+  metadata.gz: '0449ea6af9e6d9795fd12f45d8b620cb7e7ce7625bc81d678a30df1ae7ad07ddc34cb0234af37657fff167d881af0bd6397548a783d792be0d70e725f95ce389'
+  data.tar.gz: 3360976fb82b04165e80cc229e4da018eb98172becb83ec553d40dbb37fb98b347e58c5715d4decf273c33826011beddbd25ae104f6094a9b98e805775324a64

data/lib/selenium_chrome_helper/railtie.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+require 'capybara'
+require 'selenium/webdriver'
+
+module SeleniumChromeHelper
+  CHROME_VERSION = ENV.fetch('SELENIUM_CHROME_VERSION', '134.0.6998.165')
+
+  # This Railtie configures Capybara to use a specific version of Google Chrome for testing.
+  # It registers two drivers: one for headless testing and one for non-headless testing.
+  class Railtie < Rails::Railtie
+    initializer 'selenium_chrome_helper.configure_capybara' do
+      platform = determine_platform
+      base_path = Rails.root.join('.chrome-for-testing', CHROME_VERSION)
+      chrome_path = determine_chrome_path(base_path, platform)
+      driver_path = base_path.join("chromedriver-#{platform}", 'chromedriver').to_s
+
+      Capybara.register_driver :chrome_for_testing do |app|
+        Selenium::WebDriver::Chrome::Service.driver_path = driver_path
+
+        options = configure_browser_options(chrome_path)
+        Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
+      end
+
+      Capybara.register_driver :chrome_for_testing do |app|
+        Selenium::WebDriver::Chrome::Service.driver_path = driver_path
+
+        options = configure_browser_options(chrome_path, headless: false)
+        Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
+      end
+    end
+
+    private
+
+    def determine_platform
+      case RUBY_PLATFORM
+      when /darwin/
+        `uname -m`.strip == 'arm64' ? 'mac-arm64' : 'mac-x64'
+      when /linux/
+        'linux64'
+      else
+        raise "Unsupported platform: #{RUBY_PLATFORM}"
+      end
+    end
+
+    def determine_chrome_path(base_path, platform)
+      if platform.start_with?('mac')
+        base_path.join("chrome-#{platform}", 'Google Chrome for Testing.app', 'Contents',
+                       'MacOS', 'Google Chrome for Testing').to_s
+      else
+        base_path.join("chrome-#{platform}", 'chrome').to_s
+      end
+    end
+
+    def configure_browser_options(chrome_path, headless: true)
+      options = Selenium::WebDriver::Chrome::Options.new
+      options.binary = chrome_path
+      options.add_argument('--headless=new') if headless
+      options.add_argument('--disable-gpu')
+      options.add_argument('--no-sandbox')
+      options.add_argument('--window-size=1400,1400')
+      options
+    end
+  end
+end

data/lib/selenium_chrome_helper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SeleniumChromeHelper
+  VERSION = '0.1.0'
+end

data/lib/selenium_chrome_helper.rb

@@ -0,0 +1,6 @@
+require "selenium_chrome_helper/version"
+
+# Auto-load rake tasks when included in a Rails app or via `require`
+if defined?(Rake)
+  load File.expand_path("tasks/install.rake", __dir__)
+end

data/lib/tasks/install.rake

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'open-uri'
+require 'json'
+require 'zip' unless defined?(Zip)
+
+# rubocop:disable Metrics/BlockLength, Security/Open
+namespace :chrome do
+  desc 'Download and extract a known good version of Chrome for Testing'
+  task :install, [:version] do |_, args|
+    version = args[:version] || '134.0.6998.165'
+    api_url = 'https://googlechromelabs.github.io/chrome-for-testing/known-good-versions-with-downloads.json'
+    install_base = File.expand_path("chrome-for-testing/\#{version}", Dir.pwd)
+
+    platform = case RUBY_PLATFORM
+               when /darwin/
+                 `uname -m`.strip == 'arm64' ? 'mac-arm64' : 'mac-x64'
+               when /linux/
+                 'linux64'
+               else
+                 raise "Unsupported platform: \#{RUBY_PLATFORM}"
+               end
+
+    puts "➡️  Platform: \#{platform}"
+    puts "📡 Fetching metadata for Chrome version \#{version}..."
+
+    json = URI.open(api_url).read
+    data = JSON.parse(json)
+
+    version_info = data['versions'].find { |v| v['version'] == version }
+
+    abort "❌ Version \#{version} not found in known-good list." unless version_info
+
+    chrome_url = version_info.dig('downloads', 'chrome')&.find { |d| d['platform'] == platform }&.dig('url')
+    driver_url = version_info.dig('downloads', 'chromedriver')&.find { |d| d['platform'] == platform }&.dig('url')
+
+    unless chrome_url && driver_url
+      abort "❌ No matching downloads found for platform \#{platform} and version \#{version}"
+    end
+
+    puts "⬇️  Chrome URL: \#{chrome_url}"
+    puts "⬇️  Chromedriver URL: \#{driver_url}"
+
+    FileUtils.mkdir_p(install_base)
+
+    download_and_unzip(chrome_url, File.join(install_base, 'chrome.zip'), install_base)
+    download_and_unzip(driver_url, File.join(install_base, 'chromedriver.zip'), install_base)
+
+    puts "✅ Chrome and Chromedriver installed to \#{install_base}"
+  end
+
+  def download_and_unzip(url, zip_path, extract_to)
+    download(url, zip_path)
+    unzip(zip_path, extract_to)
+
+    File.delete(zip_path)
+  end
+
+  def download(url, dest)
+    URI.open(url) do |remote_file|
+      File.open(dest, 'wb') { |file| file.write(remote_file.read) }
+    end
+  end
+
+  def unzip(zip_path, extract_to)
+    Zip::File.open(zip_path) do |zip_file|
+      zip_file.each do |entry|
+        entry_path = File.join(extract_to, entry.name)
+        FileUtils.mkdir_p(File.dirname(entry_path))
+        zip_file.extract(entry, entry_path) unless File.exist?(entry_path)
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength, Security/Open

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: selenium_chrome_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gonzalo Robaina
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds a rake task (`chrome:install`) to easily fetch a pinned version
+  of Chrome and Chromedriver locally or in CI.
+email:
+- gonzalor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/selenium_chrome_helper.rb
+- lib/selenium_chrome_helper/railtie.rb
+- lib/selenium_chrome_helper/version.rb
+- lib/tasks/install.rake
+homepage: https://github.com/yourname/selenium_chrome_helper
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Downloads and installs Chrome for Testing for use with Selenium system specs.
+test_files: []