bugsnag-maze-runner 7.30.2 → 7.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75bf49e2ef2be5fb751ede3a2d633f82c876680c213979585a15848368e58e6e
-  data.tar.gz: c0c0f2172353f1cfd0db10966b5080cb1fdf899dda0fa2a89ccf76930f95f5a1
+  metadata.gz: d41cfd37f8f7a6b9c1ded38ede7bb1e1bb4bd2f88157fd0e8e06f0eb4509910e
+  data.tar.gz: 5094050c79c43ba0715ee9448828bac5c1ce85f2720ce16e61c321347a44417d
 SHA512:
-  metadata.gz: a37a7e7cf01aba09e4002839e505e9f544d961c342e5abbefef32f662ff3c162db67da2616cb7fd6ce58a7997853d0bd657637a6ab3fcbbfb4f6b0a037a30713
-  data.tar.gz: 801b67b0e8713096551a907d9fdd7b1d522efd6aef8bf37af9a57cdf974128b6d3ec10de3ddaeb893a94a7fc64b2f3f2a4a984f05970d1eca775dc1cedb54233
+  metadata.gz: 1d5dee129b92e41a8e021e85192416250bc3ad5f081bc94759873832d210c8c1ede1aa61b085b0238a9c6bfa0ad54e8db6e657faba112e4be2b76a359fdc6084
+  data.tar.gz: 730ea82561c6e093967c94acd0d2fcdf94c3d89cdfea68f6084b4c147b46a0e5a3f18021baf5b4896dcd3fe8aed1614e0b3ce2fe8243beff8e1f336dfb129ca9

data/lib/features/steps/request_assertion_steps.rb

@@ -10,9 +10,24 @@ require_relative '../../maze/wait'
 
 def assert_received_requests(request_count, list, list_name, precise = true)
   timeout = Maze.config.receive_requests_wait
-  wait = Maze::Wait.new(timeout: timeout)
-
-  received = wait.until { list.size_remaining >= request_count }
+  # Interval set to 0.5s to make it more likely to detect erroneous extra requests,
+  # without impacting overall speed too much
+  wait = Maze::Wait.new(interval: 0.5, timeout: timeout)
+
+  last_count = 0
+  start_time = Time.now
+  received = wait.until do
+
+    count_now = list.size_remaining
+    elapsed = Time.now - start_time
+    if elapsed > Maze.config.receive_requests_slow_threshold
+      if count_now > last_count
+        $logger.warn "Received #{count_now - last_count} request(s) after #{elapsed.round(1)}s"
+      end
+    end
+    last_count = count_now
+    count_now >= request_count
+  end
 
   unless received
     raise Test::Unit::AssertionFailedError.new <<-MESSAGE

data/lib/features/steps/runner_steps.rb

@@ -243,7 +243,7 @@ Then('I wait for the shell prompt {string}') do |expected_prompt|
   wait = Maze::Wait.new(timeout: Maze.config.receive_requests_wait)
   shell = Maze::Runner.interactive_session
 
-  success = wait.until { shell.current_buffer == expected_prompt }
+  success = wait.until { expected_prompt == sanitized(shell.current_buffer) }
 
   Maze.check.true(success, "The current output line \"#{shell.current_buffer}\" did not match \"#{expected_prompt}\"")
 end
@@ -265,12 +265,19 @@ Then('I wait for the shell to output {string} to stdout') do |expected_line|
   current_shell = Maze::Runner.interactive_session
 
   success = wait.until do
-    current_shell.stdout_lines.any? { |line| line == expected_line }
+    current_shell.stdout_lines.any? do |line|
+      # Remove inconsequential escape codes
+      expected_line == sanitized(line)
+    end
   end
 
   Maze.check.true(success, "No output lines from #{current_shell.stdout_lines} matched #{expected_line}")
 end
 
+def sanitized(line)
+  line.sub "\e[?25h", '' # Make cursor visible
+end
+
 # Verify a string using a regex in the stdout logs
 #
 # @step_input regex_matcher [String] The regex expected to match a line in stdout logs

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

@@ -39,7 +39,7 @@ module Maze
               'testTimeout' => 7200
             }
           }
-          capabilities.deep_merge! dashboard_capabilities
+          capabilities.deep_merge! BitBarClientUtils.dashboard_capabilities
           capabilities.deep_merge! BitBarDevices.get_available_device(config.device)
           capabilities.deep_merge! JSON.parse(config.capabilities_option)
           capabilities
@@ -65,49 +65,6 @@ module Maze
             Maze::Client::BitBarClientUtils.stop_local_tunnel
           end
         end
