test-prof 1.4.0.rc.2 → 1.4.0.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24fc1f10f015aca5ffcaa3fa9568bd397f31d4a23c043d2b2781a1ebb2158a9e
-  data.tar.gz: fe79040f5a8455525e42d8b282cd6a48ff9d1be63ee9de2975c25f561419d7d9
+  metadata.gz: 55eaa3ce2f79b5cae7992ea0e45a499c28ae1d301b2f7c9e34796d587c0e6090
+  data.tar.gz: 2f5a07b3a9c78304c054e025d0e785a253d310c354005ca767a7ea0674033e0f
 SHA512:
-  metadata.gz: 29e36545b692685977c96fd0f489a71189ee3472f2e1a09896c34635d43f01fe60de58a52a6bbec9f0352668057a4178d2f1f15aa454f94cafc4a87a933150ed
-  data.tar.gz: a80468699056d18f936e53b7474f9082b39105d222b05e713e2bd2bf3d992568d0cc51a308ba679e123a1e3c8f222e2522b545a2db60fbc07869044c53b9449e
+  metadata.gz: f26d5cdd70cd05d93fc0cc596302a72089c1718fd5b58084b5a219333ac6b0ba034d09c7a0e57840fa790f4198c7b8ba24f8dfdaa0d0b85a5f7404246b922b07
+  data.tar.gz: 22e6d9304af0c182f4bd1bf7d4b34a9bc8d5435b505100bebe9519cdac2f3d29ba47db3fe7de48179cc88c191cac3da531de4d3b6f506c2275dc52f45b832444

data/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## master (unreleased)
 
+- Add new TPS (tests per second) profiler. ([@palkan][])
+
 - FactoryDefault: add Fabrication support. ([@palkan][])
 
 - Drop support for **Ruby <2.7** and **Rails <6**.

data/lib/test_prof/factory_default/factory_bot_patch.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
+require "test_prof/factory_bot"
+
 module TestProf
   module FactoryDefault # :nodoc: all
     module FactoryBotPatch
-      module RunnerExt
-        refine TestProf::FactoryBot::FactoryRunner do
-          attr_reader :name, :traits, :overrides
+      if defined?(TestProf::FactoryBot::FactoryRunner)
+        module RunnerExt
+          refine TestProf::FactoryBot::FactoryRunner do
+            attr_reader :name, :traits, :overrides
+          end
         end
-      end
 
-      using RunnerExt
+        using RunnerExt
+      end
 
       module StrategyExt
         def association(runner)
@@ -53,7 +57,6 @@ module TestProf
       end
 
       def self.patch
-        require "test_prof/factory_bot"
         return unless defined?(TestProf::FactoryBot)
 
         TestProf::FactoryBot::Syntax::Methods.include SyntaxExt

data/lib/test_prof/tps_prof/profiler.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "test_prof/utils/sized_ordered_set"
+
+module TestProf
+  module TPSProf
+    class Profiler
+      attr_reader :top_count, :groups, :total_count, :total_time, :threshold
+
+      def initialize(top_count, threshold: 10)
+        @threshold = threshold
+        @top_count = top_count
+        @total_count = 0
+        @total_time = 0.0
+        @groups = Utils::SizedOrderedSet.new(top_count, sort_by: :tps)
+      end
+
+      def group_started(id)
+        @current_group = id
+        @examples_count = 0
+        @examples_time = 0.0
+        @group_started_at = TestProf.now
+      end
+
+      def group_finished(id)
+        return unless @examples_count >= threshold
+
+        # Context-time
+        group_time = (TestProf.now - @group_started_at) - @examples_time
+        run_time = @examples_time + group_time
+
+        groups << {
+          id: id,
+          run_time: run_time,
+          group_time: group_time,
+          count: @examples_count,
+          tps: -(@examples_count / run_time).round(2)
+        }
+      end
+
+      def example_started(id)
+        @example_started_at = TestProf.now
+      end
+
+      def example_finished(id)
+        @examples_count += 1
+        @total_count += 1
+
+        time = (TestProf.now - @example_started_at)
+        @examples_time += time
+        @total_time += time
+      end
+    end
+  end
+end

