test-prof 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d382abde5291f54f1168e9403e3151aaafbe6e6e7409de394169169a0eca19fe
-  data.tar.gz: 68037c8c7d819c6e68d7e8d4a4291471101539a6239f452e630de5ea0a4648d6
+  metadata.gz: 65bd3447c63c3e7c037707ebd0f637831ccf0c98af1b0b3d9bf0a6fa72c56b11
+  data.tar.gz: d6af1b43e6924c67ef4c2297602ef641377584f3282eafc236e48eb951e04b68
 SHA512:
-  metadata.gz: fe73709e9e6d6e609f4a0f705d2de0dbab37daecffeb1bac91a4b1a7585a9f81bc656489e9b84d43ad5a9dd04be93a5b9b1020eecd370cbbfee2d2c2fbc862ce
-  data.tar.gz: 91ff9f2c02b86260c9d0d88b834775528007b05eefa3fb00ba28ce9464dbfc615ae7ddde33f2d7544bfc048602687da078b6d01bd38038609b1ca33bb83500fe
+  metadata.gz: 2eae07fcbce70eb7598b92fc578530ed5e20edfb3d7752c672740d44aa13f5d925005500aa26e83ce004c0b2ba128b0091362c39771b67e12d352360aacc2081
+  data.tar.gz: 213858acbdaa8d5e2e6e1fcdd99ca952a044949d23846f631a34513d379ce583013c13ed76c0303c8bd8fec777f44b99bf992e8937598d22bf4110cedb408eb6

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## master
 
