bugsnag 6.12.2 → 6.13.0

data/features/rails_features/send_environment.feature

@@ -1,41 +1,13 @@
 Feature: Send environment
 
-Background:
-  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And I set environment variable "APP_PATH" to "/usr/src"
-  And I configure the bugsnag endpoint
-
-Scenario Outline: Send_environment should send environment in handled errors when true
-  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
-  And I set environment variable "BUGSNAG_SEND_ENVIRONMENT" to "true"
-  And I start the service "rails<rails_version>"
-  And I wait for the app to respond on port "6128<rails_version>"
-  When I navigate to the route "/send_environment/initializer" on port "6128<rails_version>"
-  Then I should receive a request
-  And the request is a valid for the error reporting API
-  And the request used the "Ruby Bugsnag Notifier" notifier
-  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And the payload field "events" is an array with 1 element
+@rails3 @rails4 @rails5 @rails6
+Scenario: Send_environment should send environment in handled errors when true
+  Given I set environment variable "BUGSNAG_SEND_ENVIRONMENT" to "true"
+  And I start the rails service
+  When I navigate to the route "/send_environment/initializer" on the rails app
+  And I wait to receive a request
+  Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
   And the exception "errorClass" equals "RuntimeError"
   And the exception "message" starts with "handled string"
   And the event "metaData.environment.REQUEST_METHOD" equals "GET"
-  And the event "metaData.environment.railsVersion" is not null
   And the event "app.type" equals "rails"
-
-  Examples:
-    | ruby_version | rails_version |
-    | 2.0          | 3             |
-    | 2.1          | 3             |
-    | 2.2          | 3             |
-    | 2.2          | 4             |
-    | 2.2          | 5             |
-    | 2.3          | 3             |
-    | 2.3          | 4             |
-    | 2.3          | 5             |
-    | 2.4          | 3             |
-    | 2.4          | 5             |
-    | 2.5          | 3             |
-    | 2.5          | 5             |
-    | 2.5          | 6             |
-    | 2.6          | 5             |
-    | 2.6          | 6             |

data/features/rails_features/unhandled.feature

@@ -1,20 +1,11 @@
 Feature: Unhandled exceptions support
 
-Background:
-  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And I set environment variable "APP_PATH" to "/usr/src"
-  And I configure the bugsnag endpoint
-
-Scenario Outline: Unhandled RuntimeError
-  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
-  And I start the service "rails<rails_version>"
-  And I wait for the app to respond on port "6128<rails_version>"
-  When I navigate to the route "/unhandled/error" on port "6128<rails_version>"
-  Then I should receive a request
-  And the request is a valid for the error reporting API
-  And the request used the "Ruby Bugsnag Notifier" notifier
-  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And the payload field "events" is an array with 1 element
+@rails3 @rails4 @rails5 @rails6
+Scenario: Unhandled RuntimeError
+  Given I start the rails service
+  When I navigate to the route "/unhandled/error" on the rails app
+  And I wait to receive a request
+  Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
   And the event "unhandled" is true
   And the exception "errorClass" equals "NameError"
   And the exception "message" starts with "undefined local variable or method `generate_unhandled_error' for #<UnhandledController"
@@ -23,21 +14,3 @@ Scenario Outline: Unhandled RuntimeError
   And the event "severity" equals "error"
   And the event "severityReason.type" equals "unhandledExceptionMiddleware"
   And the event "severityReason.attributes.framework" equals "Rack"
-
-  Examples:
-    | ruby_version | rails_version |
-    | 2.0          | 3             |
-    | 2.1          | 3             |
-    | 2.2          | 3             |
-    | 2.2          | 4             |
-    | 2.2          | 5             |
-    | 2.3          | 3             |
-    | 2.3          | 4             |
-    | 2.3          | 5             |
-    | 2.4          | 3             |
-    | 2.4          | 5             |
-    | 2.5          | 3             |
-    | 2.5          | 5             |
-    | 2.5          | 6             |
-    | 2.6          | 5             |
-    | 2.6          | 6             |

data/features/rails_features/user_info.feature

@@ -1,93 +1,52 @@
 Feature: Capture user information
 
-Background:
-  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And I set environment variable "APP_PATH" to "/usr/src"
-  And I configure the bugsnag endpoint
-
+@rails3
 Scenario Outline: Warden user information is sent
-  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
-  And I start the service "rails<rails_version>"
-  And I wait for the app to respond on port "6128<rails_version>"
-  When I navigate to the route "/warden/create" on port "6128<rails_version>"
-  And I navigate to the route "/warden/<route>?email=testtest@test.test" on port "6128<rails_version>"
-  Then I should receive a request
-  And the request is a valid for the error reporting API
-  And the request used the "Ruby Bugsnag Notifier" notifier
-  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And the payload field "events" is an array with 1 element
+  Given I start the rails service
+  When I navigate to the route "/warden/create" on the rails app
+  And I navigate to the route "/warden/<route>?email=testtest@test.test" on the rails app
+  And I wait to receive a request
+  Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
   And the event "user.email" equals "testtest@test.test"
   And the event "user.name" equals "Warden User"
   And the event "user.first_name" equals "Warden"
   And the event "user.last_name" equals "User"
 
   Examples:
-    | ruby_version | rails_version | route     |
-    | 2.0          | 3             | handled   |
-    | 2.0          | 3             | unhandled |
-    | 2.1          | 3             | handled   |
-    | 2.1          | 3             | unhandled |
-    | 2.2          | 3             | handled   |
-    | 2.2          | 3             | unhandled |
-    | 2.3          | 3             | handled   |
-    | 2.3          | 3             | unhandled |
-    | 2.4          | 3             | handled   |
-    | 2.4          | 3             | unhandled |
-    | 2.5          | 3             | handled   |
-    | 2.5          | 3             | unhandled |
+    | route     |
+    | handled   |
+    | unhandled |
 
+@rails4
 Scenario Outline: Devise user information is sent
-  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
-  And I start the service "rails<rails_version>"
-  And I wait for the app to respond on port "6128<rails_version>"
-  When I navigate to the route "/devise/create" on port "6128<rails_version>"
-  And I navigate to the route "/devise/<route>" on port "6128<rails_version>"
-  Then I should receive a request
-  And the request is a valid for the error reporting API
-  And the request used the "Ruby Bugsnag Notifier" notifier
-  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And the payload field "events" is an array with 1 element
+  Given I start the rails service
+  When I navigate to the route "/devise/create" on the rails app
+  And I navigate to the route "/devise/<route>" on the rails app
+  And I wait to receive a request
+  Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
   And the event "user.email" equals "test+test@test.test"
   And the event "user.name" equals "Devise User"
   And the event "user.first_name" equals "Devise"
   And the event "user.last_name" equals "User"
 
   Examples:
-    | ruby_version | rails_version | route     |
-    | 2.2          | 4             | handled   |
-    | 2.2          | 4             | unhandled |
-    | 2.3          | 4             | handled   |
-    | 2.3          | 4             | unhandled |
+    | route     |
+    | handled   |
+    | unhandled |
 
+@rails5 @rails6
 Scenario Outline: Clearance user information is sent
-  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
-  And I start the service "rails<rails_version>"
-  And I wait for the app to respond on port "6128<rails_version>"
-  When I navigate to the route "/clearance/create" on port "6128<rails_version>"
-  And I navigate to the route "/clearance/<route>" on port "6128<rails_version>"
-  Then I should receive a request
-  And the request is a valid for the error reporting API
-  And the request used the "Ruby Bugsnag Notifier" notifier
-  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And the payload field "events" is an array with 1 element
+  Given I start the rails service
+  When I navigate to the route "/clearance/create" on the rails app
+  And I navigate to the route "/clearance/<route>" on the rails app
+  And I wait to receive a request
+  Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
   And the event "user.email" equals "testtest@test.test"
   And the event "user.name" equals "Clearance User"
   And the event "user.first_name" equals "Clearance"
   And the event "user.last_name" equals "User"
 
   Examples:
-    | ruby_version | rails_version | route     |
-    | 2.2          | 5             | handled   |
-    | 2.2          | 5             | unhandled |
-    | 2.3          | 5             | handled   |
-    | 2.3          | 5             | unhandled |
-    | 2.4          | 5             | handled   |
-    | 2.4          | 5             | unhandled |
-    | 2.5          | 5             | handled   |
-    | 2.5          | 5             | unhandled |
-    | 2.5          | 6             | handled   |
-    | 2.5          | 6             | unhandled |
-    | 2.6          | 5             | handled   |
-    | 2.6          | 5             | unhandled |
-    | 2.6          | 6             | handled   |
-    | 2.6          | 6             | unhandled |
+    | route     |
+    | handled   |
+    | unhandled |

data/features/sidekiq.feature

@@ -1,97 +1,30 @@
 Feature: Bugsnag raises errors in Sidekiq workers
 
-Background:
-  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And I set environment variable "APP_PATH" to "/usr/src"
-  And I configure the bugsnag endpoint
-
-Scenario Outline: An unhandled RuntimeError sends a report
-  And I set environment variable "RUBY_VERSION" to "<ruby version>"
-  And I set environment variable "SIDEKIQ_VERSION" to "<sidekiq_version>"
-  And I start the service "sidekiq"
-  And I run the command "bundle exec ruby initializers/UnhandledError.rb" on the service "sidekiq"
-  And I wait for 1 seconds
-  Then I should receive a request
-  And the request used the "Ruby Bugsnag Notifier" notifier
-  And the request used payload v4 headers
-  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+Scenario: An unhandled RuntimeError sends a report
+  Given I run the service "sidekiq" with the command "bundle exec rake sidekiq_tests:unhandled_error"
+  And I wait to receive a request
+  Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
   And the event "unhandled" is true
   And the event "severity" equals "error"
   And the event "context" equals "UnhandledError@default"
   And the event "severityReason.type" equals "unhandledExceptionMiddleware"
   And the event "severityReason.attributes.framework" equals "Sidekiq"
   And the exception "errorClass" equals "RuntimeError"
-  And the "file" of stack frame 0 equals "/usr/src/app.rb"
+  And the "file" of stack frame 0 equals "/app/app.rb"
   And the "lineNumber" of stack frame 0 equals 33
-  And the payload field "events.0.metaData.sidekiq" matches the JSON fixture in "features/fixtures/sidekiq/payloads/unhandled_metadata_ca_<created_at_present>.json"
+  And the payload field "events.0.metaData.sidekiq" matches the appropriate Sidekiq unhandled payload
   And the event "metaData.sidekiq.msg.created_at" is a parsable timestamp in seconds
   And the event "metaData.sidekiq.msg.enqueued_at" is a parsable timestamp in seconds
 
-  Examples:
-  | ruby version | sidekiq_version | created_at_present |
-  | 1.9.3        | ~> 2            | false              |
-  | 2.0          | ~> 2            | false              |
-  | 2.0          | ~> 3            | true               |
-  | 2.1          | ~> 2            | false              |
-  | 2.1          | ~> 3            | true               |
-  | 2.2          | ~> 2            | false              |
-  | 2.2          | ~> 3            | true               |
-  | 2.2          | ~> 4            | true               |
-  | 2.2          | ~> 5            | true               |
-  | 2.3          | ~> 2            | false              |
-  | 2.3          | ~> 3            | true               |
-  | 2.3          | ~> 4            | true               |
-  | 2.3          | ~> 5            | true               |
-  | 2.4          | ~> 2            | false              |
-  | 2.4          | ~> 3            | true               |
-  | 2.4          | ~> 4            | true               |
-  | 2.4          | ~> 5            | true               |
-  | 2.5          | ~> 2            | false              |
-  | 2.5          | ~> 3            | true               |
-  | 2.5          | ~> 4            | true               |
-  | 2.5          | ~> 5            | true               |
-
-Scenario Outline: A handled RuntimeError can be notified
-  And I set environment variable "RUBY_VERSION" to "<ruby version>"
-  And I set environment variable "SIDEKIQ_VERSION" to "<sidekiq_version>"
-  And I start the service "sidekiq"
-  And I run the command "bundle exec ruby initializers/HandledError.rb" on the service "sidekiq"
-  And I wait for 1 seconds
-  Then I should receive a request
-  And the request used the "Ruby Bugsnag Notifier" notifier
-  And the request used payload v4 headers
-  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+Scenario: A handled RuntimeError can be notified
+  Given I run the service "sidekiq" with the command "bundle exec rake sidekiq_tests:handled_error"
+  And I wait to receive a request
+  Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
   And the event "unhandled" is false
   And the event "context" equals "HandledError@default"
   And the event "severity" equals "warning"
   And the event "severityReason.type" equals "handledException"
   And the exception "errorClass" equals "RuntimeError"
-  And the "file" of stack frame 0 equals "/usr/src/app.rb"
-  And the "lineNumber" of stack frame 0 equals 24
-  And the payload field "events.0.metaData.sidekiq" matches the JSON fixture in "features/fixtures/sidekiq/payloads/handled_metadata_ca_<created_at_present>.json"
+  And the payload field "events.0.metaData.sidekiq" matches the appropriate Sidekiq handled payload
   And the event "metaData.sidekiq.msg.created_at" is a parsable timestamp in seconds
-  And the event "metaData.sidekiq.msg.enqueued_at" is a parsable timestamp in seconds
-
-  Examples:
-  | ruby version | sidekiq_version | created_at_present |
-  | 1.9.3        | ~> 2            | false              |
-  | 2.0          | ~> 2            | false              |
-  | 2.0          | ~> 3            | true               |
-  | 2.1          | ~> 2            | false              |
-  | 2.1          | ~> 3            | true               |
-  | 2.2          | ~> 2            | false              |
-  | 2.2          | ~> 3            | true               |
-  | 2.2          | ~> 4            | true               |
-  | 2.2          | ~> 5            | true               |
-  | 2.3          | ~> 2            | false              |
-  | 2.3          | ~> 3            | true               |
-  | 2.3          | ~> 4            | true               |
-  | 2.3          | ~> 5            | true               |
-  | 2.4          | ~> 2            | false              |
-  | 2.4          | ~> 3            | true               |
-  | 2.4          | ~> 4            | true               |
-  | 2.4          | ~> 5            | true               |
-  | 2.5          | ~> 2            | false              |
-  | 2.5          | ~> 3            | true               |
-  | 2.5          | ~> 4            | true               |
-  | 2.5          | ~> 5            | true               |
+  And the event "metaData.sidekiq.msg.enqueued_at" is a parsable timestamp in seconds

data/features/steps/ruby_notifier_steps.rb

@@ -1,31 +1,75 @@
-When("I set environment variable {string} to the current IP") do |env_var|
+Then(/^the "(.+)" of the top non-bugsnag stackframe equals (\d+|".+")$/) do |element, value|
+  stacktrace = read_key_path(Server.current_request[:body], 'events.0.exceptions.0.stacktrace')
+  frame_index = stacktrace.find_index { |frame| ! /.*lib\/bugsnag.*\.rb/.match(frame["file"]) }
   steps %Q{
-    When I set environment variable "#{env_var}" to "#{current_ip}"
+    the "#{element}" of stack frame #{frame_index} equals #{value}
   }
 end
 
-When("I set environment variable {string} to the mock API port") do |env_var|
+Then(/^the total sessionStarted count equals (\d+)$/) do |value|
+  session_counts = read_key_path(Server.current_request[:body], "sessionCounts")
+  total_count = session_counts.inject(0) { |count, session| count += session["sessionsStarted"] }
+  assert_equal(value, total_count)
+end
+
+
+# Due to an ongoing discussion on whether the `payload_version` needs to be present within the headers
+# and body of the payload, this step is a local replacement for the similar step present in the main
+# maze-runner library. Once the discussion is resolved this step should be removed and replaced in scenarios
+# with the main library version.
+Then("the request is valid for the error reporting API version {string} for the {string}") do |payload_version, notifier_name|
   steps %Q{
-    When I set environment variable "#{env_var}" to "#{MOCK_API_PORT}"
+    Then the "Bugsnag-Api-Key" header equals "#{$api_key}"
+    And the payload field "apiKey" equals "#{$api_key}"
+    And the "Bugsnag-Payload-Version" header equals "#{payload_version}"
+    And the "Content-Type" header equals "application/json"
+    And the "Bugsnag-Sent-At" header is a timestamp
+
+    And the payload field "notifier.name" equals "#{notifier_name}"
+    And the payload field "notifier.url" is not null
+    And the payload field "notifier.version" is not null
+    And the payload field "events" is a non-empty array
+
+    And each element in payload field "events" has "severity"
+    And each element in payload field "events" has "severityReason.type"
+    And each element in payload field "events" has "unhandled"
+    And each element in payload field "events" has "exceptions"
   }
 end
 
-When("I set environment variable {string} to the proxy settings with credentials {string}") do |env_var, credentials|
+Given("I start the rails service") do
+  rails_version = ENV["RAILS_VERSION"]
   steps %Q{
-    When I set environment variable "#{env_var}" to "#{credentials}@#{current_ip}:#{MOCK_API_PORT}"
+    When I start the service "rails#{rails_version}"
+    And I wait for the host "rails#{rails_version}" to open port "3000"
   }
 end
 
