bugsnag-maze-runner 7.22.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25918b6a96c58be96023fec6acae1dca6463db11c722fe9ef612f1faa1137f48
+  data.tar.gz: 68af4db3ee29db253541685361060a0b969371752a22c7c7e7e78bfd51c7dc31
+SHA512:
+  metadata.gz: 5734aa0594c7286ebe127cb4261b0d029f7241a88c090eea5c52a059459e3f7deed26a3fc14d754155ae8d1000b5001d65b3b903e2d98822ccc6cf7a824573e4
+  data.tar.gz: 91d4e5a297ec91c2f71bc2f023632eab9c328fe70bcd61bf511f8eab688b7e85c4cba8a9d5dc5ccec3017a2240daee180f6c0364db490e71376389f77cc5a45f

data/bin/bugsnag-print-load-paths

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+CUKE_LOAD_DIR = File.expand_path(File.dirname(File.dirname(__FILE__)))
+
+paths = Dir.glob("#{CUKE_LOAD_DIR}/lib/features/**/*.rb")
+print paths.join(" ")

data/bin/download-logs

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/maze'
+require_relative '../lib/maze/client/bs_client_utils'
+require_relative '../lib/maze/logger'
+require 'net/http'
+require 'json'
+require 'uri'
+require 'optimist'
+require 'fileutils'
+
+class DownloadLogEntry
+  def start(args)
+    p = Optimist::Parser.new do
+      text 'Download device sessions logs from BrowserStack using the build ID'
+      text ''
+      text 'Requires BROWSER_STACK_USERNAME and BROWSER_STACK_ACCESS_KEY'
+      text ''
+      text 'Usage [OPTIONS] <filenames>'
+      text ''
+      opt :help,
+          'Print this help.'
+      opt :build_id,
+          "ID of the BrowserStack build",
+          :type => :string
+    end
+
+    opts = Optimist::with_standard_exception_handling p do
+      raise Optimist::HelpNeeded if ARGV.empty? # show help screen
+      p.parse ARGV
+    end
+
+    # Get browserstack username and access key from the environment
+    username = ENV['BROWSER_STACK_USERNAME']
+    access_key = ENV['BROWSER_STACK_ACCESS_KEY']
+
+    # 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
+        raise Optimist::HelpNeeded
+      end
+    end
+
+
+    build_info = Maze::Client::BrowserStackClientUtils.build_info username,
+                                                                  access_key,
+                                                                  opts[:build_id]
+
+    $logger.info "Getting logs for build: #{opts[:build_id]}"
+
+    build_info.each_with_index do |session, index|
+      $logger.info "Downloading Device Logs for Session: #{index + 1} to #{Dir.pwd}/maze_output"
+
+      log_name = "#{opts[:build_id]}-#{index + 1}"
+
+      Maze::Client::BrowserStackClientUtils.download_log username,
+                                                         access_key,
+                                                         log_name,
+                                                         session['automation_session']['device_logs_url'],
+                                                         :device
+
+      $logger.info "Downloading Appium Logs for Session: #{index + 1}"
+      Maze::Client::BrowserStackClientUtils.download_log username,
+                                                         access_key,
+                                                         log_name,
+                                                         session['automation_session']['appium_logs_url'],
+                                                         :appium
+    end
+  end
+end
+
+DownloadLogEntry.new.start(ARGV)

data/bin/maze-runner

