bugsnag-maze-runner 9.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7294cf169ef0a66ead9789be570496771a20734bb793340653b4235aa016f07
-  data.tar.gz: 30bfe8f408345f79524c37165e9760b97a9acfb1c546628a1cac3b0aa3063f1f
+  metadata.gz: 2846c608ba08c4cd98faa8907c25e1d56ab36da97a56c28aa02aee8f39adf0b2
+  data.tar.gz: 75e3d297031547a4478c83added87975d5205e973f7777eddfe99718da664d9f
 SHA512:
-  metadata.gz: ec4f97ffe50aa33479d9c3f36748ffe72932798d165e71f25072c69613cbb30c485a2efe0aec792aac6c50149ee885d9ecc52dc11a71c813313e79d7b2bfb4d5
-  data.tar.gz: dd0e9a17df5d6298b59d5932777f423486ab8aed01b95625c47e72450325b61a71df0b417c984cf73a9c3fe029f29ec383defa29fd168270a0658abec418ff19
+  metadata.gz: 51b9290030731e65a5f93df77000e17a404b5fab4ca8e728606d2c3f29be4b1846fe36cc2e3fbd034a1d0b100396f735d28bd969da158bc9118f14b14d70a5bf
+  data.tar.gz: 023ae9dee40ce4d5e01d9a7f0bdd926754f1145d0a113ca91862841df5e6186a2884c36acdadcc34139e21f81743f2dc82b9330fabb119c9909343f4f7fa2562

data/bin/download-logs

@@ -6,7 +6,7 @@ require 'em/pure_ruby'
 
 require_relative '../lib/maze'
 require_relative '../lib/maze/client/bs_client_utils'
-require_relative '../lib/maze/logger'
+require_relative '../lib/maze/loggers/logger'
 require 'net/http'
 require 'json'
 require 'uri'

data/bin/maze-runner

@@ -40,7 +40,6 @@ require_relative '../lib/maze/errors'
 require_relative '../lib/maze/generator'
 require_relative '../lib/maze/helper'
 require_relative '../lib/maze/http_request'
-require_relative '../lib/maze/logger'
 require_relative '../lib/maze/macos_utils'
 require_relative '../lib/maze/maze_output'
 require_relative '../lib/maze/metrics_processor'
@@ -53,6 +52,8 @@ require_relative '../lib/maze/repeaters/bugsnag_repeater'
 require_relative '../lib/maze/runner'
 require_relative '../lib/maze/terminating_server'
 
+require_relative '../lib/maze/loggers/logger'
+
 require_relative '../lib/maze/servlets/base_servlet'
 require_relative '../lib/maze/servlets/all_commands_servlet'
 require_relative '../lib/maze/servlets/command_servlet'
@@ -85,6 +86,7 @@ require_relative '../lib/maze/hooks/appium_hooks'
 require_relative '../lib/maze/hooks/browser_hooks'
 require_relative '../lib/maze/hooks/command_hooks'
 require_relative '../lib/maze/hooks/error_code_hook'
+require_relative '../lib/maze/hooks/logger_hooks'
 
 require_relative '../lib/maze/driver/appium'
 require_relative '../lib/maze/driver/browser'
@@ -93,6 +95,7 @@ require_relative '../lib/maze/plugins/bugsnag_reporting_plugin'
 require_relative '../lib/maze/plugins/error_code_plugin'
 require_relative '../lib/maze/plugins/global_retry_plugin'
 require_relative '../lib/maze/plugins/datadog_metrics_plugin'
+require_relative '../lib/maze/plugins/logging_scenarios_plugin'
 
 # Require monkey-patches after everything else
 require_relative '../lib/utils/selenium_money_patch'

data/bin/purge-projects

@@ -6,7 +6,7 @@ require 'em/pure_ruby'
 
 require_relative '../lib/maze'
 require_relative '../lib/maze/client/bb_api_client'
-require_relative '../lib/maze/logger'
+require_relative '../lib/maze/loggers/logger'
 require_relative '../lib/maze/helper'
 require 'optimist'
 require 'uri'

data/bin/upload-app

