bugsnag-maze-runner 9.21.0 → 9.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b00232685620344397218ed5ccf143f583dea9cb7a94c454dcbc7f8d5ea00c3
-  data.tar.gz: 44d839ae61d043e63c01b4462359d6b8ccef54a73eac1cc679c1813099aeafab
+  metadata.gz: 8884abca15e25562492a3411949b061374130f0975c39da3635939c31ab94ccb
+  data.tar.gz: fe80b49925c6579219f0e8a307d31be1915e6cfacabe30293d3c24898e663a29
 SHA512:
-  metadata.gz: 0a8ac5cdcb8da3b8cfc80b54f8318989eef4df1f8b92dcff63884544bb25f6dde895aeeac0aa4c9091f385d029e7fd6a00ff6b04772bbdb71699686c6620eeda
-  data.tar.gz: 8e88e848cf6599fb944ce054a0fda6e65bc873fc3b6bf7b91c62f5a55f06332d00096c9ef060f69dccabe670475371d3d59e8d88036a870dd41fe157ee2621b0
+  metadata.gz: 748f7b6a945799d375b4b7d18d3183b3627f696fa229c0572e21ba5074b8d23f4c7833605b470deaaf3ef00acef2b6f54f48a3d3a4eb8f105f62de592903a20e
+  data.tar.gz: a06ea26f1055c4837fe9ccf22703bdcad6bab92dc58caa2c04edfa5aaefec0950c82bc39805dc5dd47fb7a8ce754dc6a6888cda11ff04f9ff9c428ec354a94a3

data/bin/maze-runner

@@ -11,6 +11,9 @@ require_relative '../lib/utils/deep_merge'
 require_relative '../lib/maze'
 
 require_relative '../lib/maze/appium_server'
+require_relative '../lib/maze/api/appium/manager'
+require_relative '../lib/maze/api/appium/app_manager'
+require_relative '../lib/maze/api/appium/device_manager'
 require_relative '../lib/maze/api/appium/file_manager'
 require_relative '../lib/maze/api/cucumber/scenario'
 require_relative '../lib/maze/api/exit_code'

data/lib/features/support/internal_hooks.rb

@@ -8,7 +8,6 @@ require 'selenium-webdriver'
 require 'uri'
 
 BeforeAll do
-
   Maze.check = Maze::Checks::AssertCheck.new
 
   # Infer mode of operation from config, one of:
@@ -101,9 +100,16 @@ end
 
 # Before each scenario
 Before do |scenario|
+  next if scenario.status == :skipped
+
   Maze.scenario = Maze::Api::Cucumber::Scenario.new(scenario)
 
-  # Default to no dynamic try
+  # Skip scenario if the driver it needs has failed
+  if (Maze.mode == :appium || Maze.mode == :browser) && Maze.driver.failed?
+    skip_this_scenario
+  end
+
+  # Default to no dynamic retry
   Maze.dynamic_retry = false
 
   if ENV['BUILDKITE']
@@ -128,6 +134,8 @@ end
 
 # General processing to be run after each scenario
 After do |scenario|
+  next if scenario.status == :skipped
+
   # If we're running on macos, take a screenshot if the scenario fails
   if Maze.config.os == "macos" && scenario.status == :failed
     Maze::MacosUtils.capture_screen(scenario)
@@ -220,6 +228,8 @@ end
 #
 # Furthermore, this hook should appear after the general hook as they are executed in reverse order by Cucumber.
 After do |scenario|
+  next if scenario.status == :skipped
+
   # Call any pre_complete hooks registered by the client
   Maze.hooks.call_pre_complete scenario
 
@@ -234,6 +244,8 @@ end
 # Test all requests against schemas or extra validation rules.  These will only run if the schema/validation is
 # specified for the specific endpoint
 After do |scenario|
+  next if scenario.status == :skipped
+
   ['error', 'session', 'build', 'trace'].each do |endpoint|
     Maze::Schemas::Validator.validate_payload_elements(Maze::Server.list_for(endpoint), endpoint)
   end

data/lib/maze/api/appium/app_manager.rb