@@ -0,0 +1,174 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'cucumber/cli/main'
+
+require_relative '../lib/utils/deep_merge'
+
+require_relative '../lib/maze'
+
+require_relative '../lib/maze/appium_server'
+require_relative '../lib/maze/api/appium/file_manager'
+require_relative '../lib/maze/bugsnag_config'
+require_relative '../lib/maze/client/bb_api_client'
+require_relative '../lib/maze/client/bb_client_utils'
+require_relative '../lib/maze/client/bs_client_utils'
+require_relative '../lib/maze/client/appium'
+require_relative '../lib/maze/client/appium/base_client'
+require_relative '../lib/maze/client/appium/bb_client'
+require_relative '../lib/maze/client/appium/bb_devices'
+require_relative '../lib/maze/client/appium/bs_client'
+require_relative '../lib/maze/client/appium/bs_legacy_client'
+require_relative '../lib/maze/client/appium/bs_devices'
+require_relative '../lib/maze/client/appium/local_client'
+require_relative '../lib/maze/client/selenium'
+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'
+require_relative '../lib/maze/document_server'
+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/network'
+require_relative '../lib/maze/proxy'
+require_relative '../lib/maze/retry_handler'
+require_relative '../lib/maze/request_repeater'
+require_relative '../lib/maze/runner'
+require_relative '../lib/maze/terminating_server'
+
+require_relative '../lib/maze/servlets/base_servlet'
+require_relative '../lib/maze/servlets/command_servlet'
+require_relative '../lib/maze/servlets/servlet'
+require_relative '../lib/maze/servlets/log_servlet'
+require_relative '../lib/maze/servlets/trace_servlet'
+require_relative '../lib/maze/servlets/reflective_servlet'
+require_relative '../lib/maze/server'
+
+require_relative '../lib/maze/assertions/request_set_assertions'
+
+require_relative '../lib/maze/schemas/trace_schema'
+require_relative '../lib/maze/schemas/trace_validator'
+
+require_relative '../lib/maze/store'
+require_relative '../lib/maze/timers'
+
+require_relative '../lib/maze/checks/noop_check'
+require_relative '../lib/maze/checks/assert_check'
+
+require_relative '../lib/maze/option'
+require_relative '../lib/maze/option/parser'
+require_relative '../lib/maze/option/processor'
+require_relative '../lib/maze/option/validator'
+
+
+require_relative '../lib/maze/hooks/hooks'
+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/driver/appium'
+require_relative '../lib/maze/driver/browser'
+
+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 monkey-patches after everything else
+require_relative '../lib/utils/selenium_money_patch'
+
+# Encapsulates the MazeRunner entry point
+class MazeRunnerEntry
+
+  # Removes Maze Runner specific args from the array, as these will cause Cucumber to error.
+  def remove_maze_runner_args
+    Maze::Option.constants.each do |opt|
+      name = Maze::Option.const_get(opt)
+      @args.reject! { |arg| arg == "--#{name}" || (arg.start_with? "--#{name}=") || arg == "--no-#{name}" }
+    end
+  end
+
+  # Adds arguments to Cucumber
+  def add_cucumber_args
+    @args << 'features' if @args.empty?
+    @args << '--publish-quiet'
+    @args << '--color'
+
+    # Pass strict mode options through to cucumber if present
+    # If not we default to strict for undefined and pending results,
+    # but no-strict for flaky in order to allow retries
+    regex = /--(no-)?strict(-(undefined|pending|flaky))?/
+    if @args.all? { |arg| regex.match(arg).nil? }
+      @args << '--strict-undefined' << '--strict-pending' << '--no-strict-flaky'
+    end
+
+    # Load internal steps and helper functions
+    load_dir = File.expand_path(File.dirname(File.dirname(__FILE__))).freeze
+    paths = Dir.glob("#{load_dir}/lib/features/**/*.rb")
+
+    # Load project-specific steps and helper functions
+    paths += Dir.glob('features/{support,steps}/*.rb')
+    paths.each { |path| @args << '-r' << path }
+  end
+
+  # List devices for the given device farm, or all otherwise
+
+  def start(args)
+    $logger.info "Maze Runner v#{Maze::VERSION}"
+
+    # Parse args, processing any Maze Runner specific options
+    @args = args.dup
+    options = Maze::Option::Parser.parse args
+
+    if options[Maze::Option::LIST_DEVICES]
+      case options[Maze::Option::FARM].to_sym
+      when :bs
+        Maze::Client::Appium::BrowserStackDevices.list_devices('ios')
+        Maze::Client::Appium::BrowserStackDevices.list_devices('android')
+      when :bb
+        unless options[Maze::Option::ACCESS_KEY]
+          puts 'Listing BitBar devices or device groups available requires a valid access key'
+          exit 1
+        end
+        access_key = options[Maze::Option::ACCESS_KEY]
+        if options[Maze::Option::DEVICE] && !options[Maze::Option::DEVICE].empty?
+          options[Maze::Option::DEVICE].each do |device_group|
+            Maze::Client::Appium::BitBarDevices.list_devices_for_group(device_group, access_key)
+          end
+        else
+          Maze::Client::Appium::BitBarDevices.list_device_groups(access_key)
+        end
+      else
+        Maze::Client::Appium::BrowserStackDevices.list_devices('ios')
+        Maze::Client::Appium::BrowserStackDevices.list_devices('android')
+      end
+      exit 0
+    end
+
+    # Validate CL options
+    errors = Maze::Option::Validator.new.validate options
+    unless errors.empty?
+      puts errors
+      exit 1
+    end
+
+    Maze::Option::Processor.populate Maze.config, options
+
+    # Adjust CL options before calling down to Cucumber
+    remove_maze_runner_args
+    add_cucumber_args
+
+    Cucumber::Cli::Main.new(@args).execute!
+  end
+end
+
+MazeRunnerEntry.new.start(ARGV)

