minitest-perf 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.minitest-perf*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in minitest-perf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Albert Llop
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# MiniTest::Perf
+
+`minitest-perf` stores information about your minitest runs so that you can later analyze and see where
+the pain points are. It's in pretty early beta status, so I'm more than glad to receive bug reportsand 
+feature suggestions.
+
+For now it should work with later versions of MiniTest 4, since the biggest test suite I have available
+is with this version. MiniTest 5 probably doesn't work yet.
+
+## How it works
+
+Every test that is executed is stored in a sqlite database for later query. Just require `minitet/perf`
+somewhere in your test_helper, and you're good to go. Internally, `minitest/perf` includes itself as 
+just another module and starts feeding the sqlite database.
+
+The sqlite database is stored by default as `.minitest-perf.db`.
+
+An executable is provided that does prints a very basic analysis of the information it already has,
+but the sqlite database is perfectly normal, so you can do your own queries.
+
+This is an example:
+
+```
+$ be minitest-perf
+Slowest individual tests
+
+      190.98ms | JobsCategoriesControllerLoggedOutTest#test_show_action_should_render_show_page_without_contact_distance_call_for_logged_out_users
+      161.12ms | APostingFrozenNotificationActiveRecordTestCasTest#test_should_log_the_exception_and_any_additional_data_when_a_PerlBackend::Error_is_thrown
+      147.39ms | VersionsTest#test_rubygems_version
+      132.52ms | JobsCategoriesControllerLoggedInTest#test_show_action_should_show__all__postings_of_a_category_for_logged_in_users
+      124.21ms | JobsCategoriesControllerLoggedInTest#test_should_show_all_postings_of_selected_subcategories
+      122.99ms | OrderReachedAboutToRunOutOfPostingsBeforeLast24HoursTest#test_should_return_false_if_at_amount_left_is_15_percent_of_amount,_and_last_posting_created_within_24_hours
+      121.98ms | JobsCategoriesControllerLoggedOutTest#test_show_action_should_show_all_public_postings_for_logged_out_users
+      116.97ms | JobsCategoriesControllerUserDependantLanguageTest#test_should_show_postings_in_categories_user's_browser_language_and_default_language_en_logged-out
+      110.12ms | JobsCategoriesControllerUserDependantLanguageTest#test_caching_of_cities_is_dependant_on_the_user's_language_logged-in
+      109.20ms | PostingsControllerNewActionTest#test_should_take_the_posters_business_country_as_default_country_for_new_postings_on_GET
+
+
+Slowest test suites
+
+      116.07ms |    3 | JobsCategoriesControllerLoggedOutTest
+      113.54ms |    2 | JobsCategoriesControllerUserDependantLanguageTest
+       98.19ms |    1 | PublishToCompanyPostingControllerTest
+       97.81ms |    1 | ShowActionPagingForPostingSearchTest
+       79.66ms |    1 | PostingMostViewedNamedScopeTest
+       78.92ms |    3 | OrderReachedAboutToRunOutOfPostingsBeforeLast24HoursTest
+       68.92ms |    1 | Jobs::ProductAvailabilityTimePeriodOverlapTest
+       68.53ms |    1 | TheMotherOfAllBillingCycleTests
+       66.77ms |    4 | CategoriesTest
+       62.60ms |    2 | RecommendationsActivityBoxFallbackTest
+```
+
+## TODO
+
+These are nice to haves I'd like to implement in the future:
+
+* Customizable db file
+* Store also in mysql
+* Web interface

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+Rake::Task['test'].comment = "Run all tests"
+
+task :default => :test

data/bin/minitest-perf

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'minitest/perf'
+
+Minitest::Perf::Cli.new.run

data/lib/minitest/perf/cli.rb

@@ -0,0 +1,21 @@
+module MiniTest
+  module Perf
+    class Cli
+      def run
+        puts "Slowest individual tests"
+        puts
+        Statistics.slowest_tests.each do |suite, test_name, time|
+          printf "% 12.2fms | %s#%s\n", time * 1000, suite, test_name
+        end
+
+        puts
+        puts
+        puts "Slowest test suites"
+        puts
+        Statistics.slowest_suites.each do |suite_name, tests_count, avg_test_time|
+          printf "% 12.2fms | % 4i | %s\n", avg_test_time * 1000, tests_count, suite_name
+        end
+      end
+    end
+  end
+end

data/lib/minitest/perf/persistence.rb

