bugsnag-maze-runner 9.24.0 → 9.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0228273568f007261eae073c5e86b4110a49457315b720af8c8485b852654c14'
-  data.tar.gz: 6e02c9d0d6dc533970fa04513fbbcef5a1d3922bd94ad56320ec94ec68728371
+  metadata.gz: 46bf8f5d1c29e09f7227b584c2f716d35051c11553bfff1ee811ae1ce3ea8301
+  data.tar.gz: 13adf959087e9fea8dcfd9abf914dcca0d39692a594b5052dc9c8e4c264ba6ab
 SHA512:
-  metadata.gz: c1f163e4176bffeb2a3c87f94513af887b51a586797c91ab615d44eba321f4bcc11a998b1f7ae5f1524a872dc3f3bd01538eeb4f36e25ec1c545be0a768db034
-  data.tar.gz: 03343e37dbd74f6d528c6a72ec7d818ae8ddb2725ed4788591e2dce4e0183b3a1a8d8ec3294ddb2e677544dce6e1da13de8400d5ea396413efdb6b5fd42b8905
+  metadata.gz: 1d8b85bf8aaf4e2689f53958cfc3758829351f955666ebb3280b1a0e86a326dd989acab928352140141b50cd865327fcf63db6a419710ece36c8c8ad253220f3
+  data.tar.gz: 95928d06b7051df121c8fcfec30c32ac7c925621029da75ceb0b05bc47d75e0fd41ac5e4cd7bf17d13f7bd21296c2fabaea554ba6e5336c11c6c124e59c6e96e

data/bin/maze-runner

@@ -29,6 +29,7 @@ require_relative '../lib/maze/client/appium/bs_client'
 require_relative '../lib/maze/client/appium/bs_legacy_client'
 require_relative '../lib/maze/client/appium/bs_devices'
 require_relative '../lib/maze/client/appium/local_client'
+require_relative '../lib/maze/client/appium/session_metadata'
 require_relative '../lib/maze/client/selenium'
 require_relative '../lib/maze/client/selenium/base_client'
 require_relative '../lib/maze/client/selenium/bb_client'
@@ -51,7 +52,6 @@ require_relative '../lib/maze/network'
 require_relative '../lib/maze/proxy'
 require_relative '../lib/maze/retry_handler'
 require_relative '../lib/maze/repeaters/request_repeater'
-require_relative '../lib/maze/repeaters/aspecto_repeater'
 require_relative '../lib/maze/repeaters/bugsnag_repeater'
 require_relative '../lib/maze/runner'
 require_relative '../lib/maze/terminating_server'

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

@@ -19,7 +19,7 @@ module Maze
           true
         rescue Selenium::WebDriver::Error::ServerError => e
           # Assume the remote appium session has stopped, so crash out of the session
-          fail_driver
+          fail_driver(e.message)
           raise e
         end
 
@@ -35,7 +35,7 @@ module Maze
           true
         rescue Selenium::WebDriver::Error::ServerError => e
           # Assume the remote appium session has stopped, so crash out of the session
-          fail_driver
+          fail_driver(e.message)
           raise e
         end
 
@@ -51,7 +51,7 @@ module Maze
           true
         rescue Selenium::WebDriver::Error::ServerError => e
           # Assume the remote appium session has stopped, so crash out of the session
-          fail_driver
+          fail_driver(e.message)
           raise e
         end
 
@@ -67,7 +67,7 @@ module Maze
           true
         rescue Selenium::WebDriver::Error::ServerError => e
           # Assume the remote appium session has stopped, so crash out of the session
-          fail_driver
+          fail_driver(e.message)
           raise e
         end
 
@@ -82,7 +82,7 @@ module Maze
           @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
+          fail_driver(e.message)
           raise e
         end
       end

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

@@ -20,7 +20,7 @@ module Maze
           true
         rescue Selenium::WebDriver::Error::ServerError => e
           # Assume the remote appium session has stopped, so crash out of the session
-          fail_driver
+          fail_driver(e.message)
           raise e
         end
 
@@ -37,7 +37,7 @@ module Maze
           true
         rescue Selenium::WebDriver::Error::ServerError => e
           # Assume the remote appium session has stopped, so crash out of the session
-          fail_driver
+          fail_driver(e.message)
           raise e
         end
 
@@ -52,7 +52,7 @@ module Maze
           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
+          fail_driver(e.message)
           raise e
         end
       end

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

@@ -36,7 +36,7 @@ module Maze
           false
         rescue Selenium::WebDriver::Error::ServerError => e
           # Assume the remote appium session has stopped, so crash out of the session
