test-prof 0.1.0.beta4 → 0.1.0.pre2

data/lib/test_prof/factory_doctor/rspec.rb

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

data/lib/test_prof/ruby_prof.rb

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

data/lib/test_prof/version.rb

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

data/spec/integrations/any_fixture_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "AnyFixture" do
+  specify "it works" do
+    output = run_rspec('any_fixture')
+
+    expect(output).to include("3 examples, 0 failures")
+  end
+end

data/spec/integrations/before_all_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "BeforeAll" do
+  specify "it works" do
+    output = run_rspec('before_all')
+
+    expect(output).to include("3 examples, 0 failures")
+  end
+end

data/spec/integrations/event_prof_spec.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "EventProf" do
+  specify "RSpec integration", :aggregate_failures do
+    output = run_rspec('event_prof', env: { 'EVENT_PROF' => 'test.event' })
+
+    expect(output).to include("EventProf results for test.event")
+    expect(output).to match(/Total time: 25:56\.\d{3}/)
+    expect(output).to include("Total events: 8")
+
+    expect(output).to include("Top 5 slowest suites (by time):")
+    expect(output).to include("Top 5 slowest tests (by time):")
+
+    expect(output).to include(
+      "Another something (./event_prof_fixture.rb:42) – 16:40.000 (1 / 2)\n"\
+      "Something (./event_prof_fixture.rb:21) – 09:16.100 (7 / 3)"
+    )
+
+    expect(output).to include(
+      "do very long (./event_prof_fixture.rb:47) – 16:40.000 (1)\n"\
+      "invokes twice (./event_prof_fixture.rb:27) – 06:20.000 (2)\n"\
+      "invokes many times (./event_prof_fixture.rb:33) – 02:16.000 (4)\n"\
+      "invokes once (./event_prof_fixture.rb:22) – 00:40.100 (1)"
+    )
+  end
+
+  specify "RSpec integration with rank by count", :aggregate_failures do
+    output = run_rspec(
+      'event_prof',
+      env: { 'EVENT_PROF' => 'test.event', 'EVENT_PROF_RANK' => 'count' }
+    )
+
+    expect(output).to include("EventProf results for test.event")
+    expect(output).to match(/Total time: 25:56\.\d{3}/)
+    expect(output).to include("Total events: 8")
+
+    expect(output).to include("Top 5 slowest suites (by count):")
+    expect(output).to include("Top 5 slowest tests (by count):")
+
+    expect(output).to include(
+      "Something (./event_prof_fixture.rb:21) – 09:16.100 (7 / 3)\n"\
+      "Another something (./event_prof_fixture.rb:42) – 16:40.000 (1 / 2)"
+    )
+
+    expect(output).to include(
+      "invokes many times (./event_prof_fixture.rb:33) – 02:16.000 (4)\n"\
+      "invokes twice (./event_prof_fixture.rb:27) – 06:20.000 (2)\n"\
+      "invokes once (./event_prof_fixture.rb:22) – 00:40.100 (1)\n"\
+      "do very long (./event_prof_fixture.rb:47) – 16:40.000 (1)"
+    )
+  end
+
+  context "CustomEvents" do
+    it "works with factory.create" do
+      output = run_rspec(
+        'event_prof_factory_create',
+        env: { 'EVENT_PROF' => 'factory.create' }
+      )
+
+      expect(output).to include("EventProf results for factory.create")
+      expect(output).to match(/Total time: \d{2}:\d{2}\.\d{3}/)
+      expect(output).to include("Total events: 3")
+
+      expect(output).to match(%r{Post \(./event_prof_factory_create_fixture.rb:7\) – \d{2}:\d{2}.\d{3} \(2 / 1\)})
+      expect(output).to match(%r{User \(./event_prof_factory_create_fixture.rb:16\) – \d{2}:\d{2}.\d{3} \(1 / 1\)})
+    end
+
+    it "works with sidekiq.inline" do
+      output = run_rspec(
+        'event_prof_sidekiq',
+        env: { 'EVENT_PROF' => 'sidekiq.inline' }
+      )
+
+      expect(output).to include("EventProf results for sidekiq.inline")
+      expect(output).to match(/Total time: \d{2}:\d{2}\.\d{3}/)
+      expect(output).to include("Total events: 3")
+
+      expect(output).to match(%r{SingleJob \(./event_prof_sidekiq_fixture.rb:28\) – \d{2}:\d{2}.\d{3} \(2 / 2\)})
+      expect(output).to match(%r{BatchJob \(./event_prof_sidekiq_fixture.rb:40\) – \d{2}:\d{2}.\d{3} \(1 / 2\)})
+    end
+
+    it "works with sidekiq.jobs" do
+      output = run_rspec(
+        'event_prof_sidekiq',
+        env: { 'EVENT_PROF' => 'sidekiq.jobs' }
+      )
+
+      expect(output).to include("EventProf results for sidekiq.jobs")
+      expect(output).to match(/Total time: \d{2}:\d{2}\.\d{3}/)
+      expect(output).to include("Total events: 6")
+
+      expect(output).to include("Top 5 slowest suites (by count):")
+
+      expect(output).to match(%r{SingleJob \(./event_prof_sidekiq_fixture.rb:28\) – \d{2}:\d{2}.\d{3} \(2 / 2\)})
+      expect(output).to match(%r{BatchJob \(./event_prof_sidekiq_fixture.rb:40\) – \d{2}:\d{2}.\d{3} \(4 / 2\)})
+    end
+  end
+end

data/spec/integrations/factory_doctor_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "FactoryDoctor" do
+  specify "RSpec integration", :aggregate_failures do
+    output = run_rspec('factory_doctor', env: { 'FDOC' => '1' })
+
+    expect(output).to include("FactoryDoctor report")
+    expect(output).to include("Total (potentially) bad examples: 3")
+    expect(output).to match(/Total wasted time: \d{2}:\d{2}\.\d{3}/)
+
+    expect(output).to include("User (./factory_doctor_fixture.rb:7)")
+    expect(output).to include("generates random names (./factory_doctor_fixture.rb:10) – 2 records created")
+    expect(output).to include("validates name (./factory_doctor_fixture.rb:15) – 1 record created")
+    expect(output).to include("clones (./factory_doctor_fixture.rb:25) – 1 record created")
+    expect(output).not_to include("is ignored")
+    expect(output).not_to include("creates and reloads user")
+  end
+end

data/spec/integrations/fixtures/rspec/any_fixture_fixture.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require_relative "../../../support/ar_models"
+require_relative "../../../support/transactional_context"
+require "test_prof/recipes/rspec/any_fixture"
+
+shared_context "user", user: true do
+  before(:all) do
+    @user = TestProf::AnyFixture.register(:user) do
+      FactoryGirl.create(:user)
+    end
+  end
+
+  let(:user) { User.find(@user.id) }
+end
+
+describe "User", :user do
+  it "creates user" do
+    user.name = ''
+    expect(user).not_to be_valid
+  end
+
+  context "with clean fixture", :transactional, :with_clean_fixture do
+    specify "no users" do
+      expect(User.count).to eq 0
+    end
+  end
+end
+
+describe "Post", :user do
+  let(:post) { FactoryGirl.create(:post, user: user) }
+
+  it "creates post with the same user" do
+    expect { post }.not_to change(User, :count)
+  end
+end

data/spec/integrations/fixtures/rspec/before_all_fixture.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require_relative "../../../support/ar_models"
+require "test_prof/recipes/rspec/before_all"
+
+describe "User" do
+  context "with before_all" do
+    before_all do
+      @user = FactoryGirl.create(:user)
+    end
+
+    let(:user) { User.find(@user.id) }
+
+    it "validates name" do
+      user.name = ''
+      expect(user).not_to be_valid
+    end
+
+    it "clones" do
+      cloned = user.clone
+      cloned.save!
+      expect(cloned.reload.name).to include("(cloned)")
+    end
+  end
+
+  context "without before_all" do
+    specify "no users" do
+      expect(User.count).to eq 0
+    end
+  end
+end

data/spec/integrations/fixtures/rspec/event_prof_factory_create_fixture.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require_relative "../../../support/ar_models"
+require "test-prof"
+
+describe "Post" do
+  let(:user) { FactoryGirl.create(:user) }
+
+  it "generates random names" do
+    user2 = FactoryGirl.create(:post).user
+    expect(user.name).not_to eq user2.name
+  end
+end
+
+describe "User" do
+  let(:user) { FactoryGirl.create(:user) }
+
+  it "validates name" do
+    user.name = ''
+    expect(user).not_to be_valid
+  end
+end

data/spec/integrations/fixtures/rspec/event_prof_fixture.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require "active_support"
+require "test-prof"
+
+TestProf::EventProf.configure do |config|
+  config.per_example = true
+end
+
+module Instrumenter
+  def self.notify(_event, time)
+    ActiveSupport::Notifications.publish(
+      'test.event',
+      0,
+      time
+    )
+  end
+end
+
+describe "Something" do
+  it "invokes once" do
+    Instrumenter.notify 'test.event', 40.1
+    expect(true).to eq true
+  end
+
+  it "invokes twice" do
+    Instrumenter.notify 'test.event', 140
+    Instrumenter.notify 'test.event', 240
+    expect(true).to eq true
+  end
+
+  it "invokes many times" do
+    Instrumenter.notify 'test.event', 14
+    Instrumenter.notify 'test.event', 40
+    Instrumenter.notify 'test.event', 42
+    Instrumenter.notify 'test.event', 40
+    expect(true).to eq true
+  end
+end
+
+describe "Another something" do
+  it "do nothing" do
+    expect(true).to eq true
+  end
+
+  it "do very long" do
+    Instrumenter.notify 'test.event', 1000
+    expect(true).to eq true
+  end
+end

data/spec/integrations/fixtures/rspec/event_prof_sidekiq_fixture.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require "active_support"
+require "sidekiq/testing"
+
+Sidekiq::Testing.inline!
+
+class SingleJob
+  include Sidekiq::Worker
+
+  def perform(*args)
+    1 == 1
+  end
+end
+
+
+class BatchJob
+  include Sidekiq::Worker
+
+  def perform(count)
+    count.times { SingleJob.perform_async(true) }
+  end
+end
+
+require "test-prof"
+
+describe "SingleJob" do
+  it "invokes once" do
+    SingleJob.perform_async(1)
+    expect(true).to eq true
+  end
+
+  it "invokes twice" do
+    SingleJob.perform_async(2)
+    expect(true).to eq true
+  end
+end
+
+describe "BatchJob" do
+  it "invokes nested" do
+    BatchJob.perform_async(3)
+    expect(true).to eq true
+  end
+
+  context "when fake" do
+    it "is fake" do
+      Sidekiq::Testing.fake! do
+        BatchJob.perform_async(3)
+      end
+      expect(true).to eq true
+    end
+  end
+end