Upgrade Selenium

DEFRA · Aug 17, 2023 · a366365 · a366365
1 parent 1f25016
commit a366365
Show file tree

Hide file tree

Showing 25 changed files with 265 additions and 198 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,3 +1,9 @@
+inherit_from: .rubocop_todo.yml
+
 inherit_gem:
   defra_ruby_style:
     - default.yml
+
+require:
+  - rubocop-rake
+  - rubocop-rspec
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -0,0 +1,82 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-08-14 14:02:05 UTC using RuboCop version 1.56.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'quke.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'quke.gemspec'
+
+# Offense count: 1
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/quke/driver_registration.rb'
+
+# Offense count: 16
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/quke/configuration_spec.rb'
+    - 'spec/quke/driver_configuration_spec.rb'
+    - 'spec/quke/driver_registration_spec.rb'
+
+# Offense count: 18
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 22
+
+# Offense count: 2
+RSpec/ExpectInHook:
+  Exclude:
+    - 'spec/quke/quke_spec.rb'
+
+# Offense count: 2
+RSpec/IdenticalEqualityAssertion:
+  Exclude:
+    - 'spec/quke/driver_registration_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 10
+RSpec/MultipleExpectations:
+  Max: 17
+
+# Offense count: 6
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 6
+
+# Offense count: 83
+# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
+# SupportedStyles: always, named_only
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/quke/browserstack_configuration_spec.rb'
+    - 'spec/quke/browserstack_status_reporter_spec.rb'
+    - 'spec/quke/configuration_spec.rb'
+    - 'spec/quke/proxy_configuration_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 4
diff --git a/.ruby-version b/.ruby-version
@@ -1 +1 @@
-2.4.2
+3.2.2
diff --git a/Gemfile b/Gemfile
@@ -4,3 +4,8 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in quke.gemspec
 gemspec
