bugsnag-maze-runner 6.27.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 508b197638d8f5af31b4018fecd9776cfa91071ba760c90ce6647cf720d0bfb0
+  data.tar.gz: 3f47abb96bfa76e64a569b06c58d13b229305405e74142da6b9709a5a655d27e
+SHA512:
+  metadata.gz: 5ad71748e2a4ee9a83c65b1192ebd3a5cbfe6c7ee31ef63cdff5ea78674c130315946cd784004c8a0b0f0bfaf21fbf4e71c8277ca94b9a036bf88f7b36781538
+  data.tar.gz: bec09abd2c07c745d561a3ffc84653b07d792614a5070af2b7fbecc88f5f4a2b720e0bdae2a4e430d872a86885432e3552837b6f1542e92c9e0226949362ad7d

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,76 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/maze'
+require_relative '../lib/maze/browser_stack_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::BrowserStackUtils.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::BrowserStackUtils.download_log username,
+                                           access_key,
+                                           log_name,
+                                           session['automation_session']['device_logs_url'],
+                                           :device
+
+      $logger.info "Downloading Appium Logs for Session: #{index + 1}"
+      Maze::BrowserStackUtils.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,136 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'cucumber/cli/main'
+
+require_relative '../lib/maze'
+
+require_relative '../lib/maze/appium_server'
+require_relative '../lib/maze/bitbar_utils'
+require_relative '../lib/maze/bitbar_devices'
+require_relative '../lib/maze/browser_stack_devices'
+require_relative '../lib/maze/browser_stack_utils'
+require_relative '../lib/maze/bugsnag_config'
+require_relative '../lib/maze/capabilities'
+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/helper'
+require_relative '../lib/maze/logger'
+require_relative '../lib/maze/macos_utils'
+require_relative '../lib/maze/network'
+require_relative '../lib/maze/proxy'
+require_relative '../lib/maze/retry_handler'
+require_relative '../lib/maze/runner'
+require_relative '../lib/maze/sauce_labs_utils'
+require_relative '../lib/maze/smart_bear_utils'
+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/reflective_servlet'
+require_relative '../lib/maze/server'
+
+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/assertions/request_set_assertions'
+
+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/driver/appium'
+require_relative '../lib/maze/driver/browser'
+require_relative '../lib/maze/driver/resilient_appium'
+
+require_relative '../lib/maze/plugins/bugsnag_reporting_plugin'
+require_relative '../lib/maze/plugins/cucumber_report_plugin'
+require_relative '../lib/maze/plugins/global_retry_plugin'
+
+# 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]
+      when :bs
+        Maze::BrowserStackDevices.list_devices('ios')
+        Maze::BrowserStackDevices.list_devices('android')
+      else
+        Maze::BrowserStackDevices.list_devices('ios')
+        Maze::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/browser_stack_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::BrowserStackUtils.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

data/lib/features/steps/app_automator_steps.rb

@@ -0,0 +1,228 @@
+# @!group App Automator steps
+
+# Checks a UI element is present
+# Requires a running Appium driver
+#
+# @step_input element_id [String] The locator id
+Given('the element {string} is present') do |element_id|
+  present = Maze.driver.wait_for_element(element_id)
+  raise Maze::Error::AppiumElementNotFoundError.new("The element #{element_id} could not be found", element_id) unless present
+end
+
+# Checks a UI element is present within a specified number of seconds
+# Requires a running Appium driver
+#
+# @step_input element_id [String] The locator id
+# @step_input timeout [Int] The number of seconds to wait before timing out
+Given('the element {string} is present within {int} seconds') do |element_id, timeout|
+  present = Maze.driver.wait_for_element(element_id, timeout)
+  raise Maze::Error::AppiumElementNotFoundError.new("The element #{element_id} could not be found", element_id) unless present
+end
+
+# Clicks a given element
+# Requires a running Appium driver
+#
+# @step_input element_id [String] The locator id
+When('I click the element {string}') do |element_id|
+  Maze.driver.click_element(element_id)
+end
+
+# Sends the app to the background indefinitely
+# Requires a running Appium driver
+When('I send the app to the background') do
+  Maze.driver.background_app(-1)
+end
+
+# Sends the app to the background for a number of seconds
+# Requires a running Appium driver
+#
+# @step_input timeout [Integer] The amount of time the app is in the background in seconds
+When('I send the app to the background for {int} second(s)') do |timeout|
+  Maze.driver.background_app(timeout)
+end
+
+# Clears a given element
+# Requires a running Appium driver
+#
+# @step_input element_id [String] The locator id
+When('I clear the element {string}') do |element_id|
+  Maze.driver.clear_element(element_id)
+end
+
+# Sends keys to a given element
+# Requires a running Appium driver
+#
+# @step_input keys [String] The keys to send to the element
+# @step_input element_id [String] The locator id
+When('I send the keys {string} to the element {string}') do |keys, element_id|
+  Maze.driver.send_keys_to_element(element_id, keys)
+end
+
+# Tests that the given payload value is correct for the target BrowserStack platform.
+# This step will assume the expected and payload values are strings.
+# If the step is invoked when a remote BrowserStack device is not in use this step will fail.
+#
+# The DataTable used for this step should have `ios` and `android` in the same row as their expected value:
+#   | android | Java.lang.RuntimeException |
+#   | ios     | NSException                |
+#
+# If the expected value is set to "@skip", the check should be skipped
+# If the expected value is set to "@null", the check will be for null
+# If the expected value is set to "@not_null", the check will be for a non-null value
+#
+# @step_input request_type [String] The type of request (error, session, build, etc)
+# @step_input field_path [String] The field to test
+# @step_input platform_values [DataTable] A table of acceptable values for each platform
+Then('the {word} payload field {string} equals the platform-dependent string:') do |request_type, field_path, platform_values|
+  test_string_platform_values(request_type, field_path, platform_values)
+end
+
+# See `the error payload field {string} equals the platform-dependent string:`
+#
+# @step_input field_path [String] The field to test, prepended with "events.0"
+# @step_input platform_values [DataTable] A table of acceptable values for each platform
+Then('the event {string} equals the platform-dependent string:') do |field_path, platform_values|
+  test_string_platform_values('error', "events.0.#{field_path}", platform_values)
+end
+
+# Tests that the given payload value is correct for the target BrowserStack platform.
+# This step will assume the expected and payload values are numeric.
+# If the step is invoked when a remote BrowserStack device is not in use this step will fail.
+#
+# The DataTable used for this step should have `ios` and `android` in the same row as their expected value:
+#   | android | 1  |
+#   | ios     | 5.5 |
+#
+# If the expected value is set to "@skip", the check should be skipped
+# If the expected value is set to "@null", the check will be for null
+# If the expected value is set to "@not_null", the check will be for a non-null value
+#
+# @step_input request_type [String] The type of request (error, session, build, etc)
+# @step_input field_path [String] The field to test
+# @step_input platform_values [DataTable] A table of acceptable values for each platform
+Then('the {word} payload field {string} equals the platform-dependent numeric:') do |request_type, field_path, platform_values|
+  test_numeric_platform_values(request_type, field_path, platform_values)
+end
+
+# See `the payload field {string} equals the platform-dependent numeric:`
+#
+# @step_input field_path [String] The field to test, prepended with "events.0"
+# @step_input platform_values [DataTable] A table of acceptable values for each platform
+Then('the event {string} equals the platform-dependent numeric:') do |field_path, platform_values|
+  test_numeric_platform_values('error', "events.0.#{field_path}", platform_values)
+end
+
+# Tests that the given payload value is correct for the target BrowserStack platform.
+# This step will assume the expected and payload values are booleans.
+# If the step is invoked when a remote BrowserStack device is not in use this step will fail.
+#
+# The DataTable used for this step should have `ios` and `android` in the same row as their expected value:
+#   | android | 1 |
+#   | ios     | 5 |
+#
+# If the expected value is set to "@skip", the check should be skipped
+# If the expected value is set to "@null", the check will be for null
+# If the expected value is set to "@not_null", the check will be for a non-null value
+#
+# @step_input request_type [String] The type of request (error, session, build, etc)
+# @step_input field_path [String] The field to test
+# @step_input platform_values [DataTable] A table of acceptable values for each platform
+Then('the {word} payload field {string} equals the platform-dependent boolean:') do |request_type, field_path, platform_values|
+  test_boolean_platform_values(request_type, field_path, platform_values)
+end
+
+# See `the payload field {string} equals the platform-dependent boolean:`
+#
+# @step_input field_path [String] The field to test, prepended with "events.0"
+# @step_input platform_values [DataTable] A table of acceptable values for each platform
+Then('the event {string} equals the platform-dependent boolean:') do |field_path, platform_values|
+  test_boolean_platform_values('error', "events.0.#{field_path}", platform_values)
+end
+
+# See `the payload field {string} equals the platform-dependent string:`
+#
+# @step_input field_path [String] The field to test, prepended with "events.0.exceptions.0."
+# @step_input platform_values [DataTable] A table of acceptable values for each platform
+Then('the exception {string} equals the platform-dependent string:') do |field_path, platform_values|
+  test_string_platform_values('error', "events.0.exceptions.0.#{field_path}", platform_values)
+end
+
+# See `the payload field {string} equals the platform-dependent string:`
+#
+# @step_input field_path [String] The field to test, prepended with "events.0.exceptions.0.stacktrace.#!{num}"
+# @step_input num [Integer] The index of the stack frame to test
+# @step_input platform_values [DataTable] A table of acceptable values for each platform
+Then('the {string} of stack frame {int} equals the platform-dependent string:') do |field_path, num, platform_values|
+  test_string_platform_values('error', "events.0.exceptions.0.stacktrace.#{num}.#{field_path}", platform_values)
+end
+
+# Sends keys to a given element, clearing it first
+# Requires a running Appium driver
+#
+# @step_input keys [String] The keys to send to the element
+# @step_input element_id [String] The locator id
+When('I clear and send the keys {string} to the element {string}') do |keys, element_id|
+  Maze.driver.clear_and_send_keys_to_element(element_id, keys)
+end
+
+def get_expected_platform_value(platform_values)
+  os = Maze::Helper.get_current_platform
+  expected_value = Hash[platform_values.raw][os.downcase]
+  raise("There is no expected value for the current platform \"#{os}\"") if expected_value.nil?
+
+  expected_value
+end
+
+def should_skip_platform_check(expected_value)
+  expected_value.eql?('@skip')
+end
+
+def test_string_platform_values(request_type, field_path, platform_values)
+  expected_value = get_expected_platform_value(platform_values)
+  return if should_skip_platform_check(expected_value)
+
+  list = Maze::Server.list_for(request_type)
+  payload_value = Maze::Helper.read_key_path(list.current[:body], field_path)
+  assert_equal_with_nullability(expected_value, payload_value)
+end
+
+def test_boolean_platform_values(request_type, field_path, platform_values)
+  expected_value = get_expected_platform_value(platform_values)
+  return if should_skip_platform_check(expected_value)
+
+  expected_bool = case expected_value.downcase
+                  when 'true'
+                    true
+                  when 'false'
+                    false
+                  else
+                    expected_value
+                  end
+  list = Maze::Server.list_for(request_type)
+  payload_value = Maze::Helper.read_key_path(list.current[:body], field_path)
+  assert_equal_with_nullability(expected_bool, payload_value)
+end
+
+def test_numeric_platform_values(request_type, field_path, platform_values)
+  expected_value = get_expected_platform_value(platform_values)
+  return if should_skip_platform_check(expected_value)
+
+  list = Maze::Server.list_for(request_type)
+  payload_value = Maze::Helper.read_key_path(list.current[:body], field_path)
+
+  # Need to do a little more processing here to allow floats
+  special_value = expected_value.eql?('@null') || expected_value.eql?('@not_null')
+  expectation = special_value ? expected_value : expected_value.to_f
+  assert_equal_with_nullability(expectation, payload_value)
+end
+
+def assert_equal_with_nullability(expected_value, payload_value)
+  case expected_value
+  when '@null'
+    Maze.check.nil(payload_value)
+  when '@not_null'
+    Maze.check.not_nil(payload_value)
+  else
+    Maze.check.equal(expected_value, payload_value)
+  end
+end