@@ -0,0 +1,91 @@
+require_relative '../../helper'
+require_relative './manager'
+
+module Maze
+  module Api
+    module Appium
+      # Provides operations for working with the app.
+      class AppManager < Maze::Api::Appium::Manager
+
+        # Activates the app
+        # @returns [Boolean] Whether the app was successfully launched
+        def activate
+          if failed_driver?
+            $logger.error 'Cannot activate the app - Appium driver failed.'
+            return false
+          end
+
+          @driver.activate_app(@driver.app_id)
+          true
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver
+          raise e
+        end
+
+        # Terminates the app
+        # @returns [Boolean] Whether the app was successfully closed
+        def terminate
+          if failed_driver?
+            $logger.error 'Cannot terminate the app - Appium driver failed.'
+            return false
+          end
+
+          @driver.terminate_app(@driver.app_id)
+          true
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver
+          raise e
+        end
+
+        # Launches the app (legacy method).
+        # @returns [Boolean] Whether the app was successfully launched
+        def launch
+          if failed_driver?
+            $logger.error 'Cannot launch the app - Appium driver failed.'
+            return false
+          end
+
+          @driver.launch_app
+          true
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver
+          raise e
+        end
+
+        # Closes the app (legacy method).
+        # @returns [Boolean] Whether the app was successfully closed
+        def close
+          if failed_driver?
+            $logger.error 'Cannot close the app - Appium driver failed.'
+            return false
+          end
+
+          @driver.close_app
+          true
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver
+          raise e
+        end
+
+        # Gets the app state.
+        # @returns [Symbol, nil] The app state, such as :not_running, :running_in_foreground, :running_in_background - of nil if the driver has failed.
+        def state
+          if failed_driver?
+            $logger.error('Cannot get the app state - Appium driver failed.')
+            return nil
+          end
+
+          @driver.app_state(@driver.app_id)
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/maze/api/appium/device_manager.rb

@@ -0,0 +1,61 @@
+require 'json'
+require_relative '../../helper'
+require_relative './manager'
+
+module Maze
+  module Api
+    module Appium
+      # Provides operations for working with the app.
+      class DeviceManager < Maze::Api::Appium::Manager
+
+        # Unlocks the device.
+        # @returns [Boolean] Success status
+        def unlock
+          if failed_driver?
+            $logger.error 'Cannot unlock the device - Appium driver failed.'
+            return false
+          end
+
+          @driver.unlock
+          true
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver
+          raise e
+        end
+
+        # Sets the rotation of the device.
+        # @param orientation [Symbol] The orientation to set the device to, :portrait or :landscape
+        # @returns [Boolean] Success status
+        def set_rotation(orientation)
+          if failed_driver?
+            $logger.error 'Cannot set the device rotation - Appium driver failed.'
+            return false
+          end
+
+          @driver.set_rotation(orientation)
+          true
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver
+          raise e
+        end
+
+        # Gets the device info, in JSON format
+        # @returns [String, nil] Device info or nil
+        def info
+          if failed_driver?
+            $logger.error 'Cannot get the device info - Appium driver failed.'
+            return nil
+          end
+
+          JSON.generate(@driver.device_info)
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/maze/api/appium/file_manager.rb

@@ -1,29 +1,43 @@
+require_relative '../../helper'
+require_relative './manager'
+
 module Maze
   module Api
     module Appium
       # Provides operations for working with files during Appium runs.
-      class FileManager
-        # param driver
-        def initialize
-          @driver = Maze.driver
-        end
-
+      class FileManager < Maze::Api::Appium::Manager
         # Creates a file with the given contents on the device (using Appium).  The file will be located in the app's
         # documents directory for iOS. On Android, it will be /sdcard/Android/data/<app-id>/files unless
         # Maze.config.android_app_files_directory has been set.
         # @param contents [String] Content of the file to be written
         # @param filename [String] Name (with no path) of the file to be written on the device
+        # @return [Boolean] Whether the file was successfully written to the device
         def write_app_file(contents, filename)
+          if failed_driver?
+            $logger.error 'Cannot write file to device - Appium driver failed.'
+            return false
+          end
+
           path = case Maze::Helper.get_current_platform
                  when 'ios'
                    "@#{@driver.app_id}/Documents/#{filename}"
                  when 'android'
                    directory = Maze.config.android_app_files_directory || "/sdcard/Android/data/#{@driver.app_id}/files"
                    "#{directory}/#{filename}"
+                 else
+                   raise 'write_app_file is not supported on this platform'
                  end
 
           $logger.trace "Pushing file to '#{path}' with contents: #{contents}"
           @driver.push_file(path, contents)
