minitest-hog 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d20e61db9373314953d5013c42f0230b11e0ec83
+  data.tar.gz: 18c01c3b533c98a3e918700c477916c10770b8df
+SHA512:
+  metadata.gz: e21444cdaf7a7d9fee9d0550a30e0448860445aad9a7b51034c9856a723164312157c69fc9746cf61d9b71959ceba8c6e87d80c063bffffc0981773530e57535
+  data.tar.gz: 760443b668344d778cf964cf559154f0498e3646b664254b736b46d9df7e3b3590432791421ec4e53df67c239792b169801b4d3ce15f6923e1aeb537dcfe7358

data/README.markdown

@@ -0,0 +1,47 @@
+Minitest Hog
+======================
+
+Prints a list of tests that take too long.
+
+Installation
+------------
+
+    gem install minitest-hog
+    
+Usage
+-----
+
+Minitest Hog can be enabled from the command line using the `max-memory` parameter:
+
+    ruby test/example_test.rb --max-memory 16
+    
+This would print out a list of any tests that use more than 16k of memory:
+
+    # Running:
+
+    ....
+
+    Finished in 1.001143s
+
+    4 runs, 7 assertions, 0 failures, 0 errors, 0 skips
+
+    2 slow tests.
+      0) ExampleTest#test_alpha: 31 kb
+      1) ExampleTest#test_beta: 18 kb
+
+Usage with Rake
+---------------
+
+If you run your tests with Rake, set the TESTOPTS environment variable:
+
+    rake TESTOPTS="--max-memory 16"
+
+Warning!
+--------
+
+There are many ways to measure memory usage in Ruby.  The results from Minitest Hog may not be exact, but should accurately reflect proportional memory usage.
+
+Authors 
+-------
+
+[Adam Sanderson](netghost@gmail.com) (http://monkeyandcrow.com)

data/lib/minitest/hog.rb

@@ -0,0 +1,89 @@
+module Minitest
+  module Hog
+
+    attr_accessor :memory_used
+  
+    def self.sample
+      sampler.call
+    end
+  
+    def self.sampler= sampler
+      @memory_sampler = sampler
+    end
+  
+    def self.sampler
+      @memory_sampler ||= Minitest::ShellPs.new
+    end
+  
+    def before_setup
+      super
+      GC.start
+      GC.disable
+    
+      self.memory_used = Minitest::Hog.sample
+    end
+
+    def after_teardown
+      super
+      if memory_used
+        self.memory_used = Minitest::Hog.sample - memory_used
+      else
+        self.memory_used
+      end
+      
+      GC.enable
+    end
+  
+  end
+
+  class HogReporter < Reporter
+    Record = Struct.new :location, :memory_used
+    attr_reader :piggy_tests, :max_memory
+    
+    def initialize(io = STDOUT, options = {})
+      super
+      
+      @max_memory = options.fetch(:max_memory, 64)
+      @piggy_tests = []
+    end
+    
+    def record result
+      if result.memory_used > max_memory
+        piggy_tests << Record.new(result.location, result.memory_used)
+      end
+    end
+    
+    def report
+      return if piggy_tests.empty?
+      
+      piggy_tests.sort_by!{|r| -r.memory_used}
+      
+      io.puts
+      io.puts "#{piggy_tests.length} hogs."
+      piggy_tests.each_with_index do |record, i|
+        io.puts "%3d) %s: %i kb" % [i+1, record.location, record.memory_used]
+      end
+    end 
+  end
+  
+  # Return the resident set size (RSS) in kB.
+  # 
+  # This is fairly foolproof, but probably not the most accurate measure possible
+  # since shelling out most likely affects memory usage and isn't terribly efficient.
+  #
+  # Other strategies could be implemented in the future, for instance see NewRelic's samplers:
+  # https://github.com/newrelic/rpm/blob/release/lib/new_relic/agent/samplers/memory_sampler.rb
+  #
+  class ShellPs
+    def initialize(pid = Process::pid)
+      @pid = pid
+    end
+    
+    # Based off of: http://zogovic.com/post/59091704817/memory-usage-monitor-in-ruby
+    # Example ps output: "  RSS\n223124\n"
+    def call
+      `ps -o rss -p #{@pid}`.split("\n").last.to_i
+    end
+  end
+  
+end

data/lib/minitest/hog_plugin.rb

@@ -0,0 +1,18 @@
+module Minitest
+  @minitest_hog = false
+  
+  def self.plugin_hog_options(opts, options)
+    opts.on "--max-memory MEM", Integer, "Report tests that use more than MEM kb." do |max_memory|
+      options[:max_memory] = max_memory.to_i
+    end
+  end
+
+  def self.plugin_hog_init(options)
+    if options[:max_memory]
+      require "minitest/hog"
+      
+      self.reporter << Minitest::HogReporter.new(options[:io], options)
+      Minitest::Test.send :include, Minitest::Hog
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: minitest-hog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Sanderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+description: Summarizes minitest tests, printing out tests that take too much memory.
+email:
+- netghost@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- lib/minitest/hog.rb
+- lib/minitest/hog_plugin.rb
+homepage: https://github.com/adamsanderson/minitest-hog
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Identify memory hogs.
+test_files: []