automation_helpers 4.1.1 → 5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 154b3a0f5fc399e0c379455a963dd13d3094be200957ecff1740dccfdd75418c
-  data.tar.gz: ba4e03604da108f8a68661f3879f69180c4f35b27796cc41660a4ee51d25f47f
+  metadata.gz: ac74d1da46721b813cf048c83f2c12393132af015ac62fbb38830f8c828550fb
+  data.tar.gz: 35342f56615fd96850664dd2c7fd1f6f662e88cf5c5c830ead0ade741fe3632e
 SHA512:
-  metadata.gz: 7fc83981d84eabd3887d096b0ab415598aa5243b9027b6b0a8e1de2fb76520346db275fd9f51ea10642946646ae0319f214ab30af76fcc218fbe56c629c17165
-  data.tar.gz: 6cf8cf6feb9820e8b781d5830557d0d4aaf2ad1e5d370b2db1e0fb7ef8198a5fe012f67ae5d30184068eabb45cfeebaa053f6926cc99955239f5cdfe0cc378e3
+  metadata.gz: ed219f7a15fdafda73b3fa56950fac854347ecb5f672e4e28475828d45c847c777d8c5534cecf5e6ee12ea168bdc6dfb96114ef386367298a4be8d5b700eb47a
+  data.tar.gz: 15874df9f590c88fa7981405f1618abedb3110dcb9ba52749835c993033ae8bb1b792e7be6afdf6efef751c87d37952bf6d5c3a0abae9ea1fb293513d9780be6

data/lib/automation_helpers/drivers/v4/capabilities.rb

@@ -26,7 +26,6 @@ module AutomationHelpers
             when :firefox;           then firefox_capabilities
             when :internet_explorer; then internet_explorer_capabilities
             when :ios;               then ios_capabilities(device_options)
-            when :safari;            then safari_capabilities
             else {}
             end
           end
@@ -83,6 +82,7 @@ module AutomationHelpers
 
           def android_appium_version(android_version)
             case android_version.to_f
+            when 12..; then '1.22.0'
             when 10..; then '1.21.0'
             when 9..;  then '1.20.2'
             else raise ArgumentError, "Your Android Version is too low. Please don't use lower than Android Pie (9)."
@@ -91,20 +91,12 @@ module AutomationHelpers
 
           def ios_appium_version(ios_version)
             case ios_version.to_f
+            when 14..; then '1.22.0'
             when 13..; then '1.21.0'
             when 12..; then '1.20.2'
-            when 11..; then '1.16.0'
-            else raise ArgumentError, "Your iOS Version is too low. Please don't use lower than iOS 11."
+            else raise ArgumentError, "Your iOS Version is too low. Please don't use lower than iOS 12."
             end
           end
-
-          def safari_capabilities
-            AutomationHelpers.logger.warn('Altering Browser Name request to alleviate Capybara failure with STP.')
-
-            {
-              'browserName' => 'Safari Technology Preview'
-            }
-          end
         end
       end
     end

data/lib/automation_helpers/drivers/v4/local.rb

@@ -31,31 +31,16 @@ module AutomationHelpers
               app,
               browser: browser,
               service: service,
-              capabilities: capabilities
+              options: options
             )
           end
         end
 
-        # @return [Array]
-        #
-        # The order of these capabilities is important because in the internal configuration
-        # for the driver; these 2 objects are merged (And both will contain a browserName)
-        # as such we need to ensure the browserName we manually set in `desired_capabilities`
-        # is retained as this is the one required by safari
-        def capabilities
-          if safari?
-            [options, desired_capabilities]
-          else
-            [desired_capabilities, options]
-          end
-        end
-
         private
 
-        # This is required to make local drivers work exclusively with Safari TP
-        # This is required in V13 of Safari as the driver there is notoriously flaky
-        # In V12 it doesn't hinder it
-        # Safari V11 is unsupported.
+        # This is required to make local drivers work with Safari TP
+        # This is required in V13+ of Safari as the driver there is notoriously flaky
+        # Safari V11/V12 is unsupported
         def service
           return unless safari?
 
@@ -63,19 +48,6 @@ module AutomationHelpers
           ::Selenium::WebDriver::Service.safari(args: ['--diagnose'])
         end
 
