test-prof 0.1.0.beta2 → 0.1.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7202c99e7ad5d1430b4a281dea1e5b8fa8f508c
-  data.tar.gz: 4b835921de89f894022a8b1620f650d15cbe7956
+  metadata.gz: 58805aeec9869d4d5b15a7a936ff1f0f10c6b7cb
+  data.tar.gz: 6e89ccd56db3e421d5660573ea4cfea9dceb8010
 SHA512:
-  metadata.gz: e6a6afe56f4973b7f17806f5aa2b0c1c4833fc813e123328603eec65e4bafeec5eaceae2247e038743f961ca8257543b4b1b15676c5452bb3ce78f55e485612c
-  data.tar.gz: d402f3373d470a031537f8c40305cbd97334739eb94d9e29e2f7a1d877fea7f28b0b658efc9ce2c3a75dc202f7334da7998add883a27d06988459cab5893a7dd
+  metadata.gz: b1985d22be179fffe92e3a1f87bf76eb5b08a4667195badd55c3caa9e4705462358708e6c9362a14cfbaf0928e0ed23baa65e3358a42b773426c567007915d83
+  data.tar.gz: 96fd3e35e266b7e5cdb2558bab332a63b0d7ccc0233866444d108a7b7549e9ffbe528d2b51b44ab558ebb80947d49c061cf69c92bec9161117c4b337d7c61c0e

data/README.md

