hoe-debugging 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9752b85471af7fb7b0cfb93374468f9363caed64
-  data.tar.gz: c8d2e617c71b3146a2edd80eb2c0183dcbde74bb
+SHA256:
+  metadata.gz: d39769e054a2227a063051c68b0599af45f585371f75cccd36410f573d512923
+  data.tar.gz: 47c2207158e4ed4968d7c221c8536bfe29f962506e7c7705830bfd765d6bfbdf
 SHA512:
-  metadata.gz: aa0e8ae03198b52b4a8be27773a97f86a1aa6e9a1a7095d5a9f94604d3c571d60166caf7812b59eab0fb8dc36edea5c89a86eb87d59fc468f5bc4080e982ba49
-  data.tar.gz: 6cf3f10113efa0d8204742000dfb3d515bdb8c9f53a0196e67457b34ba44f71db6b08392bcfdd4c61198d136fa1fa0a1287ca658d15bf7879a8d03ae5bb63cb0
+  metadata.gz: 29f3d8e7cf2944169832cb7f7189baf525c16790b2dc77a49916ba36117ee50d0a5d2c726c40c9cb6ec6a3d41154e4fa704cb7465b02f8503e3fa2da35b1762d
+  data.tar.gz: 22f26dd9e758470f71f891d0cf719e173c1bec60e5c7e56709d46b46a8f645daa70483cc83ecd1fc4cb2f73a60caf765ea8081b8563be06d595f105a4a5c40c2

data/CHANGELOG.rdoc

@@ -1,3 +1,13 @@
+== Changelog for `hoe-debugging`
+
+=== 1.5.0 / 2018-11-02
+
+Features:
+
+* Suppression metadata is always logged when warnings are generated
+* Rake task `valgrind:suppression` can generate a suppression file from a previous run's log file. Great for when CI finds things that are hard to reproduce!
+
+
 === 1.4.2 / 2017-06-19
 
 Features:

data/README.md

@@ -5,26 +5,58 @@
 
 ## Description
 
-A Hoe plugin to help you debug your C extensions. This plugin provides `test:gdb` and `test:valgrind` tasks (plus a few variants).
+A Hoe plugin to help you debug your C extensions. This plugin provides `test:gdb` and `test:valgrind` tasks (plus a few variants). As of v1.5 it also can generate a valgrind suppression from a previous test suite's log file.
 
 See the `Hoe::Debugging` module for a few configuration options.
 
 This plugin expects you to have `gdb` and `valgrind` available in your `PATH`.
 
 
+## Summary
+
+In your Rakefile:
+
+``` ruby
+Hoe.plugin :debugging
+```
+
+Then you'll get the following rake tasks:
+
+```
+rake test:valgrind               # debugging # Run the test suite under Valgrind
+rake test:valgrind:mem           # debugging # Run the test suite under Valgrind with memory-fill
+rake test:valgrind:mem0          # debugging # Run the test suite under Valgrind with memory-zero
+rake test:valgrind:suppression   # debugging # Generate a valgrind suppression file for your test suite
+rake valgrind:suppression[file]  # debugging # Generate a valgrind suppression file from a previous run's log file
+```
+
+
 ## Examples
 
+Run your test suite under gdb:
+
+``` sh
+rake test:gdb
+```
+
+Run your test suite with valgrind's memcheck:
+
+``` sh
+rake test:valgrind
+```
+
+If you have repeatable valgrind warnings that you've decided it's OK to suppress:
+
+``` sh
+rake test:valgrind:suppression
+rake test:valgrind # when this runs, the previous run's errors will be suppressed
 ```
-# in your Rakefile
-Hoe.plugin :debugging
 
-# in your shell
-$ rake test:gdb
-$ rake test:valgrind
+If you have a log file containing hard-to-reproduce valgrind warnings (e.g., from CI) that you've decided it's OK to suppress:
 
-# 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
+``` sh
+rake valgrind:suppression[path/to/file]
+rake test:valgrind # when this runs, the errors from that log file will be suppressed
 ```
 
 

data/Rakefile

@@ -16,7 +16,7 @@ Hoe.spec "hoe-debugging" do
 
   license "MIT"
 
-  extra_dev_deps << ["bundler",       ">= 0"]
+  extra_dev_deps << ["bundler",       "~> 1.16"]
   extra_dev_deps << ["hoe",           "~> 3.1"]
   extra_dev_deps << ["hoe-bundler",   ">= 0"]
   extra_dev_deps << ["hoe-gemspec",   ">= 0"]

data/lib/hoe/debugging.rb

@@ -11,7 +11,7 @@ class Hoe #:nodoc:
   # * <tt>test:valgrind:mem0</tt>
 
   module Debugging
-    VERSION = "1.4.2" #:nodoc:
+    VERSION = "1.5.0" #:nodoc:
 
     ##
     # The exit code of valgrind when it detects an error.
@@ -37,6 +37,7 @@ class Hoe #:nodoc:
                                "--partial-loads-ok=yes",
                                "--undef-value-errors=no",
                                "--error-exitcode=#{ERROR_EXITCODE}",
+                               "--gen-suppressions=all",
                               ]
     end
 
@@ -104,7 +105,7 @@ class Hoe #:nodoc:
 
       desc "Generate a valgrind suppression file for your test suite."
       task "test:valgrind:suppression" do
