test-prof 1.0.3 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ea5b7078b12209f32a60554f25acffccd184bdf852ebfe14cad161ded2c180
-  data.tar.gz: 34e61ec6d58e5688b441ea09c1be524ae563f9ca82f334541c3f2c3197787cbd
+  metadata.gz: 2f55e42ee372a9ebe0f8981487931bf70ab3209e38163b32f84a7553bdfb4249
+  data.tar.gz: 3ca0352ca4671c11d18937d3ee1de361322c827671d199d079b1460667c32a1c
 SHA512:
-  metadata.gz: d866bfe03650d81cb2dd5b698b5de5703a8fa505c7c8d0b0e4283b8130eb774ac43c5cca6a750fef6f8342acdec7e518613489e898fd354f133e1793df833e45
-  data.tar.gz: cf92cef8973837d2e09ff3bcc4449fb0675ebfca3f10fc75a314f10d885ad92aaae2f6fac0cd99e7250eb57985208e6d6f53b88d101f177709a172b8fcae1815
+  metadata.gz: 00dcd7797667e28b54fe32e36392e44b80a1dd6fdcc04b8a0565084311c5420bbe017eecba2ae553b84b2cdd6bc92886f15a919da8e1ba7a293aa737bc2c81da
+  data.tar.gz: eed04e297d23872fae979d7da614d4cf2730c4414b7eb26ad14095e619eeabd872619cd3e51293a4949fc04f214807cb10425da4a7ebe343df8a8f9af766f413

data/CHANGELOG.md

@@ -2,6 +2,48 @@
 
 ## master (unrealeased)
 
+## 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)
+
+- Fix logging regression when no newline has been added. ([@palkan][])
+
+## 1.0.4 (2021-05-12)
+
+- Add ability to use custom logger. ([@palkan][])
+
+```ruby
+TestProf.configure do |config|
+  config.logger = Logger.new($stdout, level: Logger::WARN)
+end
+```
+
+- Add `nate_heckler` mode for FactoryProf. ([@palkan][])
+
+Drop this into your `rails_helper.rb` or `test_helper.rb`:
+
+```ruby
+require "test_prof/factory_prof/nate_heckler"
+```
+
+And for every test run see the overall factories usage:
+
+```sh
+[TEST PROF INFO] Time spent in factories: 04:31.222 (54% of total time)
+```
+
 ## 1.0.3 (2021-04-30)
 
 - Minor fixes.
@@ -150,7 +192,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)
 
@@ -208,20 +250,20 @@ 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

data/lib/test_prof/any_fixture/dump.rb

@@ -102,7 +102,7 @@ module TestProf
         def quoted(val)
           if val.is_a?(Array)
             val.map { |v| quoted(v) }
-          elsif val.is_a?(ActiveRecord::Relation::QueryAttribute)
+          elsif val.is_a?(ActiveModel::Attribute)
             quoted(val.value_for_database)
           else
             ActiveRecord::Base.connection.quote(val)

data/lib/test_prof/factory_prof/nate_heckler.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "test_prof/factory_prof"
+
+# A standalone Factory Prof printer which is meant to be always enabled
+
+TestProf::FactoryProf.patch!
+
+started_at = TestProf.now
+at_exit do
+  TestProf::FactoryProf::Printers::NateHeckler.dump(
+    TestProf::FactoryProf.result, start_time: started_at
+  )
+end
+
+TestProf::FactoryProf.start

data/lib/test_prof/factory_prof/printers/flamegraph.rb

@@ -11,7 +11,7 @@ module TestProf::FactoryProf
       class << self
         include TestProf::Logging
 
