test-prof 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb103d86ccc7a513de8b30ae8ddf536c9bbc6255
-  data.tar.gz: f0fe1c206faab5761b4419ccbf8745f4060d3e82
+  metadata.gz: d45463f21e439e42506d700ace1dcc6202869ee8
+  data.tar.gz: 1f6cd4e4a1161cfacda3f6f95371408131e4e49f
 SHA512:
-  metadata.gz: f6a4881cfc954438fa4184c2cd9be1784d10bfcd6d92931ea5132c8422aa08866b77e60ec91066ddd6afb620c524e99b4584818d158f396176f9649ef3a0e038
-  data.tar.gz: a699bd6e308b370aa4e53447025551a5b2f30249eb893356d30238eaed4dc135bb69335c780ea9d0b306ce569bca29117494ab91b6a70bbb7a22f714a65f827f
+  metadata.gz: 816ca6fed6eb159671eb0563294daae38ec832e7a6530eec7c6cefe16bf66d96d7014c5d3a110a3c207f0cbaa49425cab335fc41b5d7be557e2ad07aee5753ae
+  data.tar.gz: a22cd5e4f92f5e47918132d5646a53593a756cfb27fb88f00152d8e58ca6ec8f0479893f99698cd50f9c4ee26da79ba04351498552224b745a4b0f9376a17179

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change log
 
