test-prof 0.1.0.beta3 → 0.1.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58805aeec9869d4d5b15a7a936ff1f0f10c6b7cb
-  data.tar.gz: 6e89ccd56db3e421d5660573ea4cfea9dceb8010
+  metadata.gz: 4bebeb0abae778ec18d0ec11538784b0255bd26d
+  data.tar.gz: '098fa4a951eba03ac7fcda3e6565ca01936dd182'
 SHA512:
-  metadata.gz: b1985d22be179fffe92e3a1f87bf76eb5b08a4667195badd55c3caa9e4705462358708e6c9362a14cfbaf0928e0ed23baa65e3358a42b773426c567007915d83
-  data.tar.gz: 96fd3e35e266b7e5cdb2558bab332a63b0d7ccc0233866444d108a7b7549e9ffbe528d2b51b44ab558ebb80947d49c061cf69c92bec9161117c4b337d7c61c0e
+  metadata.gz: 1099d6a1805f71697cccbb555025bffba6589e87016e33d715a046368e20dda1d5d1b2df259792b144c2ba0e7f816f64e6dd745f14114b1bb4ee6446e2edbba2
+  data.tar.gz: 4212b16b0487b6a5c4853e855a07278778cc487f0b378148d4903e180d20a935e3110542bdaf553070f499ddce220a046366b2b18049ae598b6dc36e4a54e0dc

data/README.md

