bugsnag-maze-runner 8.5.0 → 8.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d11bc8e7ebea9cb0ec05467af0e950a4481d248fd1451528f79750c00a41a2af
-  data.tar.gz: 860bc9eab1e48fa6a0d7bad855206bd064271e585d92b87387864974d3990932
+  metadata.gz: 0b7f9aa07e4e22e0ba3a5e1190fc89ec96027c03f68715ff9fc1b12899f8d253
+  data.tar.gz: 4ec7ef8d4c1de53f7affa6e0a627265c451ebb89f0379b036faaf4b4af03923b
 SHA512:
-  metadata.gz: 5c212301ee67f41a484dd5421f751d4de06c97c5c83e06b75f34abf335a9863150838c4034f71a36b9bb708f1d4c867117da897c07f80fb4ea4a80fb6311e9d2
-  data.tar.gz: 6f6cc461ca50319e32087f60de3bbaeec5662566f313f64a8f3899b1277c3af333db9c8a6aae2f870735ceb8ffc3ac6737a37203a8aaabeb23948efe33662a34
+  metadata.gz: 6e05c8bd71dab45c398f70f95295bf12338a6459e02dc4b296ba69576654753ea9522f1a6213e0b85ba0a47ba0a3e9375d2a4c747e4b23f3ef057c511d9a03bc
+  data.tar.gz: b364461de84878a0c9f0e1fca85782fef3d27c08b1f22f91f7cfc72cc15fc7a3ff98451d88a6300cef5bc3af7be61222e56030f87d5ec29162e5093a143eaadb

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/bin/purge-projects

@@ -14,7 +14,7 @@ class PurgeProjectEntry
     p = Optimist::Parser.new do
       text 'Purge anonymous projects from BitBar'
       text ''
-      text 'Requires BITBAR_API_KEY'
+      text 'Requires BITBAR_ACCESS_KEY'
       text ''
       text 'Usage [OPTIONS]'
       text ''
@@ -29,10 +29,10 @@ class PurgeProjectEntry
       p.parse ARGV
     end
 
-    api_key = opts[:api_key] || ENV['BITBAR_API_KEY']
+    api_key = opts[:api_key] || ENV['BITBAR_ACCESS_KEY']
 
     if api_key.nil?
-      $logger.warn "API KEY has not been provided or BITBAR_API_KEY has not been set"
+      $logger.warn "API KEY has not been provided or BITBAR_ACCESS_KEY has not been set"
       Optimist::with_standard_exception_handling p do
         raise Optimist::HelpNeeded
       end

data/lib/features/support/internal_hooks.rb

@@ -91,7 +91,9 @@ InstallPlugin do |config|
 
   # Only add the retry plugin if --retry is not used on the command line
   config.filters << Maze::Plugins::GlobalRetryPlugin.new(config) if config.options[:retry].zero?
-  config.filters << Maze::Plugins::BugsnagReportingPlugin.new(config)
+
+  # TODO: Reporting of test failures as errors deactivated pending PLAT-10963
+  #config.filters << Maze::Plugins::BugsnagReportingPlugin.new(config)
 end
 
 # Before each scenario

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/aws_public_ip.rb

@@ -1,3 +1,5 @@
+require 'bugsnag'
+
 module Maze
   # Determines the public IP address and port when running on Buildkite with the Elastic CI Stack for AWS
   class AwsPublicIp
@@ -52,7 +54,8 @@ module Maze
             json_string = result[0][0].strip
             json_result = JSON.parse(json_string)
             port = json_result['NetworkSettings']['Ports']["#{local_port}/tcp"][0]['HostPort']
-          rescue StandardError
+          rescue StandardError => error
+            Bugsnag.notify error
             $logger.error "Unable to parse public port from: #{json_string}"
             return 0
           end

data/lib/maze/bugsnag_config.rb

@@ -35,7 +35,6 @@ module Maze
             Bugsnag.notify($!)
           end
         end