+## 0.4.0
+
+### Features:
+
+- [#29](https://github.com/palkan/test-prof/pull/29) EventProf Minitest integration. ([@IDolgirev][])
+
+It is possible now to use Event Prof with Minitest
+
+- [#30](https://github.com/palkan/test-prof/pull/30) Fabrication support for FactoryProf. ([@Shkrt][])
+
+FactoryProf now also accounts objects created by Fabrication gem (in addition to FactoryGirl)
+
 ## 0.3.0
 
 ### Features:
@@ -20,7 +32,7 @@ After running the command above the top 5 slowest example groups would be marked
 
 - [#14](https://github.com/palkan/test-prof/pull/14) RSpecDissect profiler. ([@palkan][])
 
-RSpecDissect tracks how much time do you spend in `before` hooks 
+RSpecDissect tracks how much time do you spend in `before` hooks
 and memoization helpers (i.e. `let`) in your tests.
 
 - [#13](https://github.com/palkan/test-prof/pull/13) RSpec `let_it_be` method. ([@palkan][])
@@ -88,4 +100,7 @@ Ensure output dir exists in `#artifact_path` method.
 
 [@palkan]: https://github.com/palkan
 [@marshall-lee]: https://github.com/marshall-lee
-[@danielwestendorf]: https://github.com/danielwestendorf
+[@danielwestendorf]: https://github.com/danielwestendorf
+[@Shkrt]: https://github.com/Shkrt
+[@IDolgirev]: https://github.com/IDolgirev
+

data/README.md

@@ -22,6 +22,8 @@ TestProf toolbox aims to help you identify bottlenecks in your test suite. It co
 
 Of course, we have some [solutions](#tips-and-tricks-or-recipes) for common performance issues too, bundled into the gem.
 
+[![](https://s3-us-west-1.amazonaws.com/vladem/test-prof/TestProf.png)](https://coggle.it/diagram/Wa7tW-87jAAB0ExN)
+
 See [Table of Contents](#table-of-contents) for more.
 
 Supported Ruby versions:
@@ -112,8 +114,6 @@ Or TODO list:
 
 - Better Minitest integration (PRs welcome!)
 
-- Other data generation library support (e.g [Fabricator](http://fabricationgem.org/)). _Does anyone use something except from FactoryGirl?_
-
 - Improve FactoryDoctor
 
 - Add more Rubocop cops (e.g. `CreateListLimit`)

data/guides/any_fixture.md

@@ -58,3 +58,58 @@ require "test_prof/recipes/rspec/any_fixture"
 ```
 
 Now you can use `TestProf::AnyFixture` in your tests.
+
+## Caveats
+
+`AnyFixture` cleans tables in the reverse order as compared to the order they were populated. That
+means when you register a fixture which references a not-yet-registered table, a
+foreign-key violation error *might* occur (if any). An example is worth more than 1000
+words:
+
+```ruby
+class Author < ApplicationRecord
+  has_many :articles
+end
+
+class Article < ApplicationRecord
+  belongs_to :author
+end
+```
+
+And the shared contexts:
+
+```ruby
+RSpec.shared_context "author" do
+  before(:all) do
+    @author = TestProf::AnyFixture.register(:author) do
+      FactoryGirl.create(:account)
+    end
+  end
+
+  let(:author) { @author }
+end
+
+RSpec.shared_context "article" do
+  before(:all) do
+    # outside of AnyFixture, we don't know about its dependent tables
+    author = FactoryGirl.create(:author)
+
+    @article = TestProf::AnyFixture.register(:article) do
+      FactoryGirl.create(:article, author: author)
+    end
+  end
+
+  let(:article) { @article }
+end
+```
+
+Then in some example:
+
+```ruby
+# This one adds only the 'articles' table to the list of affected tables
+include_context "article"
+# And this one adds the 'authors' table
+include_context "author"
+```
+
+Now we have the following affected tables list: `["articles", "authors"]`. At the end of the suite, the "authors" table is cleaned first which leads to a foreign-key violation error.

data/guides/event_prof.md

@@ -30,15 +30,53 @@ fails (./spec/shared_examples/controllers/invalid_examples.rb:3) – 00:00.007 (
 
 ## Instructions
 
-Currently, EventProf supports only ActiveSupport::Notifications and RSpec.
+Currently, EventProf supports only ActiveSupport::Notifications
 
-To activate EventProf use `EVENT_PROF` environment variable set to event name:
+To activate EventProf with:
+
+### Rspec
+
+Use `EVENT_PROF` environment variable set to event name:
 
 ```sh
 # Collect SQL queries stats for every suite and example
 EVENT_PROF='sql.active_record' rspec ...
 ```
 
+### Minitest
+
+Use `EVENT_PROF` environment variable set to event name:
+
+```sh
+# Collect SQL queries stats for every suite and example
+EVENT_PROF='sql.active_record' rake test
+```
+or use CLI options as well:
+
+```sh
+# Run a specific file using CLI option
+ruby test/my_super_test.rb --event-prof=sql.active_record
+
+# Show the list of possible options:
+ruby test/my_super_test.rb --help
+```
+
+### Using with Minitest::Reporters
+
+If you're using `Minitest::Reporters` in your project you have to explicitly declare it
+in your test helper file:
+
+```sh
+require 'minitest/reporters'
+Minitest::Reporters.use! [YOUR_FAVORITE_REPORTERS]
+```
+#### NOTICE
+When you have `minitest-reporters` installed as a gem but not declared in your `Gemfile`
+make sure to always prepend your test run command with `bundle exec` (but we sure that you always do it).
+Otherwise, you'll get an error caused by Minitest plugin system, which scans all the entries in the
+`$LOAD_PATH` for any `minitest/*_plugin.rb`, thus initialization of `minitest-reporters` plugin which is
+available in that case doesn't happens correctly.
+
 See [Rails guides](http://guides.rubyonrails.org/active_support_instrumentation.html)
 for the list of available events if you're using Rails.
 

data/guides/factory_prof.md

@@ -16,11 +16,12 @@ Example output:
 
 It shows both the total number of the factory runs and the number of _top-level_ runs, i.e. not during another factory invocation (e.g. when using associations.)
 
-**NOTE**: FactoryProf only tracks the usage of `create` strategy.
+**NOTE**: FactoryProf only tracks the database-persisted factories. In case of FactoryFirl these are the factories
+provided by using `create` strategy. In case of Fabrication - objects that created using `create` method.
 
 ## Instructions
 
-FactoryProf can only be used with FactoryGirl.
+FactoryProf can be used with FactoryGirl or Fabrication - application can be bundled with both gems at the same time.
 
 To activate FactoryProf use `FPROF` environment variable:
 

data/lib/minitest/event_prof_plugin.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'test_prof/event_prof/minitest'
+
+module Minitest # :nodoc:
+  def self.plugin_event_prof_options(opts, options)
+    opts.on "--event-prof=EVENT", "Collects metrics for specified EVENT" do |event|
+      options[:event] = event
+    end
+    opts.on "--event-prof-rank-by=RANK_BY", "Defines RANK_BY parameter for results" do |rank|
+      options[:rank_by] = rank.to_sym
+    end
+    opts.on "--event-prof-top-count=N", "Limits results with N groups/examples" do |count|
+      options[:top_count] = count.to_i
+    end
+    opts.on "--event-prof-per-example", TrueClass, "Includes examples metrics to results" do |flag|
+      options[:per_example] = flag
+    end
+  end
+
+  def self.plugin_event_prof_init(options)
+    options[:event] = ENV['EVENT_PROF'] if ENV['EVENT_PROF']
+    options[:rank_by] = ENV['EVENT_PROF_RANK'].to_sym if ENV['EVENT_PROF_RANK']
+    options[:top_count] = ENV['EVENT_PROF_TOP'].to_i if ENV['EVENT_PROF_TOP']
+    options[:per_example] = true if ENV['EVENT_PROF_EXAMPLES']
+
+    return unless options[:event]
+    reporter << EventProfReporter.new(options[:io], options)
+  end
+end

data/lib/test_prof/event_prof.rb

@@ -186,5 +186,5 @@ module TestProf
 end
 
 require "test_prof/event_prof/rspec" if defined?(RSpec::Core)
-require "test_prof/event_prof/minitest" if defined?(Minitest::Reporters)
+require "test_prof/event_prof/minitest" if defined?(Minitest)
 require "test_prof/event_prof/custom_events"

data/lib/test_prof/event_prof/formatters/minitest.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "test_prof/ext/float_duration"
+require "test_prof/ext/string_truncate"
+require "test_prof/ext/string_strip_heredoc"
+
+module TestProf
+  module EventProf
+    class MinitestFormatter # :nodoc:
+      using FloatDuration
+      using StringTruncate
+      using StringStripHeredoc
+
+      def initialize(profiler)
+        @profiler = profiler
+        @results = []
+      end
+
+      def prepare_results
+        total_results
+        by_groups
+        by_examples
+        @results.join
+      end
+
+      private
+
+      def total_results
+        @results <<
+          <<-MSG.strip_heredoc
+            EventProf results for #{@profiler.event}
+
+            Total time: #{@profiler.total_time.duration}
+            Total events: #{@profiler.total_count}
+
+            Top #{@profiler.top_count} slowest suites (by #{@profiler.rank_by}):
+
+          MSG
+      end
+
+      def by_groups
+        @profiler.results[:groups].each do |group|
+          description = group[:id][:name]
+          location = group[:id][:location]
+
+          @results <<
+            <<-GROUP.strip_heredoc
+              #{description.truncate} (#{location}) – #{group[:time].duration} (#{group[:count]} / #{group[:examples]})
+            GROUP
+        end
+      end
+
+      def by_examples
+        return unless @profiler.results[:examples]
+        @results << "\nTop #{@profiler.top_count} slowest tests (by #{@profiler.rank_by}):\n\n"
+
+        @profiler.results[:examples].each do |example|
+          description = example[:id][:name]
+          location = example[:id][:location]
+
+          @results <<
+            <<-GROUP.strip_heredoc
+              #{description.truncate} (#{location}) – #{example[:time].duration} (#{example[:count]})
+            GROUP
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/event_prof/minitest.rb

@@ -1,3 +1,90 @@
 # frozen_string_literal: true
 
-# TODO: write Minitest reporter
+require 'test_prof/logging'
+require 'test_prof/event_prof/formatters/minitest'
+
+module Minitest
+  class EventProfReporter < AbstractReporter # :nodoc:
+    include TestProf::Logging
+
+    attr_accessor :io
+
+    def initialize(io = $stdout, options = {})
+      @io = io
+      @profiler = configure_profiler(options)
+      @formatter = TestProf::EventProf::MinitestFormatter.new(@profiler)
+      @current_group = nil
+      @current_example = nil
+      inject_to_minitest_reporters if defined? Minitest::Reporters
+    end
+
+    def start; end
+
+    def prerecord(group, example)
+      change_current_group(group, example) unless @current_group
+      track_current_example(group, example)
+    end
+
+    def before_test(test)
+      prerecord(test.class, test.name)
+    end
+
+    def record(*)
+      @profiler.example_finished(@current_example)
+    end
+
+    def after_test(*); end
+
+    def report
+      @profiler.group_finished(@current_group)
+      result = @formatter.prepare_results
+      puts "\n"
+      log :info, result
+    end
+
+    private
+
+    def track_current_example(group, example)
+      unless @current_group[:name] == group.name
+        @profiler.group_finished(@current_group)
+        change_current_group(group, example)
+      end
+
+      @current_example = {
+        name: example.gsub(/^test_(?:\d+_)?/, ''),
+        location: File.expand_path(location(group, example).join(':')).gsub(Dir.getwd, '.')
+      }
+
+      @profiler.example_started(@current_example)
+    end
+
+    def change_current_group(group, example)
+      @current_group = {
+        name: group.name,
+        location: File.expand_path(location(group, example).first).gsub(Dir.getwd, '.')
+      }
+
+      @profiler.group_started(@current_group)
+    end
+
+    def location(group, example)
+      suite = group.public_instance_methods.select { |mtd| mtd.to_s.match /^test_/ }
+      name = suite.find { |mtd| mtd.to_s == example }
+      group.instance_method(name).source_location
+    end
+
+    def configure_profiler(options)
+      TestProf::EventProf.configure do |config|
+        config.event = options[:event]
+        config.rank_by = options[:rank_by] if options[:rank_by]
+        config.top_count = options[:top_count] if options[:top_count]
+        config.per_example = options[:per_example] if options[:per_example]
+      end
+      TestProf::EventProf.build
+    end
+
+    def inject_to_minitest_reporters
+      Minitest::Reporters.reporters << self if Minitest::Reporters.reporters
+    end
+  end
+end

data/lib/test_prof/factory_prof.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
-require "test_prof/factory_prof/factory_girl_patch"
 require "test_prof/factory_prof/printers/simple"
 require "test_prof/factory_prof/printers/flamegraph"
+require "test_prof/factory_prof/factory_builders/factory_girl"
+require "test_prof/factory_prof/factory_builders/fabrication"
 
 module TestProf
   # FactoryProf collects "factory stacks" that can be used to build
   # flamegraphs or detect most popular factories
   module FactoryProf
+    FACTORY_BUILDERS = [FactoryBuilders::FactoryGirl,
+                        FactoryBuilders::Fabrication].freeze
+
     # FactoryProf configuration
     class Configuration
       attr_accessor :mode
@@ -69,9 +73,7 @@ module TestProf
 
         log :info, "FactoryProf enabled (#{config.mode} mode)"
 
-        # Monkey-patch FactoryGirl
-        ::FactoryGirl::FactoryRunner.prepend(FactoryGirlPatch) if
-          defined?(::FactoryGirl)
+        FACTORY_BUILDERS.each(&:patch)
       end
 
       # Inits FactoryProf and setups at exit hook,
@@ -99,8 +101,8 @@ module TestProf
         Result.new(@stacks, @stats)
       end
 
-      def track(strategy, factory)
-        return yield if !running? || (strategy != :create)
+      def track(factory)
+        return yield unless running?
         begin
           @depth += 1
           @current_stack << factory if config.flamegraph?

data/lib/test_prof/factory_prof/fabrication_patch.rb

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

data/lib/test_prof/factory_prof/factory_builders/fabrication.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "test_prof/factory_prof/fabrication_patch"
+
+module TestProf
+  module FactoryProf
+    module FactoryBuilders
+      # implementation of #patch and #track methods
+      # to provide unified interface for all factory-building gems
+      class Fabrication
+        # Monkey-patch Fabrication
+        def self.patch
+          TestProf.require 'fabrication', ""
+          ::Fabricate.singleton_class.prepend(FabricationPatch) if
+            defined?(::Fabrication)
+        end
+
+        def self.track(factory, &block)
+          FactoryProf.track(factory, &block)
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/factory_prof/factory_builders/factory_girl.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "test_prof/factory_prof/factory_girl_patch"
+
+module TestProf
+  module FactoryProf
+    module FactoryBuilders
+      # implementation of #patch and #track methods
+      # to provide unified interface for all factory-building gems
+      class FactoryGirl
+        # Monkey-patch FactoryGirl
+        def self.patch
+          ::FactoryGirl::FactoryRunner.prepend(FactoryGirlPatch) if
+            defined?(::FactoryGirl)
+        end
+
+        def self.track(strategy, factory, &block)
+          return yield unless strategy == :create
+          FactoryProf.track(factory, &block)
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/factory_prof/factory_girl_patch.rb

@@ -5,7 +5,7 @@ module TestProf
     # Wrap #run method with FactoryProf tracking
     module FactoryGirlPatch
       def run(strategy = @strategy)
-        FactoryProf.track(strategy, @name) { super }
+        FactoryBuilders::FactoryGirl.track(strategy, @name) { super }
       end
     end
   end

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.50'
 description: "\n    Ruby applications tests profiling tools.\n\n    Contains tools
-  to anylyze factories usage, integrate with Ruby profilers,\n    profile your examples
+  to analyze factories usage, integrate with Ruby profilers,\n    profile your examples
   using ActiveSupport notifications (if any) and\n    statically analyze your code
   with custom Rubocop cops.\n  "
 email:
@@ -116,6 +116,7 @@ files:
 - guides/stack_prof.md
 - guides/tag_prof.md
 - guides/tests_sampling.md
+- lib/minitest/event_prof_plugin.rb
 - lib/test-prof.rb
 - lib/test_prof.rb
 - lib/test_prof/any_fixture.rb
@@ -125,6 +126,7 @@ files:
 - lib/test_prof/event_prof/custom_events/factory_create.rb
 - lib/test_prof/event_prof/custom_events/sidekiq_inline.rb
 - lib/test_prof/event_prof/custom_events/sidekiq_jobs.rb
+- lib/test_prof/event_prof/formatters/minitest.rb
 - lib/test_prof/event_prof/instrumentations/active_support.rb
 - lib/test_prof/event_prof/minitest.rb
 - lib/test_prof/event_prof/rspec.rb
@@ -139,6 +141,9 @@ files:
 - 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/fabrication_patch.rb
+- lib/test_prof/factory_prof/factory_builders/fabrication.rb
+- lib/test_prof/factory_prof/factory_builders/factory_girl.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
@@ -184,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby applications tests profiling tools