-        def dump(result)
+        def dump(result, **)
           return log(:info, "No factories detected") if result.raw_stats == {}
           report_data = {
             total_stacks: result.stacks.size,

data/lib/test_prof/factory_prof/printers/nate_heckler.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "test_prof/ext/float_duration"
+
+module TestProf::FactoryProf
+  module Printers
+    # See https://twitter.com/nateberkopec/status/1389945187766456333
+    module NateHeckler # :nodoc: all
+      class << self
+        using TestProf::FloatDuration
+        include TestProf::Logging
+
+        def dump(result, start_time:)
+          return if result.raw_stats == {}
+
+          total_time = result.stats.sum { |stat| stat[:top_level_time] }
+          total_run_time = TestProf.now - start_time
+
+          percentage = ((total_time / total_run_time) * 100).round(2)
+
+          log :info, "Time spent in factories: #{total_time.duration} (#{percentage}% of total time)"
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/factory_prof/printers/simple.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
+require "test_prof/ext/float_duration"
+
 module TestProf::FactoryProf
   module Printers
     module Simple # :nodoc: all
       class << self
+        using TestProf::FloatDuration
         include TestProf::Logging
 
-        def dump(result)
+        def dump(result, start_time:)
           return log(:info, "No factories detected") if result.raw_stats == {}
           msgs = []
 
+          total_run_time = TestProf.now - start_time
           total_count = result.stats.sum { |stat| stat[:total_count] }
           total_top_level_count = result.stats.sum { |stat| stat[:top_level_count] }
           total_time = result.stats.sum { |stat| stat[:top_level_time] }
@@ -21,7 +25,7 @@ module TestProf::FactoryProf
 
                Total: #{total_count}
                Total top-level: #{total_top_level_count}
-               Total time: #{format("%.4f", total_time)}s
+               Total time: #{total_time.duration} (out of #{total_run_time.duration})
                Total uniq factories: #{total_uniq_factories}
 
                  total   top-level     total time      time per call      top-level time               name

data/lib/test_prof/factory_prof.rb

@@ -2,6 +2,7 @@
 
 require "test_prof/factory_prof/printers/simple"
 require "test_prof/factory_prof/printers/flamegraph"
+require "test_prof/factory_prof/printers/nate_heckler"
 require "test_prof/factory_prof/factory_builders/factory_bot"
 require "test_prof/factory_prof/factory_builders/fabrication"
 
@@ -14,10 +15,19 @@ module TestProf
 
     # FactoryProf configuration
     class Configuration
-      attr_accessor :mode
+      attr_accessor :mode, :printer
 
       def initialize
         @mode = ENV["FPROF"] == "flamegraph" ? :flamegraph : :simple
+        @printer =
+          case ENV["FPROF"]
+          when "flamegraph"
+            Printers::Flamegraph
+          when "nate_heckler"
+            Printers::NateHeckler
+          else
+            Printers::Simple
+          end
       end
 
       # Whether we want to generate flamegraphs
@@ -74,7 +84,15 @@ module TestProf
 
         log :info, "FactoryProf enabled (#{config.mode} mode)"
 
+        patch!
+      end
+
+      def patch!
+        return if @patched
+
         FACTORY_BUILDERS.each(&:patch)
+
+        @patched = true
       end
 
       # Inits FactoryProf and setups at exit hook,
@@ -82,9 +100,11 @@ module TestProf
       def run
         init
 
-        printer = config.flamegraph? ? Printers::Flamegraph : Printers::Simple
+        printer = config.printer
+
+        started_at = TestProf.now
 
-        at_exit { printer.dump(result) }
+        at_exit { printer.dump(result, start_time: started_at) }
 
         start
       end

data/lib/test_prof/logging.rb

@@ -4,23 +4,29 @@ module TestProf
   # Helper for output printing
   module Logging
     COLORS = {
-      info: "\e[34m", # blue
-      warn: "\e[33m", # yellow
-      error: "\e[31m" # red
+      INFO: "\e[34m", # blue
+      WARN: "\e[33m", # yellow
+      ERROR: "\e[31m" # red
     }.freeze
 
-    def log(level, msg)
-      TestProf.config.output.puts(build_log_msg(level, msg))
-    end
+    class Formatter
+      def call(severity, _time, progname, msg)
+        colorize(severity.to_sym, "[#{progname} #{severity}] #{msg}\n")
+      end
 
-    def build_log_msg(level, msg)
-      colorize(level, "[TEST PROF #{level.to_s.upcase}] #{msg}")
-    end
+      private
+
+      def colorize(level, msg)
+        return msg unless TestProf.config.color?
 
-    def colorize(level, msg)
-      return msg unless TestProf.config.color?
+        return msg unless COLORS.key?(level)
 
-      "#{COLORS[level]}#{msg}\e[0m"
+        "#{COLORS[level]}#{msg}\e[0m"
+      end
+    end
+
+    def log(level, msg)
+      TestProf.config.logger.public_send(level, "TEST PROF") { msg }
     end
   end
 end

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

@@ -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_stamp.rb

@@ -39,7 +39,7 @@ module TestProf
           acc << if v.nil?
             k.to_sym
           else
-            Hash[k.to_sym, v.to_sym]
+            {k.to_sym => v.to_sym}
           end
         end
       end

data/lib/test_prof/tag_prof/result.rb

@@ -12,7 +12,7 @@ module TestProf
 
         @data = Hash.new do |h, k|
           h[k] = {value: k, count: 0, time: 0.0}
-          h[k].merge!(Hash[events.map { |event| [event, 0.0] }]) unless
+          h[k].merge!(events.map { |event| [event, 0.0] }.to_h) unless
             events.empty?
           h[k]
         end

data/lib/test_prof/tag_prof/rspec.rb

@@ -53,11 +53,9 @@ module TestProf
       def fetch_events_data
         return {} unless @events_profiler
 
-        Hash[
-          @events_profiler.profilers.map do |profiler|
-            [profiler.event, profiler.time]
-          end
-        ]
+        @events_profiler.profilers.map do |profiler|
+          [profiler.event, profiler.time]
+        end.to_h
       end
     end
   end

data/lib/test_prof/version.rb

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

data/lib/test_prof.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "fileutils"
+require "logger"
+
 require "test_prof/version"
 require "test_prof/logging"
 require "test_prof/utils"
@@ -44,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)
@@ -63,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
@@ -130,7 +139,7 @@ module TestProf
 
   # TestProf configuration
   class Configuration