+          true
+        rescue Selenium::WebDriver::Error::UnknownError => e
+          $logger.error "Error writing file to device: #{e.message}"
+          false
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver
+          raise e
         end
 
         # Attempts to retrieve a given file from the device (using Appium).  The default location for the file will be
@@ -31,9 +45,15 @@ module Maze
         # Maze.config.android_app_files_directory has been set.
         # @param filename [String] Name (with no path) of the file to be retrieved from the device
         # @param directory [String] Directory on the device where the file is located (optional)
+        # @return [String, nil] The content of the file read, or nil
         def read_app_file(filename, directory = nil)
+          if failed_driver?
+            $logger.error 'Cannot read file from device - Appium driver failed.'
+            return nil
+          end
+
           if directory
-            path = directory
+            path = "#{directory}/#{filename}"
           else
             path = case Maze::Helper.get_current_platform
                   when 'ios'
@@ -41,11 +61,20 @@ module Maze
                   when 'android'
                     dir = Maze.config.android_app_files_directory || "/sdcard/Android/data/#{@driver.app_id}/files"
                     "#{dir}/#{filename}"
+                  else
+                    raise 'read_app_file is not supported on this platform'
                   end
           end
 
           $logger.trace "Attempting to read file from '#{path}'"
-          file = @driver.pull_file(path)
+          @driver.pull_file(path)
+        rescue Selenium::WebDriver::Error::UnknownError => e
+          $logger.error "Error reading file from device: #{e.message}"
+          nil
+        rescue Selenium::WebDriver::Error::ServerError => e
+          # Assume the remote appium session has stopped, so crash out of the session
+          fail_driver
+          raise e
         end
       end
     end

data/lib/maze/api/appium/manager.rb

@@ -0,0 +1,20 @@
+module Maze
+  module Api
+    module Appium
+      # Base class for all Appium managers.
+      class Manager
+        def initialize
+          @driver = Maze.driver
+        end
+
+        def failed_driver?
+          @driver.failed?
+        end
+
+        def fail_driver
+          @driver.fail_driver
+        end
+      end
+    end
+  end
+end

data/lib/maze/aws/sam.rb

@@ -65,7 +65,7 @@ module Maze
           unless valid?(output)
             message = <<-WARNING
               The lambda function did not successfully complete.
-              This may be expected and a normal result of the text execution.
+              This may be expected and a normal result of the test execution.
               The listed cause is:
                 > #{output.last.chomp}
 
@@ -75,11 +75,12 @@ module Maze
             $logger.warn message
           end
 
-          # Attempt to parse the last line of output as this is where a JSON
-          # response would be. It's possible for a Lambda to output nothing,
+          # Attempt to parse response line of the output.
+          # It's possible for a Lambda to output nothing,
           # e.g. if it forcefully exited, so we allow JSON parse failures here
           begin
-            parsed_output = JSON.parse(output.last)
+            response_line = output.find { |line| /{.*}/.match(line.strip) }
+            parsed_output = JSON.parse(response_line)
           rescue JSON::ParserError
             return {}
           end

data/lib/maze/client/appium/base_client.rb

@@ -33,6 +33,9 @@ module Maze
             $logger.debug "session_capabilities: #{Maze.driver.session_capabilities.inspect}"
           end
 
+          # Log the device information after it's started
+          write_device_info
+
           # Ensure the device is unlocked
           begin
             Maze.driver.unlock
@@ -56,6 +59,16 @@ module Maze
           raise 'Method not implemented by this class'
         end
 
+        def write_device_info
+          info = Maze.driver.device_info
+          filepath = File.join(Dir.pwd, 'maze_output', 'device_info.json')
+          File.open(filepath, 'w+') do |file|
+            file.puts(JSON.pretty_generate(info))
+          end
+        rescue => error
+          $logger.warn "Could not write device information file, #{error.message}"
+        end
+
         def attempt_start_driver(config)
           config.capabilities = device_capabilities
           driver = Maze::Driver::Appium.new config.appium_server_url,
@@ -134,7 +147,7 @@ module Maze
         end
 
         def stop_session
-          Maze.driver&.driver_quit
+          Maze.driver.driver_quit unless Maze.driver.failed?
           Maze::AppiumServer.stop if Maze::AppiumServer.running
         end
       end

data/lib/maze/client/appium/bs_client.rb