-
       end
     end
   end

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

@@ -1,3 +1,4 @@
+require 'bugsnag'
 require 'json'
 
 module Maze
@@ -26,8 +27,9 @@ module Maze
           # Ensure the device is unlocked
           begin
             Maze.driver.unlock
-          rescue => e
-            $logger.warn "Failed to unlock device: #{e}"
+          rescue => error
+            Bugsnag.notify error
+            $logger.warn "Failed to unlock device: #{error}"
           end
 
           log_run_intro
@@ -41,11 +43,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
@@ -62,23 +71,25 @@ module Maze
                     $logger.info "Running on device: #{udid}" unless udid.nil?
                   end
                   result
-                rescue => start_error
-                  $logger.error "Session creation failed: #{start_error}"
-                  raise start_error unless retry_failure
+                rescue => error
+                  Bugsnag.notify error
+                  $logger.error "Session creation failed: #{error}"
                   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
+                $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/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/client/bb_api_client.rb

@@ -103,8 +103,7 @@ module Maze
             end
           end
         rescue StandardError => e
-          $logger.error "Error getting projects from BitBar"
-          $logger.error e
+          $logger.error "Error getting projects from BitBar: #{e}"
           raise
         end
         projects

data/lib/maze/client/bb_client_utils.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'bugsnag'
 require 'open3'
 require 'fileutils'
 require 'json'
@@ -49,7 +50,8 @@ module Maze
                 $logger.error "Unexpected response body: #{response}"
                 raise 'App upload failed'
               end
-            rescue JSON::ParserError
+            rescue JSON::ParserError => error
+              Bugsnag.notify error
               $logger.error "Expected JSON response, received: #{res}"
               raise
             end

data/lib/maze/client/bs_client_utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'bugsnag'
+
 module Maze
   module Client
     # Utils supporting the BrowserStack device farm integration
@@ -42,9 +44,11 @@ module Maze
                   # Successful upload
                   break
                 end
-              rescue Net::ReadTimeout
+              rescue Net::ReadTimeout => error
+                Bugsnag.notify error
                 $logger.error "Upload failed due to ReadTimeout"
-              rescue JSON::ParserError
+              rescue JSON::ParserError => error
+                Bugsnag.notify error
                 $logger.error "Unexpected JSON response, received: #{body}"
               end
 

data/lib/maze/driver/appium.rb

@@ -1,4 +1,5 @@
 require 'appium_lib'
+require 'bugsnag'
 require 'json'
 require 'open3'
 require 'securerandom'
@@ -56,6 +57,8 @@ module Maze
           super
           $logger.info "Appium driver started in #{(Time.now - time).to_i}s"
         rescue => error
+          Bugsnag.notify(error)
+
           $logger.warn "Appium driver failed to start in #{(Time.now - time).to_i}s"
           $logger.warn "#{error.class} occurred with message: #{error.message}"
           raise error

data/lib/maze/driver/browser.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bugsnag'
 require 'selenium-webdriver'
 
 module Maze
@@ -122,6 +123,7 @@ module Maze
           $logger.info "Selenium driver started in #{(Time.now - time).to_i}s"
           @driver = driver
         rescue => error
+          Bugsnag.notify error
           $logger.warn "Selenium driver failed to start in #{(Time.now - time).to_i}s"
           raise error
         end

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/hooks/appium_hooks.rb

@@ -43,7 +43,10 @@ module Maze
       end
 
       def at_exit
-        @client&.stop_session
+        if @client
+          $logger.info 'Stopping the Appium session'
+          @client.stop_session
+        end
       end
 
       private

data/lib/maze/logger.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bugsnag'
 require 'logger'
 require 'singleton'
 
@@ -78,8 +79,9 @@ module Maze
           else
             log_hash_by_field severity, data
           end
-        rescue Encoding::UndefinedConversionError
+        rescue Encoding::UndefinedConversionError => error
           # Just give up, we don't want to risk a further error trying to log garbage
+          Bugsnag.notify error
           $logger.error 'Unable to log hash as JSON'
         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/proxy.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bugsnag'
 require 'json'
 require 'singleton'
 require 'webrick'
@@ -82,10 +83,11 @@ module Maze
             config[:ProxyAuthProc] = authenticator.method(:authenticate).to_proc
           end
 
-          # Crwate and start the proxy
+          # Create and start the proxy
           proxy = WEBrick::HTTPProxyServer.new config
           proxy.start
         rescue StandardError => e
+          Bugsnag.notify e
           $logger.warn "Failed to start proxy server: #{e.message}"
         ensure
           proxy&.shutdown

data/lib/maze/server.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bugsnag'
 require 'json'
 require 'securerandom'
 require 'webrick'
@@ -227,6 +228,7 @@ module Maze
             server.mount '/reflect', Servlets::ReflectiveServlet
             server.start
           rescue StandardError => e
+            Bugsnag.notify e
             $logger.warn "Failed to start mock server: #{e.message}"
           ensure
             server&.shutdown

data/lib/maze/servlets/log_servlet.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'bugsnag'
+
 module Maze
   module Servlets
 
@@ -30,6 +32,7 @@ module Maze
         response.header['Access-Control-Allow-Origin'] = '*'
         response.status = Server.status_code('POST')
       rescue JSON::ParserError => e
+        Bugsnag.notify e
         msg = "Unable to parse request as JSON: #{e.message}"
         $logger.error msg
         Server.invalid_requests.add({
@@ -39,6 +42,7 @@ module Maze
           body: request.body
         })
       rescue StandardError => e
+        Bugsnag.notify e
         $logger.error "Invalid request: #{e.message}"
         Server.invalid_requests.add({
           invalid: true,

data/lib/maze/servlets/reflective_servlet.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'bugsnag'
 require 'rack'
 
 module Maze
@@ -41,10 +42,12 @@ module Maze
 
         reflect response, delay_ms, status
       rescue JSON::ParserError => e
+        Bugsnag.notify e
         msg = "Unable to parse request as JSON: #{e.message}"
         $logger.error msg
         response.status = 418
       rescue StandardError => e
+        Bugsnag.notify e
         $logger.error "Invalid request: #{e.message}"
         response.status = 500
       end

data/lib/maze/servlets/servlet.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bugsnag'
 require 'zlib'
 require 'stringio'
 require 'json_schemer'
@@ -101,6 +102,7 @@ module Maze
         set_response_header response.header
         response.status = post_status_code
       rescue JSON::ParserError => e
+        Bugsnag.notify e
         msg = "Unable to parse request as JSON: #{e.message}"
         if Maze.config.captured_invalid_requests.include? @request_type
           $logger.error msg
@@ -113,6 +115,7 @@ module Maze
           $logger.warn msg
         end
       rescue StandardError => e
+        Bugsnag.notify e
         if Maze.config.captured_invalid_requests.include? @request_type
           $logger.error "Invalid request: #{e.message}"
           Server.invalid_requests.add({

data/lib/maze/terminating_server.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bugsnag'
 require 'socket'
 
 module Maze
@@ -33,6 +34,7 @@ module Maze
               end_connection(socket)
             }
           rescue StandardError => e
+            Bugsnag.notify e
             $logger.warn "Terminating server error: #{e.message}"
           end
 

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.5.0'
+  VERSION = '8.7.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.5.0
+  version: 8.7.0
 platform: ruby
 authors:
 - Steve Kirkland
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-05 00:00:00.000000000 Z
+date: 2023-09-26 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
@@ -447,11 +448,11 @@ files:
 - lib/maze/wait.rb
 - lib/utils/deep_merge.rb
 - lib/utils/selenium_money_patch.rb
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -467,7 +468,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Bugsnag API request validation harness
 test_files: []