-        # This is required because Capybara and Safari aren't quite sure what the difference
-        # is between the two browsers. So to compensate an illegal browserName value is
-        # set that allows easy distinction between the two browsers
-        #
-        # NB: Whilst using Safari TP this is required.
-        def desired_capabilities
-          if safari?
-            Capabilities.for(:safari)
-          else
-            ::Selenium::WebDriver::Remote::Capabilities.new
-          end
-        end
-
         def options
           Options.for(browser)
         end

data/lib/automation_helpers/drivers/v4/options.rb

@@ -11,29 +11,41 @@ module AutomationHelpers
       #
       # #### Initial setup options
       #
-      # - **ENV["HEADLESS"]** (optional) - Whether you want your browser to run headless or not
+      # - **ENV["HEADLESS"]** (optional) - Whether you want your browser (only applicable ones) to run headless or not
       class Options
         class << self
           # @return [Selenium::Webdriver::Options]
           #
           # Returns the Options payload relevant to the browser specified to be passed to the driver instantiation
           def for(browser)
-            initial_options(browser).tap { |opts| opts.headless! if headless? }
-          end
-
-          private
-
-          def initial_options(browser)
             case browser
-            when :chrome;             then ::Selenium::WebDriver::Chrome::Options.new
-            when :firefox;            then ::Selenium::WebDriver::Firefox::Options.new(log_level: 'trace')
-            when :edge;               then ::Selenium::WebDriver::Edge::Options.new
-            when :safari;             then ::Selenium::WebDriver::Safari::Options.new(automatic_inspection: true)
+            when :chrome;             then chrome_options
+            when :firefox;            then firefox_options
+            when :edge;               then edge_options
+            when :safari;             then safari_options
             when :internet_explorer;  then internet_explorer_options
             else {}
             end
           end
 
+          private
+
+          def chrome_options
+            ::Selenium::WebDriver::Chrome::Options.new.tap { |opts| opts.add_argument('--headless=new') if headless? }
+          end
+
+          def firefox_options
+            ::Selenium::WebDriver::Firefox::Options.new(log_level: 'trace').tap { |opts| opts.add_argument('-headless') if headless? }
+          end
+
+          def edge_options
+            ::Selenium::WebDriver::Edge::Options.new.tap { |opts| opts.add_argument('--headless=new') if headless? }
+          end
+
+          def safari_options
+            ::Selenium::WebDriver::Safari::Options.new(automatic_inspection: true)
+          end
+
           # Constantly fire mouseOver events on click actions (Should help mitigate flaky clicks)
           def internet_explorer_options
             ::Selenium::WebDriver::IE::Options.new(persistent_hover: true).tap do |opts|

data/lib/automation_helpers/drivers/v4/remote.rb

@@ -7,7 +7,7 @@ module AutomationHelpers
   module Drivers
     module V4
       #
-      # The Remote Driver that will connect to a dockerised self-hosted grid
+      # The Remote Driver that will connect to a dockerized self-hosted grid
       # This expects the grid to be live **and** accepting node requests
       #
       class Remote
@@ -17,7 +17,7 @@ module AutomationHelpers
         # #### Initial setup options
         #
         # - **browser** (required) - When instantiating, the first argument must be the symbol that represents what browser to use
-        # - **ENV["HUB_URL"]** (required) - The environment variable HUB_URL must be set to the actively running dockerised grid
+        # - **ENV["HUB_URL"]** (required) - The environment variable HUB_URL must be set to the actively running dockerized grid
         #   (By default this should be +http://hub:4444/wd/hub+)
         def initialize(browser)
           @browser = browser
@@ -54,7 +54,7 @@ module AutomationHelpers
         end
 
         def supported_browser?
-          %i[chrome firefox].include?(browser)
+          %i[chrome edge firefox].include?(browser)
         end
       end
     end

data/lib/automation_helpers/patches/base.rb

@@ -14,7 +14,7 @@ module AutomationHelpers
 
         Kernel.warn('This is now deprecated and should not be used') if deprecate?
         AutomationHelpers.logger.info("Adding patch: #{self.class}")
-        AutomationHelpers.logger.debug(description)
+        AutomationHelpers.logger.info(description)
         perform
         AutomationHelpers.logger.info('Patch successfully added.')
       end

data/lib/automation_helpers/patches.rb

@@ -4,7 +4,4 @@ require 'automation_helpers/logger'
 
 require 'automation_helpers/patches/base'
 require 'automation_helpers/patches/capybara'
-require 'automation_helpers/patches/parallel_cucumber'
 require 'automation_helpers/patches/selenium_logger'