-          fail_driver
+          fail_driver(e.message)
           raise e
         end
 
@@ -73,7 +73,7 @@ module Maze
           nil
         rescue Selenium::WebDriver::Error::ServerError => e
           # Assume the remote appium session has stopped, so crash out of the session
-          fail_driver
+          fail_driver(e.message)
           raise e
         end
       end

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

@@ -11,8 +11,8 @@ module Maze
           @driver.failed?
         end
 
-        def fail_driver
-          @driver.fail_driver
+        def fail_driver(message)
+          @driver.fail_driver(message)
         end
       end
     end

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

@@ -8,7 +8,6 @@ module Maze
         FIXTURE_CONFIG = 'fixture_config.json'
 
         def initialize
-          @session_ids = []
           @start_attempts = 0
         end
 
@@ -79,9 +78,9 @@ module Maze
           if result
             # Log details of this session
             $logger.info "Created Appium session: #{driver.session_id}"
-            @session_ids << driver.session_id
-            udid = driver.session_capabilities['udid']
-            $logger.info "Running on device: #{udid}" unless udid.nil?
+            @session_metadata = Maze::Client::Appium::SessionMetadata.new
+            @session_metadata.id = driver.session_id
+            @session_metadata.farm = Maze.config.farm.to_s
           end
           driver
         end
@@ -147,9 +146,47 @@ module Maze
         end
 
         def stop_session
-          Maze.driver.driver_quit unless Maze.driver.failed?
+          if Maze.driver.failed?
+            @session_metadata.success = false
+            @session_metadata.failure_message = Maze.driver.failure_reason
+          else
+            # TODO: The call to quit could also fail
+            Maze.driver.driver_quit
+            @session_metadata.success = true
+          end
+
+          # Report session outcome to Bugsnag
+          report_session if ENV['MAZE_APPIUM_BUGSNAG_API_KEY']
+
           Maze::AppiumServer.stop if Maze::AppiumServer.running
         end
+
+        def report_session
+          message = @session_metadata.success ? 'Success' : @session_metadata.failure_message
+          error = Exception.new(message)
+
+          Bugsnag.notify(error) do |event|
+            event.api_key = ENV['MAZE_APPIUM_BUGSNAG_API_KEY']
+            event.grouping_hash = event.exceptions.first[:message]
+
+            metadata = {
+              'session id': @session_metadata.id,
+              'success': @session_metadata.success,
+              'device farm': @session_metadata.farm.to_s,
+            }
+            metadata['device'] = @session_metadata.device if @session_metadata.device
+
+            if @session_metadata.success
+              event.severity = 'info'
+            else
+              event.severity = 'error'
+              event.unhandled = true
+              metadata['failure message'] = @session_metadata.failure_message
+            end
+
+            event.add_metadata(:'Appium Session', metadata)
+          end
+        end
       end
     end
   end

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

@@ -91,14 +91,12 @@ module Maze
         def log_run_outro
           api_client = BitBarApiClient.new(Maze.config.access_key)
 
-          $logger.info 'Appium session(s) created:'
-          @session_ids.each do |id|
-            info = api_client.get_device_session_info(id)
-            if info
-              link = Maze::Loggers::LogUtil.linkify(info[:dashboard_link], "BitBar session: #{id}")
-              $logger.info link
-              $logger.info "Device used: #{info[:device_name]}"
-            end
+          info = api_client.get_device_session_info(@session_metadata.id)
+          if info
+            link = Maze::Loggers::LogUtil.linkify(info[:dashboard_link], "BitBar session: #{@session_metadata.id}")
+            $logger.info link
+            @session_metadata.device = info[:device_name]
+            $logger.info "Device used: #{@session_metadata.device}"
           end
         end
 

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

@@ -72,8 +72,7 @@ module Maze
         end
 
         def log_run_outro
-          $logger.info 'Appium session(s) created:'
-          @session_ids.each { |id| $logger.info "  #{id}" }
+          $logger.info "Appium session created: #{@session_metadata.id}"
           log_run_intro
         end
 

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

@@ -75,7 +75,7 @@ module Maze
               'ANDROID_14' => make_android_hash('Google Pixel 8', '14.0'),
               'ANDROID_13' => make_android_hash('Google Pixel 6 Pro', '13.0'),
               'ANDROID_12' => make_android_hash('Google Pixel 5', '12.0'),
