bugsnag-maze-runner 7.22.1 → 7.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25918b6a96c58be96023fec6acae1dca6463db11c722fe9ef612f1faa1137f48
-  data.tar.gz: 68af4db3ee29db253541685361060a0b969371752a22c7c7e7e78bfd51c7dc31
+  metadata.gz: f07c9dfdaab73bc584bf02c73a553e949851c700d2d1b54411b1886e936f9b3d
+  data.tar.gz: 8894d62125f81610660c6df39a05ad73c03b21cb12d8bff69888e9bc1bec3d1e
 SHA512:
-  metadata.gz: 5734aa0594c7286ebe127cb4261b0d029f7241a88c090eea5c52a059459e3f7deed26a3fc14d754155ae8d1000b5001d65b3b903e2d98822ccc6cf7a824573e4
-  data.tar.gz: 91d4e5a297ec91c2f71bc2f023632eab9c328fe70bcd61bf511f8eab688b7e85c4cba8a9d5dc5ccec3017a2240daee180f6c0364db490e71376389f77cc5a45f
+  metadata.gz: fe3934ed47df9f0c0c921f66802b8cccdd8aa06af1e17005079850009bc797107d13f612a4dcdb708868215ffd5bd3ab7b97a08f2e333f04feb9bf70d8728144
+  data.tar.gz: 59bf8a127529f30624586d86493f8db88c5b142ef42841dc58082890229925e7cf4e17946855222d0f10c7fd7a6845622d872f2de829c8d5bbcaa321fdaa3e7a

data/bin/maze-runner

@@ -26,6 +26,7 @@ require_relative '../lib/maze/client/selenium/base_client'
 require_relative '../lib/maze/client/selenium/bb_client'
 require_relative '../lib/maze/client/selenium/bs_client'
 require_relative '../lib/maze/client/selenium/local_client'
+
 require_relative '../lib/maze/aws_public_ip'
 require_relative '../lib/maze/compare'
 require_relative '../lib/maze/docker'
@@ -82,6 +83,7 @@ require_relative '../lib/maze/plugins/bugsnag_reporting_plugin'
 require_relative '../lib/maze/plugins/cucumber_report_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 monkey-patches after everything else
 require_relative '../lib/utils/selenium_money_patch'

data/bin/upload-app

@@ -3,6 +3,7 @@
 
 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/helper'
 require 'optimist'
@@ -11,45 +12,70 @@ require 'net/http'
 
 class UploadAppEntry
   def start(args)
-    p = Optimist::Parser.new do
-      text 'Upload app files to BrowserStack'
-      text ''
-      text 'Requires BROWSER_STACK_USERNAME and BROWSER_STACK_ACCESS_KEY'
+    parser = Optimist::Parser.new do
+      text 'Upload app files to a device farm'
       text ''
       text 'Usage [OPTIONS]'
       text ''
       opt :help,
-          'Print this help.'
+        'Print this help.'
       opt :app,
-          'The app to upload.',
-          :type => :string
+        'The app to upload.',
+        type: :string,
+        required: true
       opt :app_id_file,
-          'The file to write the uploaded app ID back to',
-          :type => :string
+        'The file to write the uploaded app ID back to',
+        type: :string
+      opt :farm,
+        'The device farm to upload the app to, one of bb (BitBar) or bs (BrowserStack) (default)',
+        type: :string,
+        default: 'bs'
+      opt :username,
+        'Device farm username. Defaults to BROWSER_STACK_DEVICES_USERNAME variable (required for BrowserStack)',
+        type: :string
+      opt :access_key,
+        'Device farm access key. Defaults to BROWSER_STACK_DEVICES_ACCESS_KEY or BITBAR_ACCESS_KEY environment variables (required)',
+        type: :string
     end
 
-    opts = Optimist::with_standard_exception_handling p do
+    options = Optimist::with_standard_exception_handling parser do
       raise Optimist::HelpNeeded if ARGV.empty? # show help screen
-      p.parse ARGV
+      parser.parse ARGV
     end
 
