test-prof 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c7d0976d2d56b7989f91253c752561a10d01ce12ba20b6a4fca377ea424c69a
-  data.tar.gz: a41df011c54a846f949238cc89ab9a021f5d86281f1f18566bcb5963782397e9
+  metadata.gz: 6b330384292e5a4bcb8429d4e2d1e215a320692e526b53cdddfb8714b43538b6
+  data.tar.gz: 0a22281b9a7acc4dde3552be07a143420bd63648a380f6b2e5cd446cdcc36b54
 SHA512:
-  metadata.gz: da313236dd4e1ab8078bac1267835b85303ba81129a5d469db198fd9fc65fae1f4decc0b0ad894878810bda3460feb4a84b76db637c4b1d1580457d48ea5e994
-  data.tar.gz: ee2e2c89b3eef006a17362d18987bdc31f5269804814c890ccb2597517f0a67cee1ab1c80c6a05b6268c87930d6c56fc7f624d0427cf6764e2d11956efb16cce
+  metadata.gz: d4d008f6cfe0055fff132d6c31f440bbd9974e0294480498d76a57b1f39a49ea51a1145632d901de54bc3a18f6e4d6c317e565ddfca090ad4d905ec9ec7e7e5a
+  data.tar.gz: 001a18ff90644936cacff9e5a00858671e070ffe4b11a10921f4401ad29fb12b4de2d190fc92c7fbc3bb137e42a2eaa2a55945bf1b7c1fd88bcb87c2ded00f13

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## master
 
+## 0.7.3 (2018-11-07)
+
+- Add a header with the general information on factories usage [#99](https://github.com/palkan/test-prof/issues/99) ([@szemek][])
+
+- Improve test sampling.([@mkldon][])
+
+ ```bash
+ SAMPLE=10 rake test # runs 10 random test examples
+ SAMPLE_GROUPS=10 rake test # runs 10 random example groups
+ ```
+
+- Extend Event Prof formatter to include the absolute run time and the percentage of the event tim [#100](https://github.com/palkan/test-prof/issues/100) ([@dmagro][])
+
 ## 0.7.2 (2018-10-08)
 
 - Add `RSpec/AggregateFailures` support for non-regular 'its' examples. ([@broels][])
@@ -368,3 +381,6 @@ Ensure output dir exists in `#artifact_path` method.
 [@desoleary]: https://github.com/desoleary
 [@rabotyaga]: https://github.com/rabotyaga
 [@Vasfed]: https://github.com/Vasfed
+[@szemek]: https://github.com/szemek
+[@mkldon]: https://github.com/mkldon
+[@dmagro]: https://github.com/dmagro

data/lib/minitest/event_prof_formatter.rb

@@ -26,11 +26,13 @@ module Minitest
       private
 
       def total_results(profiler)
+        time_percentage = time_percentage(profiler.total_time, profiler.absolute_run_time)
+
         @results <<
           <<~MSG
             EventProf results for #{profiler.event}
 
-            Total time: #{profiler.total_time.duration}
+            Total time: #{profiler.total_time.duration} of #{profiler.absolute_run_time.duration} (#{time_percentage}%)
             Total events: #{profiler.total_count}
 
             Top #{profiler.top_count} slowest suites (by #{profiler.rank_by}):
@@ -39,31 +41,47 @@ module Minitest
       end
 
       def by_groups(profiler)
-        profiler.results[:groups].each do |group|
+        result = profiler.results
+        groups = result[:groups]
+
+        groups.each do |group|
           description = group[:id][:name]
           location = group[:id][:location]
+          time = group[:time]
+          run_time = group[:run_time]
+          time_percentage = time_percentage(time, run_time)
 
           @results <<
             <<~GROUP
-              #{description.truncate} (#{location}) – #{group[:time].duration} (#{group[:count]} / #{group[:examples]})
+              #{description.truncate} (#{location}) – #{time.duration} (#{group[:count]} / #{group[:examples]}) of #{run_time.duration} (#{time_percentage}%)
             GROUP
         end
       end
 
       def by_examples(profiler)
-        return unless profiler.results[:examples]
+        result = profiler.results
+        examples = result[:examples]
+
+        return unless examples
         @results << "\nTop #{profiler.top_count} slowest tests (by #{profiler.rank_by}):\n\n"
 
-        profiler.results[:examples].each do |example|
+        examples.each do |example|
           description = example[:id][:name]
           location = example[:id][:location]
+          time = example[:time]
+          run_time = example[:run_time]
+          time_percentage = time_percentage(time, run_time)
 
           @results <<
             <<~GROUP
-              #{description.truncate} (#{location}) – #{example[:time].duration} (#{example[:count]})
+              #{description.truncate} (#{location}) – #{time.duration} (#{example[:count]}) of #{run_time.duration} (#{time_percentage}%)
             GROUP
         end
       end
+
+      def time_percentage(time, total_time)
+        (time / total_time * 100).round(2)
+      end
     end
   end
 end

data/lib/test_prof/any_fixture.rb

@@ -5,7 +5,7 @@ require "test_prof/ext/float_duration"
 module TestProf
   # Make DB fixtures from blocks.
   module AnyFixture
-    INSERT_RXP = /^INSERT INTO ([\S]+)/
+    INSERT_RXP = /^INSERT INTO ([\S]+)/.freeze
 
     using FloatDuration
 

data/lib/test_prof/event_prof/profiler.rb

@@ -4,7 +4,7 @@ module TestProf
   module EventProf
     class Profiler # :nodoc:
       attr_reader :event, :total_count, :total_time, :rank_by, :top_count, :per_example,
-                  :time, :count, :example_time, :example_count
+                  :time, :count, :example_time, :example_count, :absolute_run_time
 
       alias per_example? per_example
 
@@ -26,6 +26,7 @@ module TestProf
 
         @total_count = 0
         @total_time = 0.0
+        @absolute_run_time = 0.0
       end
 
       def track(time)
@@ -48,7 +49,16 @@ module TestProf
       end
 
       def group_finished(id)
-        data = { id: id, time: @time, count: @count, examples: @total_examples }
+        group_run_time = take_time(@group_ts)
+        @absolute_run_time += group_run_time
+
+        data = {
+          id: id,
+          time: @time,
+          run_time: group_run_time,
+          count: @count,
+          examples: @total_examples
+        }
 
         @groups << data unless data[rank_by].zero?
 
@@ -65,19 +75,31 @@ module TestProf
         @total_examples += 1
         return unless per_example?
 
-        data = { id: id, time: @example_time, count: @example_count }
+        example_run_time = take_time(@example_ts)
+        data = {
+          id: id,
+          time: @example_time,
+          run_time: example_run_time,
+          count: @example_count
+        }
+
         @examples << data unless data[rank_by].zero?
         @current_example = nil
       end
 
       def results
-        {
+        results = {
           groups: @groups.to_a
         }.tap do |data|
           next unless per_example?
 
           data[:examples] = @examples.to_a
         end
+        results
+      end
+
+      def take_time(start_ts)
+        TestProf.now - start_ts
       end
 
       private
@@ -86,11 +108,13 @@ module TestProf
         @time = 0.0
         @count = 0
         @total_examples = 0
+        @group_ts = TestProf.now
       end
 
       def reset_example!
         @example_count = 0
         @example_time = 0.0
+        @example_ts = TestProf.now
       end
     end
 

data/lib/test_prof/event_prof/rspec.rb

@@ -54,6 +54,7 @@ module TestProf
 
       def report(profiler)
         result = profiler.results
+        time_percentage = time_percentage(profiler.total_time, profiler.absolute_run_time)
 
         msgs = []
 
@@ -61,7 +62,7 @@ module TestProf
           <<~MSG
             EventProf results for #{profiler.event}
 
-            Total time: #{profiler.total_time.duration}
+            Total time: #{profiler.total_time.duration} of #{profiler.absolute_run_time.duration} (#{time_percentage}%)
             Total events: #{profiler.total_count}
 
             Top #{profiler.top_count} slowest suites (by #{profiler.rank_by}):
@@ -71,10 +72,13 @@ module TestProf
         result[:groups].each do |group|
           description = group[:id].top_level_description
           location = group[:id].metadata[:location]
+          time = group[:time]
+          run_time = group[:run_time]
+          time_percentage = time_percentage(time, run_time)
 
           msgs <<
             <<~GROUP
-              #{description.truncate} (#{location}) – #{group[:time].duration} (#{group[:count]} / #{group[:examples]})
+              #{description.truncate} (#{location}) – #{time.duration} (#{group[:count]} / #{group[:examples]}) of #{run_time.duration} (#{time_percentage}%)
             GROUP
         end
 
@@ -84,9 +88,13 @@ module TestProf
           result[:examples].each do |example|
             description = example[:id].description
             location = example[:id].metadata[:location]
+            time = example[:time]
+            run_time = example[:run_time]
+            time_percentage = time_percentage(time, run_time)
+
             msgs <<
               <<~GROUP
-                #{description.truncate} (#{location}) – #{example[:time].duration} (#{example[:count]})
+                #{description.truncate} (#{location}) – #{time.duration} (#{example[:count]}) of #{run_time.duration} (#{time_percentage}%)
               GROUP
           end
         end
@@ -128,6 +136,10 @@ module TestProf
 
         log :info, msgs.join
       end
+
+      def time_percentage(time, total_time)
+        (time / total_time * 100).round(2)
+      end
     end
   end
 end

data/lib/test_prof/factory_doctor.rb

@@ -35,7 +35,7 @@ module TestProf
       \AROLLBACK|
       \ARELEASE|
       \ASAVEPOINT
-    )}xi
+    )}xi.freeze
 
     class << self
       include TestProf::Logging

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