@@ -0,0 +1,43 @@
+require 'sqlite3'
+
+module MiniTest
+  module Perf
+    module Persistence
+      class << self
+        def write(test)
+          db.execute <<-SQL, [test.run.to_s, test.suite, test.name, test.total]
+            INSERT INTO tests (run, suite, name, total)
+            VALUES (?, ?, ?, ?)
+          SQL
+        end
+
+        def read_tests
+          db.execute("SELECT * FROM TESTS").map do |run, suite, name, total|
+            Test.new(run, suite, name, total)
+          end
+        end
+
+        def sql(query)
+          db.execute query
+        end
+
+        private
+
+        def db
+          @@db ||= begin
+                     db = SQLite3::Database.new ".minitest-perf.db"
+                     db.execute <<-SQL
+                      create table if not exists tests (
+                        run varchar(255),
+                        suite varchar(255),
+                        name varchar(255),
+                        total float
+                      );
+                     SQL
+                     db
+                   end
+        end
+      end
+    end
+  end
+end

data/lib/minitest/perf/plugin.rb

@@ -0,0 +1,19 @@
+module MiniTest
+  module Perf
+    module Plugin
+      def before_setup
+        current_perf_run.start(self.class.name, __name__)
+        super
+      end
+
+      def after_teardown
+        super
+        current_perf_run.finish(self.class.name, __name__)
+      end
+
+      def current_perf_run
+        @@current_perf_run ||= MiniTest::Perf::Run.new
+      end
+    end
+  end
+end

data/lib/minitest/perf/run.rb

@@ -0,0 +1,28 @@
+module MiniTest
+  module Perf
+    class Run
+      attr_reader :tests
+
+      def initialize(started_at = Time.now)
+        @tests       = []
+        @started_at  = started_at
+      end
+
+      def start(suite, name, now = Time.now)
+        @test_start = now
+      end
+
+      def finish(suite, name, now = Time.now)
+        test_total  = now - @test_start
+
+        add_test Test.new(
+          @started_at, suite, name, test_total
+        ).tap(&:persist)
+      end
+
+      def add_test(test)
+        @tests << test
+      end
+    end
+  end
+end

data/lib/minitest/perf/statistics.rb

@@ -0,0 +1,31 @@
+module MiniTest
+  module Perf
+    module Statistics
+      class << self
+        def slowest_tests
+          Persistence.sql(<<-SQL)
+            SELECT suite, name, avg(total) as avg_total
+            FROM tests
+            GROUP BY suite, name
+            ORDER BY avg_total DESC
+            LIMIT 10
+          SQL
+        end
+
+        def slowest_suites
+          Persistence.sql(<<-SQL)
+            SELECT suite, AVG(test_count), AVG(avg_total_per_test_run) as avg_total
+            FROM (
+              SELECT run, suite, COUNT(name) AS test_count, AVG(total) as avg_total_per_test_run
+              FROM tests
+              GROUP BY run, suite
+            ) as temp
+            GROUP BY suite
+            ORDER BY avg_total desc
+            LIMIT 10
+          SQL
+        end
+      end
+    end
+  end
+end

data/lib/minitest/perf/test.rb

@@ -0,0 +1,18 @@
+module MiniTest
+  module Perf
+    class Test
+      attr_reader :run, :suite, :name, :total
+
+      def initialize(run, suite, name, total)
+        @run    = run
+        @suite  = suite
+        @name   = name
+        @total  = total
+      end
+
+      def persist
+        Persistence.write(self)
+      end
+    end
+  end
+end

data/lib/minitest/perf/version.rb

@@ -0,0 +1,5 @@
+module MiniTest
+  module Perf
+    VERSION = "0.0.1"
+  end
+end

data/lib/minitest/perf.rb

@@ -0,0 +1,16 @@
+require 'minitest/perf/version'
+require 'minitest/unit'
+
+module MiniTest::Perf
+  autoload :Run,    'minitest/perf/run'
+  autoload :Test,   'minitest/perf/test'
+  autoload :Suite,  'minitest/perf/suite'
+  autoload :Cli,    'minitest/perf/cli'
+  autoload :Plugin, 'minitest/perf/plugin'
+  autoload :Persistence, 'minitest/perf/persistence'
+  autoload :Statistics,  'minitest/perf/statistics'
+end
+
+class MiniTest::Unit::TestCase
+  include MiniTest::Perf::Plugin
+end

data/lib/minitest-perf.rb

@@ -0,0 +1 @@
+require 'minitest/perf'

data/minitest-perf.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/perf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-perf"
+  spec.version       = MiniTest::Perf::VERSION
+  spec.authors       = ["Albert Llop"]
+  spec.email         = ["mrsimo@gmail.com"]
+  spec.description   = %q{Save test run data to find slow tests and other interesting information}
+  spec.summary       = <<-SUMMARY
+    Require minitest/perf when running your tests, and a handful of data will be recorded
+    for later query and study. Find particularly slow tests, and understand your tests
+    even more.
+  SUMMARY
+  spec.homepage      = "https://github.com/mrsimo/minitest-perf"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "debugger"
+  spec.add_dependency "minitest", "~> 4.0"
+  spec.add_dependency "sqlite3"
+end

data/test/perf/persistence_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+require 'sqlite3'
+
+module MiniTest::Perf
+  class PersistenceTest < MiniTest::Unit::TestCase
+    def setup
+      @test = Test.new('run', 'suite', 'name', 10)
+      Persistence.sql "delete from tests"
+    end
+
+    def test_exposes_a_sql_interface
+      assert_instance_of Array, Persistence.sql('select * from tests')
+    end
+
+    def test_stores_the_test_as_a_new_row
+      Persistence.write(@test)
+
+      result = Persistence.sql "SELECT * FROM tests"
+
+      assert_equal 1, result.size
+
+      run, suite, name, total = result.first
+
+      assert_equal 'run',   run
+      assert_equal 'suite', suite
+      assert_equal 'name',  name
+      assert_equal 10,      total
+    end
+  end
+end

data/test/perf/plugin_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class PluginTest < MiniTest::Unit::TestCase
+  def test_minitest_has_the_plugin_included
+    assert_includes MiniTest::Unit::TestCase.included_modules, MiniTest::Perf::Plugin
+  end
+end

data/test/perf/run_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module MiniTest::Perf
+  class RunTest < MiniTest::Unit::TestCase
+    def test_a_new_run_has_no_tests
+      run = Run.new
+
+      assert_empty run.tests
+    end
+
+    def test_creates_a_new_test_calling_start_and_finish
+      run = Run.new(Time.at(0))
+      run.start('SuiteName', 'test_something', Time.at(1))
+
+      assert_empty run.tests
+
+      run.finish('SuiteName', 'test_something', Time.at(8))
+
+      assert_equal 1, run.tests.size
+
+      test = run.tests.last
+
+      assert_equal 'SuiteName',      test.suite
+      assert_equal 'test_something', test.name
+      assert_equal Time.at(0),       test.run
+      assert_equal 7,                test.total
+    end
+
+    def test_persists_the_test
+      run = Run.new
+      run.start('SuiteName', 'test_something')
+
+      Test.any_instance.expects(:persist)
+      run.finish('SuiteName', 'test_something')
+    end
+  end
+end

data/test/perf/test_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+module MiniTest::Perf
+  class TestTest < MiniTest::Unit::TestCase
+    def test_creation
+      test = Test.new('run', 'suite', 'name', 10)
+
+      assert_equal 'run',   test.run
+      assert_equal 'suite', test.suite
+      assert_equal 'name',  test.name
+      assert_equal 10,      test.total
+    end
+
+    def test_persists_calls_persistence
+      test = Test.new('run', 'suite', 'name', 10)
+
+      Persistence.expects(:write).with(test)
+
+      test.persist
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'mocha/setup'
+require 'debugger'
+
+require 'minitest/perf'
+
+##
+# We disable the real plugin or stuff gets all confusing
+# in the tests when mocking and creating expectations.
+class FakeRun
+  def start(*pars); end
+  def finish(*pars); end
+end
+
+MiniTest::Perf::Plugin.class_eval do
+  def current_perf_run
+    @current_perf_run ||= FakeRun.new
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: minitest-perf
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Albert Llop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Save test run data to find slow tests and other interesting information
+email:
+- mrsimo@gmail.com
+executables:
+- minitest-perf
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/minitest-perf
+- lib/minitest-perf.rb
+- lib/minitest/perf.rb
+- lib/minitest/perf/cli.rb
+- lib/minitest/perf/persistence.rb
+- lib/minitest/perf/plugin.rb
+- lib/minitest/perf/run.rb
+- lib/minitest/perf/statistics.rb
+- lib/minitest/perf/test.rb
+- lib/minitest/perf/version.rb
+- minitest-perf.gemspec
+- test/perf/persistence_test.rb
+- test/perf/plugin_test.rb
+- test/perf/run_test.rb
+- test/perf/test_test.rb
+- test/test_helper.rb
+homepage: https://github.com/mrsimo/minitest-perf
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Require minitest/perf when running your tests, and a handful of data will
+  be recorded for later query and study. Find particularly slow tests, and understand
+  your tests even more.
+test_files:
+- test/perf/persistence_test.rb
+- test/perf/plugin_test.rb
+- test/perf/run_test.rb
+- test/perf/test_test.rb
+- test/test_helper.rb