-    attr_accessor :output, # IO to write output messages.
+    attr_accessor :output, # IO to write logs
       :color, # Whether to colorize output or not
       :output_dir, # Directory to store artifacts
       :timestamps, # Whether to use timestamped names for artifacts,
@@ -145,12 +154,16 @@ module TestProf
     end
 
     def color?
-      color == true
+      color == true && output.is_a?(IO) && output.tty?
     end
 
     def timestamps?
       timestamps == true
     end
+
+    def logger
+      @logger ||= Logger.new(output, formatter: Logging::Formatter.new)
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.7
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-30 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -174,7 +174,9 @@ files:
 - lib/test_prof/factory_prof/factory_bot_patch.rb
 - lib/test_prof/factory_prof/factory_builders/fabrication.rb
 - lib/test_prof/factory_prof/factory_builders/factory_bot.rb
+- lib/test_prof/factory_prof/nate_heckler.rb
 - lib/test_prof/factory_prof/printers/flamegraph.rb
+- lib/test_prof/factory_prof/printers/nate_heckler.rb
 - lib/test_prof/factory_prof/printers/simple.rb
 - lib/test_prof/logging.rb
 - lib/test_prof/recipes/logging.rb
@@ -214,11 +216,12 @@ homepage: http://github.com/test-prof/test-prof
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: http://github.com/test-prof/test-prof/issues
+  bug_tracker_uri: https://github.com/test-prof/test-prof/issues
   changelog_uri: https://github.com/test-prof/test-prof/blob/master/CHANGELOG.md
   documentation_uri: https://test-prof.evilmartians.io/
   homepage_uri: https://test-prof.evilmartians.io/
-  source_code_uri: http://github.com/test-prof/test-prof
+  source_code_uri: https://github.com/test-prof/test-prof
+  funding_uri: https://github.com/sponsors/test-prof
 post_install_message:
 rdoc_options: []
 require_paths: