bugsnag-maze-runner 7.33.1 → 8.0.0

data/lib/maze/option/parser.rb

@@ -22,6 +22,9 @@ module Maze
                 'Print this help.'
             opt :version,
                 'Display Maze Runner and Cucumber versions'
+            opt :expand,
+                'Output for Scenario Outlines is expanded by default, suppress using --no-expand',
+            short: :none
 
             text ''
             text 'General options:'
@@ -29,24 +32,29 @@ module Maze
             opt Option::AWS_PUBLIC_IP,
                 'Intended for use on Buildkite with the Elastic CI Stack for CI.  Enables awareness of being run with a public IP address.',
                 type: :boolean,
+                short: :none,
                 default: false
 
-            opt Option::ENABLE_RETRIES,
+            opt Option::RETRIES,
                 'Enables retrying failed scenarios when tagged',
                 type: :boolean,
+                short: :none,
                 default: true
 
-            opt Option::ENABLE_BUGSNAG,
+            opt Option::BUGSNAG,
                 'Enables reporting to Bugsnag on scenario failure (requires MAZE_BUGSNAG_API_KEY)',
                 type: :boolean,
+                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,
                 type: :string
 
             text ''
@@ -54,12 +62,15 @@ module Maze
 
             opt Option::BIND_ADDRESS,
                 'Mock server bind address',
+                short: :none,
                 type: :string
             opt Option::PORT,
                 'Mock server port',
+                short: :none,
                 default: 9339
             opt Option::NULL_PORT,
                 'Terminating connection port',
+                short: :none,
                 default: 9341
 
             text ''
@@ -67,12 +78,15 @@ module Maze
 
             opt Option::DS_ROOT,
                 'Document server root',
+                short: :none,
                 type: :string
             opt Option::DS_BIND_ADDRESS,
                 'Document server bind address',
+                short: :none,
                 type: :string
             opt Option::DS_PORT,
                 'Document server port',
+                short: :none,
                 default: 9340
 
             text ''
@@ -80,16 +94,20 @@ module Maze
 
             opt Option::FARM,
                 'Device farm to use: "bs" (BrowserStack) or "local"',
+                short: :none,
                 type: :string
             opt Option::APP,
                 'The app to be installed and run against.  Assumed to be contained in a file if prefixed with @.',
+                short: :none,
                 type: :string
             opt Option::A11Y_LOCATOR,
                 'Locate elements by accessibility id rather than id',
+                short: :none,
                 type: :boolean,
                 default: false
             opt Option::CAPABILITIES,
                 'Additional desired Appium capabilities as a JSON string',
+                short: :none,
                 default: '{}'
 
             text ''
@@ -106,49 +124,50 @@ module Maze
                 type: :string
             opt Option::USERNAME,
                 'Device farm username. Consumes env var from environment based on farm set',
+                short: :none,
                 type: :string
             opt Option::ACCESS_KEY,
                 'Device farm access key. Consumes env var from environment based on farm set',
+                short: :none,
                 type: :string
             opt Option::APPIUM_VERSION,
                 'The Appium version to use',
+                short: :none,
                 type: :string
             opt Option::LIST_DEVICES,
                 'Lists the devices available for the configured device farm, or all devices if none are specified',
+                short: :none,
                 default: false
             opt Option::APP_BUNDLE_ID,
                 'The bundle identifier of the test application',
+                short: :none,
                 type: :string
             opt Option::TUNNEL,
                 'Start the device farm secure tunnel',
+                short: :none,
                 default: true
             opt Option::APPIUM_SERVER,
                 "Appium server URL.  Defaults are: \n" +
                 "  --farm=local - MAZE_APPIUM_SERVER or http://localhost:4723/wd/hub\n" +
                 "  --farm=bb - MAZE_APPIUM_SERVER or https://us-west-mobile-hub.bitbar.com/wd/hub\n" +
                 'Not used for --farm=bs',
+                short: :none,
                 type: :string
             opt Option::SELENIUM_SERVER,
                 "Selenium server URL. Only used for --farm=bb, defaulting to MAZE_SELENIUM_SERVER or https://us-west-desktop-hub.bitbar.com/wd/hub",
+                short: :none,
                 type: :string
 
             # SmartBear-only options
             opt Option::SB_LOCAL,
                 '(SB only) Path to the SBSecureTunnel binary. MAZE_SB_LOCAL env var or "/SBSecureTunnel" by default',
+                short: :none,
                 type: :string
 
             # BrowserStack-only options
             opt Option::BS_LOCAL,
                 '(BS only) Path to the BrowserStackLocal binary. MAZE_BS_LOCAL env var or "/BrowserStackLocal" by default',
-                type: :string
-
-            # TMS options
-            opt Option::TMS_URI,
-                'URI of the test management server root.  MAZE_TMS_URI env var',
-                type: :string
-
-            opt Option::TMS_TOKEN,
-                'Token used to access the test management server.  MAZE_TMS_TOKEN env var',
+                short: :none,
                 type: :string
 
             text ''
@@ -156,21 +175,27 @@ module Maze
 
             opt Option::OS,
                 'OS type to use ("ios", "android")',
+                short: :none,
                 type: :string
             opt Option::OS_VERSION,
                 'The intended OS version when running on a local device',
+                short: :none,
                 type: :string
             opt Option::START_APPIUM,
                 'Whether a local Appium server should be start.  Only used for --farm=local.',
+                short: :none,
                 default: true
             opt Option::APPIUM_LOGFILE,
                 'The file local appium server output is logged to, defaulting to "appium_server.log"',
+                short: :none,
                 default: 'appium_server.log'
             opt Option::APPLE_TEAM_ID,
                 'Apple Team Id, required for local iOS testing. MAZE_APPLE_TEAM_ID env var by default',
+                short: :none,
                 type: :string
             opt Option::UDID,
                 'Apple UDID, required for local iOS testing. MAZE_UDID env var by default',
+                short: :none,
                 type: :string
 
             text ''
@@ -178,16 +203,19 @@ module Maze
 
             opt Option::FILE_LOG,
                 "Writes lists of received requests to the maze_output folder for all scenarios",
+                short: :none,
                 type: :boolean,
                 default: true
 
             opt Option::LOG_REQUESTS,
                 "Log lists of received requests to the console in the event of scenario failure.  Defaults to true if the BUILDKITE environment variable is set",
+                short: :none,
                 type: :boolean,
                 default: false
 
             opt Option::ALWAYS_LOG,
                 "Always log all received requests at the end of a scenario, whether is passes or fails",
+                short: :none,
                 type: :boolean,
                 default: false
 
@@ -231,7 +259,6 @@ module Maze
           when 'bb'
             options[Option::USERNAME] ||= ENV['BITBAR_USERNAME']
             options[Option::ACCESS_KEY] ||= ENV['BITBAR_ACCESS_KEY']
-            options[Option::TMS_URI] ||= ENV['MAZE_TMS_URI']
             options[Option::APPIUM_SERVER] ||= ENV['MAZE_APPIUM_SERVER'] || 'https://us-west-mobile-hub.bitbar.com/wd/hub'
             options[Option::SELENIUM_SERVER] ||= ENV['MAZE_SELENIUM_SERVER'] || 'https://us-west-desktop-hub.bitbar.com/wd/hub'
           end
@@ -239,8 +266,6 @@ module Maze
           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::TMS_URI] ||= ENV['MAZE_TMS_URI']
-          options[Option::TMS_TOKEN] ||= ENV['MAZE_TMS_TOKEN']
           options[Option::BS_LOCAL] ||= ENV['MAZE_BS_LOCAL'] || '/BrowserStackLocal'
           options[Option::APPIUM_SERVER] ||= ENV['MAZE_APPIUM_SERVER'] || 'http://localhost:4723/wd/hub'
           options[Option::APPLE_TEAM_ID] ||= ENV['MAZE_APPLE_TEAM_ID']

data/lib/maze/option/processor.rb

@@ -19,10 +19,8 @@ module Maze
 
           # General options
           config.aws_public_ip = options[Maze::Option::AWS_PUBLIC_IP]
-          config.enable_retries = options[Maze::Option::ENABLE_RETRIES]
-          config.enable_bugsnag = options[Maze::Option::ENABLE_BUGSNAG]
-          config.tms_uri = options[Maze::Option::TMS_URI]
-          config.tms_token = options[Maze::Option::TMS_TOKEN]
+          config.enable_retries = options[Maze::Option::RETRIES]
+          config.enable_bugsnag = options[Maze::Option::BUGSNAG]
           config.aspecto_repeater_api_key = options[Maze::Option::ASPECTO_REPEATER_API_KEY]
           config.bugsnag_repeater_api_key = options[Maze::Option::BUGSNAG_REPEATER_API_KEY]
 
@@ -80,7 +78,6 @@ module Maze
           when :bb then
             config.username = options[Maze::Option::USERNAME]
             config.access_key = options[Maze::Option::ACCESS_KEY]
-            config.tms_uri = options[Maze::Option::TMS_URI]
             config.appium_version = options[Maze::Option::APPIUM_VERSION]
             device_option = options[Maze::Option::DEVICE]
             if device_option.nil? || device_option.empty?

data/lib/maze/option/validator.rb

@@ -89,13 +89,9 @@ module Maze
       def validate_bitbar(options, errors)
         browser = options[Option::BROWSER]
         device = options[Option::DEVICE]
-
-        if ENV['BUILDKITE'] && browser
-          errors << "--#{Option::TMS_URI} must be specified when running on Buildkite" if options[Option::TMS_URI].nil?
-        else
-          errors << "--#{Option::USERNAME} must be specified" if options[Option::USERNAME].nil?
-          errors << "--#{Option::ACCESS_KEY} must be specified" if options[Option::ACCESS_KEY].nil?
-        end
+        
+        errors << "--#{Option::USERNAME} must be specified" if options[Option::USERNAME].nil?
+        errors << "--#{Option::ACCESS_KEY} must be specified" if options[Option::ACCESS_KEY].nil?
 
         # Device
         if browser.nil? && device.empty?

data/lib/maze/option.rb

@@ -39,10 +39,6 @@ module Maze
     # BrowserStack-only options
     BS_LOCAL = 'bs-local'
 
-    # BitBar-only options
-    TMS_URI = 'tms-uri'
-    TMS_TOKEN = 'tms-token'
-
     # Local-only options
     APPIUM_LOGFILE = 'appium-logfile'
     APPLE_TEAM_ID = 'apple-team-id'
@@ -58,7 +54,7 @@ module Maze
     AWS_PUBLIC_IP = 'aws-public-ip'
     ASPECTO_REPEATER_API_KEY = 'aspecto-repeater-api-key'
     BUGSNAG_REPEATER_API_KEY = 'repeater-api-key'
-    ENABLE_BUGSNAG = 'enable-bugsnag'
-    ENABLE_RETRIES = 'enable-retries'
+    BUGSNAG = 'bugsnag'
+    RETRIES = 'retries'
   end
 end

data/lib/maze/repeaters/request_repeater.rb

@@ -80,7 +80,7 @@ module Maze
       end
       
       def log(message = '')
-        $logger.debug message
+        $logger.trace message
       end
     end
   end

data/lib/maze/schemas/trace_validator.rb

@@ -25,8 +25,6 @@ module Maze
       # Runs the validation against the trace given
       def validate
         @success = true
-        # Shortcut the validation if the body is empty for initial P gathering reasons
-        return if @body.keys.eql?(['resourceSpans']) && @body['resourceSpans'].empty?
 
         regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.spanId', '^[A-Fa-f0-9]{16}$')
         regex_comparison('resourceSpans.0.scopeSpans.0.spans.0.traceId', '^[A-Fa-f0-9]{32}$')

data/lib/maze/server.rb

@@ -85,6 +85,8 @@ module Maze
           logs
         when 'metric', 'metrics'
           metrics
+        when 'sampling request', 'sampling requests'
+          sampling_requests
         when 'trace', 'traces'
           traces
         when 'upload', 'uploads'
@@ -107,14 +109,21 @@ module Maze
 
       # A list of session requests received
       #
-      # @return [RequestList] Received error requests
+      # @return [RequestList] Received session requests
       def sessions
         @sessions ||= RequestList.new
       end
 
+      # A list of sampling requests received
+      #
+      # @return [RequestList] Received sampling requests
+      def sampling_requests
+        @sampling_requests ||= RequestList.new
+      end
+
       # A list of trace requests received
       #
