test-prof 1.0.5 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edd58f04fbf02f8bfa863b2c68e19f26fbdfb95c36bb361d012848f0a4f76790
-  data.tar.gz: 820c00eeaaea782bc89581005ac83cc147551550477519d7dd1a59a212f497c9
+  metadata.gz: 9e1623dde5386ea71184b81cf99eb67ac377613d46b2ebac3ce874164103fcbd
+  data.tar.gz: 1b9fa94cb2616226019cbc57ee8dbefa5c03db8f42f0be277352884ab6dfdb48
 SHA512:
-  metadata.gz: f999f2073374210ef7c2afbedc977c21210f69e6e180fb54f6ce452741db1841b396b9358c9892e85ae972019d7204676d8a906d6a9f1f896c3669249027c935
-  data.tar.gz: 38c1f0d45d386acca3edbbd7c52b9d246f02f030cce0717f2480b2917b003c6f2b3542beb6caac45d8fe432bc69b6a7db1720768297eb4a1588f471727664409
+  metadata.gz: 7eeec86920c82c3afb8b89478b3992bf1750fdacd949913c0a6c18a684bcefb5998880e4da2cecec1c8d5866dcc89b8a16de31e7e881713f8a4707aa08b25fd6
+  data.tar.gz: 793ec788e3cb95c29b8b3b1a9026db05e64d1ae828ca2ce8a180ffc460cf3d653710b2c4356e47d0dbc3aa8a3fd5ea633502fa5c0f0114a467a5dd01ae99b5b5

data/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Change log
 
-## master (unrealeased)
+## master (unreleased)
+
+## 1.0.8 (2022-03-11)
+
+- Restore the lock_thread value after rollback. ([@cou929][])
+
+- Fixes the configuration of a printer for factory_prof runs
+
+- Ensure that defaults are stored in a threadsafe manner
+
+## 1.0.7 (2021-08-30)
+
+- Fix access to `let_it_be` variables in `after(:all)` hook. ([@cbarton][])
+
+- Add support for using the before_all hook with Rails' parallelize feature (using processes). ([@peret][])
+
+Make sure to include `TestProf::BeforeAll::Minitest` before you call `parallelize`.
+
+## 1.0.6 (2021-06-23)
+
+- Fix Spring detection when `DISABLE_SPRING=1` is used. ([@palkan][])
+
+- Make `before_all` in Minitest inheritable. ([@palkan][])
 
 ## 1.0.5 (2021-05-13)
 
@@ -178,7 +200,7 @@ end
 ```
 
 - Print warning when `ActiveRecordSharedConnection` is used in the version of Rails
-supporting `lock_threads` (5.1+). ([@palkan][])
+  supporting `lock_threads` (5.1+). ([@palkan][])
 
 ## 0.9.0 (2019-05-14)
 
@@ -236,20 +258,22 @@ See [changelog](https://github.com/test-prof/test-prof/blob/v0.8.0/CHANGELOG.md)
 [@palkan]: https://github.com/palkan
 [@marshall-lee]: https://github.com/marshall-lee
 [@danielwestendorf]: https://github.com/danielwestendorf
-[@Shkrt]: https://github.com/Shkrt
-[@IDolgirev]: https://github.com/IDolgirev
+[@shkrt]: https://github.com/Shkrt
+[@idolgirev]: https://github.com/IDolgirev
 [@desoleary]: https://github.com/desoleary
 [@rabotyaga]: https://github.com/rabotyaga
-[@Vasfed]: https://github.com/Vasfed
+[@vasfed]: https://github.com/Vasfed
 [@szemek]: https://github.com/szemek
 [@mkldon]: https://github.com/mkldon
 [@dmagro]: https://github.com/dmagro
 [@danielwaterworth]: https://github.com/danielwaterworth
-[@Envek]: https://github.com/Envek
+[@envek]: https://github.com/Envek
 [@tyleriguchi]: https://github.com/tyleriguchi
 [@lostie]: https://github.com/lostie
 [@pirj]: https://github.com/pirj
-[@LynxEyes]: https://github.com/LynxEyes
+[@lynxeyes]: https://github.com/LynxEyes
 [@stefkin]: https://github.com/stefkin
 [@jaimerson]: https://github.com/jaimerson
 [@alexvko]: https://github.com/alexvko
+[@grillermo]: https://github.com/grillermo
+[@cou929]: https://github.com/cou929

data/lib/test_prof/any_fixture/dump/postgresql.rb

@@ -23,7 +23,7 @@ module TestProf
         end
 
         def compile_sql(sql, binds)
-          sql.gsub(/\$\d+/) { binds.shift }
+          sql.gsub(/\$\d+/) { binds.shift.gsub("\n", "' || chr(10) || '") }
         end
 
         def import(path)

data/lib/test_prof/any_fixture/dump/sqlite.rb

@@ -18,7 +18,7 @@ module TestProf
         end
 
         def compile_sql(sql, binds)
-          sql.gsub(/\?/) { binds.shift }
+          sql.gsub(/\?/) { binds.shift.gsub("\n", "' || char(10) || '") }
         end
 
         def import(path)

data/lib/test_prof/any_fixture.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require "test_prof/ext/float_duration"
 require "test_prof/any_fixture/dump"
 

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

@@ -37,6 +37,9 @@ module TestProf
       end
     end
 
+    # avoid instance variable collisions with cats
+    PREFIX_RESTORE_LOCK_THREAD = "@😺"
+
     configure do |config|
       # Make sure ActiveRecord uses locked thread.
       # It only gets locked in `before` / `setup` hook,
@@ -44,8 +47,14 @@ module TestProf
       # might lead to leaking connections
       config.before(:begin) do
         next unless ::ActiveRecord::Base.connection.pool.respond_to?(:lock_thread=)
+        instance_variable_set("#{PREFIX_RESTORE_LOCK_THREAD}_orig_lock_thread", ::ActiveRecord::Base.connection.pool.instance_variable_get(:@lock_thread))
         ::ActiveRecord::Base.connection.pool.lock_thread = true
       end
+
+      config.after(:rollback) do
+        next unless ::ActiveRecord::Base.connection.pool.respond_to?(:lock_thread=)
+        ::ActiveRecord::Base.connection.pool.lock_thread = instance_variable_get("#{PREFIX_RESTORE_LOCK_THREAD}_orig_lock_thread")
+      end
     end
   end
 end

data/lib/test_prof/before_all.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "test_prof"
+
 module TestProf
   # `before_all` helper configuration
   module BeforeAll

data/lib/test_prof/cops/rspec/aggregate_examples/matchers_with_side_effects.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../language"
+require "test_prof/cops/rspec/language"
 
 module RuboCop
   module Cop

data/lib/test_prof/cops/rspec/aggregate_examples/node_matchers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../language"
+require "test_prof/cops/rspec/language"
 
 module RuboCop
   module Cop

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "aggregate_examples/line_range_helpers"
-require_relative "aggregate_examples/metadata_helpers"
-require_relative "aggregate_examples/node_matchers"
+require "test_prof/cops/rspec/aggregate_examples/line_range_helpers"
+require "test_prof/cops/rspec/aggregate_examples/metadata_helpers"
+require "test_prof/cops/rspec/aggregate_examples/node_matchers"
 
-require_relative "aggregate_examples/its"
-require_relative "aggregate_examples/matchers_with_side_effects"
+require "test_prof/cops/rspec/aggregate_examples/its"
+require "test_prof/cops/rspec/aggregate_examples/matchers_with_side_effects"
 
 module RuboCop
   module Cop

data/lib/test_prof/factory_all_stub.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require "test_prof/factory_bot"
 require "test_prof/factory_all_stub/factory_bot_patch"
 

data/lib/test_prof/factory_default.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require "test_prof/factory_bot"
 require "test_prof/factory_default/factory_bot_patch"
 
@@ -31,7 +32,6 @@ module TestProf
         TestProf::FactoryBot::Strategy::Build.prepend StrategyExt
         TestProf::FactoryBot::Strategy::Stub.prepend StrategyExt
 
-        @store = {}
         # default is false to retain backward compatibility
         @preserve_traits = false
       end
@@ -57,12 +57,14 @@ module TestProf
       end
 
       def reset
-        @store.clear
+        store.clear
       end
 
       private
 
-      attr_reader :store
+      def store
+        Thread.current[:testprof_factory_store] ||= {}
+      end
     end
   end
 end

data/lib/test_prof/factory_prof.rb

@@ -100,15 +100,21 @@ module TestProf
       def run
         init
 
-        printer = config.printer
-
         started_at = TestProf.now
 
-        at_exit { printer.dump(result, start_time: started_at) }
+        at_exit do
+          print(started_at)
+        end
 
         start
       end
 
+      def print(started_at)
+        printer = config.printer
+
+        printer.dump(result, start_time: started_at)
+      end
+
       def start
         reset!
         @running = true

data/lib/test_prof/recipes/logging.rb

@@ -24,8 +24,6 @@ module TestProf
           ]
         end
 
-        # rubocop:disable Metrics/CyclomaticComplexity
-        # rubocop:disable Metrics/PerceivedComplexity
         def all_loggables
           return @all_loggables if instance_variable_defined?(:@all_loggables)
 

data/lib/test_prof/recipes/minitest/before_all.rb

@@ -2,6 +2,22 @@
 
 require "test_prof/before_all"
 
+Minitest.singleton_class.prepend(Module.new do
+  attr_reader :previous_klass
+  @previous_klass = nil
+
+  def run_one_method(klass, method_name)
+    return super unless klass.respond_to?(:parallelized) && klass.parallelized
+
+    if @previous_klass && @previous_klass != klass
+      @previous_klass.before_all_executor&.deactivate!
+    end
+    @previous_klass = klass
+
+    super
+  end
+end)
+
 module TestProf
   module BeforeAll
     # Add before_all hook to Minitest: wrap all examples into a transaction and
@@ -9,13 +25,15 @@ module TestProf
     module Minitest # :nodoc: all
       class Executor
         attr_reader :active, :block, :captured_ivars, :teardown_block, :current_test_object,
-          :setup_fixtures
+          :setup_fixtures, :parent
 
         alias_method :active?, :active
         alias_method :setup_fixtures?, :setup_fixtures
 
-        def initialize(setup_fixtures: false, &block)
-          @setup_fixtures = setup_fixtures
+        def initialize(setup_fixtures: false, parent: nil, &block)
+          @parent = parent
+          # Fixtures must be instantiated if any of the executors needs them
+          @setup_fixtures = setup_fixtures || parent&.setup_fixtures
           @block = block
           @captured_ivars = []
         end
@@ -28,7 +46,9 @@ module TestProf
           @current_test_object = test_object
 
           return restore_ivars(test_object) if active?
+
           @active = true
+
           BeforeAll.setup_fixtures(test_object) if setup_fixtures?
           BeforeAll.begin_transaction do
             capture!(test_object)
@@ -36,20 +56,20 @@ module TestProf
         end
 
         def deactivate!
+          return unless active
+
           @active = false
 
-          current_test_object&.instance_eval(&teardown_block) if teardown_block
+          perform_teardown(current_test_object)
 
           @current_test_object = nil
           BeforeAll.rollback_transaction
         end
 
         def capture!(test_object)
-          return unless block
-
           before_ivars = test_object.instance_variables
 
-          test_object.instance_eval(&block)
+          perform_setup(test_object)
 
           (test_object.instance_variables - before_ivars).each do |ivar|
             captured_ivars << [ivar, test_object.instance_variable_get(ivar)]
@@ -64,19 +84,76 @@ module TestProf
             )
           end
         end
+
+        def perform_setup(test_object)
+          parent&.perform_setup(test_object)
+          test_object.instance_eval(&block) if block
+        end
+
+        def perform_teardown(test_object)
+          current_test_object&.instance_eval(&teardown_block) if teardown_block
+          parent&.perform_teardown(test_object)
+        end
       end
 
       class << self
         def included(base)
           base.extend ClassMethods
+
+          base.cattr_accessor :parallelized
+          if base.respond_to?(:parallelize_teardown)
+            base.parallelize_teardown do
+              last_klass = ::Minitest.previous_klass
+              if last_klass&.respond_to?(:parallelized) && last_klass&.parallelized
+                last_klass.before_all_executor&.deactivate!
+              end
+            end
+          end
+
+          if base.respond_to?(:parallelize)
+            base.singleton_class.prepend(Module.new do
+              def parallelize(workers: :number_of_processors, with: :processes)
+                # super.parallelize returns nil when no parallelization is set up
+                if super(workers: workers, with: with).nil?
+                  return
+                end
+
+                case with
+                when :processes
+                  self.parallelized = true
+                when :threads
+                  warn "!!! before_all is not implemented for parallalization with threads and " \
+                    "could work incorrectly"
+                else
+                  warn "!!! tests are using an unknown parallelization strategy and before_all " \
+                    "could work incorrectly"
+                end
+              end
+            end)
+          end
         end
       end
 
       module ClassMethods
-        attr_accessor :before_all_executor
+        attr_writer :before_all_executor
+
+        def before_all_executor
+          return @before_all_executor if instance_variable_defined?(:@before_all_executor)
+
+          @before_all_executor = if superclass.respond_to?(:before_all_executor)
+            superclass.before_all_executor
+          end
+        end
 
         def before_all(setup_fixtures: BeforeAll.config.setup_fixtures, &block)
-          self.before_all_executor = Executor.new(setup_fixtures: setup_fixtures, &block)
+          self.before_all_executor = Executor.new(
+            setup_fixtures: setup_fixtures,
+            parent: before_all_executor,
+            &block
+          )
+
+          # Do not add patches multiple times
+          return if before_all_executor.parent
 
           prepend(Module.new do
             def before_setup
@@ -89,13 +166,13 @@ module TestProf
             def run(*)
               super
             ensure
-              before_all_executor&.deactivate!
+              before_all_executor&.deactivate! unless parallelized
             end
           end)
         end
 
         def after_all(&block)
-          self.before_all_executor ||= Executor.new
+          self.before_all_executor = Executor.new(parent: before_all_executor)
           before_all_executor.teardown(&block)
         end
       end

data/lib/test_prof/recipes/rspec/let_it_be.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "test_prof"
-require_relative "./before_all"
+require "test_prof/recipes/rspec/before_all"
 
 module TestProf
   # Just like `let`, but persist the result for the whole group.
@@ -75,7 +75,7 @@ module TestProf
     # Use uniq prefix for instance variables to avoid collisions
     # We want to use the power of Ruby's unicode support)
     # And we love cats!)
-    PREFIX = RUBY_ENGINE == "jruby" ? "@__jruby_is_not_cat_friendly__" : "@😸"
+    PREFIX = "@😸"
 
     FROZEN_ERROR_HINT = "\nIf you are using `let_it_be`, you may want to pass `reload: true` or `refind: true` modifier to it."
 
@@ -107,7 +107,7 @@ module TestProf
         define_method(identifier) do
           # Trying to detect the context
           # Based on https://github.com/rspec/rspec-rails/commit/7cb796db064f58da7790a92e73ab906ef50b1f34
-          if @__inspect_output.include?("before(:context)") || @__inspect_output.include?("before_all")
+          if /(before|after)\(:context\)/.match?(@__inspect_output) || @__inspect_output.include?("before_all")
             instance_variable_get(:"#{PREFIX}#{identifier}")
           else
             # Fallback to let definition

data/lib/test_prof/rspec_dissect/collectors/before.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./base"
+require "test_prof/rspec_dissect/collectors/base"
 
 module TestProf
   module RSpecDissect

data/lib/test_prof/rspec_dissect/collectors/let.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./base"
+require "test_prof/rspec_dissect/collectors/base"
 
 module TestProf
   module RSpecDissect

data/lib/test_prof/rspec_stamp/parser.rb

@@ -28,8 +28,6 @@ module TestProf
       end
 
       class << self
-        # rubocop: disable Metrics/CyclomaticComplexity
-        # rubocop: disable Metrics/PerceivedComplexity
         def parse(code)
           sexp = Ripper.sexp(code)
           return unless sexp

data/lib/test_prof/rspec_stamp.rb

@@ -116,8 +116,6 @@ module TestProf
 
       private
 
-      # rubocop: disable Metrics/CyclomaticComplexity
-      # rubocop: disable Metrics/PerceivedComplexity
       def stamp_example(example, tags)
         matches = example.match(EXAMPLE_RXP)
         return false unless matches

data/lib/test_prof/rubocop.rb

@@ -9,5 +9,5 @@ end
 
 require "rubocop"
 
-require_relative "cops/inject"
+require "test_prof/cops/inject"
 require "test_prof/cops/rspec/aggregate_examples"

data/lib/test_prof/stack_prof.rb

@@ -162,13 +162,13 @@ module TestProf
         log :info, <<~MSG
           Run the following command to generate a flame graph report:
 
-          stackprof --flamegraph #{path} > #{html_path} && stackprof --flamegraph-viewer=#{html_path}
+          stackprof --d3-flamegraph #{path} > #{html_path} && stackprof --flamegraph-viewer=#{html_path}
         MSG
       end
 
       def dump_json_report(path)
         report = ::StackProf::Report.new(
-          Marshal.load(IO.binread(path)) # rubocop:disable Security/MarshalLoad
+          Marshal.load(IO.binread(path))
         )
         json_path = path.gsub(/\.dump$/, ".json")
         File.write(json_path, JSON.generate(report.data))

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "1.0.5"
+  VERSION = "1.0.8"
 end

data/lib/test_prof.rb

@@ -46,6 +46,13 @@ module TestProf
       defined?(Minitest)
     end
 
+    # Returns true if Spring is used and not disabled
+    def spring?
+      # See https://github.com/rails/spring/blob/577cf01f232bb6dbd0ade7df2df2ac209697e741/lib/spring/binstub.rb
+      disabled = ENV["DISABLE_SPRING"]
+      defined?(::Spring::Application) && (disabled.nil? || disabled.empty? || disabled == "0")
+    end
+
     # Returns the current process time
     def now
       Process.clock_gettime(Process::CLOCK_MONOTONIC)
@@ -65,7 +72,7 @@ module TestProf
     # equal to the provided value (if any).
     # Contains workaround for applications using Spring.
     def activate(env_var, val = nil)
-      if defined?(::Spring::Application)
+      if spring?
         notify_spring_detected
         ::Spring.after_fork do
           activate!(env_var, val) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.8
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -237,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby applications tests profiling tools