data/lib/test_prof/tps_prof/reporter/text.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "test_prof/ext/float_duration"
+require "test_prof/ext/string_truncate"
+
+module TestProf
+  module TPSProf
+    module Reporter
+      class Text
+        include Logging
+        using FloatDuration
+        using StringTruncate
+
+        def print(profiler)
+          groups = profiler.groups
+
+          total_tps = (profiler.total_count / profiler.total_time).round(2)
+
+          msgs = []
+
+          msgs <<
+            <<~MSG
+              Total TPS (tests per second): #{total_tps}
+
+              Top #{profiler.top_count} slowest suites by TPS (tests per second) (min examples per group: #{profiler.threshold}):
+
+            MSG
+
+          groups.each do |group|
+            description = group[:id].top_level_description
+            location = group[:id].metadata[:location]
+            time = group[:run_time]
+            group_time = group[:group_time]
+            count = group[:count]
+            tps = -group[:tps]
+
+            msgs <<
+              <<~GROUP
+                #{description.truncate} (#{location}) – #{tps} TPS (#{time.duration} / #{count}), group time: #{group_time.duration}
+              GROUP
+          end
+
+          log :info, msgs.join
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/tps_prof/rspec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module TestProf
+  module TPSProf
+    class RSpecListener # :nodoc:
+      include Logging
+
+      NOTIFICATIONS = %i[
+        example_group_started
+        example_group_finished
+        example_started
+        example_finished
+      ].freeze
+
+      attr_reader :reporter, :profiler
+
+      def initialize
+        @profiler = Profiler.new(TPSProf.config.top_count, threshold: TPSProf.config.threshold)
+        @reporter = TPSProf.config.reporter
+
+        log :info, "TPSProf enabled (top-#{TPSProf.config.top_count})"
+      end
+
+      def example_group_started(notification)
+        return unless notification.group.top_level?
+        profiler.group_started notification.group
+      end
+
+      def example_group_finished(notification)
+        return unless notification.group.top_level?
+        profiler.group_finished notification.group
+      end
+
+      def example_started(notification)
+        profiler.example_started notification.example
+      end
+
+      def example_finished(notification)
+        profiler.example_finished notification.example
+      end
+
+      def print
+        reporter.print(profiler)
+      end
+    end
+  end
+end
+
+# Register TPSProf listener
+TestProf.activate("TPS_PROF") do
+  RSpec.configure do |config|
+    listener = nil
+
+    config.before(:suite) do
+      listener = TestProf::TPSProf::RSpecListener.new
+      config.reporter.register_listener(
+        listener, *TestProf::TPSProf::RSpecListener::NOTIFICATIONS
+      )
+    end
+
+    config.after(:suite) { listener&.print }
+  end
+end

data/lib/test_prof/tps_prof.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "test_prof/tps_prof/profiler"
+require "test_prof/tps_prof/reporter/text"
+
+module TestProf
+  # TPSProf shows top-N example group based on their tests-per-second value.
+  #
+  # Example:
+  #
+  #   TPS_PROF=10 rspec ...
+  #
+  module TPSProf
+    class Configuration
+      attr_accessor :top_count, :threshold, :reporter
+
+      def initialize
+        @top_count = ENV["TPS_PROF"].to_i
+        @top_count = 10 if @top_count == 1
+        @threshold = ENV.fetch("TPS_PROF_MIN", 10).to_i
+        @reporter = resolve_reporter(ENV["TPS_PROF_FORMAT"])
+      end
+
+      private
+
+      def resolve_reporter(format)
+        # TODO: support other formats
+        TPSProf::Reporter::Text.new
+      end
+    end
+
+    class << self
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+    end
+  end
+end
+
+require "test_prof/tps_prof/rspec" if TestProf.rspec?
+# TODO: Minitest support
+# require "test_prof/tps_prof/minitest" if TestProf.minitest?

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "1.4.0.rc.2"
+  VERSION = "1.4.0.rc.3"
 end

data/lib/test_prof.rb

@@ -12,5 +12,6 @@ require "test_prof/factory_prof"
 require "test_prof/memory_prof"
 require "test_prof/rspec_stamp"
 require "test_prof/tag_prof"
+require "test_prof/tps_prof"
 require "test_prof/rspec_dissect" if TestProf.rspec?
 require "test_prof/factory_all_stub"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.4.0.rc.2
+  version: 1.4.0.rc.3
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-23 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,6 +219,10 @@ files:
 - lib/test_prof/tag_prof/printers/simple.rb
 - lib/test_prof/tag_prof/result.rb
 - lib/test_prof/tag_prof/rspec.rb
+- lib/test_prof/tps_prof.rb
+- lib/test_prof/tps_prof/profiler.rb
+- lib/test_prof/tps_prof/reporter/text.rb
+- lib/test_prof/tps_prof/rspec.rb
 - lib/test_prof/utils.rb
 - lib/test_prof/utils/html_builder.rb
 - lib/test_prof/utils/rspec.rb