test-prof 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0678bc968a267ebeece00e12338f6408683140428ecdd041ece64c70e6bb91c0'
-  data.tar.gz: 3ab5bc88b7b5dea557847f05a16d7fc3e4c6c9212115cd16984a56b7dd7b1737
+  metadata.gz: ed617176a00461b30a96b07f086b52ea89d28fff7d1e4b085110e1b2333b6c60
+  data.tar.gz: c2e425a439407505f4ac1ecbfe25d84517343d7e9d7f1260ce675382f3ee6f1f
 SHA512:
-  metadata.gz: 5b32e7e689cef27e72ce5f7e65ca0463bae7b83dfcaf77eba17aa0cc9bae1b74d6223b6b141e805debb7640b74b75be34bf238a8f41cb3efaf0386929935d814
-  data.tar.gz: 34200774bc30c39acc48109fbc5031fd8f48abb5f7175799a1e1bbfd7650a11a441c9ba63638bf186d78ef5cd15b7b33e64782c781a7f28bd43e43cb6d1e5588
+  metadata.gz: 3548abd19a6f283dd230e340a0651fc2196b7253bc4fcf4f5115d53a3e55b35e43ece87a875d4267a00edfa5105c303365bc1b7e9f787a0fcd5d3d8ffd86634b
+  data.tar.gz: 911ed9f79a48b4fd72b1ea7885f2eb5d3f75410421946cdd61966b9ffc50a245bb1f0c88b93b256ec5b06159267b16ccfcf129c06fde3d021605f1b15375c7cf

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master (unreleased)
 
+## 1.3.2 (2024-03-08) 🌷
+
+- Add Minitest support for TagProf. ([@lioneldebauge][])
+
+## 1.3.1 (2023-12-12)
+
+- Add support for dumping FactoryProf results in JSON format. ([@uzushino][])
+
 ## 1.3.0 (2023-11-21)
 
 - Add Vernier integration. ([@palkan][])
@@ -376,3 +384,5 @@ See [changelog](https://github.com/test-prof/test-prof/blob/v0.8.0/CHANGELOG.md)
 [@peret]: https://github.com/peret
 [@bf4]: https://github.com/bf4
 [@Vankiru]: https://github.com/Vankiru
+[@uzushino]: https://github.com/uzushino
+[@lioneldebauge]: https://github.com/lioneldebauge

data/lib/minitest/test_prof_plugin.rb

@@ -3,6 +3,7 @@
 require "test_prof/event_prof/minitest"
 require "test_prof/factory_doctor/minitest"
 require "test_prof/memory_prof/minitest"
+require "test_prof/tag_prof/minitest"
 
 module Minitest # :nodoc:
   module TestProf # :nodoc:
@@ -16,6 +17,7 @@ module Minitest # :nodoc:
         opts[:sample] = true if ENV["SAMPLE"] || ENV["SAMPLE_GROUPS"]
         opts[:mem_prof_mode] = ENV["TEST_MEM_PROF"] if ENV["TEST_MEM_PROF"]
         opts[:mem_prof_top_count] = ENV["TEST_MEM_PROF_COUNT"] if ENV["TEST_MEM_PROF_COUNT"]
+        opts[:tag_prof] = true if ENV["TAG_PROF"] == "type"
       end
     end
   end
@@ -50,6 +52,7 @@ module Minitest # :nodoc:
     reporter << TestProf::EventProfReporter.new(options[:io], options) if options[:event]
     reporter << TestProf::FactoryDoctorReporter.new(options[:io], options) if options[:fdoc]
     reporter << TestProf::MemoryProfReporter.new(options[:io], options) if options[:mem_prof_mode]
+    reporter << Minitest::TestProf::TagProfReporter.new(options[:io], options) if options[:tag_prof]
 
     ::TestProf::MinitestSample.call if options[:sample]
   end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "test_prof/ext/float_duration"
+
+module TestProf::FactoryProf
+  module Printers
+    module Json  # :nodoc: all
+      class << self
+        using TestProf::FloatDuration
+        include TestProf::Logging
+
+        def dump(result, start_time:)
+          return log(:info, "No factories detected") if result.raw_stats == {}
+
+          outpath = TestProf.artifact_path("test-prof.result.json")
+          File.write(outpath, convert_stats(result, start_time).to_json)
+
+          log :info, "Profile results to JSON: #{outpath}"
+        end
+
+        def convert_stats(result, start_time)
+          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] }
+          total_uniq_factories = result.stats.map { |stat| stat[:name] }.uniq.count
+
+          {
+            total_count: total_count,
+            total_top_level_count: total_top_level_count,
+            total_time: total_time.duration,
+            total_run_time: total_run_time.duration,
+            total_uniq_factories: total_uniq_factories,
+
+            stats: result.stats
+          }
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/factory_prof.rb

@@ -3,6 +3,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/printers/json"
 require "test_prof/factory_prof/factory_builders/factory_bot"
 require "test_prof/factory_prof/factory_builders/fabrication"
 
@@ -25,6 +26,8 @@ module TestProf
             Printers::Flamegraph
           when "nate_heckler"
             Printers::NateHeckler
+          when "json"
+            Printers::Json
           else
             Printers::Simple
           end

data/lib/test_prof/tag_prof/minitest.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Minitest
+  module TestProf
+    class TagProfReporter < BaseReporter # :nodoc:
+      attr_reader :results
+
+      def initialize(io = $stdout, _options = {})
+        super
+        @results = ::TestProf::TagProf::Result.new("type")
+
+        if event_prof_activated?
+          require "test_prof/event_prof"
+          @current_group_id = nil
+          @events_profiler = configure_profiler
+          @results = ::TestProf::TagProf::Result.new("type", @events_profiler.events)
+        end
+      end
+
+      def prerecord(group, example)
+        return unless event_prof_activated?
+
+        # enable event profiling
+        @events_profiler.group_started(true)
+      end
+
+      def record(result)
+        results.track(main_folder_path(result), time: result.time, events: fetch_events_data)
+        @events_profiler.group_started(nil) if event_prof_activated? # reset and disable event profilers
+      end
+
+      def report
+        printer = (ENV["TAG_PROF_FORMAT"] == "html") ? ::TestProf::TagProf::Printers::HTML : ::TestProf::TagProf::Printers::Simple
+        printer.dump(results)
+      end
+
+      private
+
+      def main_folder_path(result)
+        return :__unknown__ if absolute_path_from(result).nil?
+
+        absolute_path_from(result)
+      end
+
+      def absolute_path_from(result)
+        absolute_path = File.expand_path(result.source_location.first)
+        absolute_path.slice(/(?<=(?:spec|test)\/)\w*/)
+      end
+
+      def configure_profiler
+        ::TestProf::EventProf::CustomEvents.activate_all(tag_prof_event)
+        ::TestProf::EventProf.build(tag_prof_event)
+      end
+
+      def event_prof_activated?
+        return false if tag_prof_event.nil?
+
+        !tag_prof_event.empty?
+      end
+
+      def tag_prof_event
+        ENV["TAG_PROF_EVENT"]
+      end
+
+      def fetch_events_data
+        return {} unless @events_profiler
+
+        @events_profiler.profilers.map do |profiler|
+          [profiler.event, profiler.time || 0.0]
+        end.to_h
+      end
+    end
+  end
+end

data/lib/test_prof/tag_prof/result.rb

@@ -21,8 +21,8 @@ module TestProf
       def track(tag, time:, events: {})
         data[tag][:count] += 1
         data[tag][:time] += time
-        events.each do |k, v|
-          data[tag][k] += v
+        events.each do |event, time|
+          data[tag][event] += time
         end
       end
 

data/lib/test_prof/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-21 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,6 +177,7 @@ files:
 - 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/json.rb
 - lib/test_prof/factory_prof/printers/nate_heckler.rb
 - lib/test_prof/factory_prof/printers/simple.rb
 - lib/test_prof/logging.rb
@@ -212,6 +213,7 @@ files:
 - lib/test_prof/stack_prof.rb
 - lib/test_prof/stack_prof/rspec.rb
 - lib/test_prof/tag_prof.rb
+- lib/test_prof/tag_prof/minitest.rb
 - lib/test_prof/tag_prof/printers/html.rb
 - lib/test_prof/tag_prof/printers/simple.rb
 - lib/test_prof/tag_prof/result.rb