-
-        # Determines capabilities used to organise sessions in the BitBar dashboard.
-        #
-        # @return [Hash] A hash containing the capabilities.
-        def dashboard_capabilities
-
-          # Determine project name
-          if ENV['BUILDKITE']
-            $logger.info 'Using BUILDKITE_PIPELINE_SLUG for BitBar project name'
-            project = ENV['BUILDKITE_PIPELINE_SLUG']
-          else
-            # Attempt to use the current git repo
-            output, status = Maze::Runner.run_command('git rev-parse --show-toplevel')
-            if status == 0
-              project = File.basename(output[0].strip)
-            else
-              $logger.warn 'Unable to determine project name, consider running Maze Runner from within a Git repository'
-              project = 'Unknown'
-            end
-          end
-
-          # Test run
-          if ENV['BUILDKITE']
-            bk_retry = ENV['BUILDKITE_RETRY_COUNT']
-            retry_string = if !bk_retry.nil? && bk_retry.to_i > 1
-                             " (#{bk_retry})"
-                           else
-                             ''
-                           end
-            test_run = "#{ENV['BUILDKITE_BUILD_NUMBER']} - #{ENV['BUILDKITE_LABEL']}#{retry_string}"
-          else
-            test_run = Maze.run_uuid
-          end
-
-          $logger.info "BitBar project name: #{project}"
-          $logger.info "BitBar test run: #{test_run}"
-          {
-            'bitbar:options' => {
-              bitbar_project: project,
-              bitbar_testrun: test_run
-            }
-          }
-        end
       end
     end
   end

data/lib/maze/client/bb_client_utils.rb

@@ -170,6 +170,49 @@ module Maze
           File.delete(BB_KILL_FILE) if File.exist?(BB_KILL_FILE)
         end
 
+        # Determines capabilities used to organise sessions in the BitBar dashboard.
+        #
+        # @return [Hash] A hash containing the capabilities.
+        def dashboard_capabilities
+
+          # Determine project name
+          if ENV['BUILDKITE']
+            $logger.info 'Using BUILDKITE_PIPELINE_SLUG for BitBar project name'
+            project = ENV['BUILDKITE_PIPELINE_SLUG']
+          else
+            # Attempt to use the current git repo
+            output, status = Maze::Runner.run_command('git rev-parse --show-toplevel')
+            if status == 0
+              project = File.basename(output[0].strip)
+            else
+              $logger.warn 'Unable to determine project name, consider running Maze Runner from within a Git repository'
+              project = 'Unknown'
+            end
+          end
+
+          # Test run
+          if ENV['BUILDKITE']
+            bk_retry = ENV['BUILDKITE_RETRY_COUNT']
+            retry_string = if !bk_retry.nil? && bk_retry.to_i > 1
+                             " (#{bk_retry})"
+                           else
+                             ''
+                           end
+            test_run = "#{ENV['BUILDKITE_BUILD_NUMBER']} - #{ENV['BUILDKITE_LABEL']}#{retry_string}"
+          else
+            test_run = Maze.run_uuid
+          end
+
+          $logger.info "BitBar project name: #{project}"
+          $logger.info "BitBar test run: #{test_run}"
+          {
+            'bitbar:options' => {
+              bitbar_project: project,
+              bitbar_testrun: test_run
+            }
+          }
+        end
+
         private
 
         def start_tunnel_thread(cmd)

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

@@ -7,6 +7,7 @@ module Maze
           capabilities = ::Selenium::WebDriver::Remote::Capabilities.new
           capabilities['bitbar_apiKey'] = config.access_key
           browsers = YAML.safe_load(File.read("#{__dir__}/bb_browsers.yml"))
+          capabilities.merge! BitBarClientUtils.dashboard_capabilities
           capabilities.merge! browsers[config.browser]
           capabilities.merge! JSON.parse(config.capabilities_option)
           config.capabilities = capabilities

data/lib/maze/configuration.rb

@@ -8,6 +8,7 @@ module Maze
     def initialize
       self.receive_no_requests_wait = 30
       self.receive_requests_wait = 30
+      self.receive_requests_slow_threshold = 10
       self.enforce_bugsnag_integrity = true
       self.captured_invalid_requests = Set[:errors, :sessions, :builds, :uploads, :sourcemaps]
       @legacy_driver = false
@@ -49,6 +50,9 @@ module Maze
     # Maximum time in seconds to wait in the `I wait to receive {int} error(s)/session(s)/build(s)` steps
     attr_accessor :receive_requests_wait
 
+    # Time after which requests are deemed to be slow to be received and a warning is logged for
+    attr_accessor :receive_requests_slow_threshold
+
     # Whether presence of the Bugsnag-Integrity header should be enforced
     attr_accessor :enforce_bugsnag_integrity
 

data/lib/maze/wait.rb

@@ -4,8 +4,8 @@ module Maze
   # Allows repeated attempts at something, until it is successful or the timeout
   # is exceed
   class Wait
-    # @param interval [Numeric] Optional. The time to sleep between attempts
-    # @param timeout [Numeric] The amount of time to spend on attempts before giving up
+    # @param interval [Float] Optional. The time to sleep between attempts
+    # @param timeout [Integer] The amount of time to spend on attempts before giving up
     def initialize(interval: 0.1, timeout:)
       raise "Interval must be greater than zero, got '#{interval}'" unless interval > 0
       raise "Timeout (#{timeout}) must be greater than interval (#{interval})" unless timeout > interval

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 = '7.30.2'
+  VERSION = '7.32.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: 7.30.2
+  version: 7.32.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber