bugsnag-maze-runner 7.24.0 → 7.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f07c9dfdaab73bc584bf02c73a553e949851c700d2d1b54411b1886e936f9b3d
-  data.tar.gz: 8894d62125f81610660c6df39a05ad73c03b21cb12d8bff69888e9bc1bec3d1e
+  metadata.gz: 02e955bef1519e412688dc3c061336307d211c724dedd39fce301e9e89113f6e
+  data.tar.gz: c4643eab515e98e1acc179d9b5ddaf90c9d3bf937ace170860c52d7a9b1235f2
 SHA512:
-  metadata.gz: fe3934ed47df9f0c0c921f66802b8cccdd8aa06af1e17005079850009bc797107d13f612a4dcdb708868215ffd5bd3ab7b97a08f2e333f04feb9bf70d8728144
-  data.tar.gz: 59bf8a127529f30624586d86493f8db88c5b142ef42841dc58082890229925e7cf4e17946855222d0f10c7fd7a6845622d872f2de829c8d5bbcaa321fdaa3e7a
+  metadata.gz: 6ce234fcc1913ba4b2b87cbe13e30ce02c3e726e3ff38f0b466282c8bb7f6236202186a224f92b6e9582715fb2eba3b3db19723e19227ae8249b72abbcd35a49
+  data.tar.gz: 25fdf555f609bc45b19c09e53ffe23f2929ad0cddf7fc3c7d32891ebaf72a71c4426e932c7fe22151169dd60a1e177b86dafccf3b1f1e6aa218945b5354f0d30

data/bin/maze-runner

@@ -38,6 +38,7 @@ 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'
 require_relative '../lib/maze/network'
 require_relative '../lib/maze/proxy'
 require_relative '../lib/maze/retry_handler'

data/lib/features/steps/network_steps.rb

@@ -8,29 +8,17 @@ When('I wait for the host {string} to open port {string}') do |host, port|
   Maze::Network.wait_for_port(host, port)
 end
 
-# Sets the HTTP status code to be used for all subsequent requests
-#
-# @step_input status_code [Integer] The status code to return
-When('I set the HTTP status code to {int}') do |status_code|
-  Maze::Server.set_status_code_generator(Maze::Generator.new [status_code].cycle)
-end
-
-# Sets the HTTP status code to be used for the next request
-#
-# @step_input status_code [Integer] The status code to return
-When('I set the HTTP status code for the next request to {int}') do |status_code|
-  Maze::Server.set_status_code_generator(create_defaulting_generator([status_code], Maze::Server::DEFAULT_STATUS_CODE))
-end
-
-# Sets the HTTP status code to be used for the next set of requests
+# Sets the HTTP status code to be used for the next set of requests for a given connection type
 #
+# @step_input http_verb [String] The type of request this code will be used for
 # @step_input status_codes [String] A comma separated list of status codes to return
-When('I set the HTTP status code for the next requests to {string}') do |status_codes|
+When('I set the HTTP status code for the next {string} requests to {string}') do |http_verb, status_codes|
+  raise("Invalid HTTP verb: #{http_verb}") unless Maze::Server::ALLOWED_HTTP_VERBS.include?(http_verb)
   codes = status_codes.split(',').map(&:strip)
-  Maze::Server.set_status_code_generator(create_defaulting_generator(codes, Maze::Server::DEFAULT_STATUS_CODE))
+  Maze::Server.set_status_code_generator(create_defaulting_generator(codes, Maze::Server::DEFAULT_STATUS_CODE), http_verb)
 end
 
-# Steps the HTTP status code to be used for all subsequent requests for a given connection type
+# Sets the HTTP status code to be used for all subsequent requests for a given connection type
 #
 # @step_input http_verb [String] The type of request this code will be used for
 # @step_input status_code [Integer] The status code to return
@@ -39,7 +27,7 @@ When('I set the HTTP status code for {string} requests to {int}') do |http_verb,
   Maze::Server.set_status_code_generator(Maze::Generator.new([status_code].cycle), http_verb)
 end
 
-# Steps the HTTP status code to be used for the next request for a given connection type
+# Sets the HTTP status code to be used for the next request for a given connection type
 #
 # @step_input http_verb [String] The type of request this code will be used for
 # @step_input status_code [Integer] The status code to return
@@ -48,6 +36,27 @@ When('I set the HTTP status code for the next {string} request to {int}') do |ht
   Maze::Server.set_status_code_generator(create_defaulting_generator([status_code], Maze::Server::DEFAULT_STATUS_CODE), http_verb)
 end
 
+# Sets the HTTP status code to be used for all subsequent POST requests
+#
+# @step_input status_code [Integer] The status code to return
+When('I set the HTTP status code to {int}') do |status_code|
+  step %{I set the HTTP status code for "POST" requests to #{status_code}}
+end
+
+# Sets the HTTP status code to be used for the next POST request
+#
+# @step_input status_code [Integer] The status code to return
+When('I set the HTTP status code for the next request to {int}') do |status_code|
+  step %{I set the HTTP status code for the next "POST" request to #{status_code}}
+end
+
+# Sets the HTTP status code to be used for the next set of POST requests
+#
+# @step_input status_codes [String] A comma separated list of status codes to return
+When('I set the HTTP status code for the next requests to {string}') do |status_codes|
+  step %{I set the HTTP status code for the next "POST" requests to "#{status_codes}"}
+end
+
 # Sets the sampling probability to be used for all subsequent trace responses
 #
 # @step_input sampling_probability [String] The sampling probability to return

data/lib/features/support/internal_hooks.rb

@@ -189,6 +189,9 @@ end
 # After all tests
 AfterAll do
 
+  metrics = Maze::MetricsProcessor.new(Maze::Server.metrics)
+  metrics.process
+
   if Maze.timers.size.positive?
     $stdout.puts '--- Timer summary'
     Maze.timers.report

data/lib/maze/metrics_processor.rb

@@ -0,0 +1,71 @@
+require_relative './request_list'
+
+module Maze
+  class MetricsProcessor
+    # @param metrics [RequestList] The metrics to be processed
+    def initialize(metrics)
+      @metrics = metrics
+      @columns = Set.new
+      @rows = []
+    end
+
+    # Collates the metrics given into a CSV-friendly structure and writes the CSV to disk
+    def process
+      return if @metrics.size_all == 0
+
+      collate
+      write_to_disk
+    end
+
+    # Organises the raw metrics into an Array of hashes representing each row of the CSV,
+    # whilst also capturing an overall set of column headings
+    def collate
+      @metrics.all.each do |request|
+        row = {}
+        metric = request[:body]
+        metric.each do |key, value|
+          @columns.add key
+          row[key] = value
+        end
+        @rows << row
+      end
+    end
+
+    def write_to_disk
+      filepath = File.join(Dir.pwd, 'maze_output', 'metrics.csv')
+
+      puts "Call with #{filepath}"
+
+      File.open(filepath, 'w') do |file|
+        # Write the header, with columns ordered alphabetically
+        sorted_columns = @columns.to_a.sort!
+        header = sorted_columns.join ','
+        file.puts header
+
+        # Write the rows
+        @rows.each do |row|
+          row_values = sorted_columns.map do |column|
+            if row.has_key? column
+              to_csv_friendly(row[column])
+            else
+              ''
+            end
+          end
+
+          file.puts row_values.join ','
+        end
+      end
+    end
+
+    def to_csv_friendly(value)
+      return value unless value.class == String
+
+      if value.include?(' ') || value.include?(',')
+        "\"#{value}\""
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/maze/request_list.rb

@@ -54,7 +54,7 @@ module Maze
       @requests.clone.freeze
     end
 
-    # Clears the list
+    # Clears the list completely
     def clear
       @requests.clear
       @current = 0

data/lib/maze/server.rb

@@ -83,6 +83,8 @@ module Maze
           builds
         when 'log', 'logs'
           logs
+        when 'metric', 'metrics'
+          metrics
         when 'trace', 'traces'
           traces
         when 'upload', 'uploads'
@@ -145,6 +147,13 @@ module Maze
         @logs ||= RequestList.new
       end
 
+      # A list of metric requests received
+      #
+      # @return [RequestList] Received metric requests
+      def metrics
+        @metrics ||= RequestList.new
+      end
+
       # A list of commands for a test fixture to perform.  Strictly speaking these are responses to HTTP
       # requests, but the list behavior is all we need.
       #
@@ -202,6 +211,7 @@ module Maze
             server.mount '/react-native-source-map', Servlets::Servlet, :sourcemaps
             server.mount '/command', Servlets::CommandServlet
             server.mount '/logs', Servlets::LogServlet
+            server.mount '/metrics', Servlets::Servlet, :metrics
             server.mount '/reflect', Servlets::ReflectiveServlet
             server.start
           rescue StandardError => e

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.24.0'
+  VERSION = '7.25.0'
 
   class << self
     attr_accessor :check, :driver, :internal_hooks, :mode, :start_time, :dynamic_retry, :public_address, :run_uuid

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag-maze-runner
 version: !ruby/object:Gem::Version
-  version: 7.24.0
+  version: 7.25.0
 platform: ruby
 authors:
 - Steve Kirkland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -408,6 +408,7 @@ files:
 - lib/maze/logger.rb
 - lib/maze/macos_utils.rb
 - lib/maze/maze_output.rb
+- lib/maze/metrics_processor.rb
 - lib/maze/network.rb
 - lib/maze/option.rb
 - lib/maze/option/parser.rb