+## 0.8.0 (2019-04-12) 🚀
+
+- **Ruby 2.4+ is requiered** ([@palkan][])
+
+- **RSpec 3.5+ is requiered for RSpec features** ([@palkan][])
+
+- Make `before_all` compatible with [`isolator`](https://github.com/palkan/isolator). ([@palkan][])
+
+- Add `with_logging` and `with_ar_logging` helpers to logging recipe. ([@palkan][])
+
+- Make `before_all` for Active Record `lock_thread` aware. ([@palkan][])
+
+  `before_all` can went crazy if you open multiple connections within it
+  (since it tracks the number of open transactions).
+  Rails 5+ `lock_thread` feature only locks the connection thread in
+  `before`/`setup` hook thus making it possible to have multiple connections/transactions
+  in `before_all` (e.g. performing jobs with Active Job async adapter).
+
 ## 0.7.5 (2019-02-22)
 
 - Make `let_it_be` and `before_all` work with `include_context`. ([@palkan][])
@@ -58,7 +76,7 @@ Add ability to specify custom exclusions through `config.custom_exclusions`, e.g
 
 ```ruby
 TestProf::RubyProf.configure do |config|
-  config.custom_exclusions = { User => %i[save save!] }
+  config.custom_exclusions = {User => %i[save save!]}
 end
 ```
 
@@ -161,7 +179,7 @@ LOG=all rspec
 Or per example (group):
 
 ```ruby
-it 'does smth weird', :log do
+it "does smth weird", :log do
   # ...
 end
 ```

data/README.md

@@ -33,9 +33,11 @@ Of course, we have some [solutions](https://test-prof.evilmartians.io/#/?id=reci
 
 Supported Ruby versions:
 
-- Ruby (MRI) >= 2.3.0 (**NOTE:** for Ruby 2.2 use TestProf < 0.7.0)
+- Ruby (MRI) >= 2.4.0 (**NOTE:** for Ruby 2.2 use TestProf < 0.7.0 or Ruby 2.3 use TestProf ~> 0.7.0)
 
-- JRuby >= 9.1.0.0
+- JRuby >= 9.1.0.0 (**NOTE:** refinements-dependent features might require 9.2.7+)
+
+Supported RSpec version (for RSpec features only): >= 3.5.0 (for older RSpec versions use TestProf < 0.8.0).
 
 <a href="https://evilmartians.com/">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
@@ -62,7 +64,7 @@ Add `test-prof` gem to your application:
 
 ```ruby
 group :test do
-  gem 'test-prof'
+  gem "test-prof"
 end
 ```
 

data/lib/minitest/base_reporter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'minitest'
-require 'test_prof/logging'
+require "minitest"
+require "test_prof/logging"
 
 module Minitest
   module TestProf
@@ -15,17 +15,23 @@ module Minitest
         inject_to_minitest_reporters if defined? Minitest::Reporters
       end
 
-      def start; end
+      def start
+      end
 
-      def prerecord(group, example); end
+      def prerecord(group, example)
+      end
 
-      def before_test(test); end
+      def before_test(test)
+      end
 
-      def record(*); end
+      def record(*)
+      end
 
-      def after_test(test); end
+      def after_test(test)
+      end
 
-      def report; end
+      def report
+      end
 
       private
 
@@ -33,22 +39,22 @@ module Minitest
         # Minitest::Result (>= 5.11) has `source_location` method
         return group.source_location if group.respond_to?(:source_location)
         if group.is_a? Class
-          suite = group.public_instance_methods.select { |mtd| mtd.to_s.match /^test_/ }
+          suite = group.public_instance_methods.select { |mtd| mtd.to_s.match(/^test_/) }
           name = suite.find { |mtd| mtd.to_s == example }
           group.instance_method(name).source_location
         else
-          suite = group.methods.select { |mtd| mtd.to_s.match /^test_/ }
+          suite = group.methods.select { |mtd| mtd.to_s.match(/^test_/) }
           name = suite.find { |mtd| mtd.to_s == group.name }
           group.method(name).source_location
         end
       end
 
       def location_with_line_number(group, example = nil)
-        File.expand_path(location(group, example).join(':')).gsub(Dir.getwd, '.')
+        File.expand_path(location(group, example).join(":")).gsub(Dir.getwd, ".")
       end
 
       def location_without_line_number(group, example = nil)
-        File.expand_path(location(group, example).first).gsub(Dir.getwd, '.')
+        File.expand_path(location(group, example).first).gsub(Dir.getwd, ".")
       end
 
       def inject_to_minitest_reporters

data/lib/minitest/test_prof_plugin.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require 'test_prof/event_prof/minitest'
-require 'test_prof/factory_doctor/minitest'
+require "test_prof/event_prof/minitest"
+require "test_prof/factory_doctor/minitest"
 
 module Minitest # :nodoc:
   module TestProf # :nodoc:
     def self.configure_options(options = {})
       options.tap do |opts|
-        opts[:event]        = ENV['EVENT_PROF'] if ENV['EVENT_PROF']
-        opts[:rank_by]      = ENV['EVENT_PROF_RANK'].to_sym if ENV['EVENT_PROF_RANK']
-        opts[:top_count]    = ENV['EVENT_PROF_TOP'].to_i if ENV['EVENT_PROF_TOP']
-        opts[:per_example]  = true if ENV['EVENT_PROF_EXAMPLES']
-        opts[:fdoc]         = true if ENV['FDOC']
+        opts[:event]        = ENV["EVENT_PROF"] if ENV["EVENT_PROF"]
+        opts[:rank_by]      = ENV["EVENT_PROF_RANK"].to_sym if ENV["EVENT_PROF_RANK"]
+        opts[:top_count]    = ENV["EVENT_PROF_TOP"].to_i if ENV["EVENT_PROF_TOP"]
+        opts[:per_example]  = true if ENV["EVENT_PROF_EXAMPLES"]
+        opts[:fdoc]         = true if ENV["FDOC"]
       end
     end
   end
@@ -29,7 +29,7 @@ module Minitest # :nodoc:
     opts.on "--event-prof-per-example", TrueClass, "Includes examples metrics to results" do |flag|
       options[:per_example] = flag
     end
-    opts.on "--factory-doctor", TrueClass, 'Enable Factory Doctor for your examples' do |flag|
+    opts.on "--factory-doctor", TrueClass, "Enable Factory Doctor for your examples" do |flag|
       options[:fdoc] = flag
     end
   end

data/lib/test_prof.rb

@@ -114,13 +114,13 @@ module TestProf
     def with_timestamps(path)
       return path unless config.timestamps?
       timestamps = "-#{now.to_i}"
-      "#{path.sub(/\.\w+$/, '')}#{timestamps}#{::File.extname(path)}"
+      "#{path.sub(/\.\w+$/, "")}#{timestamps}#{::File.extname(path)}"
     end
 
     def with_report_suffix(path)
       return path if config.report_suffix.nil?
 
-      "#{path.sub(/\.\w+$/, '')}-#{config.report_suffix}#{::File.extname(path)}"
+      "#{path.sub(/\.\w+$/, "")}-#{config.report_suffix}#{::File.extname(path)}"
     end
 
     def notify_spring_detected
@@ -147,7 +147,7 @@ module TestProf
       @color = true
       @output_dir = "tmp/test_prof"
       @timestamps = false
-      @report_suffix = ENV['TEST_PROF_REPORT']
+      @report_suffix = ENV["TEST_PROF_REPORT"]
     end
 
     def color?

data/lib/test_prof/any_fixture.rb

@@ -27,7 +27,7 @@ module TestProf
 
         ts = TestProf.now
         store[key] = yield
-        stats[key] = { time: TestProf.now - ts, hit: 0 }
+        stats[key] = {time: TestProf.now - ts, hit: 0}
         store[key]
       end
 
@@ -91,7 +91,7 @@ module TestProf
 
         msgs << format(
           "%#{first_column}s  %12s  %9s  %12s",
-          'key', 'build time', 'hit count', 'saved time'
+          "key", "build time", "hit count", "saved time"
         )
 
         msgs << ""
@@ -144,6 +144,6 @@ module TestProf
       end
     end
 
-    self.reporting_enabled = ENV['ANYFIXTURE_REPORT'] == '1'
+    self.reporting_enabled = ENV["ANYFIXTURE_REPORT"] == "1"
   end
 end

data/lib/test_prof/before_all.rb

@@ -18,6 +18,11 @@ module TestProf
       def begin_transaction
         raise AdapterMissing if adapter.nil?
         adapter.begin_transaction
+        yield
+      end
+
+      def within_transaction
+        yield
       end
 
       def rollback_transaction
@@ -33,3 +38,7 @@ if defined?(::ActiveRecord::Base)
 
   TestProf::BeforeAll.adapter = TestProf::BeforeAll::Adapters::ActiveRecord
 end
+
+if defined?(::Isolator)
+  require "test_prof/before_all/isolator"
+end

data/lib/test_prof/before_all/adapters/active_record.rb

@@ -12,6 +12,7 @@ module TestProf
       module ActiveRecord
         class << self
           def begin_transaction
+            lock_thread!
             ::ActiveRecord::Base.connection.begin_transaction(joinable: false)
           end
 
@@ -23,6 +24,17 @@ module TestProf
             end
             ::ActiveRecord::Base.connection.rollback_transaction
           end
+
+          private
+
+          # Make sure ActiveRecord uses locked thread.
+          # It only gets locked in `before` / `setup` hook,
+          # thus using thread in `before_all` (e.g. ActiveJob async adapter)
+          # might lead to leaking connections
+          def lock_thread!
+            return unless ::ActiveRecord::Base.connection.pool.respond_to?(:lock_thread=)
+            ::ActiveRecord::Base.connection.pool.lock_thread = true
+          end
         end
       end
     end

data/lib/test_prof/before_all/isolator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TestProf
+  module BeforeAll
+    # Disable Isolator within before_all blocks
+    module Isolator
+      def begin_transaction(*)
+        ::Isolator.disable { super }
+      end
+
+      def within_transaction(*)
+        ::Isolator.disable { super }
+      end
+    end
+  end
+end
+
+TestProf::BeforeAll.singleton_class.prepend(TestProf::BeforeAll::Isolator)

data/lib/test_prof/cops/rspec/aggregate_failures.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require 'test_prof/utils'
+require "rubocop"
+require "test_prof/utils"
 
 module RuboCop
   module Cop
@@ -38,7 +38,7 @@ module RuboCop
         class << self
           def supported?
             return @supported if instance_variable_defined?(:@supported)
-            @supported = TestProf::Utils.verify_gem_version('rubocop', at_least: '0.51.0')
+            @supported = TestProf::Utils.verify_gem_version("rubocop", at_least: "0.51.0")
 
             unless @supported
               warn "RSpec/AggregateFailures cop requires RuboCop >= 0.51.0. Skipping"
@@ -62,7 +62,7 @@ module RuboCop
           add_offense(
             node,
             location: :expression,
-            message: 'Use :aggregate_failures instead of several one-liners.'
+            message: "Use :aggregate_failures instead of several one-liners."
           )
         end
 
@@ -140,7 +140,7 @@ module RuboCop
           %(#{method_name} "works", :aggregate_failures do)
         end
 
-        def body_from(node, base_indent = '')
+        def body_from(node, base_indent = "")
           method, _args, body = *node
           body_source = method.method_name == :its ? body_from_its(method, body) : body.source
           "#{base_indent}#{indent}#{body_source}"
@@ -162,7 +162,7 @@ module RuboCop
         end
 
         def indent
-          @indent ||= " " * (config.for_cop('IndentationWidth')['Width'] || 2)
+          @indent ||= " " * (config.for_cop("IndentationWidth")["Width"] || 2)
         end
       end
     end

data/lib/test_prof/event_prof.rb

@@ -31,19 +31,19 @@ module TestProf
     class Configuration
       # Map of supported instrumenters
       INSTRUMENTERS = {
-        active_support: 'ActiveSupport'
+        active_support: "ActiveSupport"
       }.freeze
 
       attr_accessor :instrumenter, :top_count, :per_example,
                     :rank_by, :event
 
       def initialize
-        @event = ENV['EVENT_PROF']
+        @event = ENV["EVENT_PROF"]
         @instrumenter = :active_support
-        @top_count = (ENV['EVENT_PROF_TOP'] || 5).to_i
-        @per_example = ENV['EVENT_PROF_EXAMPLES'] == '1'
-        @rank_by = (ENV['EVENT_PROF_RANK'] || :time).to_sym
-        @stamp = ENV['EVENT_PROF_STAMP']
+        @top_count = (ENV["EVENT_PROF_TOP"] || 5).to_i
+        @per_example = ENV["EVENT_PROF_EXAMPLES"] == "1"
+        @rank_by = (ENV["EVENT_PROF_RANK"] || :time).to_sym
+        @stamp = ENV["EVENT_PROF_STAMP"]
 
         RSpecStamp.config.tags = @stamp if stamp?
       end

data/lib/test_prof/event_prof/custom_events/factory_create.rb

@@ -26,7 +26,7 @@ module TestProf::EventProf::CustomEvents
           res =
             if @depth == 1
               ActiveSupport::Notifications.instrument(
-                'factory.create',
+                "factory.create",
                 name: factory
               ) { yield }
             else

data/lib/test_prof/event_prof/custom_events/sidekiq_inline.rb

@@ -22,7 +22,7 @@ module TestProf::EventProf::CustomEvents
           res =
             if @depth == 1
               ActiveSupport::Notifications.instrument(
-                'sidekiq.inline'
+                "sidekiq.inline"
               ) { yield }
             else
               yield
@@ -38,7 +38,7 @@ end
 
 TestProf::EventProf::CustomEvents.register("sidekiq.inline") do
   if TestProf.require(
-    'sidekiq/testing',
+    "sidekiq/testing",
     <<~MSG
       Failed to load Sidekiq.
 

data/lib/test_prof/event_prof/custom_events/sidekiq_jobs.rb

@@ -16,7 +16,7 @@ module TestProf::EventProf::CustomEvents
 
       def track
         ActiveSupport::Notifications.instrument(
-          'sidekiq.jobs'
+          "sidekiq.jobs"
         ) { yield }
       end
     end
@@ -25,7 +25,7 @@ end
 
 TestProf::EventProf::CustomEvents.register("sidekiq.jobs") do
   if TestProf.require(
-    'sidekiq/testing',
+    "sidekiq/testing",
     <<~MSG
       Failed to load Sidekiq.
 

data/lib/test_prof/event_prof/instrumentations/active_support.rb

@@ -6,7 +6,7 @@ module TestProf::EventProf
     module ActiveSupport
       class << self
         def subscribe(event)
-          raise ArgumentError, 'Block is required!' unless block_given?
+          raise ArgumentError, "Block is required!" unless block_given?
 
           ::ActiveSupport::Notifications.subscribe(event) do |_event, start, finish, *_args|
             yield (finish - start)

data/lib/test_prof/event_prof/minitest.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'minitest/base_reporter'
-require 'minitest/event_prof_formatter'
+require "minitest/base_reporter"
+require "minitest/event_prof_formatter"
 
 module Minitest
   module TestProf
@@ -10,7 +10,7 @@ module Minitest
         super
         @profiler = configure_profiler(options)
 
-        log :info, "EventProf enabled (#{@profiler.events.join(', ')})"
+        log :info, "EventProf enabled (#{@profiler.events.join(", ")})"
 
         @formatter = EventProfFormatter.new(@profiler)
         @current_group = nil
@@ -45,7 +45,7 @@ module Minitest
         end
 
         @current_example = {
-          name: example.gsub(/^test_(?:\d+_)?/, ''),
+          name: example.gsub(/^test_(?:\d+_)?/, ""),
           location: location_with_line_number(group, example)
         }