bugsnag-maze-runner 8.4.1 → 8.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f4746e6a6b4789c6a7fe8b6f501f12f87a931fa8d4ecddc000f3a7aae7ea9ee
-  data.tar.gz: c6da9d5ab45afc9bd4edd711d9122f4e022f4362871c3c369d25d145c496698e
+  metadata.gz: 96a68ab4f0db7889bf4889f9d3af3acaff592f9e24477df3e80c6d72ca32da0f
+  data.tar.gz: 949f8c4cc9d658f7535b9ec7adb06a087ff5d649f68c08d9e74b223c207896ae
 SHA512:
-  metadata.gz: 9b2bdcaf44ec0c4a366585373dceaf0db310626feae71a7e51fd9d36c8f1e1c04049e842ee9de508267ad047e701bc83819437d54c1c41b3b829d9fd19ce097f
-  data.tar.gz: c76978dd97bfd6c28e845937c3a6079be1e0eb3717a491020971ecd458d5b59ab0b9e5a504ca019178cb6363768b1d569b196a6a8cb6657650f6041519e5a36a
+  metadata.gz: f49cd17392e55b29924cd0a9ab9b11b41a0e1799d6d5659399674529123b1928b5b2608191a9db4cf355377316fc22ba9f7e000eda8a21446a774e127de5ace8
+  data.tar.gz: 8c50541e8de8aed4ec810459bb0aaa67b4a4c4c80bdfdb106a1653868039036c9314cc7b07986a7551a2c8448b5761fc0d16c53d70817d5c58615085bb4ed31b

data/bin/maze-runner

@@ -10,6 +10,7 @@ require_relative '../lib/maze'
 require_relative '../lib/maze/appium_server'
 require_relative '../lib/maze/api/appium/file_manager'
 require_relative '../lib/maze/api/cucumber/scenario'
+require_relative '../lib/maze/api/exit_code'
 require_relative '../lib/maze/bugsnag_config'
 require_relative '../lib/maze/client/bb_api_client'
 require_relative '../lib/maze/client/bb_client_utils'

data/lib/maze/api/exit_code.rb

@@ -0,0 +1,16 @@
+module Maze
+  module Api
+    class ExitCode
+      # Cucumber itself can use codes 0 to 2
+
+      AUTOMATION_GENERIC_ERROR = 10
+      AUTOMATION_ELEMENT_NOT_FOUND = 11
+      AUTOMATION_TIMEOUT = 12
+      AUTOMATION_STALE_ELEMENT = 13
+
+      APP_UPLOAD_FAILURE = 100
+      TUNNEL_FAILURE = 101
+      SESSION_CREATION_FAILURE = 102
+    end
+  end
+end

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

@@ -41,11 +41,18 @@ module Maze
           raise 'Method not implemented by this class'
         end
 
+        def retry_start_driver?
+          raise 'Method not implemented by this class'
+        end
+
         def start_driver(config)
-          retry_failure = config.device_list.nil? || config.device_list.empty?
+          retry_failure = retry_start_driver?
           driver = nil
           until Maze.driver
             begin
+
+
+              # Proc to start the driver
               start_driver_closure = Proc.new do
                 begin
                   config.capabilities = device_capabilities
@@ -64,21 +71,23 @@ module Maze
                   result
                 rescue => start_error
                   $logger.error "Session creation failed: #{start_error}"
-                  raise start_error unless retry_failure
                   false
                 end
               end
 
+
+              # Invoke the proc, with or without retries
               if retry_failure
                 wait = Maze::Wait.new(interval: 10, timeout: 60)
                 success = wait.until(&start_driver_closure)
-
-                unless success
-                  $logger.error 'Appium driver failed to start after 6 attempts in 60 seconds'
-                  raise RuntimeError.new('Appium driver failed to start in 60 seconds')
-                end
               else
-                start_driver_closure.call
+                success = start_driver_closure.call
+              end
+
+              unless success
+                # TODO Bugsnag notify
+                $logger.error 'Failed to create Appium driver, exiting'
+                exit(::Maze::Api::ExitCode::SESSION_CREATION_FAILURE)
               end
 
               # Infer OS version if necessary when running locally

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

@@ -13,6 +13,10 @@ module Maze
           end
         end
 
+        def retry_start_driver?
+          false
+        end
+
         def start_scenario
           unless Maze.config.legacy_driver?
             # Write Maze's address to file and push to the device

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

@@ -50,7 +50,7 @@ module Maze
                                 else
                                   'UiAutomator2'
                                 end
-              make_android_hash(device_name, automation_name)
+              make_android_hash(device_name, automation_name, prefix)
             when 'ios'
               make_ios_hash(device_name, prefix)
             else
@@ -98,20 +98,20 @@ module Maze
             end
           end
 
-          def make_android_hash(device, automation_name)
+          def make_android_hash(device, automation_name, prefix='appium:')
             hash = {
               'automationName' => automation_name,
               'platformName' => 'Android',
               'deviceName' => 'Android Phone',
               'bitbar:options' => {
-                'autoGrantPermissions' => true,
+                "#{prefix}autoGrantPermissions" => true,
                 'device' => device,
               }
             }
             hash.freeze
           end
 
-          def make_ios_hash(device, prefix='')
+          def make_ios_hash(device, prefix='appium:')
             {
               'automationName' => 'XCUITest',
               'deviceName' => 'iPhone device',
@@ -124,7 +124,7 @@ module Maze
           end
 
           def caps_prefix(appium_version)
-            appium_version.nil? || (appium_version.to_i < 2) ? '' : 'appium:'
+            appium_version.nil? || (appium_version.to_i >= 2) ? 'appium:' : ''
           end
         end
       end

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

@@ -15,6 +15,10 @@ module Maze
           end
         end
 
+        def retry_start_driver?
+          Maze.config.device_list.nil? || Maze.config.device_list.empty?
+        end
+
         def start_scenario
           unless Maze.config.legacy_driver?
             # Write Maze's address to file and push to the device

data/lib/maze/errors.rb

@@ -24,29 +24,29 @@ module Maze
     ERROR_CODES = {
       ::Selenium::WebDriver::Error::UnknownError => {
         retry: true,
-        error_code: 10
+        error_code: Maze::Api::ExitCode::AUTOMATION_GENERIC_ERROR
       },
       ::Selenium::WebDriver::Error::WebDriverError => {
         retry: true,
-        error_code: 10
+        error_code: Maze::Api::ExitCode::AUTOMATION_GENERIC_ERROR
       },
       Maze::Error::AppiumElementNotFoundError => {
         retry: true,
-        error_code: 11
+        error_code: Maze::Api::ExitCode::AUTOMATION_ELEMENT_NOT_FOUND
       },
       ::Selenium::WebDriver::Error::NoSuchElementError => {
         retry: true,
-        error_code: 12
+        error_code: Maze::Api::ExitCode::AUTOMATION_ELEMENT_NOT_FOUND
       },
       ::Selenium::WebDriver::Error::TimeoutError => {
         retry: true,
-        error_code: 13
+        error_code: Maze::Api::ExitCode::AUTOMATION_TIMEOUT
       },
       ::Selenium::WebDriver::Error::StaleElementReferenceError => {
         retry: true,
-        error_code: 14
+        error_code: Maze::Api::ExitCode::AUTOMATION_STALE_ELEMENT
       },
     }.freeze
 
   end
-end
+end

data/lib/maze/plugins/bugsnag_reporting_plugin.rb

@@ -26,8 +26,15 @@ module Maze
 
           Bugsnag.notify(event.result.exception) do |bsg_event|
             unless @last_test_step.nil?
-              bsg_event.context = @last_test_step.location
-              bsg_event.grouping_hash = test_case.name + @last_test_step.location
+
+              repo = ENV['BUILDKITE_PIPELINE_SLUG']
+              bsg_event.context = if repo.nil?
+                                    @last_test_step.location
+                                  else
+                                    "#{repo}/#{@last_test_step.location}"
+                                  end
+              bsg_event.grouping_hash = @last_test_step.location
+
               bsg_event.add_metadata(:'scenario', {
                 'failing step': @last_test_step.to_s,
                 'failing step location': @last_test_step.location

data/lib/maze.rb

@@ -7,7 +7,7 @@ require_relative 'maze/timers'
 # Glues the various parts of MazeRunner together that need to be accessed globally,
 # providing an alternative to the proliferation of global variables or singletons.
 module Maze
-  VERSION = '8.4.1'
+  VERSION = '8.6.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: 8.4.1
+  version: 8.6.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2023-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -369,6 +369,7 @@ files:
 - lib/maze.rb
 - lib/maze/api/appium/file_manager.rb
 - lib/maze/api/cucumber/scenario.rb
+- lib/maze/api/exit_code.rb
 - lib/maze/appium_server.rb
 - lib/maze/assertions/request_set_assertions.rb
 - lib/maze/aws/sam.rb