-        vopts = valgrind_options + ["--gen-suppressions=all"]
+        vopts = valgrind_options
         generated_suppression_file = false
         ::Tempfile.open "hoe_debugging_valgrind_suppression_log" do |logfile|
           begin
@@ -119,6 +120,14 @@ class Hoe #:nodoc:
           puts "WARNING: no valgrind warnings detected, no suppressions file generated"
         end
       end
+
+      desc "Generate a valgrind suppression file from a previous run's log file"
+      task "valgrind:suppression", [:file] do |task, args|
+        file_path = args[:file]
+        raise "Please specify the path to your log file" unless file
+        suppfile = hoe_debugging_valgrind_helper.save_suppressions_from file_path
+        puts "NOTICE: saved suppressions to #{suppfile}"
+      end
     end
 
     class ValgrindHelper

data/spec/files/test_project/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-gem "bundler"
+gem "bundler", "~> 1.16"
 gem "hoe"
 gem "hoe-debugging", path: "../../.."
 gem "minitest"

data/spec/files/test_project/Rakefile

@@ -23,6 +23,8 @@ HOE = Hoe.spec "test_project" do |spec|
   spec.version = "1.0.0"
 end
 
+raise "ERROR: failed to load gem under test" if ::Hoe.bad_plugins.include?(:debugging)
+
 Rake::ExtensionTask.new("test_project")
 
 # vim: syntax=ruby

data/spec/hoe_debugging_exit_code_spec.rb

@@ -5,14 +5,30 @@ describe "exit code" do
     Rake.sh command, verbose: false
   end
 
+  def do_in_test_dir
+    Bundler.with_clean_env do
+      Dir.chdir test_dir do
+        saved_gemfile = ENV['BUNDLE_GEMFILE']
+        ENV['BUNDLE_GEMFILE'] = "./Gemfile"
+        begin
+          yield
+        ensure
+          ENV['BUNDLE_GEMFILE'] = saved_gemfile
+        end
+      end
+    end
+  end
+
   let(:test_dir) { File.join(File.dirname(__FILE__), "files/test_project") }
 
   before do
-    Bundler.with_clean_env do
-      Dir.chdir test_dir do
-        sh "gem install bundler > #{logfile} 2>&1"
-        sh "bundle install >> #{logfile} 2>&1"
+    do_in_test_dir do
+      begin
+        sh "bundle install > #{logfile} 2>&1"
         sh "bundle exec rake compile >> #{logfile} 2>&1"
+      rescue RuntimeError => e
+        puts "SETUP FAILED:\n#{File.read(logfile)}"
+        raise
       end
     end
   end
@@ -20,25 +36,21 @@ describe "exit code" do
   context "from a good run" do
     let(:logfile) { "good-run.log" }
     it "is zero" do
-      Bundler.with_clean_env do
-        Dir.chdir test_dir do
-          system "bundle exec rake test:valgrind TESTOPTS='--name /notexist/' >> #{logfile} 2>&1"
-          exitcode = $?
-          expect(exitcode.success?).to(be_truthy, File.read(logfile))
-        end
+      do_in_test_dir do
+        system "bundle exec rake test:valgrind TESTOPTS='--name /notexist/' >> #{logfile} 2>&1"
+        exitcode = $?
+        expect(exitcode.success?).to(be_truthy, File.read(logfile))
       end
     end
   end
 
   context "from a bad run" do
-    let(:logfile) { "good-run.log" }
+    let(:logfile) { "bad-run.log" }
     it "is nonzero" do
-      Bundler.with_clean_env do
-        Dir.chdir test_dir do
-          system "bundle exec rake test:valgrind >> #{logfile} 2>&1"
-          exitcode = $?
-          expect(exitcode.success?).to(be_falsey, File.read(logfile))
-        end
+      do_in_test_dir do
+        system "bundle exec rake test:valgrind >> #{logfile} 2>&1"
+        exitcode = $?
+        expect(exitcode.success?).to(be_falsey, File.read(logfile))
       end
     end
   end

data/spec/hoe_debugging_valgrind_helper_spec.rb

@@ -27,7 +27,7 @@ describe Hoe::Debugging::ValgrindHelper do
     it "returns possible suppression file matches in order of specificity" do
       helper = klass.new "myproj"
       allow(helper).to receive(:formatted_ruby_version) { "ruby-1.9.3.194" }
-      expect(helper.version_matches).to eq %w[ruby-1.9.3.194 ruby-1.9.3 ruby-1.9]
+      expect(helper.version_matches).to eq %w[ruby-1.9.3.194 ruby-1.9.3 ruby-1.9 ruby-1]
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hoe-debugging
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - John Barnette
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2018-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +138,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 description: |-
-  A Hoe plugin to help you debug your C extensions. This plugin provides `test:gdb` and `test:valgrind` tasks (plus a few variants).
+  A Hoe plugin to help you debug your C extensions. This plugin provides `test:gdb` and `test:valgrind` tasks (plus a few variants). As of v1.5 it also can generate a valgrind suppression from a previous test suite's log file.
 
   See the `Hoe::Debugging` module for a few configuration options.
 
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A Hoe plugin to help you debug your C extensions