top_tests 0.0.3 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ee9095ac592d144455ac280f91819b3fa0886148f41af4f5c02b4e031ab6256
+  data.tar.gz: 9e3f02ba897f988c2f7868010368a4deb697ba2a2a218e077815174be4d727f4
+SHA512:
+  metadata.gz: 44724156a8d2fdc6a6991121f07d3a93b2f3146e56ea35af9773e28105a7f3fb891f2baf9393a7329359f36e896a5d42c882f930ce7c9a3430195186a086f204
+  data.tar.gz: f6a5daaeff5d68d0b35f469ce89381d454e47b87044b5478a9b228c15208d8e86c928429499253098188157a933c6639428c3c41afec4b75f298e1521ecb9434

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in top_tests.gemspec
 gemspec
+
+gem 'minitest', '>= 5.10.2'

data/Gemfile.lock

@@ -1,14 +1,19 @@
 PATH
   remote: .
   specs:
-    top_tests (0.0.1)
+    top_tests (0.0.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    minitest (5.10.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  minitest (>= 5.10.2)
   top_tests!
+
+BUNDLED WITH
+   1.13.6

data/README.rdoc

@@ -2,11 +2,33 @@
 Top tests displays your 10 slowest tests after execution. The goal is to help you
 keeping your tests fast.
 
-== How to setup top tests?
-First of all top tests works only with ActiveSupport::TestCase. Then require top
-tests and just include into your test class:
+Moreover top tests can break your build if any test is taking longer than a specified duration.
 
-    class ActiveSupport::TestCase
-      include TopTests
+== How to use it?
+Add to your Gemfile.
+
+    group :test do
+      gem 'top_tests'
     end
 
+Then run your test as usual and you will have a similar output:
+
+  Top 10 slowest tests:
+      0.429 ApplicationControllerTest#test_notify_error
+      0.322 HoneyBadgersControllerTest#test_show
+      0.200 BearsControllerTest#test_destroy_collection
+      0.134 SuricatsControllerTest#test_can_not_update
+      0.124 SuricatsControllerTest#test_create
+      0.105 SuricatsControllerTest#test_update
+      0.096 HoneyBadgersControllerTest#test_create
+      0.093 HoneyBadgersControllerTest#test_update
+      0.091 SuricatsControllerTest#test_destroy
+      0.090 HoneyBadgersControllerTest#test_show
+
+Run your your with the option `--max-time=SECONDS` to break the tests that are slower than the specified time:
+
+    3 tests are taking longer than 0.2 seconds:
+        0.410 HoneyBadgerTest#test_fighting_a_cobra
+        0.228 SuricatTest#test_caught_by_an_eagle
+        0.203 HoneyBadgerTest#test_eating_larvae
+

data/lib/minitest/top_tests_plugin.rb

@@ -0,0 +1,60 @@
+module Minitest
+  def self.plugin_top_tests_init(options)
+    self.reporter << TopTestReporter.new(options)
+  end
+
+  def self.plugin_top_tests_options(opts, options)
+    opts.on "--max-time=ms", "Test fails if it exceeds specified time in seconds" do |max_time|
+      options[:max_time] = max_time.to_f
+    end
+  end
+
+  class TopTestReporter < AbstractReporter
+    attr_reader :results, :max_time
+
+    def initialize(options)
+      @results = []
+      @max_time = options[:max_time]
+    end
+
+    def record(result)
+      results << result
+      #result.refute(true, "Too long") if max_time && result.time > max_time
+    end
+
+    def passed?
+      slow_tests.empty?
+    end
+
+    def report
+      if slow_tests.empty?
+        puts "\nTop 10 slowest tests:\n#{format_tests(slowest_results[0,10])}"
+      else
+        print_slow_tests
+      end
+    end
+
+    def slowest_results
+      results.sort { |a, b| b.time <=> a.time }
+    end
+
+    def slow_tests
+      max_time ? results.find_all { |r| r.time > max_time } : []
+    end
+
+    def print_slow_tests
+      if !slow_tests.empty?
+        if slow_tests.size == 1
+          puts "\n1 test is taking longer than #{max_time} seconds:"
+        else
+          puts "\n3 tests are taking longer than #{max_time} seconds:"
+        end
+        puts format_tests(slow_tests)
+      end
+    end
+
+    def format_tests(tests)
+      tests.map { |t| "  #{format("%7.3f", t.time)} #{t.klass}##{t.name}" }.join("\n")
+    end
+  end
+end

data/lib/top_tests.rb

@@ -7,23 +7,30 @@ module TopTests
   #####################
 
   def self.included(klass)
-    klass.setup :start_timer
-    klass.teardown :stop_timer
     klass.extend(ClassMethods)
-    at_exit { at_exit { klass.at_exit_callback } }
+    if Minitest.respond_to?(:after_run)
+      Minitest.after_run { klass.after_all_tests }
+    else
+      MiniTest::Unit.after_tests { klass.after_all_tests }  # Deprecated
+    end
   end
 
   ########################
   ### Instance methods ###
   ########################
 
-  def start_timer
+  def before_setup
+    super
     @timer_started_at = Time.now
   end
 
-  def stop_timer
-    name = self.class.to_s + '#' + @__name__
-    self.class.tests_durations << [name, Time.now - @timer_started_at]
+  def after_teardown
+    super
+    if @timer_started_at # Unset when a setup hook fails before top test.
+      # Instance variable @__name__ is used prior to minitest 5.
+      test_name = "#{self.class}##{@__name__ || name}"
+      self.class.tests_durations << [test_name, Time.now - @timer_started_at]
+    end
   end
 
   #####################
@@ -40,7 +47,7 @@ module TopTests
     end
 
     def max_duration
-      @@max_duration
+      @@max_duration ||= nil
     end
 
     def top_tests
@@ -56,21 +63,25 @@ module TopTests
     end
 
     def print_top_tests
-      puts "\nTop tests:"
+      puts "\nTop 10 slowest tests:"
       puts format_tests(top_tests.shift(10))
       puts
     end
 
     def check_tests_duration
       if !slow_tests.empty?
-        puts "\nTEST?FAIL! #{slow_tests.count} test(s) are taking longer than #{max_duration} seconds:"
+        if slow_tests.size == 1
+          puts "\nTEST?FAIL! 1 test is taking longer than #{max_duration} seconds:"
+        else
+          puts "\nTEST?FAIL! #{slow_tests.count} tests are taking longer than #{max_duration} seconds:"
+        end
         puts format_tests(slow_tests)
         puts
         exit 1
       end
     end
 
-    def at_exit_callback
+    def after_all_tests
       check_tests_duration
       print_top_tests
     end

data/lib/top_tests/version.rb

@@ -1,8 +1,6 @@
 # -*- encoding : utf-8 -*-
 
 module TopTests
-
-  VERSION = '0.0.3'.freeze
-
+  VERSION = '0.1.1'.freeze
 end
 

data/test/failing_test.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+require 'minitest/autorun'
+require 'top_tests'
+
+class FailingTest < MiniTest::Unit::TestCase
+  def test_bad
+    assert(false)
+  end
+end

data/test/fast_test.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+require 'minitest/autorun'
+require 'top_tests'
+
+class FastTest < MiniTest::Unit::TestCase
+  def test_good
+    sleep(0.499)
+  end
+end

data/test/slow_test.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+
+require 'minitest/autorun'
+require 'top_tests'
+
+class SlowTest < MiniTest::Unit::TestCase
+  def test_good
+    sleep(0.5)
+  end
+
+  def test_bad
+    assert(true)
+  end
+end

data/top_tests.gemspec

@@ -6,10 +6,10 @@ Gem::Specification.new do |s|
   s.name        = 'top_tests'
   s.version     = TopTests::VERSION.dup
   s.authors     = ['Alexis Bernard']
-  s.email       = ['alexis@official.fm']
-  s.homepage    = 'https://github.com/officialfm/top_tests'
-  s.summary     = 'Top tests displays your 10 slowest tests after execution'
-  s.description = 'Top tests displays your 10 slowest tests after execution'
+  s.email       = ['alexis@bernard.io']
+  s.homepage    = 'https://github.com/alexisbernard/top_tests'
+  s.summary     = 'Top tests lists the 10 slowest tests after execution'
+  s.description = 'Top tests lists the 10 slowest tests after execution'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,54 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: top_tests
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexis Bernard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-12 00:00:00.000000000Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies: []
-description: Top tests displays your 10 slowest tests after execution
+description: Top tests lists the 10 slowest tests after execution
 email:
-- alexis@official.fm
+- alexis@bernard.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
+- lib/minitest/top_tests_plugin.rb
 - lib/top_tests.rb
 - lib/top_tests/version.rb
+- test/failing_test.rb
+- test/fast_test.rb
+- test/slow_test.rb
 - top_tests.gemspec
-homepage: https://github.com/officialfm/top_tests
+homepage: https://github.com/alexisbernard/top_tests
 licenses: []
+metadata: {}
 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.10
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
-summary: Top tests displays your 10 slowest tests after execution
+specification_version: 4
+summary: Top tests lists the 10 slowest tests after execution
 test_files: []