-              'ANDROID_11' => make_android_hash('Google Pixel 4', '11.0'),
+              'ANDROID_11' => make_android_hash('Samsung Galaxy S21', '11.0'),
               'ANDROID_10' => make_android_hash('Google Pixel 4', '10.0'),
               'ANDROID_9' => make_android_hash('Google Pixel 3', '9.0'),
               'ANDROID_8' => make_android_hash('Samsung Galaxy S9', '8.0'),
@@ -92,8 +92,6 @@ module Maze
             }
 
             # Specific Android devices
-            add_android 'Google Pixel 4', '11.0', hash                        # ANDROID_11_0_GOOGLE_PIXEL_4
-
             add_android 'Xiaomi Redmi Note 9', '10.0', hash                   # ANDROID_10_0_XIAOMI_REDMI_NOTE_9
             add_android 'Samsung Galaxy Note 20', '10.0', hash                # ANDROID_10_0_SAMSUNG_GALAXY_NOTE_20
             add_android 'Motorola Moto G9 Play', '10.0', hash                 # ANDROID_10_0_MOTOROLA_MOTO_G9_PLAY

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

@@ -0,0 +1,18 @@
+module Maze
+  module Client
+    module Appium
+      class SessionMetadata
+        def initialize
+          @success = false
+          @failure_message = 'Default failure message'
+        end
+
+        attr_accessor :id
+        attr_accessor :farm
+        attr_accessor :device
+        attr_accessor :success
+        attr_accessor :failure_message
+      end
+    end
+  end
+end

data/lib/maze/client/bb_api_client.rb

@@ -88,6 +88,7 @@ module Maze
           }
         else
           $logger.warn "Could not retrieve details for device session #{session_id}, BitBar may not have had time to create it yet."
+          nil
         end
       end
 

data/lib/maze/configuration.rb

@@ -72,9 +72,6 @@ module Maze
     # The server endpoints for which invalid requests should be captured and cause tests to fail
     attr_accessor :captured_invalid_requests
 
-    # API key to use when repeating requests to Bugsnag
-    attr_accessor :aspecto_repeater_api_key
-
     # API key to use when repeating requests to Bugsnag
     attr_accessor :bugsnag_repeater_api_key
 

data/lib/maze/driver/appium.rb

@@ -33,6 +33,7 @@ module Maze
         capabilities ||= {}
 
         @failed = false
+        @failure_reason = ''
         @element_locator = locator
         @capabilities = capabilities
 
@@ -70,10 +71,15 @@ module Maze
         @failed
       end
 
+      def failure_reason
+        @failure_reason
+      end
+
       # Marks the driver as failed
-      def fail_driver
-        $logger.error 'Appium driver failed, remaining scenarios will be skipped'
+      def fail_driver(reason)
+        $logger.error "Appium driver failed: #{reason}"
         @failed = true
+        @failure_reason = reason
       end
 
       # Checks for an element, waiting until it is present or the method times out
@@ -95,7 +101,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        fail_driver
+        fail_driver(e.message)
         raise e
       else
         true
@@ -106,7 +112,7 @@ module Maze
         super
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        fail_driver
+        fail_driver(e.message)
         raise e
       end
 
@@ -115,7 +121,7 @@ module Maze
         super
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        fail_driver
+        fail_driver(e.message)
         raise e
       end
 
@@ -126,7 +132,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        fail_driver
+        fail_driver(e.message)
         raise e
       end
 
@@ -140,7 +146,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        fail_driver
+        fail_driver(e.message)
         raise e
       end
 
@@ -158,7 +164,7 @@ module Maze
         false
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        fail_driver
+        fail_driver(e.message)
         raise e
       end
 
@@ -172,7 +178,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        fail_driver
+        fail_driver(e.message)
         raise e
       end
 
@@ -197,7 +203,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        fail_driver
+        fail_driver(e.message)
         raise e
       end
 
@@ -234,7 +240,7 @@ module Maze
         end
       rescue Selenium::WebDriver::Error::ServerError => e
         # Assume the remote appium session has stopped, so crash out of the session
-        fail_driver
+        fail_driver(e.message)
         raise e
       end
 

data/lib/maze/option/parser.rb

@@ -47,11 +47,6 @@ module Maze
                 short: :none,
                 default: true
 
-            opt Option::ASPECTO_REPEATER_API_KEY,
-                'Enables forwarding of all received POST requests to Aspecto, using the API key provided.  MAZE_ASPECTO_REPEATER_API_KEY may also be set.',
-                short: :none,
-                type: :string
-
             opt Option::BUGSNAG_REPEATER_API_KEY,
                 'Enables forwarding of all received POST requests to Bugsnag, using the API key provided.  MAZE_REPEATER_API_KEY may also be set.',
                 short: :none,