+
+group :development, :test do
+  gem "rubocop-rake"
+  gem "rubocop-rspec"
+end
diff --git a/README.md b/README.md
@@ -119,14 +119,6 @@ A very simple overview of how things work is that
 - [Selenium](https://github.com/SeleniumHQ/selenium/tree/master/rb) is used to tell the browsers what to do
 - each browser has a driver ([Chromedriver](https://chromedriver.chromium.org/), [Geckodriver](https://github.com/mozilla/geckodriver) etc) which can interpret Selenium commands into actual actions
 
-For Quke to work those browser drivers need to be installed. Quke manages this for you using a tool called [Webdrivers](https://github.com/titusfortner/webdrivers). There may be times you want to check the version of these drivers, or force an update to a specific version.
-
-If your project is using [Rake](https://github.com/ruby/rake) add the following to the `Rakefile` and you can then access a series of helper functions, for example `rake webdrivers:chromedriver:version`
-
-```ruby
-require "quke"
-load "quke/Rakefile"
-```
 
 ## Development
 

diff --git a/lib/quke.rb b/lib/quke.rb
@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "selenium/webdriver"
-require "webdrivers"
 require "capybara"
 
 require "quke/version"
@@ -13,7 +12,7 @@
 require "quke/driver_configuration"
 require "quke/proxy_configuration"
 
-module Quke #:nodoc:
+module Quke # :nodoc:
 
   class QukeError < StandardError; end
 

diff --git a/lib/quke/Rakefile b/lib/quke/Rakefile
diff --git a/lib/quke/browserstack_configuration.rb b/lib/quke/browserstack_configuration.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Quke #:nodoc:
+module Quke # :nodoc:
 
   # Determines the configuration for browserstack, when selected as the driver
   class BrowserstackConfiguration
@@ -108,7 +108,7 @@ def using_browserstack?
     #     )
     #
     def url
-      return "http://#{@username}:#{@auth_key}@hub.browserstack.com/wd/hub" unless @username == ""
+      "http://#{@username}:#{@auth_key}@hub.browserstack.com/wd/hub" unless @username == ""
     end
 
     private

diff --git a/lib/quke/browserstack_status_reporter.rb b/lib/quke/browserstack_status_reporter.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Quke #:nodoc:
+module Quke # :nodoc:
 
   # Used to update the status of a session in Browserstack to mark it as passed
   # or failed. It does this by making a PUT request to Browserstack's REST API

diff --git a/lib/quke/configuration.rb b/lib/quke/configuration.rb
@@ -2,7 +2,7 @@
 
 require "yaml"
 
-module Quke #:nodoc:
+module Quke # :nodoc:
 
   # Manages all configuration for Quke.
   class Configuration
@@ -110,9 +110,7 @@ def pause
     def stop_on_error
       # This use of Yaml.load to convert a string to a boolean comes from
       # http://stackoverflow.com/a/21804027/6117745
-      # rubocop:disable Security/YAMLLoad
       YAML.load(@data["stop_on_error"])
-      # rubocop:enable Security/YAMLLoad
     end
 
     # Returns the value set for +display_failures+.

diff --git a/lib/quke/cuke_runner.rb b/lib/quke/cuke_runner.rb
@@ -2,7 +2,7 @@
 
 require "cucumber"
 
-module Quke #:nodoc:
+module Quke # :nodoc:
 
   # Handles executing Cucumber, including sorting the arguments we pass to it
   class CukeRunner

diff --git a/lib/quke/driver_configuration.rb b/lib/quke/driver_configuration.rb
@@ -2,7 +2,7 @@
 
 require "quke/configuration"
 
-module Quke #:nodoc:
+module Quke # :nodoc:
 
   # Helper class that manages the options, switches and capabilities for each of
   # the different drivers.
@@ -54,8 +54,9 @@ def initialize(config)
     def chrome
       no_proxy = config.proxy.no_proxy.tr(",", ";")
 
-      options = Selenium::WebDriver::Chrome::Options.new
-      options.headless! if config.headless
+      args = config.headless ? ["--headless=new"] : []
+
+      options = Selenium::WebDriver::Options.chrome(args: args)
 
       options.add_argument("--proxy-server=#{config.proxy.host}:#{config.proxy.port}") if config.proxy.use_proxy?
       options.add_argument("--proxy-bypass-list=#{no_proxy}") unless config.proxy.no_proxy.empty?

diff --git a/lib/quke/driver_registration.rb b/lib/quke/driver_registration.rb
@@ -3,7 +3,7 @@
 require "quke/configuration"
 require "selenium/webdriver"
 
-module Quke #:nodoc:
+module Quke # :nodoc:
 
   # Helper class that contains all methods related to registering drivers with
   # Capybara.

diff --git a/lib/quke/proxy_configuration.rb b/lib/quke/proxy_configuration.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Quke #:nodoc:
+module Quke # :nodoc:
 
   # Manages all proxy configuration for Quke.
   class ProxyConfiguration

diff --git a/lib/quke/version.rb b/lib/quke/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Quke #:nodoc:
+module Quke # :nodoc:
   VERSION = "0.10.0"
 end
diff --git a/quke.gemspec b/quke.gemspec
@@ -22,7 +22,6 @@ Gem::Specification.new do |spec|
   spec.files = Dir["{bin,exe,lib}/**/*", "LICENSE", "Rakefile", "README.md"]
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.test_files = Dir["spec/**/*"]
 
   spec.require_paths = ["lib"]
 
@@ -33,7 +32,7 @@ Gem::Specification.new do |spec|
     spec.metadata["allowed_push_host"] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+          "public gem pushes."
   end
 
   spec.required_ruby_version = ">= 2.4"
@@ -54,14 +53,7 @@ Gem::Specification.new do |spec|
 
   # selenium-webdriver is used to drive browsers like Firefox, Chrome and
   # Internet Explorer.
-  spec.add_dependency "selenium-webdriver", "~> 3.14"
-
-  # Needed to use Chrome or Firefox for selenium tests. You can opt
-  # to install each driver separately. However in an effort to make using this
-  # gem as simple as possible we have gone with using webdrivers. To quote
-  # from it "Run Selenium tests more easily with automatic installation and
-  # updates for all supported webdrivers."
-  spec.add_dependency "webdrivers", "~> 4.0"
+  spec.add_dependency "selenium-webdriver", "~> 4.1"
 
   # Experience has shown that keeping tests dry helps make them more
   # maintainable over time. One practice that helps is the use of the
@@ -94,4 +86,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.8"
   spec.add_development_dependency "simplecov", "~> 0.17.1"
   spec.add_development_dependency "webmock", "~> 3.5"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end