-require 'automation_helpers/patches/selenium_manager'
-require 'automation_helpers/patches/selenium_options'

data/lib/automation_helpers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AutomationHelpers
-  VERSION = '4.1.1'
+  VERSION = '5.0'
 end

data/lib/automation_helpers.rb

@@ -17,7 +17,6 @@ module AutomationHelpers
 
     # The Automation Helpers logger object - This is called automatically in several
     # locations and will log messages according to the normal Ruby protocol
-    # To alter (or check), the log level; call .log_level= or .log_level
     #
     # This logger object can also be used to manually log messages
     #
@@ -31,12 +30,6 @@ module AutomationHelpers
       @logger ||= Logger.create
     end
 
-    def logger=(logger)
-      raise ArgumentError, 'You must supply an existing Logger' unless logger.is_a?(::Logger)
-
-      @logger = logger
-    end
-
     # This writer method allows you to configure where you want the output of
     # the automation_helpers logs to go (Default is $stdout)
     #
@@ -45,24 +38,5 @@ module AutomationHelpers
     def log_path=(logdev)
       logger.reopen(logdev)
     end
-
-    # To enable full logging (This uses the Ruby API, so can accept any of a
-    # Symbol / String / Integer as an input
-    #   AutomationHelpers.log_level = :DEBUG
-    #   AutomationHelpers.log_level = 'DEBUG'
-    #   AutomationHelpers.log_level = 0
-    #
-    # To disable all logging
-    #   AutomationHelpers.log_level = :UNKNOWN
-    def log_level=(value)
-      logger.level = value
-    end
-
-    # To query what level is being logged
-    #   AutomationHelpers.log_level
-    #   => :INFO # By default
-    def log_level
-      %i[DEBUG INFO WARN ERROR FATAL UNKNOWN][logger.level]
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: automation_helpers
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: '5.0'
 platform: ruby
 authors:
 - Luke Hill
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -65,26 +65,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: parallel_tests
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.7'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -105,76 +85,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.45.0
+        version: 1.56.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.45.0
+        version: 1.56.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.22.0
+        version: 2.23.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.22.0
+        version: 2.23.2
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '4.0'
 description: Automation Patches / Extensions that allow you to extend your Ruby-based
   testing frameworks
 email:
@@ -207,10 +167,7 @@ files:
 - lib/automation_helpers/patches.rb
 - lib/automation_helpers/patches/base.rb
 - lib/automation_helpers/patches/capybara.rb
-- lib/automation_helpers/patches/parallel_cucumber.rb
 - lib/automation_helpers/patches/selenium_logger.rb
-- lib/automation_helpers/patches/selenium_manager.rb
-- lib/automation_helpers/patches/selenium_options.rb
 - lib/automation_helpers/version.rb
 homepage: https://www.github.com/site-prism/automation_helpers
 licenses:
@@ -227,14 +184,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Automation Helpers - Avoid writing the most common things in Ruby Automation

data/lib/automation_helpers/patches/parallel_cucumber.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module AutomationHelpers
-  module Patches
-    #
-    # Fix the issue where the parser for parallel_tests doesn't permit the --retry flag (Or other flags at the end)
-    #
-    class ParallelCucumber < Base
-      private
-
-      def description
-        <<~DESCRIPTION
-          This patch fixes an issue where the parallel tests gem won't place the --retry flag in the correct
-          position for command invocation with cucumber
-          See: https://github.com/grosser/parallel_tests/pull/827 for more details/discussion including this fix
-        DESCRIPTION
-      end
-
-      def perform
-        ::ParallelTests::Gherkin::Runner.extend RetryFlagFix
-      end
-
-      def deprecate_from
-        '3.12.0'
-      end
-
-      def prevent_usage_from
-        '4.0.0'
-      end
-
-      def gem_version
-        ::ParallelTests::VERSION
-      end
-    end
-
-    module RetryFlagFix
-      def run_tests(test_files, process_number, num_processes, options)
-        # Copied Code - https://github.com/grosser/parallel_tests/blob/master/lib/parallel_tests/gherkin/runner.rb#L9
-        combined_scenarios = test_files
-
-        if options[:group_by] == :scenarios
-          grouped = test_files.map { |t| t.split(':') }.group_by(&:first)
-          combined_scenarios = grouped.map do |file, files_and_lines|
-            "#{file}:#{files_and_lines.map(&:last).join(':')}"
-          end
-        end
-
-        sanitized_test_files = combined_scenarios.map { |val| WINDOWS ? "\"#{val}\"" : Shellwords.escape(val) }
-
-        options[:env] ||= {}
-        options[:env] = options[:env].merge({ 'AUTOTEST' => '1' }) if $stdout.tty?
-
-        # New code
-        opts = cucumber_opts(options[:test_options])
-        cmd = [
-          executable,
-          (runtime_logging if File.directory?(File.dirname(runtime_log))),
-          opts[0],
-          *sanitized_test_files,
-          opts[1]
-        ].compact.reject(&:empty?).join(' ')
-        execute_command(cmd, process_number, num_processes, options)
-      end
-
-      def cucumber_opts(given)
-        # All new code
-        initial =
-          if given =~ (/--profile/) || given =~ (/(^|\s)-p /)
-            given
-          else
-            [given, profile_from_config].compact.join(" ")
-          end
-
-        opts_as_individuals = initial.scan(/\S+\s\S+/)
-        desired_output = ['', '']
-
-        opts_as_individuals.each do |opt|
-          if opt.match?(/--retry \d+/)
-            desired_output[1] = opt
-          else
-            desired_output[0] = "#{desired_output[0]} #{opt}".strip
-          end
-        end
-
-        desired_output
-      end
-    end
-  end
-end

data/lib/automation_helpers/patches/selenium_manager.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module AutomationHelpers
-  module Patches
-    #
-    # Fix the issue where the `#convert_cookie` API private method in selenium-webdriver doesn't include the
-    # 'httpOnly' property in the returned cookie hash structure
-    #
-    class SeleniumManager < Base
-      private
-
-      def description
-        <<~DESCRIPTION
-          This patch fixes an issue with Selenium4 not bubbling up the httpOnly property of a cookie
-          See: https://github.com/SeleniumHQ/selenium/pull/8958 for more details/discussion including this fix
-        DESCRIPTION
-      end
-
-      def perform
-        ::Selenium::WebDriver::Manager.prepend CookieConverter
-      end
-
-      def deprecate_from
-        '4.0.0.beta3'
-      end
-
-      def prevent_usage_from
-        '4.0.0'
-      end
-
-      def gem_version
-        ::Selenium::WebDriver::VERSION
-      end
-    end
-
-    #
-    # @api private
-    #
-    module CookieConverter
-      def convert_cookie(cookie)
-        super(cookie)
-          .merge(
-            {
-              http_only: cookie['httpOnly']
-            }
-          )
-      end
-    end
-  end
-end

data/lib/automation_helpers/patches/selenium_options.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module AutomationHelpers
-  module Patches
-    #
-    # Fix the issue where for some drivers selenium doesn't camelize the browser name key 'browserName' correctly
-    #
-    class SeleniumOptions < Base
-      def initialize(browser)
-        @browser = browser
-        super()
-      end
-
-      # @return [nil || true]
-      #
-      # For SeleniumOptions we only want to run the patch when
-      # we are on browsers without the relevant JSON fixes in upstream
-      def patch!
-        return unless valid?
-
-        super
-      end
-
-      private
-
-      def valid?
-        %i[firefox safari].include?(@browser)
-      end
-
-      def description
-        <<~DESCRIPTION
-          This patch fixes an issue with Selenium4 not camelising the browser_name property
-          The issue is the driver, which is now fully W3C conformant expects `browserName`
-
-          See: https://github.com/SeleniumHQ/selenium/pull/8834 for more details/discussion including this fix
-        DESCRIPTION
-      end
-
-      def perform
-        case @browser
-        when :firefox then ::Selenium::WebDriver::Firefox::Options.include CapabilitiesAsJsonFix
-        when :safari then ::Selenium::WebDriver::Safari::Options.include CapabilitiesAsJsonFix
-        end
-      end
-
-      def deprecate_from
-        '4.0.0'
-      end
-
-      def prevent_usage_from
-        '4.0.3'
-      end
-
-      def gem_version
-        ::Selenium::WebDriver::VERSION
-      end
-    end
-
-    #
-    # @api private
-    #
-    module CapabilitiesAsJsonFix
-      private
-
-      def generate_as_json(value, camelize_keys: true)
-        if value.is_a?(Hash)
-          value.each_with_object({}) do |(key, val), hash|
-            key = convert_json_key(key, camelize: camelize_keys)
-            hash[key] = generate_as_json(val, camelize_keys: key != 'prefs')
-          end
-        else
-          super
-        end
-      end
-    end
-  end
-end