-Then(/^the "(.+)" of the top non-bugsnag stackframe equals (\d+|".+")(?: for request (\d+))?$/) do |element, value, request_index|
-  stacktrace = read_key_path(find_request(request_index)[:body], 'events.0.exceptions.0.stacktrace')
-  frame_index = stacktrace.find_index { |frame| ! /.*lib\/bugsnag.*\.rb/.match(frame["file"]) }
+When("I navigate to the route {string} on the rails app") do |route|
+  rails_version = ENV["RAILS_VERSION"]
   steps %Q{
-    the "#{element}" of stack frame #{frame_index} equals #{value}
+    When I open the URL "http://rails#{rails_version}:3000#{route}"
   }
 end
 
-Then(/^the total sessionStarted count equals (\d+)(?: for request (\d+))?$/) do |value, request_index|
-  session_counts = read_key_path(find_request(request_index)[:body], "sessionCounts")
-  total_count = session_counts.inject(0) { |count, session| count += session["sessionsStarted"] }
-  assert_equal(value, total_count)
-end
+Then("the payload field {string} matches the appropriate Sidekiq handled payload") do |field|
+  if ENV["SIDEKIQ_VERSION"] == "~> 2"
+    created_at_present = "false"
+  else
+    created_at_present = "true"
+  end
+  steps %Q{
+    And the payload field "#{field}" matches the JSON fixture in "features/fixtures/sidekiq/payloads/handled_metadata_ca_#{created_at_present}.json"
+  }
+end
+
+Then("the payload field {string} matches the appropriate Sidekiq unhandled payload") do |field|
+  if ENV["SIDEKIQ_VERSION"] == "~> 2"
+    created_at_present = "false"
+  else
+    created_at_present = "true"
+  end
+  steps %Q{
+    And the payload field "#{field}" matches the JSON fixture in "features/fixtures/sidekiq/payloads/unhandled_metadata_ca_#{created_at_present}.json"
+  }
+end

data/features/support/env.rb

@@ -1,56 +1,23 @@
 require 'fileutils'
 
-Before do
-  find_default_docker_compose
-end
-
-def output_logs
-  $docker_services.each do |service|
-    logged_service = service[:service] == :all ? '' : service[:service]
-    command = "logs -t #{logged_service}"
-    begin
-      response = run_docker_compose_command(service[:file], command)
-    rescue => exception
-      response = "Couldn't retreive logs for #{service[:file]}:#{logged_service}"
-    end
-    STDOUT.puts response.is_a?(String) ? response : response.to_a
-  end
-end
-
 def install_fixture_gems
-  gem_dir = File.expand_path('../../../', __FILE__)
-  Dir.chdir(gem_dir) do
-    `rm bugsnag-*.gem` unless Dir.glob('bugsnag-*.gem').empty?
-    `gem build bugsnag.gemspec`
-    Dir.entries('features/fixtures').reject { |entry| ['.', '..'].include?(entry) }.each do |entry|
-      target_dir = "features/fixtures/#{entry}"
-      if File.directory?(target_dir)
-        `cp bugsnag-*.gem #{target_dir}`
-        `gem unpack #{target_dir}/bugsnag-*.gem --target #{target_dir}/temp-bugsnag-lib`
-      end
-    end
-    `rm bugsnag-*.gem`
-  end
-end
-
-# Added to ensure that multiple versions of Gems do not exist within the fixture folders,
-# which can be difficult to track down and clear up
-def remove_installed_gems
-  removal_targets = ['temp-bugsnag-lib', 'bugsnag-*.gem']
+  throw Error.new("Bugsnag.gem not found. Is this running in a docker-container?") unless File.exist?("/app/bugsnag.gem")
   Dir.entries('features/fixtures').reject { |entry| ['.', '..'].include?(entry) }.each do |entry|
     target_dir = "features/fixtures/#{entry}"
-    target_entries = []
-    removal_targets.each do |r_target|
-      target_entries += Dir.glob("#{target_dir}/#{r_target}")
-    end
-    target_entries.each do |d_target|
-      FileUtils.rm_rf(d_target)
+    if File.directory?(target_dir)
+      `cp /app/bugsnag.gem #{target_dir}`
+      `gem unpack #{target_dir}/bugsnag.gem --target #{target_dir}/temp-bugsnag-lib`
     end
   end
 end
 
-at_exit do
-  remove_installed_gems
+AfterConfiguration do |config|
+  install_fixture_gems
 end
 
-install_fixture_gems
+Before do
+  Docker.compose_project_name = "#{rand.to_s}:#{Time.new.strftime("%s")}"
+  Runner.environment.clear
+  Runner.environment["BUGSNAG_API_KEY"] = $api_key
+  Runner.environment["BUGSNAG_ENDPOINT"] = "http://maze-runner:#{MOCK_API_PORT}"
+end