@@ -7,7 +7,7 @@ require 'em/pure_ruby'
 require_relative '../lib/maze'
 require_relative '../lib/maze/client/bs_client_utils'
 require_relative '../lib/maze/client/bb_client_utils'
-require_relative '../lib/maze/logger'
+require_relative '../lib/maze/loggers/logger'
 require_relative '../lib/maze/helper'
 require 'optimist'
 require 'uri'

data/lib/features/support/internal_hooks.rb

@@ -92,6 +92,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?
 
+  # Add step logging
+  config.filters << Maze::Plugins::LoggingScenariosPlugin.new(config)
+
   # TODO: Reporting of test failures as errors deactivated pending PLAT-10963
   #config.filters << Maze::Plugins::BugsnagReportingPlugin.new(config)
 end
@@ -113,6 +116,9 @@ Before do |scenario|
 
   # Call any blocks registered by the client
   Maze.hooks.call_before scenario
+
+  # Invoke the logger hook for the scenario
+  Maze::Hooks::LoggerHooks.before scenario
 end
 
 # General processing to be run after each scenario
@@ -122,6 +128,9 @@ After do |scenario|
     Maze::MacosUtils.capture_screen(scenario)
   end
 
+  # Invoke the logger hook for the scenario
+  Maze::Hooks::LoggerHooks.after scenario
+
   # Call any blocks registered by the client
   Maze.hooks.call_after scenario
 
@@ -184,17 +193,17 @@ def output_received_requests(request_type)
       $stdout.puts "--- #{request_type} #{number} of #{count}"
 
       $logger.info 'Request body:'
-      Maze::LogUtil.log_hash(Logger::Severity::INFO, request[:body])
+      Maze::Loggers::LogUtil.log_hash(Logger::Severity::INFO, request[:body])
 
       $logger.info 'Request headers:'
-      Maze::LogUtil.log_hash(Logger::Severity::INFO, request[:request].header)
+      Maze::Loggers::LogUtil.log_hash(Logger::Severity::INFO, request[:request].header)
 
       $logger.info 'Request digests:'
-      Maze::LogUtil.log_hash(Logger::Severity::INFO, request[:digests])
+      Maze::Loggers::LogUtil.log_hash(Logger::Severity::INFO, request[:digests])
 
       $logger.info "Response body: #{request[:response].body}"
       $logger.info 'Response headers:'
-      Maze::LogUtil.log_hash(Logger::Severity::INFO, request[:response].header)
+      Maze::Loggers::LogUtil.log_hash(Logger::Severity::INFO, request[:response].header)
     end
   end
 end
@@ -226,6 +235,9 @@ end
 
 # After all tests
 AfterAll do
+  # Ensure the logger output is in the correct location
+  Maze::Hooks::LoggerHooks.after_all
+
   maze_output = File.join(Dir.pwd, 'maze_output')
   maze_output_zip = File.join(Dir.pwd, 'maze_output.zip')
   # zip a folder with files and subfolders

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

@@ -30,6 +30,8 @@ module Maze
             interval = 300
           elsif error.message.include? 'There are no devices available'
             interval = 120
+          elsif error.message.include? 'Appium Settings app is not running'
+            interval = 10
           else
             # Do not retry in any other case
           end
@@ -73,7 +75,9 @@ module Maze
           }
           capabilities.deep_merge! BitBarClientUtils.dashboard_capabilities
           capabilities.deep_merge! BitBarDevices.get_available_device(config.device)
+          capabilities['bitbar:options']['appiumVersion'] = config.appium_version unless config.appium_version.nil?
           capabilities.deep_merge! JSON.parse(config.capabilities_option)
+
           capabilities
         end
 
@@ -87,7 +91,7 @@ module Maze
           $logger.info 'Appium session(s) created:'
           @session_ids.each do |id|
             link = api_client.get_device_session_ui_link(id)
-            $logger.info Maze::LogUtil.linkify(link, "BitBar session: #{id}") if link
+            $logger.info Maze::Loggers::LogUtil.linkify(link, "BitBar session: #{id}") if link
           end
         end
 

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

@@ -68,7 +68,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"
-          $logger.info Maze::LogUtil.linkify(url, 'BrowserStack session(s)')
+          $logger.info Maze::Loggers::LogUtil.linkify(url, 'BrowserStack session(s)')
         end
 
         def log_run_outro

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

@@ -34,7 +34,7 @@ module Maze
           $logger.info 'Selenium session created:'
           id = Maze.driver.session_id
           link = api_client.get_device_session_ui_link(id)
-          $logger.info Maze::LogUtil.linkify link, 'BitBar session(s)' if link
+          $logger.info Maze::Loggers::LogUtil.linkify link, 'BitBar session(s)' if link
         end
 
         def stop_session

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

@@ -85,7 +85,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"
-          $logger.info Maze::LogUtil.linkify url, 'BrowserStack session(s)'
+          $logger.info Maze::Loggers::LogUtil.linkify url, 'BrowserStack session(s)'
         end
       end
     end

data/lib/maze/driver/appium.rb

@@ -3,7 +3,7 @@ require 'bugsnag'
 require 'json'
 require 'open3'
 require 'securerandom'
-require_relative '../logger'
+require_relative '../loggers/logger'
 require_relative '../../maze'
 
 module Maze

data/lib/maze/hooks/appium_hooks.rb

@@ -43,7 +43,6 @@ module Maze
       end
 
       def after_all
-        @client&.log_run_outro
         if $success
           Maze::Plugins::DatadogMetricsPlugin.send_increment('appium.test_succeeded')
         else
@@ -57,6 +56,7 @@ module Maze
 
       def at_exit
         if @client
+          @client.log_run_outro
           $logger.info 'Stopping the Appium session'
           @client.stop_session
         end

data/lib/maze/hooks/logger_hooks.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Maze
+  module Hooks
+    # Hooks for Browser mode use
+    class LoggerHooks
+      class << self
+        def before(scenario)
+          location = "\"# #{scenario.location}\""
+          $logger.trace ''
+          $logger.trace "\n--- Begin Scenario: #{scenario.name} #{location}"
+        end
+
+        def after(scenario)
+          location = "\"# #{scenario.location}\""
+          $logger.trace "--- End Scenario: #{scenario.name} #{location}"
+          $logger.trace ''
+        end
+
+        def after_all
+          if ENV['BUILDKITE']
+            FileUtils.mv("#{Dir.pwd}/#{Maze::Loggers::FileLogger::LOG_LOCATION}", "#{Dir.pwd}/maze_output/maze-runner.log")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maze/loggers/file_logger.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Maze
+  module Loggers
+    # A logger to file, always logging at TRACE level
+    class FileLogger < Logger
+
+      LOG_LOCATION = 'maze-runner.log'
+
+      include Singleton
+
+      attr_accessor :datetime_format
+
+      def initialize
+        # Remove the previous log file if it exists
+        File.delete(LOG_LOCATION) if File.exist?(LOG_LOCATION)
+
+        super(LOG_LOCATION, level: ::Logger::TRACE)
+
+        @datetime_format = '%H:%M:%S'
+
+        @formatter = proc do |severity, time, _name, message|
+          formatted_time = time.strftime(@datetime_format)
+
+          "\e[2m[#{formatted_time}]\e[0m #{severity.rjust(5)}: #{message}\n"
+        end
+      end
+    end
+  end
+end