-      # @return [RequestList] Received error requests
+      # @return [RequestList] Received trace requests
       def traces
         @traces ||= RequestList.new
       end
@@ -195,7 +204,7 @@ module Maze
 
             # Mount a block to respond to all requests with status:200
             server.mount_proc '/' do |_request, response|
-              $logger.debug 'Received request on server root, responding with 200'
+              $logger.trace 'Received request on server root, responding with 200'
               response.header['Access-Control-Allow-Origin'] = '*'
               response.body = 'Maze runner received request'
               response.status = 200
@@ -252,6 +261,7 @@ module Maze
         builds.clear
         uploads.clear
         sourcemaps.clear
+        sampling_requests.clear
         traces.clear
         logs.clear
         invalid_requests.clear

data/lib/maze/servlets/servlet.rb

@@ -37,7 +37,6 @@ module Maze
       def initialize(server, request_type, schema=nil)
         super server
         @request_type = request_type
-        @requests = Server.list_for 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)
@@ -88,7 +87,7 @@ module Maze
           schema_errors = @schema.validate(hash[:body])
           hash[:schema_errors] = schema_errors.to_a
         end
-        @requests.add(hash)
+        add_request(hash)
 
         # For the response, delaying if configured to do so
         response_delay_ms = Server.response_delay_ms
@@ -144,10 +143,14 @@ module Maze
 
       private
 
+      def add_request(request)
+        Server.list_for(@request_type).add(request)
+      end
+
       def log_request(request)
-        $logger.debug "#{request.request_method} request received"
-        $logger.debug "URI: #{request.unparsed_uri}"
-        $logger.debug "HEADERS: #{request.raw_header}"
+        $logger.trace "#{request.request_method} request received"
+        $logger.trace "URI: #{request.unparsed_uri}"
+        $logger.trace "HEADERS: #{request.raw_header}"
         return if request.body.nil?
 
         case request['Content-Type']
@@ -156,12 +159,12 @@ module Maze
         when %r{^multipart/form-data; boundary=([^;]+)}
           boundary = WEBrick::HTTPUtils.dequote(Regexp.last_match(1))
           body = WEBrick::HTTPUtils.parse_form_data(request.body, boundary)
-          $logger.debug 'BODY:'
-          LogUtil.log_hash(Logger::Severity::DEBUG, body)
+          $logger.trace 'BODY:'
+          LogUtil.log_hash(Logger::Severity::TRACE, body)
         when %r{^application/json$}
-          $logger.debug "BODY: #{JSON.pretty_generate(JSON.parse(request.body))}"
+          $logger.trace "BODY: #{JSON.pretty_generate(JSON.parse(request.body))}"
         else
-          $logger.debug "BODY: #{request.body}"
+          $logger.trace "BODY: #{request.body}"
         end
       end
 
@@ -183,7 +186,7 @@ module Maze
         # Both digest types are stored whatever
         sha1 = Digest::SHA1.hexdigest(request.body)
         simple = request.body.bytesize
-        $logger.debug "DIGESTS computed: sha1=#{sha1} simple=#{simple}"
+        $logger.trace "DIGESTS computed: sha1=#{sha1} simple=#{simple}"
 
         # Check digests match
         case parts[0]

data/lib/maze/servlets/trace_servlet.rb

@@ -11,6 +11,21 @@ module Maze
 
         header['Access-Control-Expose-Headers'] = 'Bugsnag-Sampling-Probability'
       end
+
+      private
+
+      def add_request(request)
+        if sampling_request? request
+          Server.sampling_requests.add request
+        else
+          Server.traces.add request
+        end
+      end
+
+      def sampling_request?(request)
+        body = request[:body]
+        body.keys.eql?(['resourceSpans']) && body['resourceSpans'].empty?
+      end
     end
   end
 end

data/lib/maze/terminating_server.rb

@@ -107,7 +107,7 @@ module Maze
         while (request = socket.gets) && (request.chomp.length > 0)
           key, val = request.chomp.split(': ')
           headers[key] = val
-          $logger.debug "Received #{headers.size} headers"
+          $logger.trace "Received #{headers.size} headers"
         end
         headers
       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 = '7.33.1'
+  VERSION = '8.0.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.33.1
+  version: 8.0.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -325,6 +325,7 @@ executables:
 - bugsnag-print-load-paths
 - download-logs
 - maze-runner
+- purge-projects
 - upload-app
 extensions: []
 extra_rdoc_files: []
@@ -332,6 +333,7 @@ files:
 - bin/bugsnag-print-load-paths
 - bin/download-logs
 - bin/maze-runner
+- bin/purge-projects
 - bin/upload-app
 - lib/features/scripts/await-android-emulator.sh
 - lib/features/scripts/clear-android-app-data.sh
@@ -360,6 +362,7 @@ files:
 - lib/features/steps/session_tracking_steps.rb
 - lib/features/steps/trace_steps.rb
 - lib/features/steps/value_steps.rb
+- lib/features/support/cucumber_types.rb
 - lib/features/support/env.rb
 - lib/features/support/internal_hooks.rb
 - lib/maze.rb
@@ -415,7 +418,6 @@ files:
 - lib/maze/option/processor.rb
 - lib/maze/option/validator.rb
 - lib/maze/plugins/bugsnag_reporting_plugin.rb
-- lib/maze/plugins/cucumber_report_plugin.rb
 - lib/maze/plugins/datadog_metrics_plugin.rb
 - lib/maze/plugins/error_code_plugin.rb
 - lib/maze/plugins/global_retry_plugin.rb

data/lib/maze/plugins/cucumber_report_plugin.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require 'bugsnag'
-require 'cucumber/core/filter'
-require 'json'
-
-# Required to access the options
-module Cucumber
-  class Configuration
-    attr_accessor :options
-  end
-end
-
-module Maze
-  module Plugins
-    class CucumberReportPlugin
-
-      def initialize
-        configured_data = {
-          driver_class: Maze.driver.class,
-          device_farm: Maze.config.farm,
-          device: Maze.config.device,
-          os: Maze.config.os,
-          os_version: Maze.config.os_version
-        }
-        buildkite_data = {
-          pipeline: ENV['BUILDKITE_PIPELINE_NAME'],
-          repo: ENV['BUILDKITE_REPO'],
-          build_url: ENV['BUILDKITE_BUILD_URL'],
-          branch: ENV['BUILDKITE_BRANCH'],
-          message: ENV['BUILDKITE_MESSAGE'],
-          step: ENV['BUILDKITE_LABEL'],
-          commit: ENV['BUILDKITE_COMMIT']
-        }
-        report['configuration'] = configured_data
-        report['build'] = buildkite_data
-      end
-
-      def install_plugin(cuc_config)
-        unless Maze.config.tms_uri && Maze.config.tms_token && ENV['BUILDKITE']
-          $logger.info 'No test report will be delivered for this run'
-          return
-        end
-        # Add installation hook
-        cuc_config.formats << ['json', {}, json_report_stream]
-
-        # Add exit hook
-        at_exit do
-          finish_report
-        end
-      end
-
-      def json_report_stream
-        @json_report_stream ||= StringIO.new
-      end
-
-      def report
-        @report ||= {}
-      end
-
-      private
-
-      def finish_report
-        session_hash = JSON.parse(json_report_stream.string)
-        report[:session] = session_hash
-        output_folder = File.join(Dir.pwd, 'maze_output')
-        filename = 'maze_report.json'
-        filepath = File.join(output_folder, filename)
-
-        begin
-          File.open(filepath, 'w') do |file|
-            file.puts JSON.pretty_generate(report)
-          end
-        rescue => e
-          $logger.warn 'Report could not be saved locally'
-          $logger.warn e.message
-        end
-
-        send_report
-      end
-
-      def send_report
-        uri = URI("#{Maze.config.tms_uri}/report")
-        request = Net::HTTP::Post.new(uri)
-        request['Content-Type'] = 'application/json'
-        request['Authorization'] = Maze.config.tms_token
-        request.body = JSON.generate(report)
-
-        begin
-          http = Net::HTTP.new(uri.hostname, uri.port)
-          http.request(request)
-        rescue => e
-          $logger.warn 'Report delivery attempt failed'
-          $logger.warn e.message
-        else
-          $logger.info 'Cucumber report delivered to test report server'
-        end
-      end
-    end
-  end
-end