-    # Get browserstack username and access key from the environment
-    username = ENV['BROWSER_STACK_USERNAME']
-    access_key = ENV['BROWSER_STACK_ACCESS_KEY']
+    # Get username and access key from the environment
+    case options[:farm]
+    when 'bs'
+      options[:username] ||= ENV['BROWSER_STACK_DEVICES_USERNAME'] || ENV['BROWSER_STACK_USERNAME']
+      options[:access_key] ||= ENV['BROWSER_STACK_DEVICES_ACCESS_KEY'] ||ENV['BROWSER_STACK_ACCESS_KEY']
+      if options[:username].nil?
+        $logger.warn 'Browserstack requires username option to be set'
+        Optimist::with_standard_exception_handling parser do
+          raise Optimist::HelpNeeded
+        end
+      end
+    when 'bb'
+      options[:access_key] ||= ENV['BITBAR_ACCESS_KEY']
+    end
 
-    # Check if BROWSER_STACK_USERNAME or BROWSER_STACK_ACCESS_KEY has been set
-    if username.nil? || access_key.nil?
-      $logger.warn "BROWSER_STACK_USERNAME or BROWSER_STACK_ACCESS_KEY has not been set"
-      Optimist::with_standard_exception_handling p do
+    if options[:access_key].nil?
+      $logger.warn 'An access_key is required to upload the app'
+      Optimist::with_standard_exception_handling parser do
         raise Optimist::HelpNeeded
       end
     end
 
-    Maze::Client::BrowserStackClientUtils.upload_app username,
-                                                     access_key,
-                                                     opts[:app],
-                                                     opts[:app_id_file]
-
+    case options[:farm]
+    when 'bs'
+      Maze::Client::BrowserStackClientUtils.upload_app options[:username],
+                                                       options[:access_key],
+                                                       options[:app],
+                                                       options[:app_id_file]
+    when 'bb'
+      Maze::Client::BitBarClientUtils.upload_app options[:access_key],
+                                                 options[:app],
+                                                 options[:app_id_file]
+    end
   end
 end
 

data/lib/features/steps/network_steps.rb

@@ -103,7 +103,7 @@ end
 # @step_input url [String] The URL to open.
 When('I open the URL {string}') do |url|
   begin
-    open(url, &:read)
+    URI.open(url, &:read)
   rescue OpenURI::HTTPError
     $logger.debug $!.inspect
   end

data/lib/features/steps/trace_steps.rb

@@ -148,6 +148,12 @@ Then('a span field {string} equals {string}') do |key, expected|
   Maze.check.includes selected_keys, expected
 end
 
+Then('a span field {string} equals {int}') do |key, expected|
+  spans = spans_from_request_list(Maze::Server.list_for('traces'))
+  selected_keys = spans.map { |span| span[key] }
+  Maze.check.includes selected_keys, expected
+end
+
 Then('a span field {string} matches the regex {string}') do |attribute, pattern|
   regex = Regexp.new pattern
   spans = spans_from_request_list(Maze::Server.list_for('traces'))
@@ -156,6 +162,30 @@ Then('a span field {string} matches the regex {string}') do |attribute, pattern|
   Maze.check.false(selected_attributes.empty?)
 end
 
+Then('a span named {string} contains the attributes:') do |span_name, table|
+  spans = spans_from_request_list(Maze::Server.list_for('traces'))
+  named_spans = spans.find_all { |span| span['name'].eql?(span_name) }
+  raise Test::Unit::AssertionFailedError.new "No spans were found with the name #{span_name}" if named_spans.empty?
+
+  expected_attributes = table.hashes
+
+  match = false
+  named_spans.each do |span|
+    matches = expected_attributes.map do |expected_attribute|
+      span['attributes'].find_all { |attribute| attribute['key'].eql?(expected_attribute['attribute']) }
+        .any? { |attribute| attribute_value_matches?(attribute['value'], expected_attribute['type'], expected_attribute['value']) }
+    end
+    if matches.all? && !matches.empty?
+      match = true
+      break
+    end
+  end
+
+  unless match
+    raise Test::Unit::AssertionFailedError.new "No spans were found containing all of the given attributes"
+  end
+end
+
 def spans_from_request_list list
   return list.remaining
              .flat_map { |req| req[:body]['resourceSpans'] }
@@ -164,6 +194,30 @@ def spans_from_request_list list
              .select { |s| !s.nil? }
 end
 