@@ -67,7 +67,7 @@ module Maze
 
         def log_run_intro
           # Log a link to the BrowserStack session search dashboard
-          url = "https://app-automate.browserstack.com/dashboard/v2/search?query=#{Maze.run_uuid}&type=builds"
+          url = "https://app-automate.browserstack.com/projects/#{project_name_capabilities[:project]}/builds/#{Maze.run_uuid}/1?tab=tests"
           $logger.info Maze::Loggers::LogUtil.linkify(url, 'BrowserStack session(s)')
         end
 

data/lib/maze/client/selenium/base_client.rb

@@ -6,12 +6,68 @@ module Maze
           raise 'Method not implemented by this class'
         end
 
+        def start_driver(config, selenium_url, max_attempts = 5)
+          attempts = 0
+
+          while attempts < max_attempts && Maze.driver.nil?
+            attempts += 1
+            start_error = nil
+
+            $logger.trace "Attempting to start Selenium driver with capabilities: #{config.capabilities.to_json}"
+            $logger.trace "Attempt #{attempts}"
+            begin
+              Maze.driver = Maze::Driver::Browser.new(:remote, selenium_url, config.capabilities)
+              Maze.driver.start_driver
+            rescue => error
+              Maze.driver = nil
+              $logger.error "Session creation failed: #{error}"
+              start_error = error
+            end
+
+            unless Maze.driver
+              interval = handle_start_error(config, start_error)
+              if interval.nil? || attempts >= max_attempts
+                $logger.error 'Failed to create Selenium driver, exiting'
+                Kernel.exit(::Maze::Api::ExitCode::SESSION_CREATION_FAILURE)
+              else
+                $logger.warn "Failed to create Selenium driver, retrying in #{interval} seconds"
+                $logger.info "Error: #{start_error.message}" if start_error
+                Kernel.sleep(interval)
+              end
+            end
+          end
+        end
+
+        def handle_start_error(config, error)
+          notify = true
+          interval = nil
+
+          # Used if we have a want to determine fatal errors later
+          case error.class.to_s
+          when 'Selenium::WebDriver::Error::WebDriverError'
+            interval = 5
+            notify = false
+          else
+            interval = 10
+          end
+
+          Bugsnag.notify error if notify
+
+          unless config.browser_list.empty?
+            # If the list is empty we have only one browser to continue with
+            config.browser = config.browser_list.shift
+            config.capabilities = create_capabilities(config)
+          end
+
+          interval
+        end
+
         def log_run_outro
           raise 'Method not implemented by this class'
         end
 
         def stop_session
-          Maze.driver&.driver_quit
+          Maze.driver.driver_quit unless Maze.driver.failed?
         end
       end
     end

data/lib/maze/client/selenium/bb_client.rb

@@ -4,6 +4,19 @@ module Maze
       class BitBarClient < BaseClient
         def start_session
           config = Maze.config
+          if Maze::Client::BitBarClientUtils.use_local_tunnel?
+            Maze::Client::BitBarClientUtils.start_local_tunnel config.sb_local,
+                                                               config.username,
+                                                               config.access_key
+          end
+
+          create_capabilities(config)
+
+          selenium_url = Maze.config.selenium_server_url
+          start_driver(config, selenium_url)
+        end
+
+        def create_capabilities(config)
           capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
           capabilities['bitbar_apiKey'] = config.access_key
           browsers = YAML.safe_load(File.read("#{__dir__}/bb_browsers.yml"))
@@ -13,20 +26,8 @@ module Maze
           capabilities.merge! JSON.parse(config.capabilities_option)
           capabilities['bitbar:options']['testTimeout'] = 900
           capabilities['acceptInsecureCerts'] = true unless Maze.config.browser.include? 'ie_'
+          capabilities['bitbar_apiKey'] = config.access_key if Maze::Client::BitBarClientUtils.use_local_tunnel?
           config.capabilities = capabilities
-
-          if Maze::Client::BitBarClientUtils.use_local_tunnel?
-            capabilities['bitbar_apiKey'] = config.access_key
-            Maze::Client::BitBarClientUtils.start_local_tunnel config.sb_local,
-                                                               config.username,
-                                                               config.access_key
-          end
-
-          selenium_url = Maze.config.selenium_server_url
-
-          $logger.trace "Starting Selenium driver with capabilities: #{config.capabilities.to_json}"
-          Maze.driver = Maze::Driver::Browser.new :remote, selenium_url, config.capabilities
-          Maze.driver.start_driver
         end
 
         def log_run_outro