@@ -281,7 +276,6 @@ module Maze
             options[Option::SELENIUM_SERVER] ||= ENV['MAZE_SELENIUM_SERVER'] || 'https://us-west-desktop-hub.bitbar.com/wd/hub'
           end
 
-          options[Option::ASPECTO_REPEATER_API_KEY] ||= ENV['MAZE_ASPECTO_REPEATER_API_KEY']
           options[Option::BUGSNAG_REPEATER_API_KEY] ||= ENV['MAZE_REPEATER_API_KEY']
           options[Option::SB_LOCAL] ||= ENV['MAZE_SB_LOCAL'] || '/SBSecureTunnel'
           options[Option::BS_LOCAL] ||= ENV['MAZE_BS_LOCAL'] || '/BrowserStackLocal'

data/lib/maze/option/processor.rb

@@ -22,8 +22,6 @@ module Maze
           config.aws_public_ip = options[Maze::Option::AWS_PUBLIC_IP]
           config.enable_retries = options[Maze::Option::RETRIES]
           config.enable_bugsnag = options[Maze::Option::BUGSNAG]
-          aspecto_repeater_api_key = options[Maze::Option::ASPECTO_REPEATER_API_KEY]
-          config.aspecto_repeater_api_key = aspecto_repeater_api_key unless aspecto_repeater_api_key&.empty?
           bugsnag_repeater_api_key = options[Maze::Option::BUGSNAG_REPEATER_API_KEY]
           config.bugsnag_repeater_api_key = bugsnag_repeater_api_key unless bugsnag_repeater_api_key&.empty? 
 

data/lib/maze/option.rb

@@ -56,7 +56,6 @@ module Maze
 
     # General options
     AWS_PUBLIC_IP = 'aws-public-ip'
-    ASPECTO_REPEATER_API_KEY = 'aspecto-repeater-api-key'
     BUGSNAG_REPEATER_API_KEY = 'repeater-api-key'
     BUGSNAG = 'bugsnag'
     RETRIES = 'retries'

data/lib/maze/servlets/servlet.rb

@@ -39,7 +39,6 @@ module Maze
         super server
         @request_type = request_type
         @schema = JSONSchemer.schema(schema) unless schema.nil?
-        @aspecto_repeater = Maze::Repeaters::AspectoRepeater.new(@request_type)
         @bugsnag_repeater = Maze::Repeaters::BugsnagRepeater.new(@request_type)
       end
 
@@ -59,7 +58,6 @@ module Maze
       # @param response [HTTPResponse] The response to return
       def do_POST(request, response)
 
-        @aspecto_repeater.repeat request
         @bugsnag_repeater.repeat request
 
         # Turn the WEBrick HttpRequest into our internal HttpRequest delegate

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.24.0'
+  VERSION = '9.25.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.24.0
+  version: 9.25.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -461,6 +461,7 @@ files:
 - lib/maze/client/appium/bs_devices.rb
 - lib/maze/client/appium/bs_legacy_client.rb
 - lib/maze/client/appium/local_client.rb
+- lib/maze/client/appium/session_metadata.rb
 - lib/maze/client/bb_api_client.rb
 - lib/maze/client/bb_client_utils.rb
 - lib/maze/client/bs_client_utils.rb
@@ -507,7 +508,6 @@ files:
 - lib/maze/plugins/global_retry_plugin.rb
 - lib/maze/plugins/logging_scenarios_plugin.rb
 - lib/maze/proxy.rb
-- lib/maze/repeaters/aspecto_repeater.rb
 - lib/maze/repeaters/bugsnag_repeater.rb
 - lib/maze/repeaters/request_repeater.rb
 - lib/maze/request_list.rb

data/lib/maze/repeaters/aspecto_repeater.rb

@@ -1,34 +0,0 @@
-module Maze
-  module Repeaters
-    # Repeats Bugsnag requests
-    class AspectoRepeater < RequestRepeater
-
-      private
-
-      def set_headers(request)
-        request['Authorization'] = Maze.config.aspecto_repeater_api_key
-      end
-
-      def enabled?
-        # enabled if the config option is on and this request type should be repeated
-        Maze.config.aspecto_repeater_api_key && url_for_request_type
-      end
-
-      def gzip_supported
-        false
-      end
-
-      def url_for_request_type
-        url = case @request_type
-              when :traces then 'https://otelcol.aspecto.io:4318/v1/traces'
-              else return nil
-              end
-        URI.parse(url)
-      end
-
-      def include_header?(key, _value)
-        true unless key.start_with? 'bugsnag'
-      end
-    end
-  end
-end