minitest_rollbar 0.2.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9b2051548b4953111f13e58d930a87dfdf8eea18
-  data.tar.gz: d08d68ff4a90fc65d991789af15ad63a6e07a5f0
+SHA256:
+  metadata.gz: c9610c9e587b99d002297b5a35cd47ff746b26918fe284ace66c5ea3ac711f76
+  data.tar.gz: 78cc79d7cbd79c6a03d87e73ea5070d3c8a675e4d45805b9c75957fa6cce8a92
 SHA512:
-  metadata.gz: db12c5079c8250081b4f968bf900196535653ec9598dfc6ec90db0d502d784221940ad80ebe3d8e3440a8355ee413098aea9eb9a97707bea2b860f232baa6d5a
-  data.tar.gz: 16cceac41e0442b16a840a7588ce97f798efaea8dcf16b55fc1daf0a9ae1d521c64542d7b1cd255fb3352d428dc81c47b6dd147868c0197fe351b806a1f6386b
+  metadata.gz: f59643be2d588a7466b40cd5a8afc68cda0701ebc05477af027c0387610542e17919c2c6f6f9d8d056f386d7db19791fca7fffe138987706dbea83fe8257d264
+  data.tar.gz: 35a5a643b94a4809ae4dd71bc9f779d2f855e22c8d5110632d954ec46b44f97bb773623f5b0ff7163b032b2eca5f2fe46c9f68249534f524d9dc0c07835b20cc

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org' do
+  gem 'appraisal', '>= 2.3', '< 3'
+  gem 'bundler', '>= 1.17.3', '< 3'
+  gem 'minitest', '>= 5.8', '< 6'
+  gem 'mocha', '>= 1.11', '< 2'
+  gem 'rake', '>= 13', '< 14'
+  gem 'rubocop', '>= 0.91', '< 1'
+  gem 'rubocop-minitest', '>= 0.10', '< 1'
+  gem 'simplecov', '>= 0.18', '< 1', group: :test, require: false
+end
+
+gemspec

data/LICENSE.txt

@@ -1,22 +1,20 @@
-Copyright (c) 2016, AppFolio, Inc.
-All rights reserved.
+Copyright (c) 2016-2020 AppFolio inc
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,42 +1,52 @@
-# Minitest-rollbar
+# MinitestRollbar
 
-Minitest-rollbar is a gem to log test exceptions to rollbar. This is useful in
-a CI environment to gather statistics on common exceptions that could indicate
-infrastructer related issues.
+minitest_rollbar is a gem to log test exceptions to rollbar. This is useful in a CI environment to gather statistics on
+common exceptions that could indicate infrastructer related issues.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'minitest_rollbar'
+  gem 'minitest_rollbar'
 ```
 
 And then execute:
 
-    $ bundle
+```bash
+  $ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install minitest_rollbar
+```bash
+  $ gem install minitest_rollbar
+```
 
 ## Usage
 
-Require necessary files on test_helper:
-
-    require 'minitest_rollbar'
+Require necessary files in the test_helper:
 
-Set up authentication token by:
+```ruby
+  require 'minitest_rollbar'
+```
 
-    MinitestRollbar.access_token = {YOUR_TOKEN}
+Get a reporter with access_token and ssl policy using:
 
-By default we try to group occurrence by string returned by exception.inspect (Concatenate exception class name and message). We generate a fingerprint for that. To use rollbar's [default](https://rollbar.com/docs/grouping-algorithm/) default grouping algorithm, do
+```ruby
+  MinitestRollbar::RollbarReporter.new(rollbar_config: { verify_ssl_peer: false, access_token: 'whatever' })
+```
 
-    MinitestRollbar.use_default_grouping = true
+By default, occurrences are grouped by string and returned by exception.inspect (Concatenate exception class name and
+message). We generate a fingerprint for that. To use rollbar's [default](https://rollbar.com/docs/grouping-algorithm/)
+grouping algorithm use:
 
+```ruby
+  MinitestRollbar.use_default_grouping = true
+```
 
 ## License
 
-This gem is available under the Simplified BSD License.
+This gem is available under the MIT License.
 
-* Copyright (c), 2016, AppFolio, Inc.
+* Copyright (c), 2016-2020, AppFolio, Inc.

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task default: :test

data/lib/minitest_rollbar.rb

@@ -1,2 +1,8 @@
-require 'minitest_rollbar/reporters'
-require 'minitest_rollbar/version'
+# frozen_string_literal: true
+
+require 'rollbar'
+require 'minitest/reporters'
+
+module MinitestRollbar
+  autoload :RollbarReporter, 'minitest_rollbar/rollbar_reporter'
+end

data/lib/minitest_rollbar/{reporters.rb → rollbar_reporter.rb}

@@ -1,46 +1,41 @@
-require 'rollbar'
-require 'minitest/reporters'
+# frozen_string_literal: true
 
 module MinitestRollbar
-  class << self
-    attr_accessor :access_token
+  class RollbarReporter < Minitest::Reporters::BaseReporter
     attr_accessor :use_default_grouping
-  end
 
-  class RollbarReporter < Minitest::Reporters::BaseReporter
     def initialize(options = {})