data/lib/maze/client/selenium/bs_client.rb

@@ -5,55 +5,63 @@ module Maze
     module Selenium
       class BrowserStackClient < BaseClient
         def start_session
-          # Set up the capabilities
-          browsers = YAML.safe_load(File.read("#{__dir__}/bs_browsers.yml"))
-
           config = Maze.config
-          browser = browsers[config.browser]
 
+          # Start the tunnel
+          Maze::Client::BrowserStackClientUtils.start_local_tunnel config.bs_local,
+                                                                   Maze.run_uuid,
+                                                                   config.access_key
+
+          create_capabilities(config)
+
+          # Start the driver
+          selenium_url = "https://#{config.username}:#{config.access_key}@hub.browserstack.com/wd/hub"
+          start_driver(config, selenium_url)
+
+          # Log details for the session
+          log_session_info
+        end
+
+        def create_capabilities(config)
           if config.legacy_driver?
             capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
             capabilities['browserstack.local'] = 'true'
             capabilities['browserstack.localIdentifier'] = Maze.run_uuid
             capabilities['browserstack.console'] = 'errors'
             capabilities['acceptInsecureCerts'] = 'true'
-
-            # Convert W3S capabilities to JSON-WP
-            capabilities['browser'] = browser['browserName']
-            capabilities['browser_version'] = browser['browserVersion']
-            capabilities['device'] = browser['device']
-            capabilities['os'] = browser['os']
-            capabilities['os_version'] = browser['osVersion']
-
             capabilities.merge! JSON.parse(config.capabilities_option)
             capabilities.merge! project_name_capabilities
-            config.capabilities = capabilities
+            add_browser_capabilities(config, capabilities)
           else
-            capabilities = {
+            raw_capabilities = {
               'acceptInsecureCerts' => true,
               'bstack:options' => {
                 'local' => 'true',
                 'localIdentifier' => Maze.run_uuid
               }
             }
-            capabilities.deep_merge! browser
-            capabilities.deep_merge! JSON.parse(config.capabilities_option)
-            capabilities.merge! project_name_capabilities
-            config.capabilities = ::Selenium::WebDriver::Remote::Capabilities.new capabilities
+            raw_capabilities.deep_merge! JSON.parse(config.capabilities_option)
+            raw_capabilities.merge! project_name_capabilities
+            add_browser_capabilities(config, raw_capabilities)
+            capabilities = ::Selenium::WebDriver::Remote::Capabilities.new raw_capabilities
           end
+          config.capabilities = capabilities
+        end
 
-          # Start the tunnel
-          Maze::Client::BrowserStackClientUtils.start_local_tunnel config.bs_local,
-                                                                   Maze.run_uuid,
-                                                                   config.access_key
-
-          # Start the driver
-          selenium_url = "https://#{config.username}:#{config.access_key}@hub.browserstack.com/wd/hub"
-          Maze.driver = Maze::Driver::Browser.new :remote, selenium_url, config.capabilities
-          Maze.driver.start_driver
+        def add_browser_capabilities(config, capabilities)
+          browsers = YAML.safe_load(File.read("#{__dir__}/bs_browsers.yml"))
+          browser = browsers[config.browser]
 
-          # Log details for the session
-          log_session_info
+          if config.legacy_driver?
+            # Convert W3S capabilities to JSON-WP
+            capabilities['browser'] = browser['browserName']
+            capabilities['browser_version'] = browser['browserVersion']
+            capabilities['device'] = browser['device']
+            capabilities['os'] = browser['os']
+            capabilities['os_version'] = browser['osVersion']
+          else
+            capabilities.deep_merge! browser
+          end
         end
 
         def stop_session
@@ -86,7 +94,7 @@ module Maze
 
         def log_session_info
           # Log a link to the BrowserStack session search dashboard
-          url = "https://automate.browserstack.com/dashboard/v2/search?query=#{Maze.run_uuid}&type=builds"
+          url = "https://automate.browserstack.com/projects/#{project_name_capabilities[:project]}/builds/#{Maze.run_uuid}/1?tab=tests"
           $logger.info Maze::Loggers::LogUtil.linkify url, 'BrowserStack session(s)'
         end
       end

data/lib/maze/configuration.rb

@@ -173,6 +173,9 @@ module Maze
     # Test browser type
     attr_accessor :browser
 
+    # A list of browsers to attempt to connect to, in order
+    attr_accessor :browser_list
+
     # Test browser version
     attr_accessor :browser_version
 

data/lib/maze/driver/appium.rb

@@ -20,7 +20,7 @@ module Maze
       attr_reader :device_type
 
       # @!attribute [r] capabilities
-      #   @return [Hash] The capabilities used to launch the BrowserStack instance
+      #   @return [Hash] The capabilities used to launch the Appium session
       attr_reader :capabilities
 
       # Creates the Appium driver
@@ -32,6 +32,7 @@ module Maze
         # Sets up identifiers for ease of connecting jobs
         capabilities ||= {}
 
+        @failed = false
         @element_locator = locator
         @capabilities = capabilities
 
@@ -64,6 +65,17 @@ module Maze
         end
       end
 
+      # Whether the driver has known to have failed (it may still have failed and us not know yet)
+      def failed?
+        @failed
+      end
+
+      # Marks the driver as failed
+      def fail_driver
+        $logger.error 'Appium driver failed, remaining scenarios will be skipped'
+        @failed = true
+      end
+
       # Checks for an element, waiting until it is present or the method times out
       #
       # @param element_id [String] the element to search for
@@ -83,7 +95,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        Maze.driver = nil
+        fail_driver
         raise e
       else
         true
@@ -94,7 +106,7 @@ module Maze
         super
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        Maze.driver = nil
+        fail_driver
         raise e
       end
 
@@ -103,7 +115,7 @@ module Maze
         super
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        Maze.driver = nil
+        fail_driver
         raise e
       end
 
@@ -114,7 +126,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        Maze.driver = nil
+        fail_driver
         raise e
       end
 
@@ -128,7 +140,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        Maze.driver = nil
+        fail_driver
         raise e
       end
 
@@ -146,7 +158,7 @@ module Maze
         false
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        Maze.driver = nil
+        fail_driver
         raise e
       end
 
@@ -160,7 +172,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        Maze.driver = nil
+        fail_driver
         raise e
       end
 
@@ -185,7 +197,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        Maze.driver = nil
+        fail_driver
         raise e
       end
 
@@ -222,7 +234,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        Maze.driver = nil
+        fail_driver
         raise e
       end
 

data/lib/maze/driver/browser.rb

@@ -13,15 +13,41 @@ module Maze
 
       def initialize(driver_for, selenium_url=nil, capabilities=nil)
         capabilities ||= {}
+        @failed = false
         @capabilities = capabilities
         @driver_for = driver_for
         @selenium_url = selenium_url
       end
 
+      # Whether the driver has known to have failed (it may still have failed and us not know yet)
+      def failed?
+        @failed
+      end
+
+      # Marks the driver as failed
+      def fail_driver
+        $logger.error 'Selenium driver failed, remaining scenarios will be skipped'
+        @failed = true
+      end
+
       def find_element(*args)
         @driver.find_element(*args)
       end
 
+      def wait_for_element(id)
+        @driver.find_element(id: id)
+      end
+
+      def click_element(id)
+        element = @driver.find_element(id: id)
+
+        if $browser.mobile?
+          element.click
+        else
+          @driver.action.move_to(element).click.perform
+        end
+      end
+
       def navigate
         @driver.navigate
       end
@@ -128,6 +154,7 @@ module Maze
           end
           $logger.info "Selenium driver started in #{(Time.now - time).to_i}s"
           @driver = driver
+          @failed = false
         rescue => error
           Bugsnag.notify error
           $logger.warn "Selenium driver failed to start in #{(Time.now - time).to_i}s"

data/lib/maze/hooks/appium_hooks.rb

@@ -42,11 +42,11 @@ module Maze
           # Reset the server to ensure that test fixtures cannot fetch
           # commands from the previous scenario (in idempotent mode).
           begin
-            Maze.driver.terminate_app Maze.driver&.app_id
+            Maze.driver.terminate_app Maze.driver.app_id
           rescue Selenium::WebDriver::Error::UnknownError, Selenium::WebDriver::Error::InvalidSessionIdError
             if Maze.config.appium_version && Maze.config.appium_version.to_f < 2.0
               $logger.warn 'terminate_app failed, using the slower but more forceful close_app instead'
-              Maze.driver&.close_app
+              Maze.driver.close_app
             else
               $logger.warn 'terminate_app failed, future errors may occur if the application did not close remotely'
             end

data/lib/maze/option/parser.rb

@@ -124,9 +124,10 @@ module Maze
                 type: :string,
                 multi: true
             opt Option::BROWSER,
-                'Browser to use (an entry in <farm>_browsers.yml)',
+                'Browser to use (an entry in <farm>_browsers.yml). Can be listed multiple times to have a prioritised list of browsers',
                 short: :none,
-                type: :string
+                type: :string,
+                multi: true
             opt Option::BROWSER_VERSION,
                 'Browser version to use (applies to entries in <farm>_browsers.yml that do not include a version)',
                 short: :none,

data/lib/maze/option/processor.rb

@@ -57,21 +57,18 @@ module Maze
           case config.farm
           when :bs
             device_option = options[Maze::Option::DEVICE]
-            if device_option.nil? || device_option.empty?
-              config.browser = options[Maze::Option::BROWSER]
-            else
-              if device_option.is_a?(Array)
-                config.device = device_option.first
-                config.device_list = device_option.drop(1)
-              else
-                config.device = device_option
-                config.device_list = []
-              end
+            browser_option = options[Maze::Option::BROWSER]
+            if !device_option.empty?
+              config.device = device_option.first
+              config.device_list = device_option.drop(1)
               if config.legacy_driver?
                 config.os_version = Maze::Client::Appium::BrowserStackDevices::DEVICE_HASH[config.device]['os_version'].to_f
               else
                 config.os_version = Maze::Client::Appium::BrowserStackDevices::DEVICE_HASH[config.device]['platformVersion'].to_f
               end
+            elsif !browser_option.empty?
+              config.browser = browser_option.first
+              config.browser_list = browser_option.drop(1)
             end
             config.bs_local = Maze::Helper.expand_path(options[Maze::Option::BS_LOCAL])
             config.appium_version = options[Maze::Option::APPIUM_VERSION]
@@ -83,18 +80,20 @@ module Maze
             config.access_key = options[Maze::Option::ACCESS_KEY]
             config.appium_version = options[Maze::Option::APPIUM_VERSION]
             device_option = options[Maze::Option::DEVICE]
-            if device_option.nil? || device_option.empty?
-              # BitBar Web
-              config.browser = options[Maze::Option::BROWSER]
-              config.browser_version = options[Maze::Option::BROWSER_VERSION]
-            else
-              # BitBar Devices
-              if device_option.is_a?(Array)
-                config.device = device_option.first
-                config.device_list = device_option.drop(1)
+            browser_option = options[Maze::Option::BROWSER]
+            browser_version = options[Maze::Option::BROWSER_VERSION]
+            if !device_option.empty?
+              config.device = device_option.first
+              config.device_list = device_option.drop(1)
+            elsif !browser_option.empty?
+              if browser_version.nil?
+                config.browser = browser_option.first
+                config.browser_list = browser_option.drop(1)
               else
-                config.device = device_option
-                config.device_list = []
+                # Dropping all but the first browser as the version is specified
+                config.browser = browser_option.first
+                config.browser_list = []
+                config.browser_version = browser_version
               end
             end
             config.os = options[Maze::Option::OS]
@@ -104,9 +103,7 @@ module Maze
             config.selenium_server_url = options[Maze::Option::SELENIUM_SERVER]
             config.app_bundle_id = options[Maze::Option::APP_BUNDLE_ID]
           when :local then
-            if options[Maze::Option::BROWSER]
-              config.browser = options[Maze::Option::BROWSER]
-            else
+            if options[Maze::Option::BROWSER].empty?
               os = config.os = options[Maze::Option::OS].downcase
               config.os_version = options[Maze::Option::OS_VERSION].to_f unless options[Maze::Option::OS_VERSION].nil?
               config.appium_server_url = options[Maze::Option::APPIUM_SERVER]
@@ -116,6 +113,8 @@ module Maze
                 config.apple_team_id = options[Maze::Option::APPLE_TEAM_ID]
                 config.device_id = options[Maze::Option::UDID]
               end
+            else
+              config.browser = options[Maze::Option::BROWSER].first
             end
           when :none
             if options[Maze::Option::OS]

data/lib/maze/option/validator.rb

@@ -53,17 +53,17 @@ module Maze
         # Device
         browser = options[Option::BROWSER]
         device = options[Option::DEVICE]
-        if browser.nil? && device.empty?
+        if browser.empty? && device.empty?
           errors << "Either --#{Option::BROWSER} or --#{Option::DEVICE} must be specified"
-        elsif browser
-
+        elsif !browser.empty?
           browsers = YAML.safe_load(File.read("#{__dir__}/../client/selenium/bs_browsers.yml"))
 
-          unless browsers.include? browser
+          rejected_browsers = browser.reject { |br| browsers.include? br }
+          unless rejected_browsers.empty?
             browser_list = browsers.keys.join ', '
-            errors << "Browser type '#{browser}' unknown on BrowserStack.  Must be one of: #{browser_list}."
+            errors << "Browser types '#{rejected_browsers.join(', ')}' unknown on BrowserStack.  Must be one of: #{browser_list}."
           end
-        elsif device
+        elsif !device.empty?
           device.each do |device_key|
             next if Maze::Client::Appium::BrowserStackDevices::DEVICE_HASH.key? device_key
             errors << "Device type '#{device_key}' unknown on BrowserStack.  Must be one of #{Maze::Client::Appium::BrowserStackDevices::DEVICE_HASH.keys}"
@@ -89,25 +89,30 @@ module Maze
       def validate_bitbar(options, errors)
         browser = options[Option::BROWSER]
         device = options[Option::DEVICE]
-        
+
         errors << "--#{Option::USERNAME} must be specified" if options[Option::USERNAME].nil?
         errors << "--#{Option::ACCESS_KEY} must be specified" if options[Option::ACCESS_KEY].nil?
 
         # Device
-        if browser.nil? && device.empty?
+        if browser.empty? && device.empty?
           errors << "Either --#{Option::BROWSER} or --#{Option::DEVICE} must be specified"
-        elsif browser
+        elsif !browser.empty?
           browsers = YAML.safe_load(File.read("#{__dir__}/../client/selenium/bb_browsers.yml"))
 
-          if browsers.include? browser
-            if options[Option::BROWSER_VERSION].nil? && !browsers[browser].include?('version')
-              errors << "--#{Option::BROWSER_VERSION} must be specified for browser '#{browser}'"
+          rejected_browsers = browser.reject { |br| browsers.include? br }
+          if rejected_browsers.empty?
+            if options[Option::BROWSER_VERSION].nil?
+              browser.each do |br|
+                next if browsers[br].include?('version')
+                errors << "--#{Option::BROWSER_VERSION} must be specified for browser '#{br}'"
+              end
             end
           else
             browser_list = browsers.keys.join ', '
-            errors << "Browser type '#{browser}' unknown on BitBar.  Must be one of: #{browser_list}."
+            errors << "Browser types '#{rejected_browsers.join(', ')}' unknown on BitBar.  Must be one of: #{browser_list}."
           end
-        elsif device
+
+        elsif !device.empty?
           app = Maze::Helper.read_at_arg_file options[Option::APP]
           if app.nil?
             errors << "--#{Option::APP} must be provided when running on a device"
@@ -123,7 +128,7 @@ module Maze
 
       # Validates Local device options
       def validate_local(options, errors)
-        if options[Option::BROWSER].nil?
+        if options[Option::BROWSER].empty?
           errors << "--#{Option::APP} must be specified" if options[Option::APP].nil?
 
           # OS

data/lib/maze.rb

@@ -8,7 +8,7 @@ require_relative 'maze/timers'
 # providing an alternative to the proliferation of global variables or singletons.
 module Maze
 
-  VERSION = '9.21.0'
+  VERSION = '9.23.0'
 
   class << self
     attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-maze-runner
 version: !ruby/object:Gem::Version
-  version: 9.21.0
+  version: 9.23.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-28 00:00:00.000000000 Z
+date: 2025-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -440,7 +440,10 @@ files:
 - lib/features/support/env.rb
 - lib/features/support/internal_hooks.rb
 - lib/maze.rb
+- lib/maze/api/appium/app_manager.rb
+- lib/maze/api/appium/device_manager.rb
 - lib/maze/api/appium/file_manager.rb
+- lib/maze/api/appium/manager.rb
 - lib/maze/api/cucumber/scenario.rb
 - lib/maze/api/exit_code.rb
 - lib/maze/appium_server.rb