@@ -31,6 +31,8 @@ See [Table of Contents](#table-of-contents) for more.
 
 - RubyConfBy, 2017, "Run Test Run" talk [[video](https://www.youtube.com/watch?v=q52n4p0wkIs), [slides](https://speakerdeck.com/palkan/rubyconfby-minsk-2017-run-test-run)]
 
+- [Tips to improve speed of your test suite](https://medium.com/appaloosa-store-engineering/tips-to-improve-speed-of-your-test-suite-8418b485205c) by [Benoit Tigeot](https://github.com/benoittgt)
+
 ## Installation
 
 Add `test-prof` gem to your application:
@@ -69,8 +71,12 @@ We also want to share some small code tricks which can help you to improve your
 
 - [AnyFixture](https://github.com/palkan/test-prof/tree/master/guides/any_fixture.md)
 
+- [FactoryDefault](https://github.com/palkan/test-prof/tree/master/guides/factory_default.md)
+
 - [RSpec Stamp](https://github.com/palkan/test-prof/tree/master/guides/rspec_stamp.md)
 
+- [Tests Sampling](https://github.com/palkan/test-prof/tree/master/guides/tests_sampling.md)
+
 ## Configuration
 
 TestProf global configuration is used by most of the profilers:

data/guides/factory_default.md

@@ -0,0 +1,109 @@
+# FactoryDefault
+
+_Factory Default_ aims to help you cope with _factory cascades_ (see [FactoryProf](https://github.com/palkan/test-prof/tree/master/guides/factory_prof.md)) by re-using associated records.
+
+It can be very useful when you're working on a typical SaaS application (or other hierarchical data).
+
+Consider an example. Assume we have the following factories:
+
+```ruby
+factory :account do
+end
+
+factory :user do
+  account
+end
+
+factory :project do
+  account
+  user
+end
+
+factory :task do
+  account
+  project
+  user
+end
+```
+
+And we want to test the `Task` model:
+
+```ruby
+describe "PATCH #update" do
+  let(:task( { create(:task) }
+
+  it "works" do
+    patch :update, id: task.id, task: { completed: 't' }
+    expect(response).to be_success
+  end
+
+  ...
+end
+```
+
+How many users and accounts are created per example? Two and four respectively.
+
+And it breaks our logic (every object should belong to the same account).
+
+Typical workaround:
+
+```ruby
+describe "PATCH #update" do
+  let(:account) { create(:account) }
+  let(:project) { create(:project, account: account) }
+  let(:task( { create(:task, project: project, account: account) }
+
+  it "works" do
+    patch :update, id: task.id, task: { completed: 't' }
+    expect(response).to be_success
+  end
+end
+```
+
+That works. And there are some cons: it's a little bit verbose and error-prone (easy to forget something).
+
+Here is how we can deal with it using FactoryDefault:
+
+```ruby
+describe "PATCH #update" do
+  let(:account) { create_default(:account) }
+  let(:project) { create_default(:project) }
+  let(:task( { create(:task) }
+
+  # and if need more projects, users, tasks with the same parent record,
+  # we just write
+  let(:another_project) { create(:project) } # uses the same account
+  let(:another_task) { create(:task) } # uses the same account and the first project
+
+  it "works" do
+    patch :update, id: task.id, task: { completed: 't' }
+    expect(response).to be_success
+  end
+end
+```
+
+*NOTE*. This feature introduces a bit of _magic_ to your tests, so use it with caution ('cause tests should be human-readable first). Good idea is to use defaults for top-level entities only (such as tenants in multi-tenancy apps).
+
+## Instructions
+
+In your `spec_helper.rb`:
+
+```ruby
+require "test_prof/recipes/rspec/factory_default"
+```
+
+This adds two new methods to FactoryGirl:
+
+- `FactoryGirl#set_factory_default(factory, object)` – use the `object` as default for associations built with `factory`
+
+Example:
+
+```ruby
+let(:user) { create(:user) }
+
+before { FactoryGirl.set_factory_default(:user, user) }
+```
+
+- `FactoryGirl#create_default(factory, *args)` – is a shortcut for `create` + `set_factory_default`.
+
+*NOTE*. Defaults are cleaned up after each example.

data/guides/tests_sampling.md

@@ -0,0 +1,24 @@
+# Tests Sampling
+
+Sometimes it's useful to run profilers against randomly chosen tests. Unfortunetaly, test frameworks don's support such functionality. That's why we've included small patches for RSpec and Minitest in TestProf.
+
+
+## Instructions
+
+Require the corresponding patch:
+
+```ruby
+# For RSpec in your spec_helper.rb
+require "test_prof/recipes/rspec/sample"
+
+# For Minitest in your test_helper.rb
+require "test_prof/recipes/minitest/sample"
+```
+
+And then just add `SAMPLE` env variable with the number of example groups (or suites) you want to run:
+
+```sh
+SAMPLE=10 rspec
+```
+
+That's it. Enjoy!

data/lib/test_prof/factory_default.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "test_prof/factory_default/factory_girl_patch"
+
+module TestProf
+  # FactoryDefault allows use to re-use associated objects
+  # in factories implicilty
+  module FactoryDefault
+    module DefaultSyntax # :nodoc:
+      def create_default(name, *args, &block)
+        set_factory_default(
+          name,
+          FactoryGirl.create(name, *args, &block)
+        )
+      end
+
+      def set_factory_default(name, obj)
+        FactoryDefault.register(name, obj)
+      end
+    end
+
+    class << self
+      def init
+        FactoryGirl::Syntax::Methods.include DefaultSyntax
+        FactoryGirl.extend DefaultSyntax
+        FactoryGirl::Strategy::Create.prepend StrategyExt
+        FactoryGirl::Strategy::Build.prepend StrategyExt
+        FactoryGirl::Strategy::Stub.prepend StrategyExt
+
+        @store = {}
+      end
+
+      def register(name, obj)
+        store[name] = obj
+      end
+
+      def get(name)
+        store[name]
+      end
+
+      def exists?(name)
+        store.key?(name)
+      end
+
+      def remove(name)
+        store.delete(name)
+      end
+
+      def reset
+        @store.clear
+      end
+
+      private
+
+      attr_reader :store
+    end
+  end
+end

data/lib/test_prof/factory_default/factory_girl_patch.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TestProf
+  module FactoryDefault # :nodoc: all
+    module RunnerExt
+      refine FactoryGirl::FactoryRunner do
+        def name
+          @name
+        end
+      end
+    end
+
+    using RunnerExt
+
+    module StrategyExt
+      def association(runner)
+        return super unless FactoryDefault.exists?(runner.name)
+        FactoryDefault.get(runner.name)
+      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/stack_prof.rb

@@ -83,6 +83,16 @@ 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

data/lib/test_prof/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta3
+  version: 0.1.0.beta4
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-08-01 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
@@ -161,6 +175,7 @@ files:
 - 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
@@ -168,6 +183,7 @@ files:
 - 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
@@ -181,6 +197,8 @@ 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
@@ -190,8 +208,11 @@ files:
 - 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