-      super
+      @rollbar_config = options.delete(:rollbar_config) || {}
+
+      raise StandardError.new('Must set rollbar access token') if @rollbar_config[:access_token].nil?
+
+      super(options)
+
       @sequential_exception_count = 0
-      # Inspect will return ExceptionType + Message.
-      # E.g #<Selenium::WebDriver::Error::NoSuchWindowError: Window not found. The browser window may have been closed.>
-      # Use this as a criteria for log batch grouping
+      @use_default_grouping = false
       @previous_exception_inspect_result = nil
       @previous_exception = nil
 
-      raise 'Must set rollbar access token' if MinitestRollbar.access_token.nil?
-      Rollbar.configure do |config|
-        config.access_token = MinitestRollbar.access_token
-        config.verify_ssl_peer = false
-      end
+      # Rollbar global setting, notifier instance won't report if this is not set
+      Rollbar.configuration.enabled = true
     end
 
     def record(result)
       super
       if result.error?
         current_exception = result.failure.exception
-        current_exception_inspect_result = current_exception.inspect
 
         if @previous_exception_inspect_result.nil?
           record_new_error(current_exception)
-        elsif current_exception_inspect_result == @previous_exception_inspect_result
+        elsif current_exception.inspect == @previous_exception_inspect_result
           increment_error_counting
         else # New exception
-          report_error_to_rollbar notifier
+          report_error_to_rollbar(notifier)
           record_new_error current_exception
         end
       else
         unless @previous_exception.nil?
-          report_error_to_rollbar notifier
+          report_error_to_rollbar(notifier)
           reset_error_counting
         end
       end
@@ -48,18 +43,39 @@ module MinitestRollbar
 
     def report
       super
-      if @sequential_exception_count > 0
-        report_error_to_rollbar notifier
+      if @sequential_exception_count.positive?
+        report_error_to_rollbar(notifier)
         reset_error_counting
       end
     end
 
     private
 
+    def git_commit_hash
+      ENV['CIRCLE_SHA1']
+    end
+
+    def build_config_name
+      ENV['CIRCLE_JOB']
+    end
+
     def notifier
-      MinitestRollbar.use_default_grouping.nil? ?
-          Rollbar.scope({count: @sequential_exception_count,  fingerprint: @previous_exception_inspect_result}):
-          Rollbar.scope({count: @sequential_exception_count})
+      scope.merge!(fingerprint: @previous_exception_inspect_result) unless @use_default_grouping
+
+      rollbar_notifier = Rollbar.scope(scope)
+
+      @rollbar_config.each { |key, value| rollbar_notifier.configuration.send("#{key}=", value) }
+
+      rollbar_notifier
+    end
+
+    def scope
+      @scope ||= {
+        environment: 'PossibleInfraFlaky',
+        count: @sequential_exception_count,
+        commit_hash: git_commit_hash,
+        build_config: build_config_name
+      }
     end
 
     def report_error_to_rollbar(notifier)

data/lib/minitest_rollbar/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MinitestRollbar
-  VERSION = '0.2.4'.freeze
+  VERSION = '1.0.0'
 end

data/minitest_rollbar.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'lib/minitest_rollbar/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'minitest_rollbar'
+  spec.version               = MinitestRollbar::VERSION
+  spec.platform              = Gem::Platform::RUBY
+  spec.authors               = ['AppFolio']
+  spec.email                 = ['dev@appfolio.com']
+  spec.summary               = 'A minitest reporter that logs test exceptions to Rollbar.'
+  spec.description           = spec.summary
+  spec.homepage              = 'https://github.com/appfolio/minitest_rollbar'
+  spec.licenses              = ['MIT']
+  spec.files                 = Dir['**/*'].select { |f| f[%r{^(lib/|Gemfile$|Rakefile|LICENSE.*|README.*|.*gemspec)}] }
+  spec.test_files            = spec.files.grep(%r{^(test)/})
+  spec.require_paths         = ['lib']
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.add_dependency('minitest-reporters', ['>= 1', '< 2'])
+  spec.add_dependency('rollbar', ['>= 2', '< 4'])
+end

metadata

@@ -1,88 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: minitest_rollbar
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.0.0
 platform: ruby
 authors:
-- Yuesong Wang
-autorequire: 
+- AppFolio
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rollbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
-description: 
+        version: '4'
+description: A minitest reporter that logs test exceptions to Rollbar.
 email:
-- wangyuesong0@qq.com
+- dev@appfolio.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
 - lib/minitest_rollbar.rb
-- lib/minitest_rollbar/reporters.rb
+- lib/minitest_rollbar/rollbar_reporter.rb
 - lib/minitest_rollbar/version.rb
-homepage: https://github.com/appfolio/minitest-rollbar
+- minitest_rollbar.gemspec
+homepage: https://github.com/appfolio/minitest_rollbar
 licenses:
-- BSD-2-Clause
-metadata: {}
-post_install_message: 
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,9 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: A minitest reporter that logs testexceptions to Rollbar.
+summary: A minitest reporter that logs test exceptions to Rollbar.
 test_files: []