bugsnag 6.12.2 → 6.13.0

data/.rubocop_todo.yml

@@ -568,7 +568,7 @@ Style/RedundantSelf:
     - 'lib/bugsnag/configuration.rb'
     - 'lib/bugsnag/integrations/railtie.rb'
 
-# Offense count: 3
+# Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, AllowInnerSlashes.
 # SupportedStyles: slashes, percent_r, mixed

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+## 6.13.0 (30 Jan 2020)
+
+### Enhancements
+
+* Add configurable `vendor_path` to configure which file paths are out of project stacktrace.
+  | [#544](https://github.com/bugsnag/bugsnag-ruby/pull/544)
+
+### Fixes
+
+* Resolve Ruby deprecation warning for keyword parameters
+  | [#580](https://github.com/bugsnag/bugsnag-ruby/pull/582)
+
 ## 6.12.2 (24 Oct 2019)
 
 ### Fixes

data/CONTRIBUTING.md

@@ -20,15 +20,7 @@ Thank you!
     ```
     bundle exec rake spec
     ```
--   You will need to add the following test dependencies:
-
-    ```
-    bundle install --with test --binstubs
-    ```
--   For adding a new integration (like support for a web framework or worker
-    queue), include an example in the `example/` directory showing off what
-    you've built. Include a `README` with the example app so others know how to
-    run it.
+-   Further information on installing and running the tests can be found in [the testing guide](TESTING.md)
 
 
 ### Ship it!

data/Gemfile

@@ -1,12 +1,12 @@
 source "https://rubygems.org"
 
-ruby_version = Gem::Version.new(RUBY_VERSION)
+ruby_version = Gem::Version.new(RUBY_VERSION.dup)
 
 group :test, optional: true do
   gem 'rake', ruby_version <= Gem::Version.new('1.9.3') ? '~> 11.3.0' : '~> 12.3.0'
   gem 'rspec'
   gem 'rspec-mocks'
-  gem 'rdoc', '~> 5.1.0'
+  gem 'rdoc', ruby_version < Gem::Version.new('2.2.0') ? '4.3.0' : '~> 5.1.0'
   gem 'pry'
   gem 'addressable', '~> 2.3.8'
   if ruby_version >= Gem::Version.new('2.2.2')
@@ -15,6 +15,15 @@ group :test, optional: true do
   end
   gem 'webmock', ruby_version <= Gem::Version.new('1.9.3') ? '2.3.2': '>2.3.2'
   gem 'hashdiff', ruby_version <= Gem::Version.new('1.9.3') ? '0.3.8': '>0.3.8'
+  if ruby_version >= Gem::Version.new('2.7.0')
+    gem 'did_you_mean', '~> 1.4.0'
+  elsif ruby_version >= Gem::Version.new('2.5.0')
+    gem 'did_you_mean', '~> 1.3.1'
+  elsif ruby_version >= Gem::Version.new('2.4.0')
+    gem 'did_you_mean', '~> 1.1.0'
+  elsif ruby_version >= Gem::Version.new('2.3.0')
+    gem 'did_you_mean', '~> 1.0.4'
+  end
 end
 
 group :coverage, optional: true do
@@ -36,8 +45,4 @@ group :doc, optional: true do
   gem 'hanna-nouveau'
 end
 
-group :maze, optional: true do
-  gem 'bugsnag-maze-runner', git: 'https://github.com/bugsnag/maze-runner' if ruby_version >= Gem::Version.new('2.0.0')
-end
-
 gemspec

data/TESTING.md

@@ -0,0 +1,81 @@
+# Testing the Ruby Bugsnag notifier
+
+## Unit tests
+
+To run locally:
+
+```
+bundle install --with test sidekiq --binstubs
+bundle exec rake
+```
+
+To run within a different environment, set `RUBY_TEST_VERSION` to your desired Ruby version, then run:
+
+```
+RUBY_TEST_VERSION=2.6 docker-compose up --build ruby-unit-tests
+```
+
+To run the unit tests against JRuby, run:
+
+```
+docker-compose up --build jruby-unit-tests
+```
+
+## End-to-end tests
+
+These tests are implemented with our notifier testing tool [Maze Runner](https://github.com/bugsnag/maze-runner).
+
+End to end tests are written in cucumber-style `.feature` files, and need Ruby-backed "steps" in order to know what to run. The tests are located in the top level [`features`](/features/) directory.
+
+Maze runner's CLI and the test fixtures are containerised so you'll need Docker (and Docker Compose) to run them.
+
+__Note: only Bugsnag employees can run the end-to-end tests.__ We have dedicated test infrastructure and private BrowserStack credentials which can't be shared outside of the organisation.
+
+##### Authenticating with the private container registry
+
+You'll need to set the credentials for the aws profile in order to access the private docker registry:
+
+```
+aws configure --profile=opensource
+```
+
+Subsequently you'll need to run the following commmand to authenticate with the registry:
+
+```
+$(aws ecr get-login --profile=opensource --no-include-email)
+```
+
+__Your session will periodically expire__, so you'll need to run this command to re-authenticate when that happens.
+
+### Running the end to end tests
+
+Once registered with the remote repository, build the test container:
+
+```
+docker-compose build ruby-maze-runner
+```
+
+Configure the tests to be run in the following way:
+
+- Determine the Ruby version to be tested using the environment variable `RUBY_TEST_VERSION` e.g. `RUBY_TEST_VERSION=2.6`
+- If testing rails, set the rails version to be tested using the environment variable `RAILS_VERSION` e.g. `RAILS_VERSION=3`
+- If testing sidekiq, set the version to be tested using the environment variable `SIDEKIQ_VERSION` as the bundler version,  e.g. `SIDEKIQ_VERSION="~> 2"`
+
+When running the end-to-end tests, you'll want to restrict the feature files run to the specific test features for the platform.  This is done using the Cucumber CLI syntax at the end of the `docker-compose run ruby-maze-runner` command, i.e:
+
+```
+RUBY_TEST_VERSION=2.6 RAILS_VERSION=6 docker-compose run ruby-maze-runner features/rails_features --tags "@rails6"
+```
+
+- Plain ruby tests should target `features/plain_features`
+- Sidekiq tests should target `features/sidekiq.feature`
+- Delayed job tests should target `features/delayed_job.feature`
+- Rails test should target `features/rails_features`. In addition, the tag syntax should be used to specify which of the scenarios within those files are run.  For example rails 3 test should feature the tag `"@rails3"`
+
+In order to target specific features the exact `.feature` file can be specified, i.e:
+
+```
+RUBY_TEST_VERSION=2.6 RAILS_VERSION=6 docker-compose run ruby-maze-runner features/rails_features/app_version.feature --tags "@rails6"
+```
+
+In order to avoid running flakey or unfinished tests, the tag `"not @wip"` can be added to the tags option. This is recommended for all CI runs. If a tag is already specified, this should be added using the `and` keyword, e.g. `--tags "@rails6 and not @wip"`

data/VERSION

@@ -1 +1 @@
-6.12.2
+6.13.0

data/docker-compose.yml

@@ -0,0 +1,46 @@
+version: '3.6'
+services:
+  ruby-maze-runner:
+    build:
+      context: .
+      dockerfile: dockerfiles/Dockerfile.ruby-maze-runner
+      target: ruby-maze-runner
+    environment:
+      NETWORK_NAME: "${BUILDKITE_JOB_ID:-ruby-maze-runner}-${RUBY_TEST_VERSION:-local}"
+      BUILDKITE_JOB_ID:
+      RAILS_VERSION:
+      SIDEKIQ_VERSION:
+      RUBY_TEST_VERSION:
+      VERBOSE:
+      DEBUG:
+    networks:
+      default:
+        aliases:
+          - maze-runner
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+
+  ruby-unit-tests:
+    build:
+      context: .
+      dockerfile: dockerfiles/Dockerfile.ruby-unit-tests
+      args:
+        - RUBY_TEST_VERSION
+        - GEMSETS=${GEMSETS:-test}
+        - BUNDLE_VERSION=${BUNDLE_VERSION:-1.12.0}
+    environment:
+      COVERALLS_REPO_TOKEN:
+      GEMSETS:
+      CI:
+
+  jruby-unit-tests:
+    build:
+      context: .
+      dockerfile: dockerfiles/Dockerfile.jruby-unit-tests
+      args:
+        - GEMSETS=${GEMSETS:-test}
+        - BUNDLE_VERSION=${BUNDLE_VERSION:-1.12.0}
+
+networks:
+  default:
+    name: ${BUILDKITE_JOB_ID:-ruby-maze-runner}-${RUBY_TEST_VERSION:-local}

data/dockerfiles/Dockerfile.jruby-unit-tests

@@ -0,0 +1,13 @@
+FROM jruby:latest
+
+RUN apt-get update && apt-get install -y git
+
+WORKDIR /app/
+
+COPY . .
+ARG BUNDLE_VERSION
+ARG GEMSETS
+RUN gem install bundler -v $BUNDLE_VERSION
+RUN bundle _${BUNDLE_VERSION}_ install --with "$GEMSETS" --binstubs
+
+CMD ["bundle", "exec", "./bin/rake", "spec"]

data/dockerfiles/Dockerfile.ruby-maze-runner

@@ -0,0 +1,26 @@
+FROM ruby:2.6 as ruby-package-builder
+
+RUN gem install bundler
+
+WORKDIR /app
+
+COPY bugsnag.gemspec Gemfile VERSION ./
+
+RUN bundle install
+
+COPY  CHANGELOG.md CONTRIBUTING.md TESTING.md LICENSE.txt Rakefile README.md UPGRADING.md .gitignore .rdoc_options .rspec .rubocop.yml .rubocop_todo.yml issue_template.md docker-compose.yml ./
+COPY .buildkite ./.buildkite
+COPY .git ./.git
+COPY .github ./.github
+COPY dockerfiles ./dockerfiles
+COPY features ./features
+COPY lib ./lib
+COPY spec ./spec
+
+RUN gem build bugsnag.gemspec
+
+# The maze-runner node tests
+FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:v2-cli as ruby-maze-runner
+WORKDIR /app/
+COPY features ./features
+COPY --from=ruby-package-builder /app/bugsnag-*.gem bugsnag.gem

data/dockerfiles/Dockerfile.ruby-unit-tests

@@ -0,0 +1,12 @@
+ARG RUBY_TEST_VERSION
+FROM ruby:$RUBY_TEST_VERSION
+
+WORKDIR /app/
+
+COPY . .
+ARG BUNDLE_VERSION
+ARG GEMSETS
+RUN gem install bundler -v ${BUNDLE_VERSION}
+RUN bundle _${BUNDLE_VERSION}_ install --with "$GEMSETS" --binstubs
+
+CMD ["bundle", "exec", "./bin/rake", "spec"]

data/features/delayed_job.feature

@@ -1,18 +1,9 @@
 Feature: Bugsnag detects errors in Delayed job workers
 
-Background:
-  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
-  And I configure the bugsnag endpoint
-
 Scenario: An unhandled RuntimeError sends a report with arguments
-  Given I set environment variable "RUBY_VERSION" to "2.5"
-  And I start the service "delayed_job"
-  And I run the command "bundle exec rails runner 'TestModel.delay.fail_with_args(\"Test\")'" on the service "delayed_job"
-  And I wait for 5 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"
+  Given I run the service "delayed_job" with the command "bundle exec rake delayed_job_tests:fail_with_args"
+  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 "TestModel.fail_with_args"
@@ -25,18 +16,12 @@ Scenario: An unhandled RuntimeError sends a report with arguments
   And the event "metaData.job.max_attempts" equals 1
   And the event "metaData.job.payload.display_name" equals "TestModel.fail_with_args"
   And the event "metaData.job.payload.method_name" equals "fail_with_args"
-  And the payload field "events.0.metaData.job.payload.args" is an array with 1 element
   And the payload field "events.0.metaData.job.payload.args.0" equals "Test"
 
 Scenario: A handled exception sends a report
-  Given I set environment variable "RUBY_VERSION" to "2.5"
-  And I start the service "delayed_job"
-  And I run the command "bundle exec rails runner 'TestModel.delay.notify_with_args(\"Test\")'" on the service "delayed_job"
-  And I wait for 5 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"
+  Given I run the service "delayed_job" with the command "bundle exec rake delayed_job_tests:notify_with_args"
+  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 "severity" equals "warning"
   And the event "context" equals "TestModel.notify_with_args"
@@ -48,5 +33,4 @@ Scenario: A handled exception sends a report
   And the event "metaData.job.max_attempts" equals 1
   And the event "metaData.job.payload.display_name" equals "TestModel.notify_with_args"
   And the event "metaData.job.payload.method_name" equals "notify_with_args"
-  And the payload field "events.0.metaData.job.payload.args" is an array with 1 element
   And the payload field "events.0.metaData.job.payload.args.0" equals "Test"

data/features/fixtures/delayed_job/Dockerfile

@@ -1,5 +1,5 @@
-ARG RUBY_VERSION
-FROM ruby:$RUBY_VERSION
+ARG RUBY_TEST_VERSION
+FROM ruby:$RUBY_TEST_VERSION
 
 WORKDIR /bugsnag
 COPY temp-bugsnag-lib ./
@@ -13,5 +13,3 @@ COPY app/ /usr/src/app
 RUN bundle exec rake rails:update:bin
 RUN bundle exec bin/rails generate delayed_job:active_record
 RUN bundle exec rake db:migrate
-
-CMD ["bundle", "exec", "rake", "jobs:work"]

data/features/fixtures/delayed_job/app/Gemfile

@@ -13,7 +13,7 @@ gem 'therubyracer'
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 5.0.7'
 # Use sqlite3 as the database for Active Record
-gem 'sqlite3'
+gem 'sqlite3', '~> 1.3.6'
 # Use Puma as the app server
 gem 'puma', '~> 3.0'
 # Use SCSS for stylesheets

data/features/fixtures/delayed_job/app/Rakefile

@@ -4,3 +4,21 @@
 require_relative 'config/application'
 
 Rails.application.load_tasks
+
+namespace :delayed_job_tests do
+  task :fail_with_args do
+    run_delayed_job_test('"TestModel.delay.fail_with_args(\"Test\")"')
+  end
+
+  task :notify_with_args do
+    run_delayed_job_test('"TestModel.delay.notify_with_args(\"Test\")"')
+  end
+end
+
+def run_delayed_job_test(command)
+  fork do
+    system("rake jobs:work")
+  end
+  system("rails runner #{command}")
+  Process.wait
+end

data/features/fixtures/docker-compose.yml

@@ -1,4 +1,4 @@
-version: '3.4'
+version: '3.6'
 services:
   # dep for job systems
   redis:
@@ -11,8 +11,7 @@ services:
     build:
       context: plain
       args:
-        - RUBY_VERSION
-        - APP_PATH
+        - RUBY_TEST_VERSION
     environment:
       - BUGSNAG_API_KEY
       - http_proxy
@@ -38,12 +37,16 @@ services:
       - BUGSNAG_TIMEOUT
       - CALLBACK_INITIATOR
     restart: "no"
+    networks:
+      default:
+        aliases:
+          - plain
 
   delayed_job:
     build:
       context: delayed_job
       args:
-        RUBY_VERSION: 2.5
+        RUBY_TEST_VERSION: 2.5
     environment:
       - BUGSNAG_API_KEY
       - http_proxy
@@ -73,29 +76,25 @@ services:
     build:
       context: rack1
       args:
-        - RUBY_VERSION
+        - RUBY_TEST_VERSION
     environment:
       - endpoint
-    ports:
-      - "3001:3000"
     restart: "no"
+
   rack2:
     build:
       context: rack2
       args:
-        - RUBY_VERSION
+        - RUBY_TEST_VERSION
     environment:
       - endpoint
-    ports:
-      - "3002:3000"
     restart: "no"
 
   rails3:
     build:
       context: rails3
       args:
-        - RUBY_VERSION
-        - APP_PATH
+        - RUBY_TEST_VERSION
     environment:
       - BUGSNAG_API_KEY
       - http_proxy
@@ -122,17 +121,13 @@ services:
       - CALLBACK_INITIATOR
       - SQL_ONLY_BREADCRUMBS
       - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
-    ports:
-      - target: 3000
-        published: 61283
     restart: "no"
 
   rails4:
     build:
       context: rails4
       args:
-        - RUBY_VERSION
-        - APP_PATH
+        - RUBY_TEST_VERSION
     depends_on:
       - mongo
     environment:
@@ -161,17 +156,13 @@ services:
       - CALLBACK_INITIATOR
       - SQL_ONLY_BREADCRUMBS
       - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
-    ports:
-      - target: 3000
-        published: 61284
     restart: "no"
 
   rails5:
     build:
       context: rails5
       args:
-        - RUBY_VERSION
-        - APP_PATH
+        - RUBY_TEST_VERSION
     depends_on:
       - mongo
     environment:
@@ -200,17 +191,15 @@ services:
       - CALLBACK_INITIATOR
       - SQL_ONLY_BREADCRUMBS
       - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
-    ports:
-      - target: 3000
-        published: 61285
     restart: "no"
 
   rails6:
     build:
       context: rails6
       args:
-        - RUBY_VERSION
-        - APP_PATH
+        - RUBY_TEST_VERSION
+    depends_on:
+      - mongo
     environment:
       - BUGSNAG_API_KEY
       - http_proxy
@@ -237,17 +226,17 @@ services:
       - CALLBACK_INITIATOR
       - SQL_ONLY_BREADCRUMBS
       - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
-    ports:
-      - target: 3000
-        published: 61286
     restart: "no"
+    networks:
+      default:
+        aliases:
+          - rails6
 
   resque:
     build:
       context: resque
       args:
-        - RUBY_VERSION
-        - APP_PATH
+        - RUBY_TEST_VERSION
     depends_on:
       - redis
     environment:
@@ -258,8 +247,7 @@ services:
     build:
       context: sidekiq
       args:
-        - RUBY_VERSION
-        - APP_PATH
+        - RUBY_TEST_VERSION
         - SIDEKIQ_VERSION
     depends_on:
       - redis
@@ -292,20 +280,20 @@ services:
     build:
       context: sinatra1
       args:
-        - RUBY_VERSION
+        - RUBY_TEST_VERSION
     environment:
       - endpoint
-    ports:
-      - "3006:3000"
     restart: "no"
 
   sinatra2:
     build:
       context: sinatra2
       args:
-        - RUBY_VERSION
+        - RUBY_TEST_VERSION
     environment:
       - endpoint
-    ports:
-      - "3007:3000"
     restart: "no"
+
+networks:
+  default:
+    name: ${NETWORK_NAME}