data/lib/maze/loggers/log_util.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Maze
+  module Loggers
+    # A collection of logging utilities
+    class LogUtil
+      class << self
+        # Logs Hash-based data, accounting for things like file upload requests that are too big to log meaningfully.
+        #
+        # @param severity [Integer] A constant from Logger::Severity
+        # @param data [Hash] The data to log (currently needs to be a Hash)
+        def log_hash(severity, data)
+          return unless data.is_a? Hash
+
+          # Try to pretty print as JSON, if not too big
+          begin
+            json = JSON.pretty_generate data
+            if json.length < 128 * 1024
+              $logger.add severity, json
+            else
+              log_hash_by_field severity, data
+            end
+          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
+
+        # Logs a hash field by field,
+        #
+        # @param severity [Integer] A Logger::Severity
+        # @param hash [Hash] The Hash
+        def log_hash_by_field(severity, hash)
+          hash.keys.each do |key|
+            value = hash[key].to_s
+            if value.length < 1024
+              $logger.add severity, "  #{key}: #{value}"
+            else
+              $logger.add severity, "  #{key} (length): #{value.length}"
+              $logger.add severity, "  #{key} (start): #{value[0, 1024]}"
+            end
+          end
+        end
+
+        # Produces a clickable link when logged in Buildkite
+        # @param url [String] Link URL
+        # @param text [String] Link text
+        def linkify(url, text)
+          if ENV['BUILDKITE']
+            "\033]1339;url='#{url}';content='#{text}'\a"
+          else
+            "#{text}: #{url}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maze/loggers/logger.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'bugsnag'
+require 'logger'
+require 'singleton'
+require_relative 'file_logger'
+require_relative 'log_util'
+require_relative 'stdout_logger'
+
+# Monkey patch a 'trace' log level into the standard Logger
+class Logger
+  remove_const(:SEV_LABEL)
+  SEV_LABEL = {
+    -1 => 'TRACE',
+    0 => 'DEBUG',
+    1 => 'INFO',
+    2 => 'WARN',
+    3 => 'ERROR',
+    4 => 'FATAL',
+    5 => 'ANY'
+  }
+  
+  module Severity
+    TRACE=-1
+  end
+  
+  def trace(name = nil, &block)
+    add(TRACE, nil, name, &block)
+  end
+  
+  def trace?
+    @level <= TRACE
+  end
+end
+
+module Maze
+  module Loggers
+    class Logger
+      include Singleton
+
+      attr_accessor :stdout_logger, :file_logger
+
+      def initialize
+        @stdout_logger = Maze::Loggers::STDOUTLogger.instance
+        @file_logger = Maze::Loggers::FileLogger.instance
+      end
+
+      # Attempts to forward all method calls to both loggers
+      def method_missing(method, *args, &block)
+        if @stdout_logger.respond_to?(method) && @file_logger.respond_to?(method)
+          @stdout_logger.send(method, *args, &block)
+          @file_logger.send(method, *args, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end
+
+$logger = Maze::Loggers::Logger.instance

data/lib/maze/loggers/stdout_logger.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Maze
+  module Loggers
+    # A logger to STDOUT, with level configured according to the environment
+    class STDOUTLogger < Logger
+      include Singleton
+
+      attr_accessor :datetime_format
+
+      def initialize
+        if ENV['TRACE']
+          super(STDOUT, level: ::Logger::TRACE)
+        elsif ENV['DEBUG']
+          super(STDOUT, level: ::Logger::DEBUG)
+        elsif ENV['QUIET']
+          super(STDOUT, level: ::Logger::ERROR)
+        else
+          super(STDOUT, level: ::Logger::INFO)
+        end
+
+        @datetime_format = '%H:%M:%S'
+
+        @formatter = proc do |severity, time, _name, message|
+          formatted_time = time.strftime(@datetime_format)
+
+          "\e[2m[#{formatted_time}]\e[0m #{severity.rjust(5)}: #{message}\n"
+        end
+      end
+    end
+  end
+end

data/lib/maze/plugins/logging_scenarios_plugin.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'bugsnag'
+require 'cucumber/core/filter'
+
+module Maze
+  module Plugins
+    class LoggingScenariosPlugin < Cucumber::Core::Filter.new(:configuration)
+
+      def test_case(test_case)
+        configuration.on_event(:test_step_started) do |event|
+          $logger.trace "Step started: #{event.test_step.to_s}"
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/maze/server.rb

@@ -3,7 +3,7 @@
 require 'bugsnag'
 require 'json'
 require 'webrick'
-require_relative './logger'
+require_relative 'loggers/logger'
 require_relative './request_list'
 
 module Maze

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 = '9.0.0'
+  VERSION = '9.1.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.0.0
+  version: 9.1.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-17 00:00:00.000000000 Z
+date: 2024-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -409,9 +409,13 @@ files:
 - lib/maze/hooks/command_hooks.rb
 - lib/maze/hooks/error_code_hook.rb
 - lib/maze/hooks/hooks.rb
+- lib/maze/hooks/logger_hooks.rb
 - lib/maze/http_request.rb
 - lib/maze/interactive_cli.rb
-- lib/maze/logger.rb
+- lib/maze/loggers/file_logger.rb
+- lib/maze/loggers/log_util.rb
+- lib/maze/loggers/logger.rb
+- lib/maze/loggers/stdout_logger.rb
 - lib/maze/macos_utils.rb
 - lib/maze/maze_output.rb
 - lib/maze/metrics_processor.rb
@@ -424,6 +428,7 @@ files:
 - lib/maze/plugins/datadog_metrics_plugin.rb
 - lib/maze/plugins/error_code_plugin.rb
 - 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

data/lib/maze/logger.rb

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-require 'bugsnag'
-require 'logger'
-require 'singleton'
-
-# Monkey patch a 'trace' log level into the standard Logger
-class Logger
-  remove_const(:SEV_LABEL)
-  SEV_LABEL = {
-    -1 => 'TRACE',
-    0 => 'DEBUG',
-    1 => 'INFO',
-    2 => 'WARN',
-    3 => 'ERROR',
-    4 => 'FATAL',
-    5 => 'ANY'
-  }
-
-  module Severity
-    TRACE=-1
-  end
-
-  def trace(name = nil, &block)
-    add(TRACE, nil, name, &block)
-  end
-
-  def trace?
-    @level <= TRACE
-  end
-end
-
-# Logger classes
-module Maze
-  # A logger, with level configured according to the environment
-  class Logger < Logger
-    include Singleton
-
-    attr_accessor :datetime_format
-
-    def initialize
-      if ENV['TRACE']
-        super(STDOUT, level: Logger::TRACE)
-      elsif ENV['DEBUG']
-        super(STDOUT, level: Logger::DEBUG)
-      elsif ENV['QUIET']
-        super(STDOUT, level: Logger::ERROR)
-      else
-        super(STDOUT, level: Logger::INFO)
-      end
-
-      @datetime_format = '%H:%M:%S'
-
-      @formatter = proc do |severity, time, _name, message|
-        formatted_time = time.strftime(@datetime_format)
-
-        "\e[2m[#{formatted_time}]\e[0m #{severity.rjust(5)}: #{message}\n"
-      end
-    end
-  end
-
-  $logger = Maze::Logger.instance
-
-  # A collection of logging utilities
-  class LogUtil
-    class << self
-      # Logs Hash-based data, accounting for things like file upload requests that are too big to log meaningfully.
-      #
-      # @param severity [Integer] A constant from Logger::Severity
-      # @param data [Hash] The data to log (currently needs to be a Hash)
-      def log_hash(severity, data)
-        return unless data.is_a? Hash
-
-        # Try to pretty print as JSON, if not too big
-        begin
-          json = JSON.pretty_generate data
-          if json.length < 128 * 1024
-            $logger.add severity, json
-          else
-            log_hash_by_field severity, data
-          end
-        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
-
-      # Logs a hash field by field,
-      #
-      # @param severity [Integer] A Logger::Severity
-      # @param hash [Hash] The Hash
-      def log_hash_by_field(severity, hash)
-        hash.keys.each do |key|
-          value = hash[key].to_s
-          if value.length < 1024
-            $logger.add severity, "  #{key}: #{value}"
-          else
-            $logger.add severity, "  #{key} (length): #{value.length}"
-            $logger.add severity, "  #{key} (start): #{value[0, 1024]}"
-          end
-        end
-      end
-
-      # Produces a clickable link when logged in Buildkite
-      # @param url [String] Link URL
-      # @param text [String] Link text
-      def linkify(url, text)
-        if ENV['BUILDKITE']
-          "\033]1339;url='#{url}';content='#{text}'\a"
-        else
-          "#{text}: #{url}"
-        end
-      end
-    end
-  end
-end