hoe-debugging 1.0.5 → 1.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+=== 1.1.0 / 2012-09-26
+
+* Valgrind suppressions can be generated with `rake test:valgrind:suppression`
+* If present, valgrind suppressions will be used when valgrinding.
+
 === 1.0.5 / 2012-06-19
 
 * RSpec support now works with TESTOPTS.

data/README.rdoc

@@ -27,6 +27,10 @@ ruby legend, {Mike Dalessio}[http://mike.daless.io].
     $ rake test:gdb
     $ rake test:valgrind
 
+    # if you've got valgrind warnings you've deemed OK to suppress
+    $ rake test:valgrind:suppression
+    $ rake test:valgrind # this runs, suppressing the errors previously emitted by valgrind
+
 
 == Installation
 
@@ -35,11 +39,13 @@ ruby legend, {Mike Dalessio}[http://mike.daless.io].
 
 == License
 
+(The MIT License)
+
 Copyright 2009
 
 * John Barnette (jbarnette@rubyforge.org)
 * {Aaron Patterson}[http://tenderlovemaking.com/]
-* {Mike Dalessio}[http://mike.daless.io]
+* {Mike Dalessio}[http://mike.daless.io] (mike.dalessio@gmail.com)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -3,13 +3,21 @@ require "hoe"
 
 Hoe.plugin :git
 Hoe.plugin :gemspec
+Hoe.plugin :bundler
 
 Hoe.spec "hoe-debugging" do
   developer "John Barnette", "jbarnette@rubyforge.org"
+  developer "Mike Dalessio", "mike.dalessio@gmail.com"
 
   self.extra_rdoc_files = FileList["*.rdoc"]
   self.history_file     = "CHANGELOG.rdoc"
   self.readme_file      = "README.rdoc"
 
-  extra_deps << ["hoe", ">= 2.2.0"]
+  license "MIT"
+
+  extra_dev_deps << ["hoe",         ">= 3.1"]
+  extra_dev_deps << ["rspec",       "~> 2.0"]
+  extra_dev_deps << ["hoe-git",     ">= 0"]
+  extra_dev_deps << ["hoe-gemspec", ">= 0"]
+  extra_dev_deps << ["hoe-bundler", ">= 0"]
 end

data/lib/hoe/debugging.rb

@@ -10,7 +10,7 @@ class Hoe #:nodoc:
   # * <tt>test:valgrind:mem0</tt>
 
   module Debugging
-    VERSION = "1.0.5" #:nodoc:
+    VERSION = "1.1.0" #:nodoc:
 
     ##
     # Optional: Used to add flags to GDB. [default: <tt>[]</tt>]
@@ -49,29 +49,135 @@ class Hoe #:nodoc:
       cmd.join(' ')
     end
 
+    def hoe_debugging_command
+      "#{hoe_debugging_ruby} #{hoe_debugging_make_test_cmd}"
+    end
+
+    def hoe_debugging_run_valgrind command, cmdline_options=[]
+      sh "valgrind #{cmdline_options.join(' ')} #{command}"
+    end
+
+    def hoe_debugging_check_for_suppression_file options
+      if suppression_file = hoe_debugging_valgrind_helper.matching_suppression_file
+        puts "NOTICE: using valgrind suppressions in #{suppression_file.inspect}"
+        options << "--suppressions=#{suppression_file}"
+      end
+    end
+
+    def hoe_debugging_valgrind_helper
+      @valgrind_helper ||= ValgrindHelper.new name
+    end
+
     def define_debugging_tasks #:nodoc:
       desc "Run the test suite under GDB."
       task "test:gdb" do
-        sh "gdb #{gdb_options.join ' '} --args #{hoe_debugging_ruby} #{hoe_debugging_make_test_cmd}"
+        sh "gdb #{gdb_options.join ' '} --args #{hoe_debugging_command}"
       end
 
       desc "Run the test suite under Valgrind."
       task "test:valgrind" do
-        sh "valgrind #{valgrind_options.join ' '} #{hoe_debugging_ruby} #{hoe_debugging_make_test_cmd}"
+        vopts = valgrind_options
+        hoe_debugging_check_for_suppression_file vopts
+        hoe_debugging_run_valgrind hoe_debugging_command, vopts
       end
 
       desc "Run the test suite under Valgrind with memory-fill."
       task "test:valgrind:mem" do
-        sh "valgrind #{valgrind_options.join ' '} " +
-          "--freelist-vol=100000000 --malloc-fill=6D --free-fill=66 " +
-          "#{hoe_debugging_ruby} #{hoe_debugging_make_test_cmd}"
+        vopts = valgrind_options + ["--freelist-vol=100000000", "--malloc-fill=6D", "--free-fill=66"]
+        hoe_debugging_check_for_suppression_file vopts
+        hoe_debugging_run_valgrind hoe_debugging_command, vopts
       end
 
       desc "Run the test suite under Valgrind with memory-zero."
       task "test:valgrind:mem0" do
-        sh "valgrind #{valgrind_options.join ' '} " +
-          "--freelist-vol=100000000 --malloc-fill=00 --free-fill=00 " +
-          "#{hoe_debugging_ruby} #{hoe_debugging_make_test_cmd}"
+        vopts = valgrind_options + ["--freelist-vol=100000000", "--malloc-fill=00", "--free-fill=00"]
+        hoe_debugging_check_for_suppression_file vopts
+        hoe_debugging_run_valgrind hoe_debugging_command, vopts
+      end
+
+      desc "Generate a valgrind suppression file for your test suite."
+      task "test:valgrind:suppression" do
+        vopts = valgrind_options + ["--gen-suppressions=all"]
+        Tempfile.open "hoe_debugging_valgrind_suppression_log" do |logfile|
+          hoe_debugging_run_valgrind "#{hoe_debugging_ruby} #{hoe_debugging_make_test_cmd} 2> #{logfile.path}", vopts
+          hoe_debugging_valgrind_helper.save_suppressions_from logfile.path
+        end
+      end
+    end
+
+    class ValgrindHelper
+      DEFAULT_DIRECTORY_NAME = "suppressions"
+
+      attr_accessor :directory, :project_name
+
+      def initialize project_name, options={}
+        @project_name = project_name
+        @directory    = options[:directory] || DEFAULT_DIRECTORY_NAME
+      end
+
+      def formatted_ruby_version
+        engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
+        %Q{#{engine}-#{RUBY_VERSION}.#{RUBY_PATCHLEVEL}}
+      end
+
+      def version_matches
+        matches = [formatted_ruby_version]
+        matches << formatted_ruby_version.split(".")[0,3].join(".")
+        matches << formatted_ruby_version.split(".")[0,2].join(".")
+        matches
+      end
+
+      def parse_suppressions_from logfile_name
+        suppressions = []
+        File.open logfile_name do |logfile|
+          suppression = nil
+          while ! logfile.eof? do
+            line = logfile.readline
+            if suppression.nil?
+              if line =~ /\<insert_a_suppression_name_here\>/
+                suppression = "{\n"
+                suppression << line
+              end
+            else
+              suppression << line
+              if line =~ /^\}$/
+                suppressions << suppression
+                suppression = nil
+              end
+            end
+          end
+        end
+        suppressions.uniq.join
+      end
+
+      def save_suppressions_from logfile, options={}
+        ensure_directory_exists
+        suppressions = parse_suppressions_from logfile
+        filename = File.join directory, "#{project_name}_#{formatted_ruby_version}.supp"
+        File.open(filename, "w") { |out| out.write suppressions }
+        filename
+      end
+
+      def matching_suppression_file
+        version_matches.each do |version_string|
+          matches = Dir[File.join(directory, "#{project_name}_#{version_string}*.supp")]
+          return matches[0] if matches[0]
+        end
+        nil
+      end
+
+      def valgrind command, options={}
+        sh "valgrind #{vopts.join ' '} #{hoe_debugging_ruby} #{hoe_debugging_make_test_cmd}"
+      end
+
+      private
+
+      def ensure_directory_exists
+        return if File.directory? directory
+        FileUtils.mkdir_p directory
+        File.open(File.join(directory, "README.txt"), "w") do |readme|
+          readme.puts "This directory contains valgrind suppression files generated by the hoe-debugging gem."
+        end
       end
     end
   end

metadata

@@ -1,38 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: hoe-debugging
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
 - John Barnette
+- Mike Dalessio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-19 00:00:00.000000000 Z
+date: 2012-09-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &16990920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :runtime
+        version: '3.1'
+  type: :development
   prerelease: false
-  version_requirements: *16990920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: &16990480 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hoe-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16990480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'A Hoe plugin to help you debug your C extensions. This plugin provides
 
   <tt>test:gdb</tt> and <tt>test:valgrind</tt> tasks (plus a few
@@ -53,20 +128,23 @@ description: ! 'A Hoe plugin to help you debug your C extensions. This plugin pr
   ruby legend, {Mike Dalessio}[http://mike.daless.io].'
 email:
 - jbarnette@rubyforge.org
+- mike.dalessio@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.rdoc
 - Manifest.txt
 - README.rdoc
-- CHANGELOG.rdoc
 files:
 - CHANGELOG.rdoc
 - Manifest.txt
 - README.rdoc
 - Rakefile
 - lib/hoe/debugging.rb
+- .gemtest
 homepage: http://github.com/jbarnette/hoe-debugging
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options:
 - --main
@@ -79,6 +157,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2243994185650622134
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -87,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: hoe-debugging
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Hoe plugin to help you debug your C extensions