data/bin/upload-app

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/maze'
+require_relative '../lib/maze/client/bs_client_utils'
+require_relative '../lib/maze/logger'
+require_relative '../lib/maze/helper'
+require 'optimist'
+require 'uri'
+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'
+      text ''
+      text 'Usage [OPTIONS]'
+      text ''
+      opt :help,
+          'Print this help.'
+      opt :app,
+          'The app to upload.',
+          :type => :string
+      opt :app_id_file,
+          'The file to write the uploaded app ID back to',
+          :type => :string
+    end
+
+    opts = Optimist::with_standard_exception_handling p do
+      raise Optimist::HelpNeeded if ARGV.empty? # show help screen
+      p.parse ARGV
+    end
+
+    # Get browserstack username and access key from the environment
+    username = ENV['BROWSER_STACK_USERNAME']
+    access_key = ENV['BROWSER_STACK_ACCESS_KEY']
+
+    # 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
+        raise Optimist::HelpNeeded
+      end
+    end
+
+    Maze::Client::BrowserStackClientUtils.upload_app username,
+                                                     access_key,
+                                                     opts[:app],
+                                                     opts[:app_id_file]
+
+  end
+end
+
+UploadAppEntry.new.start(ARGV)

data/lib/features/scripts/await-android-emulator.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# Wait for device to finish booting
+`adb wait-for-device`
+
+while `adb shell getprop sys.boot_completed`.strip != "1"
+  puts "Awaiting boot completion..."
+  sleep 1
+end
+
+puts "Device Ready!"

data/lib/features/scripts/clear-android-app-data.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+if [ -z "$APP_BUNDLE" ]; then
+    echo APP_BUNDLE environment variable is not set
+    exit 1
+fi
+
+adb shell pm clear $APP_BUNDLE

data/lib/features/scripts/force-stop-android-app.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+if [ -z "$APP_BUNDLE" ]; then
+    echo APP_BUNDLE environment variable is not set
+    exit 1
+fi
+
+adb shell am force-stop $APP_BUNDLE

data/lib/features/scripts/install-android-app.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+if [ -z "$APP_BUNDLE" ]; then
+    echo APP_BUNDLE environment variable is not set
+    exit 1
+fi
+if [ -z "$APK_PATH" ]; then
+    echo APK_PATH environment variable is not set
+    exit 1
+fi
+
+echo "Uninstalling '$APP_BUNDLE'"
+adb uninstall "$APP_BUNDLE"
+echo "Installing '$APK_PATH'"
+adb install "$APK_PATH"

data/lib/features/scripts/launch-android-app.sh

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+if [ -z "$APP_BUNDLE" ]; then
+    echo APP_BUNDLE environment variable is not set
+    exit 1
+fi
+
+if [ -z "$APP_ACTIVITY" ]; then
+    echo APP_ACTIVITY environment variable is not set
+    exit 1
+fi
+
+if [ -z "$EVENT_TYPE" ]; then
+    echo EVENT_TYPE environment variable is not set
+    exit 1
+fi
+
+if [ -z "$EVENT_METADATA" ]; then
+    EVENT_METADATA="none"
+fi
+
+if [ -z "$MOCK_API_PORT" ]; then
+    echo MOCK_API_PORT environment variable is not set
+    exit 1
+fi
+
+if [ -z "$BUGSNAG_API_KEY" ]; then
+    echo BUGSNAG_API_KEY environment variable is not set
+    exit 1
+fi
+echo "Launching MainActivity with '$EVENT_TYPE'"
+adb shell am start -n "$APP_BUNDLE/$APP_ACTIVITY" \
+    --es EVENT_TYPE "$EVENT_TYPE" \
+    --es EVENT_METADATA "$EVENT_METADATA" \
+    --es BUGSNAG_PORT "$MOCK_API_PORT" \
+    --es BUGSNAG_API_KEY "$BUGSNAG_API_KEY"
+
+echo "Ran Android Test case"

data/lib/features/scripts/launch-android-emulator.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+if [ -z "$ANDROID_EMULATOR" ]; then
+    echo EMULATOR environment variable is not set
+    exit 1
+fi
+
+if [ -z "$ANDROID_HOME" ]; then
+    echo ANDROID_HOME environment variable is not set
+    exit 1
+fi
+
+echo "Launching $ANDROID_EMULATOR emulator"
+$ANDROID_HOME/emulator/emulator @$ANDROID_EMULATOR -no-boot-anim -noaudio -no-snapshot
+

data/lib/features/steps/android_steps.rb

@@ -0,0 +1,51 @@
+# @!group Android steps
+
+# Starts an Android emulator available within the local environment
+#
+# @step_input emulator [String] The name of the emulator to start
+When("I start Android emulator {string}") do |emulator|
+  steps %Q{
+    When I set environment variable "ANDROID_EMULATOR" to "#{emulator}"
+    And I run the script "launch-android-emulator.sh"
+    And I run the script "await-android-emulator.sh" synchronously
+  }
+end
+
+# Synchronously clears the data for the test application
+# Requires an ADB connection
+When("I clear the Android app data") do
+  step('I run the script "clear-android-app-data.sh" synchronously')
+end
+
+# Force stops the test application
+# Requires an ADB connection
+When("I force stop the Android app") do
+  step('I run the script "force-stop-android-app.sh" synchronously')
+end
+
+# Installs a given bundle from an APK onto a device
+# Requires an ADB connection
+#
+# @step_input bundle [String] The bundle to be installed
+# @step_input filepath [String] The path to the application's .apk
+When("I install the {string} Android app from {string}") do |bundle, filepath|
+  steps %Q{
+    When I set environment variable "APP_BUNDLE" to "#{bundle}"
+    And I set environment variable "APK_PATH" to "#{filepath}"
+    And I run the script "install-android-app.sh" synchronously
+  }
+end
+
+# Starts a specific activity for a given app
+# Requires an ADB connection
+#
+# @step_input app [String] The application name
+# @step_input activity [String] The activity to start
+When("I start the {string} Android app using the {string} activity") do |app, activity|
+  steps %Q{
+    When I set environment variable "APP_BUNDLE" to "#{app}"
+    When I set environment variable "APP_ACTIVITY" to "#{activity}"
+    And I run the script "launch-android-app.sh" synchronously
+    And I wait for 4 seconds
+  }
+end