@@ -10,10 +10,18 @@ module TestProf::FactoryProf
           return log(:info, "No factories detected") if result.raw_stats == {}
           msgs = []
 
+          total = result.stats.sum { |stat| stat[:total] }
+          total_top_level = result.stats.sum { |stat| stat[:top_level] }
+          total_uniq_factories = result.stats.map { |stat| stat[:name] }.uniq.count
+
           msgs <<
             <<~MSG
               Factories usage
 
+               Total: #{total}
+               Total top-level: #{total_top_level}
+               Total uniq factories: #{total_uniq_factories}
+
                total      top-level                            name
             MSG
 

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

@@ -10,16 +10,39 @@ module TestProf
       Minitest::Spec
     ].freeze
 
-    def run(*)
-      unless ENV['SAMPLE'].nil?
-        sample_size = ENV['SAMPLE'].to_i
+    class << self
+      def suites
         # Make sure that sample contains only _real_ suites
-        runnables = Minitest::Runnable.runnables
-                                      .sample(sample_size + CORE_RUNNABLES.size)
-                                      .reject { |suite| CORE_RUNNABLES.include?(suite) }
-                                      .take(sample_size)
+        Minitest::Runnable.runnables
+                          .reject { |suite| CORE_RUNNABLES.include?(suite) }
+      end
+
+      def sample_groups(sample_size)
+        saved_suites = suites
         Minitest::Runnable.reset
-        runnables.each { |r| Minitest::Runnable.runnables << r }
+        saved_suites.sample(sample_size).each { |r| Minitest::Runnable.runnables << r }
+      end
+
+      def sample_examples(sample_size)
+        all_examples = suites.flat_map do |runnable|
+          runnable.runnable_methods.map { |method| [runnable, method] }
+        end
+        sample = all_examples.sample(sample_size)
+        # Filter examples by overriding #runnable_methods for all suites
+        suites.each do |runnable|
+          runnable.define_singleton_method(:runnable_methods) do
+            super() & sample.select { |ex| ex.first.equal?(runnable) }.map(&:last)
+          end
+        end
+      end
+    end
+
+    # Overrides Minitest.run
+    def run(*)
+      if ENV['SAMPLE']
+        MinitestSample.sample_examples(ENV['SAMPLE'].to_i)
+      elsif ENV['SAMPLE_GROUPS']
+        MinitestSample.sample_groups(ENV['SAMPLE_GROUPS'].to_i)
       end
       super
     end

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

@@ -1,13 +1,40 @@
 # frozen_string_literal: true
 
 module TestProf
-  # Add ability to run only a specified number of example groups (randomly selected)
-  module RSpecSample
-    def ordered_example_groups
-      @example_groups = @example_groups.sample(ENV['SAMPLE'].to_i) unless ENV['SAMPLE'].nil?
-      super
+  # Instance variable writer for RSpec::Core::World
+  module RSpecWorldSamplePatch
+    def filtered_examples=(val)
+      @filtered_examples = val
     end
   end
 end
 
-RSpec::Core::World.prepend(TestProf::RSpecSample)
+if ENV["SAMPLE"]
+  RSpec::Core::World.include(TestProf::RSpecWorldSamplePatch)
+
+  RSpec.configure do |config|
+    config.before(:suite) do
+      filtered_examples = RSpec.world.filtered_examples.values.flatten
+      sample = filtered_examples.sample(ENV["SAMPLE"].to_i)
+      RSpec.world.filtered_examples = Hash.new do |hash, group|
+        hash[group] = group.examples & sample
+      end
+    end
+  end
+end
+
+if ENV["SAMPLE_GROUPS"]
+  RSpec::Core::World.include(TestProf::RSpecWorldSamplePatch)
+
+  RSpec.configure do |config|
+    config.before(:suite) do
+      filtered_groups = RSpec.world.filtered_examples.reject do |_group, examples|
+        examples.empty?
+      end.keys
+      sample = filtered_groups.sample(ENV["SAMPLE_GROUPS"].to_i)
+      RSpec.world.filtered_examples = Hash.new do |hash, group|
+        hash[group] = sample.include?(group) ? group.examples : []
+      end
+    end
+  end
+end

data/lib/test_prof/rspec_stamp.rb

@@ -6,7 +6,7 @@ require "test_prof/rspec_stamp/parser"
 module TestProf
   # Mark RSpec examples with provided tags
   module RSpecStamp
-    EXAMPLE_RXP = /(\s*)(\w+\s*(?:.*)\s*)(do|{)/
+    EXAMPLE_RXP = /(\s*)(\w+\s*(?:.*)\s*)(do|{)/.freeze
 
     # RSpecStamp configuration
     class Configuration

data/lib/test_prof/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.0
+        version: 0.60.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.0
+        version: 0.60.0
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement