test-prof 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42dd5bfd5d77f676d37c3cf9ff88d366cf19b459da3736d891d974f31dcaef97
-  data.tar.gz: 7b99baeb4d93f86b11bb34c3a43fe2bb2f2b75487cd66190fcd2decc3d8ed532
+  metadata.gz: 65bd3447c63c3e7c037707ebd0f637831ccf0c98af1b0b3d9bf0a6fa72c56b11
+  data.tar.gz: d6af1b43e6924c67ef4c2297602ef641377584f3282eafc236e48eb951e04b68
 SHA512:
-  metadata.gz: 12a11804603dc80ef72ecfae63ec6f33f172c63bd447a9032df131cf33265c02926871d55eaabb08fc74d61de211d6bd78727b44802d6a488b20c9a1fee854cc
-  data.tar.gz: a826158093a4f66433c3b521311f2f3028f526d1864f2106c2294eb97e22b996da3328bebaed0d247b51baf9905fa117a8b75472b81119ffda2c6ebb660566a2
+  metadata.gz: 2eae07fcbce70eb7598b92fc578530ed5e20edfb3d7752c672740d44aa13f5d925005500aa26e83ce004c0b2ba128b0091362c39771b67e12d352360aacc2081
+  data.tar.gz: 213858acbdaa8d5e2e6e1fcdd99ca952a044949d23846f631a34513d379ce583013c13ed76c0303c8bd8fec777f44b99bf992e8937598d22bf4110cedb408eb6

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## 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][])
+
+  Fixes [#117](https://github.com/palkan/test-prof/issues/117)
+
 ## 0.7.4 (2019-02-16)
 
 - Add JSON report support for StackProf. ([@palkan][])
@@ -52,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
 ```
 
@@ -155,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/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/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/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/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/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)
         }
 

data/lib/test_prof/event_prof/rspec.rb

@@ -14,15 +14,13 @@ module TestProf
         example_group_started
         example_group_finished
         example_started
-        example_failed
-        example_passed
-        example_pending
+        example_finished
       ].freeze
 
       def initialize
         @profiler = EventProf.build
 
-        log :info, "EventProf enabled (#{@profiler.events.join(', ')})"
+        log :info, "EventProf enabled (#{@profiler.events.join(", ")})"
       end
 
       def example_group_started(notification)
@@ -43,11 +41,6 @@ module TestProf
         @profiler.example_finished notification.example
       end
 
-      # NOTE: RSpec < 3.4.0 doesn't have example_finished event
-      alias example_passed example_finished
-      alias example_failed example_finished
-      alias example_pending example_finished
-
       def print
         @profiler.each(&method(:report))
       end
@@ -145,8 +138,8 @@ module TestProf
 end
 
 # Register EventProf listener
-TestProf.activate('EVENT_PROF') do
-  TestProf::EventProf::CustomEvents.activate_all(ENV['EVENT_PROF'])
+TestProf.activate("EVENT_PROF") do
+  TestProf::EventProf::CustomEvents.activate_all(ENV["EVENT_PROF"])
 
   RSpec.configure do |config|
     listener = nil

data/lib/test_prof/event_prof.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require "test_prof/rspec_stamp"
 require "test_prof/event_prof/profiler"
 require "test_prof/event_prof/instrumentations/active_support"
@@ -30,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
@@ -103,5 +104,5 @@ module TestProf
 end
 
 require "test_prof/event_prof/custom_events"
-require "test_prof/event_prof/rspec" if defined?(RSpec::Core)
-require "test_prof/event_prof/minitest" if defined?(Minitest)
+require "test_prof/event_prof/rspec" if TestProf.rspec?
+require "test_prof/event_prof/minitest" if TestProf.minitest?

data/lib/test_prof/factory_bot.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module TestProf # :nodoc: all
-  FACTORY_GIRL_NAMES = { 'factory_bot' => '::FactoryBot', 'factory_girl' => '::FactoryGirl' }.freeze
+  FACTORY_GIRL_NAMES = {"factory_bot" => "::FactoryBot", "factory_girl" => "::FactoryGirl"}.freeze
 
   FACTORY_GIRL_NAMES.find do |name, cname|
     TestProf.require(name) do

data/lib/test_prof/factory_default.rb

@@ -38,7 +38,7 @@ module TestProf
 
       def register(name, obj, **options)
         options[:preserve_traits] = true if FactoryDefault.preserve_traits
-        store[name] = { object: obj, **options }
+        store[name] = {object: obj, **options}
         obj
       end
 

data/lib/test_prof/factory_doctor/minitest.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'minitest/base_reporter'
-require 'test_prof/ext/float_duration'
+require "minitest/base_reporter"
+require "test_prof/ext/float_duration"
 
 module Minitest
   module TestProf # :nodoc:
@@ -47,7 +47,7 @@ module Minitest
         }
 
         @example_groups[group] << {
-          description: example.name.gsub(/^test_(?:\d+_)?/, ''),
+          description: example.name.gsub(/^test_(?:\d+_)?/, ""),
           location: location_with_line_number(example),
           factories: result.count,
           time: result.time
@@ -87,7 +87,7 @@ module Minitest
       private
 
       def pluralize_records(count)
-        count == 1 ? '1 record' : "#{count} records"
+        count == 1 ? "1 record" : "#{count} records"
       end
     end
   end

data/lib/test_prof/factory_doctor/rspec.rb

@@ -12,9 +12,7 @@ module TestProf
 
       NOTIFICATIONS = %i[
         example_started
-        example_passed
-        example_failed
-        example_pending
+        example_finished
       ].freeze
 
       def initialize
@@ -45,11 +43,6 @@ module TestProf
         @time += result.time
       end
 
-      # NOTE: RSpec < 3.4.0 doesn't have example_finished event
-      alias example_passed example_finished
-      alias example_failed example_finished
-      alias example_pending example_finished
-
       def print
         return log(:info, SUCCESS_MESSAGE) if @example_groups.empty?
 
@@ -122,7 +115,7 @@ module TestProf
 end
 
 # Register FactoryDoctor listener
-TestProf.activate('FDOC') do
+TestProf.activate("FDOC") do
   TestProf::FactoryDoctor.init
 
   RSpec.configure do |config|
@@ -138,7 +131,11 @@ TestProf.activate('FDOC') do
     config.after(:suite) { listener&.print }
   end
 
-  RSpec.shared_context "factory_doctor:ignore", fd_ignore: true do
+  RSpec.shared_context "factory_doctor:ignore" do
     around(:each) { |ex| TestProf::FactoryDoctor.ignore(&ex) }
   end
+
+  RSpec.configure do |config|
+    config.include_context "factory_doctor:ignore", fd_ignore: true
+  end
 end

data/lib/test_prof/factory_doctor.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require "test_prof/factory_bot"
 require "test_prof/factory_doctor/factory_bot_patch"
 
@@ -44,7 +45,7 @@ module TestProf
       attr_reader :count, :time, :queries_count
 
       # Patch factory lib, init counters
-      def init(event = 'sql.active_record')
+      def init(event = "sql.active_record")
         @event = event
         reset!
 
@@ -56,7 +57,7 @@ module TestProf
 
         subscribe!
 
-        @stamp = ENV['FDOC_STAMP']
+        @stamp = ENV["FDOC_STAMP"]
 
         RSpecStamp.config.tags = @stamp if stamp?
       end
@@ -139,5 +140,5 @@ module TestProf
   end
 end
 
-require "test_prof/factory_doctor/rspec" if defined?(RSpec::Core)
-require "test_prof/factory_doctor/minitest" if defined?(Minitest)
+require "test_prof/factory_doctor/rspec" if TestProf.rspec?
+require "test_prof/factory_doctor/minitest" if TestProf.minitest?

data/lib/test_prof/factory_prof/factory_builders/fabrication.rb

@@ -10,7 +10,7 @@ module TestProf
       class Fabrication
         # Monkey-patch Fabrication
         def self.patch
-          TestProf.require 'fabrication' do
+          TestProf.require "fabrication" do
             ::Fabricate.singleton_class.prepend(FabricationPatch)
           end
         end

data/lib/test_prof/factory_prof/factory_builders/factory_bot.rb

@@ -9,6 +9,24 @@ module TestProf
       # implementation of #patch and #track methods
       # to provide unified interface for all factory-building gems
       class FactoryBot
+        # FactoryBot 5.0 uses strategy classes for associations,
+        # older versions and top-level invocations use Symbols
+        using(Module.new do
+          refine Symbol do
+            def create?
+              self == :create
+            end
+          end
+
+          if defined?(::FactoryBot::Strategy::Create)
+            refine Class do
+              def create?
+                self <= ::FactoryBot::Strategy::Create
+              end
+            end
+          end
+        end)
+
         # Monkey-patch FactoryBot / FactoryGirl
         def self.patch
           TestProf::FactoryBot::FactoryRunner.prepend(FactoryBotPatch) if
@@ -16,7 +34,7 @@ module TestProf
         end
 
         def self.track(strategy, factory, &block)
-          return yield unless strategy == :create
+          return yield unless strategy.create?
           FactoryProf.track(factory, &block)
         end
       end