dvla-browser-drivers 2.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ded8210272d81162b05c9b4fd5f6f47fb6dd17f7c668b3d2415435499b3326ed
+  data.tar.gz: 3b642d367f46e22fc3b05dd9480a47c811608f08aa0d8f9bc2cb1b06b5a46d70
+SHA512:
+  metadata.gz: b0fdb8305b590e7523605a25d90bfa66ecea8653da35dcc43c52a75788c92707a4fff47480686cdb98783e811852ff736833eb0d95b07ed6a1f5d818cb34a15d
+  data.tar.gz: bb18727288978ce41b9ea0ba0a084e143bb13e8499febeb87893701f7d29bf16ae398e71331081ffd6b911fb20356fc1a2c0f5d8dfae0e454f3e5eb49eec4359

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dvla-browser-drivers.gemspec
+gemspec

data/README.md

@@ -0,0 +1,82 @@
+# DVLA::Browser::Drivers
+
+DVLA-Browser-Drivers is a gem that has pre-configured browser drivers that you can use out-of-the-box for the
+development of your application. 
+
+## Installation
+
+```ruby
+source 'https://gemstash.tooling.dvla.gov.uk/private' do
+  gem 'dvla-browser-drivers'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dvla-browser-drivers -s https://gemstash.tooling.dvla.gov.uk/private
+
+## Usage
+
+Once installed, you are able to use any pre-configured browser driver from the list below:
+
+### Selenium drivers
+
+| Driver           | Usage                                     |
+|------------------|-------------------------------------------|
+| chrome           | `DVLA::Browser::Drivers.chrome`           |
+| headless_chrome  | `DVLA::Browser::Drivers.headless_chrome`  |
+| edge             | `DVLA::Browser::Drivers.edge`             |
+| headless_edge    | `DVLA::Browser::Drivers.headless_edge`    |
+| firefox          | `DVLA::Browser::Drivers.firefox`          |
+| headless_firefox | `DVLA::Browser::Drivers.headless_firefox` |
+
+### Non-selenium drivers
+
+| Driver              | Usage                                        |
+|---------------------|----------------------------------------------|
+| cuprite             | `DVLA::Browser::Drivers.cuprite`             |
+| headless_cuprite    | `DVLA::Browser::Drivers.headless_cuprite`    |
+| apparition          | `DVLA::Browser::Drivers.apparition`          |
+| headless_apparition | `DVLA::Browser::Drivers.headless_apparition` |
+
+---
+
+### Default configuration
+
+| Driver                | Configuration                                         |
+|-----------------------|-------------------------------------------------------|
+| chrome, edge, firefox | --disable-dev-shm-usage<br/>                          |
+| headless_<driver>     | --headless<br/>--no-sandbox                           |
+| cuprite, apparition   | { 'no-sandbox': nil, disable-smooth-scrolling: true } |
+
+---
+
+### Additional configuration
+
+| Option                                                                      | Description                                                                                                                                                                        | supported-browsers    |
+|-----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
+| remote: 'http://localhost:4444/wd/hub'                                      | Allows you to talk to a remote browser                                                                                                                                             | firefox               |
+| additional_options: ['window-size=1400,1920']                               | Pass additional options to the driver<br/>Supported switches: https://peter.sh/experiments/chromium-command-line-switches/                                                         | chrome, edge, firefox |
+| additional_preferences: [{'download.default_directory': '<download_path>'}] | Pass additional preferences to the driver<br/>Documentation: https://www.selenium.dev/selenium/docs/api/rb/Selenium/WebDriver/Chromium/Options.html#add_preference-instance_method | chrome, edge, firefox |
+| additional_options: { 'option': value, 'option': value }                    | Pass additional options to the driver<br/>Supported switched: https://www.rubydoc.info/gems/cuprite/                                                                               | cuprite, apparition   |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dvla-browser-drivers.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require 'pry'
+require "dvla/browser/drivers"
+
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dvla-browser-drivers.gemspec

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'lib/dvla/browser/drivers/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'dvla-browser-drivers'
+  spec.version = DVLA::Browser::Drivers::VERSION
+  spec.authors = ['Driver and Vehicle Licensing Agency (DVLA)','Tomos Griffiths']
+  spec.email = %w[tomos.griffiths@dvla.gov.uk]
+
+  spec.summary = 'Browser-drivers has pre-configured web-browser drivers that ' \
+                 'can be used out-of-the-box for the development of UI based applications.'
+  spec.description = 'Browser-drivers has pre-configured web-browser drivers that '                                   \
+                     'can be used out-of-the-box for the development of UI based applications. '                      \
+                     'It is built using Ruby and utilises the Capybara library (A web application testing platform) ' \
+                     'to simulate how a user interacts with the applications being tested. '                          \
+                     'It also has the facility to run Cuprite, which is a pure Ruby driver utilising Ferrum, '        \
+                     'a high level API to run headless tests.'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1'
+  spec.homepage = 'https://github.com/dvla/dvla-browser-drivers'
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").select do |f|
+      f.match(/\A(?:lib|bin|exe)/) ||
+        f.match(/.(?:gemspec|md|ruby-version)\Z/) ||
+        f.match(/\AGemfile\Z/)
+    end
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_runtime_dependency 'apparition', '>= 0.6'
+  spec.add_runtime_dependency 'capybara', '>= 3.37'
+  spec.add_runtime_dependency 'cuprite', '>= 0.14'
+  spec.add_runtime_dependency 'dvla-herodotus', '>= 1.0'
+  spec.add_runtime_dependency 'selenium-webdriver', '>= 4.0'
+
+  spec.add_development_dependency 'bundler-audit', '~> 0.9'
+  spec.add_development_dependency 'dvla-lint', '~> 1.7'
+  spec.add_development_dependency 'pry', '~> 0.14'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+  spec.add_development_dependency 'rspec-sonarqube-formatter', '~> 1.5'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'simplecov-console', '~> 0.9'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/dvla/browser/drivers/meta_drivers.rb

@@ -0,0 +1,85 @@
+module DVLA
+  module Browser
+    module Drivers
+      DRIVER_REGEX = /^(?:(?<headless>headless)_)?(?<browser>chrome|firefox|edge|cuprite|apparition)$/
+
+      OTHER_ACCEPTED_PARAMS = %i[timeout].freeze
+      OTHER_DRIVERS = %i[cuprite apparition].freeze
+      SELENIUM_ACCEPTED_PARAMS = %i[remote additional_options additional_preferences].freeze
+      SELENIUM_DRIVERS = %i[chrome firefox edge].freeze
+
+      # Creates methods in the Drivers module that matches the DRIVER_REGEX
+      # These methods will register a Driver for use by Capybara in a test pack
+      #
+      # @example Basic driver
+      #   DVLA::Browser::Drivers.chrome
+      #
+      # @example Driver with additional arguments
+      #   DVLA::Browser::Drivers.chrome(remote: 'http://localhost:4444/wd/hub')
+      def self.method_missing(method, *args, **kwargs, &block)
+        if (matches = method.match(DRIVER_REGEX))
+          headless = matches[:headless].is_a? String
+          browser = matches[:browser].to_sym
+
+          case browser
+          when *SELENIUM_DRIVERS
+            kwargs.each do |key, _value|
+              LOG.warn { "Key: '#{key}' will be ignored | Use one from: '#{SELENIUM_ACCEPTED_PARAMS}'" } unless SELENIUM_ACCEPTED_PARAMS.include?(key)
+            end
+
+            Capybara.register_driver method do |app|
+              options = Object.const_get("Selenium::WebDriver::#{browser.to_s.capitalize}::Options").new
+              options.add_argument('--disable-dev-shm-usage')
+
+              if headless
+                options.add_argument('--headless')
+                options.add_argument('--no-sandbox')
+              end
+
+              browser = :remote if kwargs[:remote]
+
+              if kwargs[:additional_options]
+                kwargs[:additional_options].each do |additional_option|
+                  additional_option.prepend('--') unless additional_option.start_with?('--')
+                  options.add_argument(additional_option)
+                end
+              end
+
+              if kwargs[:additional_preferences]
+                kwargs[:additional_preferences].each do |preference|
+                  key, value = preference.first
+                  options.add_preference(key, value)
+                end
+              end
+
+              Capybara::Selenium::Driver.new(app, url: kwargs[:remote], browser:, options:)
+            end
+          else
+            kwargs.each do |key, _value|
+              LOG.warn { "Key: '#{key}' will be ignored | Use one from: '#{OTHER_ACCEPTED_PARAMS}'" } unless OTHER_ACCEPTED_PARAMS.include?(key)
+            end
+
+            Capybara.register_driver method do |app|
+              Object.const_get("Capybara::#{browser.to_s.capitalize}::Driver").new(
+                app,
+                headless:,
+                timeout: kwargs[:timeout] || 30,
+                browser_options: { 'no-sandbox': nil, 'disable-smooth-scrolling': true },
+              )
+            end
+          end
+
+          LOG.info("Driver set to: '#{method}'")
+          Capybara.default_driver = method
+          Capybara.current_driver = method
+        else
+          super.method_missing(method, *args, &block)
+        end
+      end
+
+      def self.respond_to_missing?(method, *args)
+        method.match(DRIVER_REGEX) || super
+      end
+    end
+  end
+end

data/lib/dvla/browser/drivers/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DVLA
+  module Browser
+    module Drivers
+      VERSION = '2.1.1'
+    end
+  end
+end

data/lib/dvla/browser/drivers.rb

@@ -0,0 +1,18 @@
+require_relative 'drivers/meta_drivers'
+require_relative 'drivers/version'
+
+require 'capybara/apparition'
+require 'capybara/cuprite'
+require 'dvla/herodotus'
+require 'selenium-webdriver'
+
+module DVLA
+  class Error < StandardError; end
+
+  DVLA::Herodotus.configure do |config|
+    config.system_name = 'browser-drivers'
+    config.pid = true
+  end
+
+  LOG = DVLA::Herodotus.logger
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: dvla-browser-drivers
+version: !ruby/object:Gem::Version
+  version: 2.1.1
+platform: ruby
+authors:
+- Driver and Vehicle Licensing Agency (DVLA)
+- Tomos Griffiths
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: apparition
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.37'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.37'
+- !ruby/object:Gem::Dependency
+  name: cuprite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: dvla-herodotus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: dvla-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: rspec-sonarqube-formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Browser-drivers has pre-configured web-browser drivers that can be used
+  out-of-the-box for the development of UI based applications. It is built using Ruby
+  and utilises the Capybara library (A web application testing platform) to simulate
+  how a user interacts with the applications being tested. It also has the facility
+  to run Cuprite, which is a pure Ruby driver utilising Ferrum, a high level API to
+  run headless tests.
+email:
+- tomos.griffiths@dvla.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- Gemfile
+- README.md
+- bin/console
+- bin/setup
+- dvla-browser-drivers.gemspec
+- lib/dvla/browser/drivers.rb
+- lib/dvla/browser/drivers/meta_drivers.rb
+- lib/dvla/browser/drivers/version.rb
+homepage: https://github.com/dvla/dvla-browser-drivers
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dvla/dvla-browser-drivers
+  source_code_uri: https://github.com/dvla/dvla-browser-drivers
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: Browser-drivers has pre-configured web-browser drivers that can be used out-of-the-box
+  for the development of UI based applications.
+test_files: []