+def attribute_value_matches?(attribute_value, expected_type, expected_value)
+  # Check that the required value type key is present
+  unless attribute_value.keys.include?(expected_type)
+    return false
+  end
+
+  case expected_type
+  when 'bytesValue', 'stringValue'
+    expected_value.eql?(attribute_value[expected_type])
+  when 'intValue'
+    expected_value.to_i.eql?(attribute_value[expected_type].to_i)
+  when 'doubleValue'
+    expected_value.to_f.eql?(attribute_value[expected_type])
+  when 'boolValue'
+    expected_value.eql?('true').eql?(attribute_value[expected_type])
+  when 'arrayValue', 'kvlistValue'
+    $logger.error('Span attribute validation does not currently support the "arrayValue" or "kvlistValue" types')
+    false
+  else
+    $logger.error("An invalid attribute type was expected: '#{expected_type}'")
+    false
+  end
+end
+
 def assert_received_spans(span_count, list)
   timeout = Maze.config.receive_requests_wait
   wait = Maze::Wait.new(timeout: timeout)

data/lib/features/support/internal_hooks.rb

@@ -65,6 +65,9 @@ BeforeAll do
   # Start document server, if asked for
   # This must happen after any client hooks have run, so that they can set the server root
   Maze::DocumentServer.start unless Maze.config.document_server_root.nil?
+
+  # An initial setup for total success status
+  $success = true
 end
 
 # @param config The Cucumber config
@@ -141,6 +144,9 @@ After do |scenario|
     output_received_requests('invalid requests')
   end
 
+  # Keep a global record of the total test status for reporting purposes
+  $success = !scenario.failed?
+
   # Log all received requests to file
   Maze::MazeOutput.new(scenario).write_requests if Maze.config.file_log
 

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

@@ -70,25 +70,37 @@ module Maze
         #
         # @return [Hash] A hash containing the capabilities.
         def dashboard_capabilities
-          # Attempt to use the current git repo as the project name
-          output, status = Maze::Runner.run_command('git rev-parse --show-toplevel')
-          if status == 0
-            project = File.basename(output[0].strip)
+
+          # Determine project name
+          if ENV['BUILDKITE']
+            $logger.info 'Using BUILDKITE_PIPELINE_SLUG for BitBar project name'
+            project = ENV['BUILDKITE_PIPELINE_SLUG']
           else
-            if ENV['BUILDKITE']
-              project = ENV['BUILDKITE_PIPELINE_SLUG']
+            # 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']
-            test_run = "#{ENV['BUILDKITE_BUILD_NUMBER']} - #{ENV['BUILDKITE_LABEL']}"
+            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,

data/lib/maze/client/bb_api_client.rb

@@ -41,7 +41,9 @@ module Maze
         all_devices = query_api(path, query)
 
         $logger.debug "All available devices in group #{device_group_id}: #{JSON.pretty_generate(all_devices)}"
+        Maze::Plugins::DatadogMetricsPlugin.send_gauge('bitbar.device.available', all_devices['data'].size, [Maze.config.device])
         filtered_devices = all_devices['data'].reject { |device| device['locked'] }
+        Maze::Plugins::DatadogMetricsPlugin.send_gauge('bitbar.device.unlocked', filtered_devices.size, [Maze.config.device])
         return filtered_devices.size, filtered_devices.sample
       end
 

data/lib/maze/client/bb_client_utils.rb

@@ -17,7 +17,8 @@ module Maze
         # Uploads an app to BitBar for later consumption
         # @param api_key [String] The BitBar API key
         # @param app [String] A path to the application file
-        def upload_app(api_key, app)
+        # @param app_id_file [String] the file to write the uploaded app url to BitBar
+        def upload_app(api_key, app, app_id_file=nil)
           uuid_regex = /\A[0-9]+\z/
 
           if uuid_regex.match? app
@@ -53,6 +54,12 @@ module Maze
               raise
             end
           end
+
+          unless app_id_file.nil?
+            $logger.info "Writing uploaded app id to #{app_id_file}"
+            File.write(Maze::Helper.expand_path(app_id_file), app_uuid)
+          end
+
           app_uuid
         end
 

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

@@ -6,6 +6,10 @@ module Maze
           raise 'Method not implemented by this class'
         end
 
+        def log_run_outro
+          raise 'Method not implemented by this class'
+        end
+
         def stop_session
           Maze.driver&.driver_quit
         end

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

@@ -27,6 +27,15 @@ module Maze
           Maze.driver.start_driver
         end
 
+        def log_run_outro
+          api_client = BitBarApiClient.new(Maze.config.access_key)
+
+          $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
+        end
+
         def stop_session
           super
           Maze::Client::BitBarClientUtils.stop_local_tunnel

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

@@ -59,6 +59,10 @@ module Maze
           Maze::Client::BrowserStackClientUtils.stop_local_tunnel
         end
 
+        def log_run_outro
+          log_session_info
+        end
+
         private
 
         # Determines and returns sensible project and build capabilities

data/lib/maze/driver/browser.rb

@@ -92,6 +92,13 @@ module Maze
         end
       end
 
+      # Returns the driver session ID
+      #
+      # @returns [String] The session ID of the selenium session
+      def session_id
+        @driver.session_id
+      end
+
       private
 
       # Creates and starts the selenium driver

data/lib/maze/hooks/appium_hooks.rb

@@ -6,6 +6,7 @@ module Maze
       @client
 
       def before_all
+        Maze::Plugins::DatadogMetricsPlugin.send_increment('appium.test_started')
         @client = Maze::Client::Appium.start
       end
 
@@ -30,6 +31,11 @@ module Maze
 
       def after_all
         @client&.log_run_outro
+        if $success
+          Maze::Plugins::DatadogMetricsPlugin.send_increment('appium.test_succeeded')
+        else
+          Maze::Plugins::DatadogMetricsPlugin.send_increment('appium.test_failed')
+        end
       end
 
       def at_exit

data/lib/maze/hooks/browser_hooks.rb

@@ -7,8 +7,12 @@ module Maze
         @client = Maze::Client::Selenium.start
       end
 
+      def after_all
+        @client&.log_run_outro
+      end
+
       def at_exit
-        @client.stop_session
+        @client&.stop_session
       end
     end
   end

data/lib/maze/plugins/datadog_metrics_plugin.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'datadog/statsd'
+
+module Maze
+  module Plugins
+    # Enables metrics to be reported to Datadog via a StatsD proxy
+    class DatadogMetricsPlugin
+
+      class << self
+        # Sends a gauge metric to Datadog
+        #
+        # @param metric [String] The identifier of the metric
+        # @param value [Integer] The value of the metric
+        # @param tags [Array] An array of strings with which to tag the metric
+        def send_gauge(metric, value, tags=[])
+          return unless logging?
+          stats_dog.gauge(metric, value, tags: tags)
+        end
+
+        # Sends an increment metric to Datadog
+        #
+        # @param metric [String] The identifier of the metric
+        # @param tags [Array] An array of strings with which to tag the metric
+        def send_increment(metric, tags=[])
+          return unless logging?
+          stats_dog.increment(metric, tags: tags)
+        end
+
+        private
+
+        # Whether metrics should be delivered to Datadog
+        #
+        # @returns [Boolean] Whether metrics should be sent
+        def logging?
+          ENV['BUILDKITE']
+        end
+
+        # Returns or initialises the DogStatsD instance
+        #
+        # @returns [Datadog::Statsd] The DogStatsD instance
+        def stats_dog
+          @stats_dog ||= initialize_stats_dog
+        end
+
+        # Initializes the DogStatsD instance, connecting to the buildkite agent Datadog agent
+        #
+        # @returns [Datadog::Statsd] The newly created DogStatsD instance
+        def initialize_stats_dog
+          tags = []
+          tags << Maze.config.device.to_s if Maze.config.device
+          tags << Maze.config.farm.to_s if Maze.config.farm
+          @stats_dog = Datadog::Statsd.new(aws_instance_ip, 8125, tags: tags, namespace: 'maze-runner')
+
+          at_exit do
+            @stats_dog.close
+          end
+
+          @stats_dog
+        end
+
+        # Retrieves the internal ipv4 address of the AWS buildkite instance the maze-runner container is run upon
+        #
+        # @returns [String] The local ipv4 address the Datadog agent is running on
+        def aws_instance_ip
+          `curl --silent -XGET http://169.254.169.254/latest/meta-data/local-ipv4`
+        end
+      end
+    end
+  end
+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.22.1'
+  VERSION = '7.24.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.22.1
+  version: 7.24.0
 platform: ruby
 authors:
 - Steve Kirkland
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
 - !ruby/object:Gem::Dependency
   name: optimist
   requirement: !ruby/object:Gem::Requirement
@@ -401,6 +415,7 @@ files:
 - 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
 - lib/maze/proxy.rb
@@ -425,11 +440,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
@@ -445,7 +460,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: []