@@ -53,6 +53,8 @@ Checkout our guides for each specific tool:
 
 - [Instrumentation Profiler](https://github.com/palkan/test-prof/tree/master/guides/event_prof.md) (e.g. ActiveSupport notifications)
 
+- [Tag Profiler](https://github.com/palkan/test-prof/tree/master/guides/tag_prof.md)
+
 - [Factory Doctor](https://github.com/palkan/test-prof/tree/master/guides/factory_doctor.md)
 
 - [Factory Profiler](https://github.com/palkan/test-prof/tree/master/guides/factory_prof.md)

data/guides/ruby_prof.md

@@ -58,4 +58,6 @@ end
 
 By default, we use `CallStackPrinter`.
 
+Also, you can specify RubyProf mode (`wall`, `cpu`, etc) through `TEST_RUBY_PROF_MODE` env variable.
+
 See [ruby_prof.rb](https://github.com/palkan/test-prof/tree/master/lib/test_prof/ruby_prof.rb) for all available configuration options and their usage.

data/guides/stack_prof.md

@@ -40,4 +40,8 @@ end
 
 ### Configuration
 
+You can change StackProf mode (which is `wall` by default) through `TEST_STACK_PROF_MODE` env variable.
+
+If you want to generate flame graphs you should collect _raw_ data. Turn _raw_ collection on by passing `TEST_STACK_PROF_RAW=1`.
+
 See [stack_prof.rb](https://github.com/palkan/test-prof/tree/master/lib/test_prof/stack_prof.rb) for all available configuration options and their usage.

data/guides/tag_prof.md

@@ -0,0 +1,52 @@
+# TagProf
+
+TagProf is a simple profiler which collects examples statistics grouped by a provided tag value.
+
+That's pretty useful in conjunction with `rspec-rails` built-in feature – `infer_spec_types_from_location!` – which automatically adds `type` to examples metadata.
+
+Example output:
+
+```sh
+[TEST PROF INFO] TagProf report for type
+
+       type          time   total  %total   %time           avg
+
+    request     00:04.808      42   33.87   54.70     00:00.114
+ controller     00:02.855      42   33.87   32.48     00:00.067
+      model     00:01.127      40   32.26   12.82     00:00.028
+```
+
+
+It shows both the total number of examples in each group and the total time spent (as long as percentages and average values).
+
+
+## Instructions
+
+TagProf can only be used with RSpec.
+
+To activate TagProf use `TAG_PROF` environment variable:
+
+```sh
+# Group by type
+TAG_PROF=type rspec
+```
+
+## Pro-Tip: More Types
+
+By default, RSpec only infers types for default Rails app entities (such as controllers, models, mailers, etc.).
+Modern Rails applications typically contain other abstractions too (e.g. services, forms, presenters, etc.), but RSpec is not aware of them and doesn't add any metadata.
+
+That's the quick workaround:
+
+```ruby
+RSpec.configure do |config|
+
+  ...
+  config.define_derived_metadata(file_path: %r{/spec/}) do |metadata|
+    # do not overwrite type if it's already set
+    next if metadata.key?(:type)
+    match = metadata[:location].match(%r{/spec/([^/]+)/})
+    metadata[:type] = match[1].singularize.to_sym
+  end
+end
+```

data/lib/test_prof.rb

@@ -42,13 +42,14 @@ module TestProf
       false
     end
 
-    # Run block only if provided env var is present.
+    # Run block only if provided env var is present and
+    # equal to the provided value (if any).
     # Contains workaround for applications using Spring.
-    def activate(env_var)
-      if defined?(::Spring) && !ENV['DISABLE_SPRING']
-        Spring.after_fork { yield if ENV[env_var] }
-      elsif ENV[env_var]
-        yield
+    def activate(env_var, val = nil)
+      if defined?(::Spring)
+        ::Spring.after_fork { activate!(env_var, val) { yield } }
+      else
+        activate!(env_var, val) { yield }
       end
     end
 
@@ -69,6 +70,10 @@ module TestProf
 
     private
 
+    def activate!(env_var, val)
+      yield if ENV[env_var] && (val.nil? || ENV[env_var] == val)
+    end
+
     def with_timestamps(path)
       return path unless config.timestamps?
       timestamps = "-#{Time.now.to_i}"
@@ -106,3 +111,4 @@ require "test_prof/event_prof"
 require "test_prof/factory_doctor"
 require "test_prof/factory_prof"
 require "test_prof/rspec_stamp"
+require "test_prof/tag_prof"

data/lib/test_prof/event_prof/custom_events.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require "test_prof/event_prof/custom_events/factory_create" if ENV['EVENT_PROF'] == "factory.create"
-require "test_prof/event_prof/custom_events/sidekiq_inline" if ENV['EVENT_PROF'] == "sidekiq.inline"
-require "test_prof/event_prof/custom_events/sidekiq_jobs" if ENV['EVENT_PROF'] == "sidekiq.jobs"
+require "test_prof/event_prof/custom_events/factory_create"
+require "test_prof/event_prof/custom_events/sidekiq_inline"
+require "test_prof/event_prof/custom_events/sidekiq_jobs"

data/lib/test_prof/event_prof/custom_events/factory_create.rb

@@ -39,13 +39,15 @@ module TestProf::EventProf::CustomEvents
   end
 end
 
-if TestProf.require(
-  'factory_girl',
-  <<~MSG
-    Failed to load FactoryGirl.
+TestProf.activate('EVENT_PROF', 'factory.create') do
+  if TestProf.require(
+    'factory_girl',
+    <<~MSG
+      Failed to load FactoryGirl.
 
-    Make sure that "factory_girl" gem is in your Gemfile.
-  MSG
-)
-  TestProf::EventProf::CustomEvents::FactoryCreate.setup!
+      Make sure that "factory_girl" gem is in your Gemfile.
+    MSG
+  )
+    TestProf::EventProf::CustomEvents::FactoryCreate.setup!
+  end
 end

data/lib/test_prof/event_prof/custom_events/sidekiq_inline.rb

@@ -36,13 +36,15 @@ module TestProf::EventProf::CustomEvents
   end
 end
 
-if TestProf.require(
-  'sidekiq/testing',
-  <<~MSG
-    Failed to load Sidekiq.
+TestProf.activate('EVENT_PROF', 'sidekiq.inline') do
+  if TestProf.require(
+    'sidekiq/testing',
+    <<~MSG
+      Failed to load Sidekiq.
 
-    Make sure that "sidekiq" gem is in your Gemfile.
-  MSG
-)
-  TestProf::EventProf::CustomEvents::SidekiqInline.setup!
+      Make sure that "sidekiq" gem is in your Gemfile.
+    MSG
+  )
+    TestProf::EventProf::CustomEvents::SidekiqInline.setup!
+  end
 end

data/lib/test_prof/event_prof/custom_events/sidekiq_jobs.rb

@@ -23,16 +23,18 @@ module TestProf::EventProf::CustomEvents
   end
 end
 
-if TestProf.require(
-  'sidekiq/testing',
-  <<~MSG
-    Failed to load Sidekiq.
+TestProf.activate('EVENT_PROF', 'sidekiq.jobs') do
+  if TestProf.require(
+    'sidekiq/testing',
+    <<~MSG
+      Failed to load Sidekiq.
 
-    Make sure that "sidekiq" gem is in your Gemfile.
-  MSG
-)
-  TestProf::EventProf::CustomEvents::SidekiqJobs.setup!
-  TestProf::EventProf.configure do |config|
-    config.rank_by = :count
+      Make sure that "sidekiq" gem is in your Gemfile.
+    MSG
+  )
+    TestProf::EventProf::CustomEvents::SidekiqJobs.setup!
+    TestProf::EventProf.configure do |config|
+      config.rank_by = :count
+    end
   end
 end

data/lib/test_prof/event_prof/rspec.rb

@@ -87,7 +87,11 @@ TestProf.activate('EVENT_PROF') do
   RSpec.configure do |config|
     listener = TestProf::EventProf::RSpecListener.new
 
-    config.reporter.register_listener(listener, *TestProf::EventProf::RSpecListener::NOTIFICATIONS)
+    config.before(:suite) do
+      config.reporter.register_listener(
+        listener, *TestProf::EventProf::RSpecListener::NOTIFICATIONS
+      )
+    end
 
     config.after(:suite) { listener.print }
   end

data/lib/test_prof/factory_doctor/rspec.rb

@@ -83,9 +83,11 @@ TestProf.activate('FDOC') do
   RSpec.configure do |config|
     listener = TestProf::FactoryDoctor::RSpecListener.new
 
-    config.reporter.register_listener(
-      listener, *TestProf::FactoryDoctor::RSpecListener::NOTIFICATIONS
-    )
+    config.before(:suite) do
+      config.reporter.register_listener(
+        listener, *TestProf::FactoryDoctor::RSpecListener::NOTIFICATIONS
+      )
+    end
 
     config.after(:suite) { listener.print }
   end

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/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)

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
 
@@ -89,7 +89,7 @@ module TestProf
 
       def build_path(name)
         TestProf.artefact_path(
-          "stack-prof-report-#{config.mode}-#{name}.dump"
+          "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.sum { |v| v[:count] }
+        total_time = @tags.values.sum { |v| 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.beta2"
+  VERSION = "0.1.0.beta3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta2
+  version: 0.1.0.beta3
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,6 +167,7 @@ files:
 - guides/rubocop.md
 - guides/ruby_prof.md
 - guides/stack_prof.md
+- guides/tag_prof.md
 - lib/test-prof.rb
 - lib/test_prof.rb
 - lib/test_prof/any_fixture.rb
@@ -199,6 +200,8 @@ files:
 - 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
 homepage: http://github.com/palkan/test-prof
 licenses: