bugsnag-maze-runner 6.27.0

data/lib/features/steps/aws_sam_steps.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+require_relative '../../maze'
+require_relative '../../maze/aws/sam'
+
+# @!group AWS SAM steps
+
+# Invoke a lambda directly with 'sam invoke'
+#
+# @step_input lambda_name [String] The name of the lambda to invoke
+# @step_input directory [String] The directory to invoke the lambda in
+Given('I invoke the {string} lambda in {string}') do |lambda_name, directory|
+  Maze::Aws::Sam.invoke(directory, lambda_name)
+end
+
+# Invoke a lambda directly with 'sam invoke' and the given event
+#
+# @step_input lambda_name [String] The name of the lambda to invoke
+# @step_input directory [String] The directory to invoke the lambda in
+# @step_input event_file [String] The event file to call the lambda with
+Given('I invoke the {string} lambda in {string} with the {string} event') do |lambda_name, directory, event_file|
+  Maze::Aws::Sam.invoke(directory, lambda_name, event_file)
+end
+
+# Test the exit code of the SAM CLI process.
+#
+# @step_input expected [Integer] The expected exit code
+Then('the SAM exit code equals {int}') do |expected|
+  Maze.check.equal(expected, Maze::Aws::Sam.last_exit_code)
+end
+
+# Test the Lambda response is empty but not-null. This indicates the Lambda did
+# not respond but did run successfully
+Then('the lambda response is empty') do
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  Maze.check.equal({}, Maze::Aws::Sam.last_response)
+end
+
+# Test a Lambda response field equals the given string.
+#
+# @step_input key_path [String] The response element to test
+# @step_input expected [String] The string to test against
+Then('the lambda response {string} equals {string}') do |key_path, expected|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.equal(expected, actual)
+end
+
+# Test a Lambda response field contains the given string.
+#
+# @step_input key_path [String] The response element to test
+# @step_input expected [String] The string to test against
+Then('the lambda response {string} contains {string}') do |key_path, expected|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.include(actual, expected)
+end
+
+# Test a Lambda response field equals the given integer.
+#
+# @step_input key_path [String] The response element to test
+# @step_input expected [Integer] The integer to test against
+Then('the lambda response {string} equals {int}') do |key_path, expected|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.equal(expected, actual)
+end
+
+# Test a Lambda response field is true.
+#
+# @step_input key_path [String] The response element to test
+Then('the lambda response {string} is true') do |key_path|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.true(actual)
+end
+
+# Test a Lambda response field is false.
+#
+# @step_input key_path [String] The response element to test
+Then('the lambda response {string} is false') do |key_path|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.false(actual)
+end
+
+# Test a Lambda response field is null.
+#
+# @step_input key_path [String] The response element to test
+Then('the lambda response {string} is null') do |key_path|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.nil(actual)
+end
+
+# Test a Lambda response field is not null.
+#
+# @step_input key_path [String] The response element to test
+Then('the lambda response {string} is not null') do |key_path|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.not_nil(actual)
+end
+
+# Test a Lambda response field is greater than the given integer.
+#
+# @step_input key_path [String] The response element to test
+# @step_input expected [Integer] The integer to test against
+Then('the lambda response {string} is greater than {int}') do |key_path, expected|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.operator(actual, :>, expected)
+end
+
+# Test a Lambda response field is less than the given integer.
+#
+# @step_input key_path [String] The response element to test
+# @step_input expected [Integer] The integer to test against
+Then('the lambda response {string} is less than {int}') do |key_path, expected|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.operator(actual, :<, expected)
+end
+
+# Test a Lambda response field starts with the given string.
+#
+# @step_input key_path [String] The response element to test
+# @step_input expected [String] The string to test against
+Then('the lambda response {string} starts with {string}') do |key_path, expected|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.kind_of(String, actual)
+  Maze.check.true(
+    actual.start_with?(expected),
+    "Field '#{key_path}' value ('#{actual}') does not start with '#{expected}'"
+  )
+end
+
+# Test a Lambda response field ends with the given string.
+#
+# @step_input key_path [String] The response element to test
+# @step_input expected [String] The string to test against
+Then('the lambda response {string} ends with {string}') do |key_path, expected|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.kind_of(String, actual)
+  Maze.check.true(
+    actual.end_with?(expected),
+    "Field '#{key_path}' value ('#{actual}') does not start with '#{expected}'"
+  )
+end
+
+# Test a Lambda response field is an array with a specific number of elements.
+#
+# @step_input key_path [String] The response element to test
+# @step_input expected [Integer] The expected number of elements
+Then('the lambda response {string} is an array with {int} element(s)') do |key_path, expected|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.kind_of(Array, actual)
+  Maze.check.equal(expected, actual.length)
+end
+
+# Test a Lambda response field is an array with at least 1 element.
+#
+# @step_input key_path [String] The response element to test
+Then('the lambda response {string} is a non-empty array') do |key_path|
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.kind_of(Array, actual)
+  Maze.check.false(actual.empty?)
+end
+
+# Test a Lambda response field matches the given regex.
+#
+# @step_input key_path [String] The response element to test
+# @step_input expected [String] The regex to match against
+Then('the lambda response {string} matches the regex {string}') do |key_path, regex|
+  expected = Regexp.new(regex)
+  Maze.check.not_nil(Maze::Aws::Sam.last_response, 'No lambda response!')
+
+  actual = Maze::Helper.read_key_path(Maze::Aws::Sam.last_response, key_path)
+
+  Maze.check.match(expected, actual)
+end

data/lib/features/steps/breadcrumb_steps.rb

@@ -0,0 +1,50 @@
+# @!group Breadcrumb steps
+
+# Tests whether the first event entry contains a specific breadcrumb with a type and name.
+#
+# @step_input type [String] The expected breadcrumb's type
+# @step_input name [String] The expected breadcrumb's name
+Then('the event has a {string} breadcrumb named {string}') do |type, name|
+  value = Maze::Server.errors.current[:body]['events'].first['breadcrumbs']
+  found = false
+  value.each do |crumb|
+    found = true if crumb['type'] == type and crumb['name'] == name
+  end
+  raise("No breadcrumb matched: #{value}") unless found
+end
+
+# Tests whether the first event entry contains a specific breadcrumb with a type and message.
+#
+# @step_input type [String] The expected breadcrumb's type
+# @step_input message [String] The expected breadcrumb's message
+Then('the event has a {string} breadcrumb with message {string}') do |type, message|
+  value = Maze::Server.errors.current[:body]['events'].first['breadcrumbs']
+  found = false
+  value.each do |crumb|
+    found = true if crumb['type'] == type && crumb['metaData'] && crumb['metaData']['message'] == message
+  end
+  raise("No breadcrumb matched: #{value}") unless found
+end
+
+# Tests whether the first event entry does not contain a breadcrumb with a specific type.
+# Used for confirming filtering of breadcrumbs
+#
+# @step_input type [String] The type of breadcrumb expected to not be present
+Then('the event does not have a {string} breadcrumb') do |type|
+  value = Maze::Server.errors.current[:body]['events'].first['breadcrumbs']
+  found = false
+  value.each do |crumb|
+    found = true if crumb['type'] == type
+  end
+  raise("Breadcrumb with type: #{type} matched") if found
+end
+
+# Tests whether any breadcrumb matches a given JSON fixture.  This follows all the usual rules for JSON fixture matching.
+#
+# @step_input json_fixture [String] A path to the JSON fixture to compare against
+Then('the event contains a breadcrumb matching the JSON fixture in {string}') do |json_fixture|
+  breadcrumbs = Maze::Helper.read_key_path(Maze::Server.errors.current[:body], 'events.0.breadcrumbs')
+  expected = JSON.parse(open(json_fixture, &:read))
+  match = breadcrumbs.any? { |breadcrumb| Maze::Compare.value(expected, breadcrumb).equal? }
+  Maze.check.true(match, 'No breadcrumbs in the event matched the given breadcrumb')
+end

data/lib/features/steps/browser_steps.rb

@@ -0,0 +1,93 @@
+# @!group Browser steps
+
+When('I navigate to the URL {string}') do |path|
+  begin
+    $logger.debug "Navigating to: #{path}"
+    Maze.driver.navigate.to path
+  rescue => exception
+    $logger.error("#{exception.class} occurred during navigation attempt with message: #{exception.message}")
+    $logger.error("Restarting driver and retrying navigation to: #{path}")
+    Maze.driver.restart_driver
+    Maze.driver.navigate.to path
+    # If a further error occurs it will get thrown as normal
+  end
+end
+
+Then(/^the error is a valid browser payload for the error reporting API$/) do
+  if !/^ie_(8|9|10)$/.match(Maze.config.browser)
+    steps %(
+      Then the error "Bugsnag-API-Key" header is not null
+      And the error "Content-Type" header equals one of:
+        | application/json |
+        | application/json; charset=UTF-8 |
+      And the error "Bugsnag-Payload-Version" header equals "4"
+      And the error "Bugsnag-Sent-At" header is a timestamp
+    )
+  else
+    steps %(
+      Then the error "apiKey" query parameter is not null
+      And the error "payloadVersion" query parameter equals "4"
+      And the error "sentAt" query parameter is a timestamp
+    )
+  end
+  steps %(
+    And the error payload field "notifier.name" is not null
+    And the error payload field "notifier.url" is not null
+    And the error payload field "notifier.version" is not null
+    And the error payload field "events" is a non-empty array
+
+    And each element in error payload field "events" has "severity"
+    And each element in error payload field "events" has "severityReason.type"
+    And each element in error payload field "events" has "unhandled"
+    And each element in error payload field "events" has "exceptions"
+
+    And the exception "type" equals "browserjs"
+  )
+end
+
+Then('the session is a valid browser payload for the session tracking API') do
+  if !/^ie_(8|9|10)$/.match(Maze.config.browser)
+    steps %(
+      Then the session "Bugsnag-API-Key" header is not null
+      And the session "Content-Type" header equals one of:
+        | application/json |
+        | application/json; charset=UTF-8 |
+      And the session "Bugsnag-Payload-Version" header equals "1"
+      And the session "Bugsnag-Sent-At" header is a timestamp
+    )
+  else
+    steps %(
+      Then the session "apiKey" query parameter is not null
+      And the session "payloadVersion" query parameter equals "1"
+      And the session "sentAt" query parameter is a timestamp
+    )
+  end
+  steps %(
+    And the session payload field "app" is not null
+    And the session payload field "device" is not null
+    And the session payload field "notifier.name" is not null
+    And the session payload field "notifier.url" is not null
+    And the session payload field "notifier.version" is not null
+    And the session payload has a valid sessions array
+  )
+end
+
+Then('the event device ID is valid') do
+  if Maze.driver.local_storage?
+    step('the event "device.id" matches "^c[a-z0-9]{20,32}$"')
+  else
+    $logger.info('Local storage is not supported in this browser, assuming device ID is null')
+    step('the event "device.id" is null')
+  end
+end
+
+Then('the event device ID is {string}') do |expected_id|
+  if Maze.driver.local_storage?
+    step("the event \"device.id\" equals \"#{expected_id}\"")
+  else
+    $logger.info('Local storage is not supported in this browser, assuming device ID is null')
+    step('the event "device.id" is null')
+  end
+end
+
+# @!endgroup

data/lib/features/steps/build_api_steps.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# @!group Build API Steps
+
+# Tests whether the top-most payload is valid for the Bugsnag build API
+# APIKey fields and headers are tested against the '$api_key' global variable
+Then('the build is valid for the Build API') do
+  steps %(
+    And the build payload field "apiKey" equals "#{$api_key}"
+    And the build payload field "appVersion" is not null
+  )
+end
+
+# Tests whether the top-most payload is valid for the Android mapping API
+# APIKey fields and headers are tested against the '$api_key' global variable
+Then('the build is valid for the Android Mapping API') do
+  steps %(
+    And the build payload field "apiKey" equals "#{$api_key}"
+    And the build payload field "proguard" is not null
+    And the build payload field "appId" is not null
+    And the build payload field "versionCode" is not null
+    And the build payload field "buildUUID" is not null
+    And the build payload field "versionName" is not null
+  )
+end

data/lib/features/steps/document_server_steps.rb

@@ -0,0 +1,7 @@
+# @!group Document steps
+
+# Starts the document server manually.  It will be stopped automatically at the end of each scenario
+# (if started in this way).
+When('I start the document server') do
+  Maze::DocumentServer.manual_start
+end