test-prof 0.1.0.pre5 → 0.1.0

data/lib/test_prof/factory_prof/factory_girl_patch.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TestProf
+  module FactoryProf
+    # Wrap #run method with FactoryProf tracking
+    module FactoryGirlPatch
+      def run(strategy = @strategy)
+        FactoryProf.track(strategy, @name) { super }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "json"
+
+module TestProf::FactoryProf
+  module Printers
+    module Flamegraph # :nodoc: all
+      class << self
+        include TestProf::Logging
+
+        def dump(result)
+          report_data = {
+            total_stacks: result.stacks.size,
+            total: result.total
+          }
+
+          report_data[:roots] = convert_stacks(result)
+
+          path = generate_html(report_data)
+
+          log :info, "FactoryFlame report generated: #{path}"
+        end
+
+        def convert_stacks(result)
+          res = []
+
+          paths = {}
+
+          result.stacks.each do |stack|
+            parent = nil
+            path = ""
+
+            stack.each do |sample|
+              path = "#{path}/#{sample}"
+
+              if paths[path]
+                node = paths[path]
+                node[:value] += 1
+              else
+                node = { name: sample, value: 1, total: result.raw_stats.fetch(sample)[:total] }
+                paths[path] = node
+
+                if parent.nil?
+                  res << node
+                else
+                  parent[:children] ||= []
+                  parent[:children] << node
+                end
+              end
+
+              parent = node
+            end
+          end
+
+          res
+        end
+
+        private
+
+        def generate_html(data)
+          template = File.read(TestProf.asset_path("flamegraph.template.html"))
+          template.sub! '/**REPORT-DATA**/', data.to_json
+
+          outpath = TestProf.artefact_path("factory-flame.html")
+          File.write(outpath, template)
+          outpath
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module TestProf::FactoryProf
+  module Printers
+    module Simple # :nodoc: all
+      class << self
+        include TestProf::Logging
+
+        def dump(result)
+          msgs = []
+
+          msgs <<
+            <<~MSG
+              Factories usage
+
+               total      top-level                            name
+            MSG
+
+          result.stats.each do |stat|
+            msgs << format("%6d    %11d  %30s", stat[:total], stat[:top_level], stat[:name])
+          end
+
+          log :info, msgs.join("\n")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module TestProf
+  # Add ability to run only a specified number of example groups (randomly selected)
+  module MinitestSample
+    # Do not add these classes to resulted sample
+    CORE_RUNNABLES = [
+      Minitest::Test,
+      Minitest::Unit::TestCase,
+      Minitest::Spec
+    ].freeze
+
+    def run(*)
+      unless ENV['SAMPLE'].nil?
+        sample_size = ENV['SAMPLE'].to_i
+        # 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.reset
+        runnables.each { |r| Minitest::Runnable.runnables << r }
+      end
+      super
+    end
+  end
+end
+
+Minitest.singleton_class.prepend(TestProf::MinitestSample)

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "test_prof/factory_default"
+
+TestProf::FactoryDefault.init
+
+RSpec.configure do |config|
+  config.after(:each) { TestProf::FactoryDefault.reset }
+end

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

@@ -0,0 +1,13 @@
+# 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
+    end
+  end
+end
+
+RSpec::Core::World.prepend(TestProf::RspecSample)

data/lib/test_prof/rspec_stamp/rspec.rb

@@ -84,7 +84,11 @@ TestProf.activate('RSTAMP') do
   RSpec.configure do |config|
     listener = TestProf::RSpecStamp::RSpecListener.new
 
-    config.reporter.register_listener(listener, *TestProf::RSpecStamp::RSpecListener::NOTIFICATIONS)
+    config.before(:suite) do
+      config.reporter.register_listener(
+        listener, *TestProf::RSpecStamp::RSpecListener::NOTIFICATIONS
+      )
+    end
 
     config.after(:suite) { listener.stamp! }
   end

data/lib/test_prof/rubocop.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "test_prof/cops/rspec/aggregate_failures"

data/lib/test_prof/ruby_prof.rb

@@ -48,8 +48,8 @@ module TestProf
                     :include_threads, :eliminate_methods
 
       def initialize
-        @printer = :call_stack
-        @mode = :wall
+        @printer = ENV.fetch('TEST_RUBY_PROF_PRINTER', :call_stack).to_sym
+        @mode = ENV.fetch('TEST_RUBY_PROF_MODE', :wall).to_sym
         @min_percent = 1
         @include_threads = false
         @eliminate_methods = ELIMINATE_METHODS
@@ -65,13 +65,10 @@ module TestProf
       end
 
       # Returns an array of printer type (ID) and class.
-      # Takes ENV variable TEST_RUBY_PROF_PRINTER into account.
       def resolve_printer
-        type = ENV['TEST_RUBY_PROF_PRINTER'] || printer
+        return ['custom', printer] if printer.is_a?(Module)
 
-        return ['custom', type] if type.is_a?(Module)
-
-        type = type.to_s
+        type = printer.to_s
 
         raise ArgumentError, "Unknown printer: #{type}" unless
           PRINTERS.key?(type)
@@ -110,11 +107,8 @@ module TestProf
       private
 
       def build_path(name, printer)
-        TestProf.with_timestamps(
-          File.join(
-            TestProf.config.output_dir,
-            "ruby-prof-report-#{printer}-#{config.mode}-#{name}.html"
-          )
+        TestProf.artefact_path(
+          "ruby-prof-report-#{printer}-#{config.mode}-#{name}.html"
         )
       end
 

data/lib/test_prof/stack_prof.rb

@@ -25,8 +25,8 @@ module TestProf
       attr_accessor :mode, :interval, :raw
 
       def initialize
-        @mode = :wall
-        @raw = false
+        @mode = ENV.fetch('TEST_STACK_PROF_MODE', :wall).to_sym
+        @raw = ENV['TEST_STACK_PROF_RAW'] == '1'
       end
     end
 
@@ -83,16 +83,23 @@ module TestProf
         ::StackProf.results(path)
 
         log :info, "StackProf report generated: #{path}"
+
+        return unless config.raw
+
+        html_path = path.gsub(/\.dump$/, '.html')
+
+        log :info, <<~MSG
+          Run the following command to generate a flame graph report:
+
+          stackprof --flamegraph #{path} > #{html_path} && stackprof --flamegraph-viewer=#{html_path}
+        MSG
       end
 
       private
 
       def build_path(name)
-        TestProf.with_timestamps(
-          File.join(
-            TestProf.config.output_dir,
-            "stack-prof-report-#{config.mode}-#{name}.dump"
-          )
+        TestProf.artefact_path(
+          "stack-prof-report-#{config.mode}#{config.raw ? '-raw' : ''}-#{name}.dump"
         )
       end
 

data/lib/test_prof/tag_prof.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module TestProf
+  module TagProf # :nodoc:
+  end
+end
+
+require "test_prof/tag_prof/rspec" if defined?(RSpec)

data/lib/test_prof/tag_prof/rspec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "test_prof/ext/float_duration"
+
+module TestProf
+  module TagProf
+    class RSpecListener # :nodoc:
+      include Logging
+      using FloatDuration
+
+      NOTIFICATIONS = %i[
+        example_started
+        example_finished
+      ].freeze
+
+      def initialize
+        @tag = ENV['TAG_PROF'].to_sym
+        @tags = Hash.new { |h, k| h[k] = { val: k, count: 0, time: 0.0 } }
+
+        log :info, "TagProf enabled (#{@tag})"
+      end
+
+      def example_started(_notification)
+        @ts = Time.now
+      end
+
+      def example_finished(notification)
+        return if notification.example.pending?
+
+        tag = notification.example.metadata.fetch(@tag, :__unknown__)
+
+        @tags[tag][:count] += 1
+        @tags[tag][:time] += (Time.now - @ts)
+      end
+
+      def print
+        msgs = []
+
+        msgs <<
+          <<~MSG
+            TagProf report for #{@tag}
+          MSG
+
+        msgs << format(
+          "%15s  %12s  %6s  %6s  %6s  %12s",
+          @tag,
+          'time', 'total', '%total', '%time', 'avg'
+        )
+
+        msgs << ""
+
+        total = @tags.values.inject(0) { |acc, v| acc + v[:count] }
+        total_time = @tags.values.inject(0) { |acc, v| acc + v[:time] }
+
+        @tags.values.sort_by { |v| -v[:time] }.each do |tag|
+          msgs << format(
+            "%15s  %12s  %6d  %6.2f  %6.2f  %12s",
+            tag[:val], tag[:time].duration, tag[:count],
+            100 * tag[:count].to_f / total,
+            100 * tag[:time] / total_time,
+            (tag[:time] / tag[:count]).duration
+          )
+        end
+
+        log :info, msgs.join("\n")
+      end
+    end
+  end
+end
+
+# Register TagProf listener
+TestProf.activate('TAG_PROF') do
+  RSpec.configure do |config|
+    listener = TestProf::TagProf::RSpecListener.new
+
+    config.before(:suite) do
+      config.reporter.register_listener(
+        listener, *TestProf::TagProf::RSpecListener::NOTIFICATIONS
+      )
+    end
+
+    config.after(:suite) { listener.print }
+  end
+end

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "0.1.0.pre5"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre5
+  version: 0.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -146,26 +160,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/setup
-- circle.yml
+- assets/flamegraph.demo.html
+- assets/flamegraph.template.html
+- assets/src/d3-tip.js
+- assets/src/d3-tip.min.js
+- assets/src/d3.flameGraph.css
+- assets/src/d3.flameGraph.js
+- assets/src/d3.flameGraph.min.css
+- assets/src/d3.flameGraph.min.js
+- assets/src/d3.v4.min.js
 - guides/any_fixture.md
 - guides/before_all.md
 - guides/event_prof.md
+- guides/factory_default.md
 - guides/factory_doctor.md
+- guides/factory_prof.md
 - guides/rspec_stamp.md
+- guides/rubocop.md
 - guides/ruby_prof.md
 - guides/stack_prof.md
+- guides/tag_prof.md
+- guides/tests_sampling.md
 - lib/test-prof.rb
 - lib/test_prof.rb
 - lib/test_prof/any_fixture.rb
+- lib/test_prof/cops/rspec/aggregate_failures.rb
 - lib/test_prof/event_prof.rb
 - lib/test_prof/event_prof/custom_events.rb
 - lib/test_prof/event_prof/custom_events/factory_create.rb
@@ -175,48 +197,33 @@ files:
 - lib/test_prof/event_prof/minitest.rb
 - lib/test_prof/event_prof/rspec.rb
 - lib/test_prof/ext/float_duration.rb
+- lib/test_prof/factory_default.rb
+- lib/test_prof/factory_default/factory_girl_patch.rb
 - lib/test_prof/factory_doctor.rb
 - lib/test_prof/factory_doctor/factory_girl_patch.rb
 - lib/test_prof/factory_doctor/minitest.rb
 - lib/test_prof/factory_doctor/rspec.rb
+- lib/test_prof/factory_prof.rb
+- lib/test_prof/factory_prof/factory_girl_patch.rb
+- lib/test_prof/factory_prof/printers/flamegraph.rb
+- lib/test_prof/factory_prof/printers/simple.rb
 - lib/test_prof/logging.rb
+- lib/test_prof/recipes/minitest/sample.rb
 - lib/test_prof/recipes/rspec/any_fixture.rb
 - lib/test_prof/recipes/rspec/before_all.rb
+- lib/test_prof/recipes/rspec/factory_default.rb
+- lib/test_prof/recipes/rspec/sample.rb
 - lib/test_prof/rspec_stamp.rb
 - lib/test_prof/rspec_stamp/parser.rb
 - lib/test_prof/rspec_stamp/rspec.rb
+- lib/test_prof/rubocop.rb
 - lib/test_prof/ruby_prof.rb
 - lib/test_prof/ruby_prof/rspec.rb
 - lib/test_prof/stack_prof.rb
 - lib/test_prof/stack_prof/rspec.rb
+- lib/test_prof/tag_prof.rb
+- lib/test_prof/tag_prof/rspec.rb
 - lib/test_prof/version.rb
-- spec/integrations/any_fixture_spec.rb
-- spec/integrations/before_all_spec.rb
-- spec/integrations/event_prof_spec.rb
-- spec/integrations/factory_doctor_spec.rb
-- spec/integrations/fixtures/rspec/any_fixture_fixture.rb
-- spec/integrations/fixtures/rspec/before_all_fixture.rb
-- spec/integrations/fixtures/rspec/event_prof_factory_create_fixture.rb
-- spec/integrations/fixtures/rspec/event_prof_fixture.rb
-- spec/integrations/fixtures/rspec/event_prof_sidekiq_fixture.rb
-- spec/integrations/fixtures/rspec/factory_doctor_fixture.rb
-- spec/integrations/fixtures/rspec/rspec_stamp_fixture_tmpl.rb
-- spec/integrations/rspec_stamp_spec.rb
-- spec/spec_helper.rb
-- spec/support/ar_models.rb
-- spec/support/instrumenter_stub.rb
-- spec/support/integration_helpers.rb
-- spec/support/transactional_context.rb
-- spec/test_prof/any_fixture_spec.rb
-- spec/test_prof/event_prof_spec.rb
-- spec/test_prof/ext/float_duration_spec.rb
-- spec/test_prof/factory_doctor_spec.rb
-- spec/test_prof/rspec_stamp/parser_spec.rb
-- spec/test_prof/rspec_stamp_spec.rb
-- spec/test_prof/ruby_prof_spec.rb
-- spec/test_prof/stack_prof_spec.rb
-- spec/test_prof_spec.rb
-- test-prof.gemspec
 homepage: http://github.com/palkan/test-prof
 licenses:
 - MIT
@@ -229,15 +236,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby applications tests profiling tools